release json

{
  "pipelines": [
    {
      "processName": "An Example Batch Process",
      "packageVersion": "2.0",
      "componentId": "83d6013f-96f5-4a75-a97b-f4934b0ec2e8",
      "notes": "This is an example set of notes",
      "schedule": "0 0 1 * * * ; 30 0 2-7 * * *",
      "automatedTestId": "used within automated_testing.py"
    },
    {
      "processName": "An Example Listener Process",
      "packageVersion": "1.0",
      "componentId": "b24f310b-6a66-4e0d-97a3-26f1e812b79a",
      "notes": "This is an example set of notes",
      "listenerStatus": "RUNNING"
    },
    {
      "processName": "An Example Custom Library",
      "componentId": "7bd40730-6df3-4ba9-b4b2-ed9153dbca6d",
      "packageVersion": "1.0",
      "notes": "Initial deployment"
    }
  ]
}

Release JSON Elements

Release JSON Element	Description
processName	Name of the process. Mainly used for human readability.
packageVersion	Define the package version. If one isn’t specified, the latest version will be used.
componentId	The component ID of the process to deploy.
notes	The notes that will be added to the packaged components and deployments.
schedule	The schedule that will be used to deploy the process. Each individual schedule is space delimited. Multiple schedules are semi-colon delimited. Additional notes below.
listenerStatus	The status of the listener when deployed. Values: RUNNING or PAUSED. RUNNING is default.

The schedule element requires six space-delimited values in the following order: minutes, hours, days of the week, days of the month, month, and year. For example, 0 0 1 * * * executes the process every Sunday at midnight.

Schedule Element Values

Field	Description
minutes	0 is the first minute of the hour — for example, 1:00 A.M. 59 is the last minute of the hour — for example, 1:59 A.M.
hours	Uses a 24-hour clock. 0 is midnight and 12 is noon.
daysOfWeek	1 is Sunday and 7 is Saturday.
daysOfMonth	1 is the first day of the month and 31 is the last day of the month.
month	1 is January and 12 is December. Often set to an asterisk [*].
year	4 digit year - for example, 2023. Often set to an asterisk [*].