Skip to main content

Processes requests

Retrieving processes according to their name​

GET

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Releases?$filter=%20Name%20eq%20'all_activities_DocEnv'

Request headers​

KeyValue
AuthorizationBearer

Response code​

200 OK

Response body​

{
  "@odata.context": "https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/$metadata#Releases",
  "@odata.count": 1,
  "value": [
    {
      "Key": "01b7cf62-98e0-4a69-9a65-be7514643229",
      "ProcessKey": "all_activities",
      "ProcessVersion": "1.0.6666.26728",
      "IsLatestVersion": false,
      "IsProcessDeleted": false,
      "Description": null,
      "Name": "all_activities_DocEnv",
      "EnvironmentId": 7,
      "EnvironmentName": "DocEnv",
      "InputArguments": null,
      "Id": 6,
      "Arguments": null
    }
  ]
}

Changing the value of the input parameters of a specific process​

The following PATCH request to the /odata/Releases(Id) endpoint enables you to add or change the values of specific input parameters, at process level. If you want to add these values when starting a job, please see the Job Requests topic.

note

Please note that a maximum of 10,000 characters is accepted for the entire length of the JSON representation of input parameters, including argument names, all the escaped characters, spaces, brackets, and arguments values.

PATCH

https://{yourDomain}/{organizationName}/{tenantName}/orchestrator_/odata/Releases(55)

Request headers​

KeyValue
AuthorizationBearer

Request body​

{
  "Arguments": {
    "Input": "{\"age\":27,\"trueOrFalse\":false,\"stringNew\":\"testing\"}"
  }
}

Response code​

200 OK