POST
/{orgId}/{itemId}/settingsAdd or update one or more settings configured for the workflow system. The adminAdvanced privilege is required.
Note: Email settings are optional for ArcGIS Online.
Settings Parameters:
| Parameter | Description | Data Type |
|---|---|---|
| smtpDefaultSenderDisplayName | Optional . The display name for email notifications. | String |
| smtpDefaultSenderEmail | Optional. The email used to send notifications. | String |
| smtpUsername | Optional. Username for the SMTP server . | String |
| smtpPassword | Optional. Password for the SMTP server. | String |
| smtpPort | Optional. Port used by the SMTP server. | String |
| smtpProtocol | Optional. Protocol used by the SMTP server. | String |
| smtpServer | Optional. The server to be used for SMTP. | String |
Query parameters
| Name | Type | Required |
|---|---|---|
token | string¦null |
Body parameters
Supported content types: application/json
Type: DataStoreSettings
An object defining the settings
| Name | Type | Required |
|---|---|---|
settings | [DataStoreSettingValue] |
Path parameters
| Name | Type | Required |
|---|---|---|
org | string | |
item | string |
Response status
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | success | Success |
| 400 | Bad Request | invalid object | WorkflowJsonExceptionDTO |
Examples
Request
# You can also use wget
curl -X POST /{orgId}/{itemId}/settings \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <YOUR_TOKEN>' \
--data '{"settings":[{"propName":"string","value":"string","encrypted":true}]}'Response
{
"success": true
}