Boomi Platform API Reference (1.0.0) - RuntimeReleaseSchedule

Toggle Pane

• RuntimeReleaseSchedule
  • postCreates a RuntimeReleaseSchedule object
  • getRetrieves an instance of a RuntimeReleaseSchedule object
  • postModifies or updates a RuntimeReleaseSchedule object
  • delDeletes a RuntimeReleaseSchedule object
  • postRetrieves multiple RuntimeReleaseSchedule objects by identifier.

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

RuntimeReleaseSchedule

The Runtime Release Schedule object allows you to configure a schedule for automatically receiving updates on a Runtime, Runtime cluster, or Runtime cloud.

Note: You must have the Runtime Management privilege to use the Runtime Release Schedule object.

Creates a RuntimeReleaseSchedule object

The CREATE operation sets a schedule for receiving updates with the scheduleType, dayOfWeek, hourOfDay, and timeZone fields.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

atomId required	string The ID of the container for which you want to set a schedule.
dayOfWeek required	string The day of the week that you want to receive updates on the Runtime, Runtime cluster, or Runtime cloud. 1. Required if scheduleType is set to FIRST or LAST
scheduleType required	string Enum: "NEVER" "FIRST" "LAST" Required. Determines whether you want to receive the updates when available, and if so, whether you receive them in the first or second (last) week they are available prior to the .- FIRST - Update within the first week that updates are available 1. LAST - Update within the second week that updates are available 2. NEVER - Update with the
timeZone required	string The time zone of your set schedule. 1. Must be a valid time zone 2. Required if scheduleType is set to FIRST or LAST
hourOfDay	integer <int32> The hour of the day that you want to receive updates on the Runtime, Runtime cluster, or Runtime cloud. 1. Must be between 0-23 2. Required if scheduleType is set to FIRST or LAST

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

atomId required	string The ID of the container for which you want to set a schedule.
dayOfWeek required	string The day of the week that you want to receive updates on the Runtime, Runtime cluster, or Runtime cloud. 1. Required if scheduleType is set to FIRST or LAST
scheduleType required	string Enum: "NEVER" "FIRST" "LAST" Required. Determines whether you want to receive the updates when available, and if so, whether you receive them in the first or second (last) week they are available prior to the .- FIRST - Update within the first week that updates are available 1. LAST - Update within the second week that updates are available 2. NEVER - Update with the
timeZone required	string The time zone of your set schedule. 1. Must be a valid time zone 2. Required if scheduleType is set to FIRST or LAST
hourOfDay	integer <int32> The hour of the day that you want to receive updates on the Runtime, Runtime cluster, or Runtime cloud. 1. Must be between 0-23 2. Required if scheduleType is set to FIRST or LAST

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/RuntimeReleaseSchedule

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "atomId": "2f717303-f3a1-4c09-8195-29d105b35620",
• "scheduleType": "LAST",
• "dayOfWeek": "SATURDAY",
• "hourOfDay": 17,
• "timeZone": "Australia/Queensland"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "RuntimeReleaseSchedule",
• "atomId": "2f717303-f3a1-4c09-8195-29d105b35620",
• "scheduleType": "LAST",
• "dayOfWeek": "SATURDAY",
• "hourOfDay": 17,
• "timeZone": "Australia/Queensland"

}

Retrieves an instance of a RuntimeReleaseSchedule object

The GET operation returns the current schedule for receiving updates on a specified Runtime, Runtime cluster, or Runtime cloud.

Authorizations:

basicAuth

path Parameters

id required

string The ID of the container for which you want to set a schedule.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

atomId required	string The ID of the container for which you want to set a schedule.
dayOfWeek required	string The day of the week that you want to receive updates on the Runtime, Runtime cluster, or Runtime cloud. 1. Required if scheduleType is set to FIRST or LAST
scheduleType required	string Enum: "NEVER" "FIRST" "LAST" Required. Determines whether you want to receive the updates when available, and if so, whether you receive them in the first or second (last) week they are available prior to the .- FIRST - Update within the first week that updates are available 1. LAST - Update within the second week that updates are available 2. NEVER - Update with the
timeZone required	string The time zone of your set schedule. 1. Must be a valid time zone 2. Required if scheduleType is set to FIRST or LAST
hourOfDay	integer <int32> The hour of the day that you want to receive updates on the Runtime, Runtime cluster, or Runtime cloud. 1. Must be between 0-23 2. Required if scheduleType is set to FIRST or LAST

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/RuntimeReleaseSchedule/{id}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "RuntimeReleaseSchedule",
• "atomId": "2f717303-f3a1-4c09-8195-29d105b35620",
• "scheduleType": "LAST",
• "dayOfWeek": "SATURDAY",
• "hourOfDay": 17,
• "timeZone": "Australia/Queensland"

}

Modifies or updates a RuntimeReleaseSchedule object

The UPDATE operation modifies a set schedule for receiving updates.

Authorizations:

basicAuth

path Parameters

id required

string The ID of the container for which you want to set a schedule.

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

atomId required	string The ID of the container for which you want to set a schedule.
dayOfWeek required	string The day of the week that you want to receive updates on the Runtime, Runtime cluster, or Runtime cloud. 1. Required if scheduleType is set to FIRST or LAST
scheduleType required	string Enum: "NEVER" "FIRST" "LAST" Required. Determines whether you want to receive the updates when available, and if so, whether you receive them in the first or second (last) week they are available prior to the .- FIRST - Update within the first week that updates are available 1. LAST - Update within the second week that updates are available 2. NEVER - Update with the
timeZone required	string The time zone of your set schedule. 1. Must be a valid time zone 2. Required if scheduleType is set to FIRST or LAST
hourOfDay	integer <int32> The hour of the day that you want to receive updates on the Runtime, Runtime cluster, or Runtime cloud. 1. Must be between 0-23 2. Required if scheduleType is set to FIRST or LAST

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

atomId required	string The ID of the container for which you want to set a schedule.
dayOfWeek required	string The day of the week that you want to receive updates on the Runtime, Runtime cluster, or Runtime cloud. 1. Required if scheduleType is set to FIRST or LAST
scheduleType required	string Enum: "NEVER" "FIRST" "LAST" Required. Determines whether you want to receive the updates when available, and if so, whether you receive them in the first or second (last) week they are available prior to the .- FIRST - Update within the first week that updates are available 1. LAST - Update within the second week that updates are available 2. NEVER - Update with the
timeZone required	string The time zone of your set schedule. 1. Must be a valid time zone 2. Required if scheduleType is set to FIRST or LAST
hourOfDay	integer <int32> The hour of the day that you want to receive updates on the Runtime, Runtime cluster, or Runtime cloud. 1. Must be between 0-23 2. Required if scheduleType is set to FIRST or LAST

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/RuntimeReleaseSchedule/{id}

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "atomId": "2f717303-f3a1-4c09-8195-29d105b35620",
• "scheduleType": "LAST",
• "dayOfWeek": "FRIDAY",
• "hourOfDay": 0,
• "timeZone": "Australia/Queensland"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "RuntimeReleaseSchedule",
• "atomId": "2f717303-f3a1-4c09-8195-29d105b35620",
• "scheduleType": "LAST",
• "dayOfWeek": "FRIDAY",
• "hourOfDay": 0,
• "timeZone": "Australia/Queensland"

}

Deletes a RuntimeReleaseSchedule object

The DELETE operation sets the scheduleType to NEVER, meaning that the Runtime, Runtime cluster, or Runtime cloud receives updates only during the .

Authorizations:

basicAuth

path Parameters

id required

string The ID of the container for which you want to set a schedule.

Responses

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/RuntimeReleaseSchedule/{id}

Response samples

• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "message": "Access denied due to insufficient permissions."

}

Retrieves multiple RuntimeReleaseSchedule objects by identifier.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

	Array of objects (BulkId)
type	string Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

	Array of objects
Array required object (RuntimeReleaseSchedule) index integer <int32> id string statusCode integer <int32> errorMessage string

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/RuntimeReleaseSchedule/bulk

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "request": [

  • {

    • "id": "56789abc-def0-1234-5678-9abcdef01234"

    }

  ],
• "type": "GET"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "response": [

  • {

    • "Result": {

      • "atomId": "string",
      • "dayOfWeek": "string",
      • "hourOfDay": 0,
      • "scheduleType": "NEVER",
      • "timeZone": "string"

      },
    • "index": 0,
    • "id": "string",
    • "statusCode": 0,
    • "errorMessage": "string"

    }

  ]

}