Add, update or delete an automated creation for a job template
Add, update or delete an automated creation for a job template. The adminBasic or adminAdvanced privilege is required. Automated creation includes scheduled job creation and webhooks. Scheduled automated job creation should use Coordinated Universal Time (UTC) for hour and minutes. This functionality requires a license for the ArcGIS Workflow Manager Server Advanced role for ArcGIS Enterprise or the ArcGIS Workflow Manager Advanced organization extension for ArcGIS Online.
Note: Automated job creation with webhooks is not supported in ArcGIS Online.
Add Automated Creation Parameters:
| Parameter | Description | Data Type |
|---|---|---|
| automationName | Required. The name of the automated creation to be created. | String |
| automationType | Required. The type of automated creation, Scheduled for scheduled automated job creation and Webhook for job creation from external resources. Once created, the automation type cannot be updated. | String |
| enabled | Required. If true, the automated creation will be active. | Boolean |
| details | Required. Details for the automated creation. | String |
Options of Details Parameter for Scheduled Job Creation:
| Input | Description | Data Type |
|---|---|---|
| timeType | Required. "HourOfDay", "NumberOfDays", "DayOfWeek", "DayOfMonth", "MonthOfYear" | String |
| month | Optional. Month of the year to run the schedule. | Integer |
| dayOfWeek | Optional. Day of the week to run the schedule. Required for time type "DayOfWeek". | Integer |
| dayOfMonth | Optional. Day of the month to run the schedule. Required for time type "DayOfMonth". | Integer |
| hour | Optional. Hour of the day to run the schedule. | Integer |
| minutes | Optional. Minute of the hour to run the schedule. | Integer |
| maxOccurrences | Optional. Maximum occurrences for the schedule | Integer |
| endDate | Optional. Date the schedule should end. | Date |
Options of timeType Value:
| Input | Range |
|---|---|
| minutes | 0 - 59 |
| hour | 0 - 23 |
| month | 1 - 12 |
| dayofMonth | 1 - 31 |
| dayofWeek | 1 - 7, with 1 being Sunday |
Options of Details Parameter for Webhook:
| Input | Description | Data Type |
|---|---|---|
| username | Required. The user name being used in the webhook | String |
| password | Required. The password being used in the webhook. | String |
| attachment | Optional. The attachment to be added to the job once the webhook is executed. It includes folder for folder name to store the attachment and customName for the attachment name. | Object |
| outputValues | Optional. The array of objects for outputs from the webhook execution. It defines key for output name, value for output value, and isEnabled. If isEnabled isn't defined, the default is true. | Array |
| fallbackUsername | Optional. The user name being used together with fallbackPassword if the username and password provided are not working. | String |
| fallbackPassword | Optional. The password being used if the username and password provided are not working. | String |
| headerSecret | Required. A secret key to include in the header of the request to secure the webhook. Include a key and value as the secret key to access the webhook, and isEnabled to enable/disable the secret key. If isEnabled is not defined, the default is true. The key and value can be defined using arcade expressions from user defined settings. | Object |
| headerSecurityType | Required. If you are using Simple header security, set the value to SecretKey. If you are using ArcGIS Webhook header security, set the value to HMAC. | String |
| headerSignatureFormat | Optional. For ArcGIS Webhook security only. Set the value to Base64. | String |
Update Automated Creation Parameters:
| Parameter | Description | Data Type |
|---|---|---|
| automationId | Required. The ID of the automated creation to be updated. | String |
| automationName | Optional. Include only if the name is being updated. | String |
| enabled | Optional. Include only if the state is being updated. | Boolean |
| details | Optional. Include only if automation details are being updated. | String |
Delete Automated Creation Parameters:
| Parameter | Description | Data Type |
|---|---|---|
| automationId | Required. The ID of the automated creation to be deleted. | String |
Body parameter
{
"adds": [
{
"automationName": "string",
"automationType": "Scheduled",
"enabled": true,
"details": "string"
}
],
"updates": [
{
"automationId": "string",
"automationName": "string",
"enabled": true,
"details": "string"
}
],
"deletes": [
"string"
]
}Query parameters
| Name | Type | Required |
|---|---|---|
| |
Path parameters
| Name | Type | Required |
|---|---|---|
| | |
| | |
| |
Examples
Request
# You can also use wget
curl -X POST /{orgId}/{itemId}/jobTemplates/{jobTemplateId}/automatedCreation \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}'Response
200 Response
{
"success": true,
"message": "string",
"automationIds": [
"string"
]
}| Status | Meaning | Description | Schema |
|---|---|---|---|
| success | ||
| Error |