Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - ProcessSchedules

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

ProcessSchedules

The Process Schedules object represents the run schedules for a deployed process.

The platform creates the Process Schedules object for every deployed process by default. Initially, the object is empty, and a run schedule is not in effect.

The fields used to specify run times conform with the Advanced (cron) syntax supported in the Scheduling dialog in the user interface at Manage > Runtime Management.

In schedule fields, an asterisk [*] indicates that the schedule runs every minute, hour, day of the week, day of the month, month, or year. Use hyphens to specify ranges of values, and use commas as delimiters between values and ranges. The time specification of a range — whether it be a range of years, months, days of the month or week, hours, or minutes — can optionally be followed by a slash and an interval of that unit of time. For example:

  • In the minutes field, a value of 0-59/15 specifies 0, 15, 30, and 45 minutes after the hour.
  • In the daysOfMonth field, a value of 3-30/3 specifies every third day beginning with the third day of the month.

Required Privileges

You need these privileges in the target environment:

Write access

  • API — Use the Boomi Platform API to access account data.
  • SCHEDULE_MAINTENANCE or ATOM_MANAGEMENT

Read access

  • API — Use the Boomi Platform API to access account data.
  • SCHEDULE_MAINTENANCE or ATOM_MANAGEMENT_READ_ONLY or ATOM_MANAGEMENT

Retrieves an instance of a ProcessSchedules object

Retrieves the Process Schedules object with a specific conceptual ID.

The ordinary GET operation retrieves the Process Schedules object with a specific conceptual ID. The bulk GET operation retrieves the Process Schedules objects with specific conceptual IDs to a maximum of 100. In addition, you can obtain conceptual IDs from the QUERY operation.

Authorizations:
basicAuth
path Parameters
id
required
string

The object’s conceptual ID, which is synthesized from the process and Runtime IDs.

Responses

Response Schema:
object (ScheduleRetry)
Array of objects (Schedule)
atomId
string

A unique ID assigned by the system to the Runtime.

id
string

The object’s conceptual ID, which is synthesized from the process and Runtime IDs.

processId
string

A unique ID assigned by the system to the process. Must not be a listener process.

Response samples

Content type
{
  • "@type": "ProcessSchedules",
  • "Schedule": [
    • {
      },
    • {
      }
    ],
  • "Retry": {
    • "@type": "ScheduleRetry",
    • "Schedule": [
      ],
    • "maxRetry": 2
    },
  • "processId": "789abcde-f012-3456-789a-bcdef0123456",
  • "atomId": "3456789a-bcde-f0123-4567-89abcdef012",
  • "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"
}

Modifies or updates a ProcessSchedules object

Clears and updates the process run schedules specified in the Process Schedules object with a specific ID. The body of the request must specify not only the conceptual object ID but also the Runtime and process IDs. You can obtain the object ID from a QUERY operation.

A Process Schedules object exists for every deployed process. If you do not update the schedule, the object is empty and a run schedule is not in effect.

Note: Listener processes cannot be scheduled. If a listener process is referenced, the call will fail with a 400 status code.

You must have the Runtime Management privilege and the Scheduling privilege to perform the UPDATE operation. If you have the Runtime Management Read Access privilege, you cannot update process run schedules.

Note: After you update run schedules for a process on a Runtime, those schedules appear in the Scheduling dialog using the Advanced (cron) syntax.

You can additionally employ a Bulk UPDATE operation for the Process Schedules object. Refer to the related links for more information about performing a Bulk UPDATE operation.

Authorizations:
basicAuth
path Parameters
id
required
string

The object’s conceptual ID, which is synthesized from the process and Runtime IDs.

Request Body schema:
optional
object (ScheduleRetry)
Array of objects (Schedule)
atomId
string

A unique ID assigned by the system to the Runtime.

id
string

The object’s conceptual ID, which is synthesized from the process and Runtime IDs.

processId
string

A unique ID assigned by the system to the process. Must not be a listener process.

Responses

Response Schema:
object (ScheduleRetry)
Array of objects (Schedule)
atomId
string

A unique ID assigned by the system to the Runtime.

id
string

The object’s conceptual ID, which is synthesized from the process and Runtime IDs.

processId
string

A unique ID assigned by the system to the process. Must not be a listener process.

Request samples

Content type
{
  • "Schedule": [
    • {
      },
    • {
      }
    ],
  • "Retry": {
    • "Schedule": [
      ],
    • "maxRetry": 2
    },
  • "processId": "789abcde-f012-3456-789a-bcdef0123456",
  • "atomId": "3456789a-bcde-f0123-4567-89abcdef012",
  • "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"
}

Response samples

Content type
{
  • "@type": "ProcessSchedules",
  • "Schedule": [
    • {
      },
    • {
      }
    ],
  • "Retry": {
    • "@type": "ScheduleRetry",
    • "Schedule": [
      ],
    • "maxRetry": 2
    },
  • "processId": "789abcde-f012-3456-789a-bcdef0123456",
  • "atomId": "3456789a-bcde-f0123-4567-89abcdef012",
  • "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"
}

Retrieves multiple ProcessSchedules objects by identifier

To learn more about bulk, refer to the topic Bulk GET operations.

Authorizations:
basicAuth
Request Body schema:
optional
Array of objects (BulkId)
type
string
Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:
Array of objects
Array
required
object (ProcessSchedules)
index
integer <int32>
id
string
statusCode
integer <int32>
errorMessage
string

Request samples

Content type
{
  • "request": [
    • {
      }
    ],
  • "type": "GET"
}

Response samples

Content type
{
  • "response": [
    • {
      }
    ]
}

Queries for a ProcessSchedules object(s)

For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging.

Authorizations:
basicAuth
Request Body schema:
optional

Possible properties include: processId, atomId

required
object
required
ProcessSchedulesSimpleExpression (object) or ProcessSchedulesGroupingExpression (object) (ProcessSchedulesExpression)
One of
operator
required
string
Enum: "EQUALS" "LIKE" "NOT_EQUALS" "IS_NULL" "IS_NOT_NULL" "BETWEEN" "GREATER_THAN" "GREATER_THAN_OR_EQUAL" "LESS_THAN" "LESS_THAN_OR_EQUAL" "CONTAINS" "NOT_CONTAINS"
property
required
string
Enum: "processId" "atomId"
argument
Array of strings

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (ProcessSchedules)

Request samples

Content type
Example
{
  • "QueryFilter": {
    • "expression": {
      }
    }
}

Response samples

Content type
{
  • "numberOfResults": 1,
  • "@type": "QueryResult",
  • "result": [
    • {
      }
    ]
}

Retrieves additional results for a ProcessSchedules query

To learn about using queryMore, refer to the topic Query paging.

Authorizations:
basicAuth
Request Body schema: text/plain
required
string

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (ProcessSchedules)

Response samples

Content type
{
  • "numberOfResults": 1,
  • "@type": "QueryResult",
  • "result": [
    • {
      }
    ]
}