ActiveVersion
Example
{
"name": "string",
"url": "string",
"privateUrl": "string",
"layerItemId": "string",
"versionId": "string",
"replicaName": "string",
"replicaId": "string",
"replicaLocation": "string",
"proReplicaLocation": "string"
}
Properties
Name | Type | Required |
---|---|---|
name | string | |
url | string | |
private | string¦null | |
layer | string | |
version | string | |
replica | string¦null | |
replica | string¦null | |
replica | string¦null | |
pro | string¦null |
Activity
Example
{
"typeName": "CloseJob",
"actionName": "Email",
"templateId": "string"
}
Properties
Name | Type | Required |
---|---|---|
type | string | |
action | string | |
template | string |
Enumerated values
typeName
CloseJob
CreateJob
AddComment
AssignJob
SetCurrentStep
DeleteJob
actionName
Email
WebRequest
Annotation
Example
{
"position": "string",
"color": "string",
"outlineColor": "string",
"labelColor": "string",
"text": "string"
}
Properties
Name | Type | Required |
---|---|---|
position | string | |
color | string¦null | |
outline | string¦null | |
label | string¦null | |
text | string |
ArcadeExpression
Example
{
"context": {
"jobId": "string"
},
"expression": "string",
"parseMode": "Standard",
"contextType": "BaseContext"
}
Properties
Name | Type | Required |
---|---|---|
context | JobArcadeExpressionContext | |
expression | string | |
parse | string | |
context | string |
Enumerated values
parseMode
Standard
URL
Query
contextType
BaseContext
JobContext
ArcadeExpressionResult
Example
{
"result": "string"
}
The result of evaluating an arcade expression
Properties
Name | Type | Required |
---|---|---|
result | string |
AssignedType
Example
"Unassigned"
- Type
- string
- Required
- false
- Restrictions
- none
- Default value
- Unassigned
Enumerated values
anonymous
Unassigned
Group
User
AssignmentBody
Example
{
"assignedTo": "string",
"assignedType": "Unassigned"
}
Properties
Name | Type | Required |
---|---|---|
assigned | string¦null | |
assigned | AssignedType |
AutomationAdd
Example
{
"automationName": "string",
"automationType": "Scheduled",
"enabled": true,
"details": "string"
}
Properties
Name | Type | Required |
---|---|---|
automation | string | |
automation | string | |
enabled | boolean | |
details | string |
Enumerated values
automationType
Scheduled
Webhook
AutomationBasic
Example
{
"automationId": "string",
"automationName": "string",
"automationType": "Scheduled",
"createdBy": "string"
}
Properties
Name | Type | Required |
---|---|---|
automation | string | |
automation | string | |
automation | string | |
created | string¦null |
Enumerated values
automationType
Scheduled
Webhook
AutomationDetails
Example
{
"automationId": "string",
"automationName": "string",
"automationType": "Scheduled",
"createdBy": "string",
"enabled": true,
"details": "string"
}
Properties
Name | Type | Required |
---|---|---|
automation | string | |
automation | string | |
automation | string | |
created | string¦null | |
enabled | boolean | |
details | string |
Enumerated values
automationType
Scheduled
Webhook
AutomationRequestBody
Example
{
"adds": [
{
"automationName": "string",
"automationType": "Scheduled",
"enabled": true,
"details": "string"
}
],
"updates": [
{
"automationId": "string",
"automationName": "string",
"enabled": true,
"details": "string"
}
],
"deletes": [
"string"
]
}
Properties
Name | Type | Required |
---|---|---|
adds | [AutomationAdd]¦null | |
updates | [AutomationUpdate]¦null | |
deletes | [string]¦null |
AutomationUpdate
Example
{
"automationId": "string",
"automationName": "string",
"enabled": true,
"details": "string"
}
Properties
Name | Type | Required |
---|---|---|
automation | string | |
automation | string¦null | |
enabled | boolean¦null | |
details | string¦null |
CodedValue
Example
{
"code": "string",
"name": "string"
}
Properties
Name | Type | Required |
---|---|---|
code | string | |
name | string |
CreateItemResponse
Example
{
"success": true,
"itemId": "string",
"status": "Executing",
"error": {
"message": "string",
"name": "UnableToDetermineHostingServer",
"details": [
"string"
]
}
}
Properties
Name | Type | Required |
---|---|---|
success | boolean¦null | |
item | string¦null | |
status | string | |
error | ErrorInfo |
Enumerated values
status
Executing
Succeeded
Failed
Upgrading
CreateJobOverrides
Example
{
"numberOfJobs": 1,
"jobName": "string",
"startDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"priority": "string",
"description": "string",
"ownedBy": "string",
"assignedType": "Unassigned",
"assignedTo": "string",
"percentComplete": 0.1,
"jobStatus": "string",
"notes": "string",
"parentJob": "string",
"location": {
"geometryType": "Multipoint",
"geometry": "string"
},
"extendedProperties": [
{
"identifier": "string",
"value": "string",
"dataType": "string",
"uniqueId": "string"
}
],
"relatedProperties": [
{
"tableName": "string",
"entries": [
{
"properties": [
{
"propertyName": "string",
"value": "string"
}
]
}
]
}
]
}
Properties
Name | Type | Required |
---|---|---|
number | number(integer) | |
job | string | |
start | string(date-time) | |
due | string(date-time) | |
priority | string | |
description | string | |
owned | string | |
assigned | AssignedType | |
assigned | string | |
percent | number(double) | |
job | string | |
notes | string | |
parent | string | |
location | Location | |
extended | [PropertyResponse] | |
related | [RelatedPropertyAdd] |
CreateJobsResponse
Example
{
"jobIds": [
"string"
],
"message": "string",
"autoExecuted": true
}
Properties
Name | Type | Required |
---|---|---|
job | [string] | |
message | string¦null | |
auto | boolean¦null |
CreateSavedSearchResponse
Example
{
"searchId": "string"
}
Properties
Name | Type | Required |
---|---|---|
search | string |
CreateWorkflowItemParameters
Example
{
"async": true
}
Properties
Name | Type | Required |
---|---|---|
async | boolean |
CurrentStep
Example
{
"stepId": "string",
"assignedTo": "string",
"assignedType": "Unassigned",
"stepName": "string",
"canSkip": true,
"manualHold": true,
"holdScheduledRelease": "2019-08-24T14:15:22Z",
"dependencies": true
}
Properties
Name | Type | Required |
---|---|---|
step | string¦null | |
assigned | string¦null | |
assigned | AssignedType | |
step | string¦null | |
can | boolean¦null | |
manual | boolean¦null | |
hold | string(date-time)¦null | |
dependencies | boolean¦null |
DataSourceDecentralized
Example
{
"name": "string",
"url": "string",
"sourceType": "string"
}
Properties
Name | Type | Required |
---|---|---|
name | string | |
url | string | |
source | string |
DataStoreSettings
Example
{
"settings": [
{
"propName": "string",
"value": "string",
"encrypted": true
}
]
}
Properties
Name | Type | Required |
---|---|---|
settings | [DataStoreSettingValue] |
DataStoreSettingValue
Example
{
"propName": "string",
"value": "string",
"encrypted": true
}
Properties
Name | Type | Required |
---|---|---|
prop | string | |
value | string¦null | |
encrypted | boolean |
DataStoreWorkflowDiagram
Example
{
"diagramId": "string",
"diagramVersion": 0,
"diagramName": "string",
"description": "string",
"diagramDetails": {}
}
Properties
Name | Type | Required |
---|---|---|
diagram | string | |
diagram | integer(int32) | |
diagram | string | |
description | string¦null | |
diagram | AbstractDiagramDetails |
DataType
Example
"String"
- Type
- string
- Required
- false
- Restrictions
- none
- Default value
- String
Enumerated values
anonymous
String
Integer
DateTime
DateOnly
TimeOnly
TimestampOffset
Boolean
Double
Unknown
DefaultStepOutput
Example
{
"value": "string",
"name": "string",
"dataType": "string",
"isEncoded": true
}
Properties
Name | Type | Required |
---|---|---|
value | string¦null | |
name | string¦null | |
data | string¦null | |
is | boolean¦null |
DetailedErrorDTO
Example
{
"message": "string",
"type": "string",
"details": [
{
"path": "string",
"errors": [
"string"
]
}
]
}
Properties
Name | Type | Required |
---|---|---|
message | string | |
type | string | |
details | JsonDetailsType |
Diagram
Example
{
"diagramId": "string",
"diagramVersion": 0,
"diagramName": "string",
"description": "string",
"initialStepId": "string",
"initialStepName": "string",
"steps": [
{
"id": "string",
"name": "string",
"description": "string",
"stepTemplateId": "string",
"automatic": true,
"proceedNext": true,
"canSkip": true,
"position": "string",
"shape": 0,
"color": "string",
"outlineColor": "string",
"labelColor": "string",
"action": {
"actionType": "string",
"args": {}
},
"paths": [
{
"nextStep": "string",
"expression": "string",
"label": "string",
"assignedTo": "string",
"points": [
{
"x": 0,
"y": 0
}
],
"ports": [
"string"
],
"assignedType": "Unassigned",
"status": "string",
"notifications": [
"string"
],
"lineColor": "string",
"labelColor": "string",
"isAssignedToCustomExpression": true,
"forceGroupAssignment": true
}
],
"helpUrl": "string",
"helpText": "string",
"helpLink": "string",
"encodeHelpLink": true,
"schedule": {
"scheduleType": "Duration",
"timeDuration": {
"months": 0,
"days": 0,
"hours": 0,
"minutes": 0,
"offset": 0
},
"specificTime": {
"type": "HourOfDay",
"dayOfWeek": 0,
"dayOfMonth": 0,
"month": 0,
"hour": 0,
"minutes": 0,
"offset": 0
},
"expression": "string"
}
}
],
"dataSources": [
{
"name": "string",
"url": "string",
"sourceType": "string"
}
],
"centralizedDataReferences": [
{}
],
"annotations": [
{
"position": "string",
"color": "string",
"outlineColor": "string",
"labelColor": "string",
"text": "string"
}
],
"displayGrid": true,
"useCentralizedDataReferences": true
}
Properties
Name | Type | Required |
---|---|---|
diagram | string | |
diagram | number | |
diagram | string | |
description | string | |
initial | string | |
initial | string | |
steps | [Step] | |
data | [DataSourceDecentralized] | |
centralized | [AbstractCentralizedDataReference] | |
annotations | [Annotation] | |
display | boolean | |
use | boolean |
ErrorDTO
Example
{
"message": "string",
"type": "string",
"name": "UnableToDetermineHostingServer",
"details": [
"string"
]
}
Properties
Name | Type | Required |
---|---|---|
message | string | |
type | string | |
name | string¦null | |
details | [string]¦null |
Enumerated values
name
UnableToDetermineHostingServer
InvalidHostingServerArguments
UnableToGetHostingServerFromPortal
InvalidConfiguration
UnableToConnectDirectlyToDatastore
UnableToGetDatastoreConnection
SourceSchemaChangesNotAllowed
InvalidPortalItemUrl
InvalidFirstStep
InvalidUserType
InvalidDiagramNameDuplicate
InvalidDiagramNameDuplicateUpdate
InvalidDiagramIdDuplicate
InvalidDiagramName
InvalidDiagramId
InvalidDiagramUnexpectedDecentralizedDataSources
InvalidDiagramUnexpectedCentralizedDataReferences
InvalidDiagramDuplicateDecentralizedDataSource
InvalidDiagramDuplicateCentralizedDataReference
InvalidDataSourceConfiguration
InvalidJobTemplateName
JobTemplateNotFound
JobTemplateInsufficientPrivilegesExtProperties
JobTemplateNotCreated
JobTemplateNameNotUnique
JobTemplateDuplicateId
JobTemplateExtPropertiesNotAllUpdated
JobTemplateNotDeleted
JobTemplatesNotDeleted
JobTemplateNotDeletedUsedInJobs
JobNotCreatedInvalidTemplateState
JobTemplateInvalidFinalJobStatus
JobTemplateInvalidInitialJobStatus
ExtPropertiesMissingAssociation
ExtPropertiesDuplicateTableNames
ExtPropertiesImportFailed
ExtPropertyTableMissingProperties
ExtPropertyTablesNotDeleted
ExtPropertyTableNameNotFound
ExtPropertyFeatureServiceIdInvalid
JobTemplateFailedInvalidExtProps
UnableToCreateExtPropTables
JobTemplateExtPropsNotUpdated
ExtPropsUnableToCreateDuplicateDetected
ExtPropsNotUpdated
ExtProps1MNotUpdated
InvalidDomainNameInvalid
InvalidDomainDataTypeInvalid
InvalidDomainFieldLengthRequired
InvalidDomainValueLength
AutomationUpdatesFailed
AutomationDetailsNotFound
AutomationScheduleInvalid
InvalidHoldArguments
AssignmentFailedStepNotUpdated
AssignmentFailedStepNotCurrent
AssignmentFailedUserNotFound
AssignmentFailedGroupNotFound
AssignmentFailedInvalidUsername
AssignmentFailedInvalidGroupId
AssignmentFailedMultipleCurrentSteps
AssignmentFailedNoCurrentStep
AssignmentFailedNoAssignPrivileges
AssignmentFailedInvalidIndividualJobAssign
AssignmentFailedInvalidGroupJobAssign
AssignmentFailedUnknown
AssignmentFailedJobClosed
AssignmentFailedStepRunning
AssignmentFailedStepHeld
JobIdNotFound
JobIdsNotFound
JobNotFoundForDelete
JobNotFoundForUpgrade
JobLocationNotFound
JobLocationNoUpdatesFound
CreateJobNegative
CreateJobTooManyJobs
InvalidJobIdLength
CreateJobCannotSpecifyNumJobsWithJobId
CreateJobCannotSpecifyNumJobsWithArcadeList
CreateJobRecursiveCreation
JobNotAssignedOrOwnedByCurrentUser
JobUpdateFailedJobClosed
JobUpdateFailedJobRunning
JobUpdateFailedImproperFormat
JobUpdateFailedInvalidField
JobUpdateFailedInsufficientPrivileges
InvalidDataReferenceId
InvalidDataSourceName
InvalidVersionNameAndGuid
VersionsNotFound
ItemIdNotFound
DataSourceNotFound
DataSourceNotFoundArcade
DataSourceNotFoundSelectedSources
DataSourceUrlNotFound
DataSourcePrivateUrlNotFound
InvalidJobQueryOrSearch
InvalidJobQuery
DiagramNotFound
MissingPrivileges
NotAllowedToUpgrade
ClaimVersionFailed
VersionCouldNotBeLocated
VersionFingerprintDoesNotExist
VersionFingerprintIsInvalid
AttachmentStepNotActive
ExecuteProGpToolboxNotFound
ExportFailed
ExportFailedJobTemplatesNotFound
ExportFailedDiagramsNotFound
ExportFailedMissingDiagramIds
ExportIdNotFound
ExportDirectoryInvalidConfiguration
ImportFailed
ImportFailedInvalidMappingFile
ImportFailedEmptyRequiredField
ImportFailedMissingTargetGroupId
ImportFailedOverwriteConfigurationWithPreserveValueFlag
ImportFailedInvalidPassphrase
ImportFailedMergeWithDecentralizedDiagram
ImportFailedCentralizedDataReferenceNotDefined
NoConfigFile
ConfigNewerSchema
CorruptConfiguration
ImportFailedJobsExist
JobsExistFailed
JobTemplateAutomationsNotAllImported
JobTemplateAutomationsNoneImported
JsonTransformFailed
ExtractChangesFailed
ExtractChangesFailedToGetResultUrl
WebsocketTokenError
InvalidToken
FailedToDeleteJobProgress
FailedToUpdateJobProgress
FailedToUploadFilePart
FailedToCommitUpload
FailedToRegisterUpload
FailedToUploadItem
FileTooLarge
AsyncInvalidStatusUrl
AsyncStatusTimeout
CurveGeometryNotSupported
GeometryCannotBeParsedToType
GeometryCannotBeParsed
ActivityRequiresAdvancedLicenseRole
ActivityInvalidMultipleJobs
ActionTypeNotSupportedWithActivity
ItemCreationStatusDoesNotExist
ItemCreationInsufficientPrivileges
ItemCreationOnlineOrgRestrictedState
ItemCreationFailed
ItemCreationFailedInvalidItem
ItemCreationInProgress
UnableToTransformViewJson
EmailSecretKeyNotFound
EmailRecipientsNotDefined
EmailSubjectInvalid
EmailBodyInvalid
EmailConfigurationInvalidForCustomSmtpProvider
EmailConfigurationInvalidForEnterprise
EmailConfigurationInvalidForOnline
EmailSendNotificationFailed
SmtpServerInvalid
SmtpPortInvalid
SmtpDefaultSenderEmailInvalid
WebRequestFailed
WebRequestBodyTooLong
WebRequestFailedToSaveAttachmentTooLong
WebRequestFailedToParseOutputsResponseTooLong
WebRequestUrlValidationEmptyUrl
WebRequestUrlValidationNotAllowed
SchemaUpgradeRequired
SchemaUpgradeRequiredToUseFeature
InvalidTimestampFormat
CleanupLogsFailed
ItemNotFound
JobArchived
ArchiveFailedToParse
ArchiveFailed
WebhooksUnsecureSettingDisabled
WebhooksMissingSignatureFormat
WebhooksMissingHeaderSecurityType
SchemaUpgradeFailed
UnableToCreateRelationship
PortalTaskLimitExceeded
PortalUnableToRetrieveWorkflowUrl
PortalUnableToRetrieveItem
UpgradeErrorAllClosed
UpgradeErrorMissingDiagram
UpgradeErrorRunning
UpgradeErrorRunningClosedMissing
UpgradeErrorMultiple
UpgradeErrorUpdateFailed
DeleteErrorRunning
DeleteError
CloseErrorRunning
ReopenError
ReopenErrorNoStep
ReopenErrorUpdateFailed
CloseErrorNoJobsClosed
CallFailedWithError
CallFailedWithMultipleErrors
CallFailedWithSuccessFalse
FeatureServiceCallFailedWithError
FeatureServiceCallFailedWithMultipleErrors
FeatureServiceCallFailedWithSuccessFalse
ResponseUnableToReadJson
ResponseFailed
UnableToReadViewJson
UnableToOpenViewLayerDefinition
UnableToCreateViewsInService
UnableToAddLocationLayersToView
NotAllViewsAdded
UnableToRecreateViews
UnableToRecreateLocationView
UnableToRecreateExtPropSearchView
UnableToRemoveLocationLayersFromView
UnableToRemoveViews
UnableToRemoveAllViews
UnableToRemoveExtPropSearchView
UnableToRetrieveCurrentUserInfo
UnableToGetLatestJobProgress
UnableToGetHoldFromJobProgress
InvalidDatastoreResponseFromFeatureLayer
InvalidDatastoreResponseMissingField
InvalidDatastoreResponse
InvalidDatastoreResponseCount
InvalidDatastoreResponseFromAddFeatures
UnableToApplyEdits
UnableToModifyEditorTracking
UnableToModifyOwnershipAccessControl
UnableToUpdateSourceSchemaChangesAllowed
UnableToCopyFields
UnableToUpdateSchemaVersionSetting
UnableToSaveSearch
UnableToUpdateSearch
UnableToSaveTemplate
UnableToUpdateTemplate
UnableToAddJobComment
InvalidFeatureLayer
FailedToAddNewLayers
FailedToCreateSchema
FailedToCreateSchemaViews
FailedToLoadData
WorkflowSchemaHasUnexpectedRelatedItems
UpgradeSchemaPartialSuccess
ErrorInfo
Example
{
"message": "string",
"name": "UnableToDetermineHostingServer",
"details": [
"string"
]
}
Properties
Name | Type | Required |
---|---|---|
message | string | |
name | string¦null | |
details | [string]¦null |
Enumerated values
name
UnableToDetermineHostingServer
InvalidHostingServerArguments
UnableToGetHostingServerFromPortal
InvalidConfiguration
UnableToConnectDirectlyToDatastore
UnableToGetDatastoreConnection
SourceSchemaChangesNotAllowed
InvalidPortalItemUrl
InvalidFirstStep
InvalidUserType
InvalidDiagramNameDuplicate
InvalidDiagramNameDuplicateUpdate
InvalidDiagramIdDuplicate
InvalidDiagramName
InvalidDiagramId
InvalidDiagramUnexpectedDecentralizedDataSources
InvalidDiagramUnexpectedCentralizedDataReferences
InvalidDiagramDuplicateDecentralizedDataSource
InvalidDiagramDuplicateCentralizedDataReference
InvalidDataSourceConfiguration
InvalidJobTemplateName
JobTemplateNotFound
JobTemplateInsufficientPrivilegesExtProperties
JobTemplateNotCreated
JobTemplateNameNotUnique
JobTemplateDuplicateId
JobTemplateExtPropertiesNotAllUpdated
JobTemplateNotDeleted
JobTemplatesNotDeleted
JobTemplateNotDeletedUsedInJobs
JobNotCreatedInvalidTemplateState
JobTemplateInvalidFinalJobStatus
JobTemplateInvalidInitialJobStatus
ExtPropertiesMissingAssociation
ExtPropertiesDuplicateTableNames
ExtPropertiesImportFailed
ExtPropertyTableMissingProperties
ExtPropertyTablesNotDeleted
ExtPropertyTableNameNotFound
ExtPropertyFeatureServiceIdInvalid
JobTemplateFailedInvalidExtProps
UnableToCreateExtPropTables
JobTemplateExtPropsNotUpdated
ExtPropsUnableToCreateDuplicateDetected
ExtPropsNotUpdated
ExtProps1MNotUpdated
InvalidDomainNameInvalid
InvalidDomainDataTypeInvalid
InvalidDomainFieldLengthRequired
InvalidDomainValueLength
AutomationUpdatesFailed
AutomationDetailsNotFound
AutomationScheduleInvalid
InvalidHoldArguments
AssignmentFailedStepNotUpdated
AssignmentFailedStepNotCurrent
AssignmentFailedUserNotFound
AssignmentFailedGroupNotFound
AssignmentFailedInvalidUsername
AssignmentFailedInvalidGroupId
AssignmentFailedMultipleCurrentSteps
AssignmentFailedNoCurrentStep
AssignmentFailedNoAssignPrivileges
AssignmentFailedInvalidIndividualJobAssign
AssignmentFailedInvalidGroupJobAssign
AssignmentFailedUnknown
AssignmentFailedJobClosed
AssignmentFailedStepRunning
AssignmentFailedStepHeld
JobIdNotFound
JobIdsNotFound
JobNotFoundForDelete
JobNotFoundForUpgrade
JobLocationNotFound
JobLocationNoUpdatesFound
CreateJobNegative
CreateJobTooManyJobs
InvalidJobIdLength
CreateJobCannotSpecifyNumJobsWithJobId
CreateJobCannotSpecifyNumJobsWithArcadeList
CreateJobRecursiveCreation
JobNotAssignedOrOwnedByCurrentUser
JobUpdateFailedJobClosed
JobUpdateFailedJobRunning
JobUpdateFailedImproperFormat
JobUpdateFailedInvalidField
JobUpdateFailedInsufficientPrivileges
InvalidDataReferenceId
InvalidDataSourceName
InvalidVersionNameAndGuid
VersionsNotFound
ItemIdNotFound
DataSourceNotFound
DataSourceNotFoundArcade
DataSourceNotFoundSelectedSources
DataSourceUrlNotFound
DataSourcePrivateUrlNotFound
InvalidJobQueryOrSearch
InvalidJobQuery
DiagramNotFound
MissingPrivileges
NotAllowedToUpgrade
ClaimVersionFailed
VersionCouldNotBeLocated
VersionFingerprintDoesNotExist
VersionFingerprintIsInvalid
AttachmentStepNotActive
ExecuteProGpToolboxNotFound
ExportFailed
ExportFailedJobTemplatesNotFound
ExportFailedDiagramsNotFound
ExportFailedMissingDiagramIds
ExportIdNotFound
ExportDirectoryInvalidConfiguration
ImportFailed
ImportFailedInvalidMappingFile
ImportFailedEmptyRequiredField
ImportFailedMissingTargetGroupId
ImportFailedOverwriteConfigurationWithPreserveValueFlag
ImportFailedInvalidPassphrase
ImportFailedMergeWithDecentralizedDiagram
ImportFailedCentralizedDataReferenceNotDefined
NoConfigFile
ConfigNewerSchema
CorruptConfiguration
ImportFailedJobsExist
JobsExistFailed
JobTemplateAutomationsNotAllImported
JobTemplateAutomationsNoneImported
JsonTransformFailed
ExtractChangesFailed
ExtractChangesFailedToGetResultUrl
WebsocketTokenError
InvalidToken
FailedToDeleteJobProgress
FailedToUpdateJobProgress
FailedToUploadFilePart
FailedToCommitUpload
FailedToRegisterUpload
FailedToUploadItem
FileTooLarge
AsyncInvalidStatusUrl
AsyncStatusTimeout
CurveGeometryNotSupported
GeometryCannotBeParsedToType
GeometryCannotBeParsed
ActivityRequiresAdvancedLicenseRole
ActivityInvalidMultipleJobs
ActionTypeNotSupportedWithActivity
ItemCreationStatusDoesNotExist
ItemCreationInsufficientPrivileges
ItemCreationOnlineOrgRestrictedState
ItemCreationFailed
ItemCreationFailedInvalidItem
ItemCreationInProgress
UnableToTransformViewJson
EmailSecretKeyNotFound
EmailRecipientsNotDefined
EmailSubjectInvalid
EmailBodyInvalid
EmailConfigurationInvalidForCustomSmtpProvider
EmailConfigurationInvalidForEnterprise
EmailConfigurationInvalidForOnline
EmailSendNotificationFailed
SmtpServerInvalid
SmtpPortInvalid
SmtpDefaultSenderEmailInvalid
WebRequestFailed
WebRequestBodyTooLong
WebRequestFailedToSaveAttachmentTooLong
WebRequestFailedToParseOutputsResponseTooLong
WebRequestUrlValidationEmptyUrl
WebRequestUrlValidationNotAllowed
SchemaUpgradeRequired
SchemaUpgradeRequiredToUseFeature
InvalidTimestampFormat
CleanupLogsFailed
ItemNotFound
JobArchived
ArchiveFailedToParse
ArchiveFailed
WebhooksUnsecureSettingDisabled
WebhooksMissingSignatureFormat
WebhooksMissingHeaderSecurityType
SchemaUpgradeFailed
UnableToCreateRelationship
PortalTaskLimitExceeded
PortalUnableToRetrieveWorkflowUrl
PortalUnableToRetrieveItem
UpgradeErrorAllClosed
UpgradeErrorMissingDiagram
UpgradeErrorRunning
UpgradeErrorRunningClosedMissing
UpgradeErrorMultiple
UpgradeErrorUpdateFailed
DeleteErrorRunning
DeleteError
CloseErrorRunning
ReopenError
ReopenErrorNoStep
ReopenErrorUpdateFailed
CloseErrorNoJobsClosed
CallFailedWithError
CallFailedWithMultipleErrors
CallFailedWithSuccessFalse
FeatureServiceCallFailedWithError
FeatureServiceCallFailedWithMultipleErrors
FeatureServiceCallFailedWithSuccessFalse
ResponseUnableToReadJson
ResponseFailed
UnableToReadViewJson
UnableToOpenViewLayerDefinition
UnableToCreateViewsInService
UnableToAddLocationLayersToView
NotAllViewsAdded
UnableToRecreateViews
UnableToRecreateLocationView
UnableToRecreateExtPropSearchView
UnableToRemoveLocationLayersFromView
UnableToRemoveViews
UnableToRemoveAllViews
UnableToRemoveExtPropSearchView
UnableToRetrieveCurrentUserInfo
UnableToGetLatestJobProgress
UnableToGetHoldFromJobProgress
InvalidDatastoreResponseFromFeatureLayer
InvalidDatastoreResponseMissingField
InvalidDatastoreResponse
InvalidDatastoreResponseCount
InvalidDatastoreResponseFromAddFeatures
UnableToApplyEdits
UnableToModifyEditorTracking
UnableToModifyOwnershipAccessControl
UnableToUpdateSourceSchemaChangesAllowed
UnableToCopyFields
UnableToUpdateSchemaVersionSetting
UnableToSaveSearch
UnableToUpdateSearch
UnableToSaveTemplate
UnableToUpdateTemplate
UnableToAddJobComment
InvalidFeatureLayer
FailedToAddNewLayers
FailedToCreateSchema
FailedToCreateSchemaViews
FailedToLoadData
WorkflowSchemaHasUnexpectedRelatedItems
UpgradeSchemaPartialSuccess
ExportSettings
Example
{
"jobTemplateIds": [
"string"
],
"diagramIds": [
"string"
],
"includeOtherConfiguration": true,
"passphrase": "string"
}
Properties
Name | Type | Required |
---|---|---|
job | [string]¦null | |
diagram | [string]¦null | |
include | boolean¦null | |
passphrase | string¦null |
ExtendedPropertyDefinition
Example
{
"propertyName": "string",
"propertyAlias": "string",
"propertyOrder": 0,
"dataType": "String",
"defaultValue": {},
"fieldLength": 0,
"required": true,
"editable": true,
"visible": true,
"domain": {
"type": "codedValue",
"codedValues": [
{
"code": "string",
"name": "string"
}
],
"range": [
"string"
]
}
}
Properties
Name | Type | Required |
---|---|---|
property | string | |
property | string | |
property | number(integer) | |
data | DataType | |
default | object | |
field | number(integer) | |
required | boolean | |
editable | boolean | |
visible | boolean | |
domain | ExtendedPropertyDomain |
ExtendedPropertyDomain
Example
{
"type": "codedValue",
"codedValues": [
{
"code": "string",
"name": "string"
}
],
"range": [
"string"
]
}
Properties
Name | Type | Required |
---|---|---|
type | string | |
coded | [CodedValue]¦null | |
range | [string]¦null |
Enumerated values
type
codedValue
range
ExtendedPropertyTableDefinition
Example
{
"tableName": "string",
"tableAlias": "string",
"tableOrder": 0,
"relationshipType": "OneToOne",
"featureServiceProperties": {
"itemId": "string",
"itemType": "SurveyForm",
"layerId": "string",
"portalType": "Current",
"portalUrl": "string",
"featureServiceUniqueId": "string",
"secure": true
},
"extendedPropertyDefinitions": [
{
"propertyName": "string",
"propertyAlias": "string",
"propertyOrder": 0,
"dataType": "String",
"defaultValue": {},
"fieldLength": 0,
"required": true,
"editable": true,
"visible": true,
"domain": {
"type": "codedValue",
"codedValues": [
{
"code": "string",
"name": "string"
}
],
"range": [
"string"
]
}
}
],
"updateExisting": true,
"associateToExisting": true,
"isAssociated": true
}
Properties
Name | Type | Required |
---|---|---|
table | string | |
table | string | |
table | integer(int32) | |
relationship | RelationshipType | |
feature | FeatureServiceProperties | |
extended | [ExtendedPropertyDefinition] | |
update | boolean¦null | |
associate | boolean¦null | |
is | boolean¦null |
FeatureServiceProperties
Example
{
"itemId": "string",
"itemType": "SurveyForm",
"layerId": "string",
"portalType": "Current",
"portalUrl": "string",
"featureServiceUniqueId": "string",
"secure": true
}
Properties
Name | Type | Required |
---|---|---|
item | string | |
item | string¦null | |
layer | string | |
portal | string¦null | |
portal | string¦null | |
feature | string | |
secure | boolean¦null |
Enumerated values
itemType
SurveyForm
portalType
Current
ArcGISOnline
Other
Found
Example
{
"found": true
}
Properties
Name | Type | Required |
---|---|---|
found | boolean |
GetLogsResponse
Example
{
"logs": [
{
"logLevel": "WARN",
"message": "string",
"jobId": "string",
"stepId": "string",
"createdDate": "2019-08-24T14:15:22Z",
"createdUser": "string"
}
]
}
Properties
Name | Type | Required |
---|---|---|
logs | [Log] |
Group
Example
{
"id": "string",
"name": "string",
"isAssignable": true,
"thumbnail": "string"
}
Properties
Name | Type | Required |
---|---|---|
id | string | |
name | string | |
is | boolean | |
thumbnail | string¦null |
GroupedValue
Example
{
"value": "string",
"count": 0
}
Properties
Name | Type | Required |
---|---|---|
value | string¦null | |
count | integer(int32) |
groupIds
Example
{
"groupIds": [
"string"
]
}
A list of group IDs
Properties
Name | Type | Required |
---|---|---|
group | [string] |
GroupRoleMembership
Example
{
"roles": [
"string"
]
}
Properties
Name | Type | Required |
---|---|---|
roles | [string] |
GroupRoleMembershipChanges
Example
{
"adds": {
"roles": [
"string"
]
},
"deletes": {
"roles": [
"string"
]
}
}
Properties
Name | Type | Required |
---|---|---|
adds | GroupRoleMembership | |
deletes | GroupRoleMembership |
Hold
Example
{
"jobId": "string",
"stepId": "string",
"holdId": "string",
"setBy": "string",
"setDate": "2019-08-24T14:15:22Z",
"scheduledRelease": "2019-08-24T14:15:22Z",
"releasedBy": "string",
"releasedDate": "2019-08-24T14:15:22Z",
"dependentJobId": "string",
"dependentStepId": "string"
}
Properties
Name | Type | Required |
---|---|---|
job | string | |
step | string | |
hold | string | |
set | string | |
set | string(date-time) | |
scheduled | string(date-time)¦null | |
released | string¦null | |
released | string(date-time)¦null | |
dependent | string¦null | |
dependent | string¦null |
ItemDetails
Example
{
"itemVersion": "string",
"upgradeAvailable": true,
"isOldestAllowedVersion": true,
"allowUnsecureWebhooks": true,
"customSMTP": true,
"settings": [
{
"propName": "string",
"value": "string",
"encrypted": true
}
]
}
Properties
Name | Type | Required |
---|---|---|
item | string | |
upgrade | boolean | |
is | boolean | |
allow | boolean | |
custom | boolean | |
settings | [DataStoreSettingValue]¦null |
Job
Example
{
"jobId": "string",
"jobName": "string",
"ownedBy": "string",
"createdBy": "string",
"notes": "string",
"description": "string",
"createdDate": "2019-08-24T14:15:22Z",
"startDate": "2019-08-24T14:15:22Z",
"startedDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"parentJob": "string",
"percentComplete": 0.1,
"priority": "string",
"diagramId": "string",
"diagramVersion": 0,
"diagramName": "string",
"currentSteps": [
{
"stepId": "string",
"assignedTo": "string",
"assignedType": "Unassigned",
"stepName": "string",
"canSkip": true,
"manualHold": true,
"holdScheduledRelease": "2019-08-24T14:15:22Z",
"dependencies": true
}
],
"jobStatus": "string",
"jobTemplateId": "string",
"jobTemplateName": "string",
"extendedProperties": [
{
"tableName": "string",
"featureServiceProperties": {
"itemId": "string",
"itemType": "SurveyForm",
"layerId": "string",
"portalType": "Current",
"portalUrl": "string",
"featureServiceUniqueId": "string",
"secure": true
},
"properties": [
{
"propertyName": "string",
"value": {}
}
]
}
],
"relatedProperties": [
{
"tableName": "string",
"featureServiceProperties": {
"itemId": "string",
"itemType": "SurveyForm",
"layerId": "string",
"portalType": "Current",
"portalUrl": "string",
"featureServiceUniqueId": "string",
"secure": true
},
"entries": [
{
"id": "string",
"createdDate": "2019-08-24T14:15:22Z",
"properties": [
{
"propertyName": "string",
"value": {}
}
]
}
]
}
],
"holds": [
{
"jobId": "string",
"stepId": "string",
"holdId": "string",
"setBy": "string",
"setDate": "2019-08-24T14:15:22Z",
"scheduledRelease": "2019-08-24T14:15:22Z",
"releasedBy": "string",
"releasedDate": "2019-08-24T14:15:22Z",
"dependentJobId": "string",
"dependentStepId": "string"
}
],
"activeVersions": [
{
"name": "string",
"url": "string",
"privateUrl": "string",
"layerItemId": "string",
"versionId": "string",
"replicaName": "string",
"replicaId": "string",
"replicaLocation": "string",
"proReplicaLocation": "string"
}
],
"hasLocation": 0,
"parentJobRefId": "string",
"closed": true,
"archived": true
}
Properties
Name | Type | Required |
---|---|---|
job | string¦null | |
job | string¦null | |
owned | string¦null | |
created | string¦null | |
notes | string¦null | |
description | string¦null | |
created | string(date-time)¦null | |
start | string(date-time)¦null | |
started | string(date-time)¦null | |
due | string(date-time)¦null | |
end | string(date-time)¦null | |
parent | string¦null | |
percent | number(double) | |
priority | string | |
diagram | string | |
diagram | integer(int32) | |
diagram | string | |
current | [CurrentStep] | |
job | string | |
job | string | |
job | string | |
extended | [JobExtendedPropertyTable]¦null | |
related | [JobRelatedPropertyTable]¦null | |
holds | [Hold]¦null | |
active | [ActiveVersion] | |
has | integer(int32)¦null | |
parent | string¦null | |
closed | boolean | |
archived | boolean¦null |
JobActionBody
Example
{
"type": "Finish",
"stepIds": [
"string"
],
"holdScheduledRelease": "2019-08-24T14:15:22Z",
"dependentJobId": "string",
"dependentStepId": "string"
}
Properties
Name | Type | Required |
---|---|---|
type | string | |
step | [string]¦null | |
hold | string(date-time)¦null | |
dependent | string¦null | |
dependent | string¦null |
Enumerated values
type
Finish
Run
Stop
SetCurrentStep
Hold
ReleaseHold
RefreshStatus
JobActionResponse
Example
{
"success": true,
"stepResponses": [
{
"stepId": "string",
"status": "Success",
"statusDescription": "The step was started running"
}
]
}
Properties
Name | Type | Required |
---|---|---|
success | boolean | |
step | [JobActionStepResponse] |
JobActionStepResponse
Example
{
"stepId": "string",
"status": "Success",
"statusDescription": "The step was started running"
}
Properties
Name | Type | Required |
---|---|---|
step | string | |
status | string | |
status | string |
Enumerated values
status
Success
NoStartedStep
NoActiveStep
AlreadyExecuting
AssignedToDifferentUser
JobClosed
StepNotCurrent
NoMatchingPaths
NotRunning
WaitingForInfo
Held
NotHeld
StepNotInDiagram
StepNotAuto
JobActionStepStatus
Example
"Success"
- Type
- string
- Required
- false
- Restrictions
- none
- Default value
- Success
Enumerated values
anonymous
Success
NoActiveStep
AlreadyExecuting
AssignedToDifferentUser
JobClosed
StepNotCurrent
NoStartedStep
NoMatchingPaths
NotRunning
JobActionType
Example
"Run"
- Type
- string
- Required
- false
- Restrictions
- none
- Default value
- Run
Enumerated values
anonymous
Run
Finish
Stop
JobArcadeExpressionContext
Example
{
"jobId": "string"
}
Properties
Name | Type | Required |
---|---|---|
job | string |
JobAttachmentDescription
Example
{
"id": "string",
"alias": "string",
"folder": "string",
"url": "string",
"lastModifiedBy": "string",
"lastModified": "2019-08-24T14:15:22Z"
}
Properties
Name | Type | Required |
---|---|---|
id | string | |
alias | string¦null | |
folder | string¦null | |
url | string¦null | |
last | string¦null | |
last | string(date-time)¦null |
JobAttachmentLinked
Example
{
"url": "string",
"alias": "string",
"folder": "string"
}
Properties
Name | Type | Required |
---|---|---|
url | string | |
alias | string | |
folder | string¦null |
JobAttachmentLinkedBody
Example
{
"attachments": [
{
"url": "string",
"alias": "string",
"folder": "string"
}
],
"stepId": "string"
}
Properties
Name | Type | Required |
---|---|---|
attachments | [JobAttachmentLinked] | |
step | string¦null |
JobAttachmentLinkedResult
Example
{
"alias": "string",
"attachmentId": "string"
}
Properties
Name | Type | Required |
---|---|---|
alias | string | |
attachment | string |
JobComment
Example
{
"jobId": "string",
"comment": "string",
"commentId": "string",
"lastModifiedBy": "string",
"lastModified": "2019-08-24T14:15:22Z"
}
Properties
Name | Type | Required |
---|---|---|
job | string | |
comment | string | |
comment | string¦null | |
last | string¦null | |
last | string(date-time)¦null |
JobCommentArg
Example
{
"comment": "string"
}
Properties
Name | Type | Required |
---|---|---|
comment | string |
JobExtendedProperty
Example
{
"propertyName": "string",
"value": {}
}
Properties
Name | Type | Required |
---|---|---|
property | string | |
value | object |
JobExtendedPropertyTable
Example
{
"tableName": "string",
"featureServiceProperties": {
"itemId": "string",
"itemType": "SurveyForm",
"layerId": "string",
"portalType": "Current",
"portalUrl": "string",
"featureServiceUniqueId": "string",
"secure": true
},
"properties": [
{
"propertyName": "string",
"value": {}
}
]
}
Properties
Name | Type | Required |
---|---|---|
table | string | |
feature | FeatureServiceProperties | |
properties | [JobExtendedProperty] |
JobHistory
Example
{
"date": "2019-08-24T14:15:22Z",
"jobId": "string",
"stepId": "string",
"username": "string",
"action": "Activated",
"result": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"durationSeconds": 0
}
Properties
Name | Type | Required |
---|---|---|
date | string(date-time)¦null | |
job | string | |
step | string¦null | |
username | string | |
action | string | |
result | string¦null | |
start | string(date-time)¦null | |
end | string(date-time)¦null | |
duration | integer(int64)¦null |
Enumerated values
action
Activated
Deactivated
Started
Paused
Finished
Completed
Error
Cancelled
Reassigned
Upgraded
Updated
Created
Deleted
Closed
Added
DependencyAdded
Held
HoldReleased
Reopened
Reactivated
JobManageBody
Example
{
"type": "Close",
"jobIds": [
"string"
]
}
Properties
Name | Type | Required |
---|---|---|
type | string | |
job | [string] |
Enumerated values
type
Close
Delete
Upgrade
Reopen
JobOverrides
Example
{
"allowRunningStepId": "string",
"jobName": "string",
"startDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"priority": "string",
"description": "string",
"ownedBy": "string",
"percentComplete": 0.1,
"jobStatus": "string",
"notes": "string",
"parentJob": "string",
"versions": [
{
"dataSourceName": "string",
"versionName": "string",
"versionGuid": "string",
"workflowAdministered": true
}
],
"extendedProperties": [
{
"identifier": "string",
"value": "string",
"dataType": "string",
"uniqueId": "string"
}
],
"relatedProperties": {
"adds": [
{
"tableName": "string",
"entries": [
{
"properties": [
{
"propertyName": "string",
"value": "string"
}
]
}
]
}
],
"deletes": [
{
"tableName": "string",
"ids": [
"string"
]
}
],
"updates": [
{
"tableName": "string",
"entries": [
{
"id": "string",
"properties": [
{
"propertyName": "string",
"value": "string"
}
]
}
]
}
]
}
}
Properties
Name | Type | Required |
---|---|---|
allow | string | |
job | string | |
start | string(date-time) | |
due | string(date-time) | |
priority | string | |
description | string | |
owned | string | |
percent | number(double) | |
job | string | |
notes | string | |
parent | string | |
versions | [Version] | |
extended | [PropertyResponse] | |
related | RelatedPropertyEdits |
JobQuery
Example
{
"q": "string",
"search": "string",
"fields": [
"string"
],
"displayNames": [
"string"
],
"sortFields": [
{
"field": "string",
"sortOrder": "Asc"
}
],
"spatialExtent": "string",
"hasLocation": true,
"start": 0,
"num": 0,
"returnAllRelatedProperties": true
}
Properties
Name | Type | Required |
---|---|---|
q | string¦null | |
search | string¦null | |
fields | [string]¦null | |
display | [string]¦null | |
sort | [SortField]¦null | |
spatial | string¦null | |
has | boolean¦null | |
start | integer(int32) | |
num | integer(int32) | |
return | boolean¦null |
JobQueryResult
Example
{
"q": "string",
"fields": [
{
"name": "string",
"fieldType": "String"
}
],
"results": [
[
{}
]
],
"start": 0,
"nextStart": 0,
"num": 0
}
Properties
Name | Type | Required |
---|---|---|
q | string | |
fields | [QueryResultFieldDefinition] | |
results | [[Anything]] | |
start | integer(int32) | |
next | integer(int32) | |
num | integer(int32) |
JobRelatedPropertyEntry
Example
{
"id": "string",
"createdDate": "2019-08-24T14:15:22Z",
"properties": [
{
"propertyName": "string",
"value": {}
}
]
}
Properties
Name | Type | Required |
---|---|---|
id | string | |
created | string(date-time) | |
properties | [JobExtendedProperty] |
JobRelatedPropertyTable
Example
{
"tableName": "string",
"featureServiceProperties": {
"itemId": "string",
"itemType": "SurveyForm",
"layerId": "string",
"portalType": "Current",
"portalUrl": "string",
"featureServiceUniqueId": "string",
"secure": true
},
"entries": [
{
"id": "string",
"createdDate": "2019-08-24T14:15:22Z",
"properties": [
{
"propertyName": "string",
"value": {}
}
]
}
]
}
Properties
Name | Type | Required |
---|---|---|
table | string | |
feature | FeatureServiceProperties | |
entries | [JobRelatedPropertyEntry] |
JobStatistics
Example
{
"total": 0,
"groupBy": "string",
"groupedValues": [
{
"value": "string",
"count": 0
}
]
}
Properties
Name | Type | Required |
---|---|---|
total | integer(int32) | |
group | string¦null | |
grouped | [GroupedValue]¦null |
JobStatisticsQuery
Example
{
"q": "string",
"search": "string",
"groupBy": "string",
"spatialExtent": "string",
"hasLocation": true
}
Properties
Name | Type | Required |
---|---|---|
q | string¦null | |
search | string¦null | |
group | string¦null | |
spatial | string¦null | |
has | boolean¦null |
JobTemplate
Example
{
"jobTemplateId": "string",
"jobTemplateName": "string",
"category": "string",
"defaultJobDuration": 0,
"defaultAssignedTo": "string",
"defaultDueDate": "2019-08-24T14:15:22Z",
"defaultStartDate": "2019-08-24T14:15:22Z",
"jobStartDateType": "CreationDate",
"diagramId": "string",
"diagramName": "string",
"diagramThumbnail": "string",
"defaultPriorityName": "string",
"defaultAssignedType": "Unassigned",
"description": "string",
"defaultDescription": "string",
"state": "Draft",
"defaultJobName": "string",
"defaultFinalStatus": "string",
"defaultStatus": "string",
"activities": [
{
"typeName": "CloseJob",
"actionName": "Email",
"templateId": "string"
}
],
"extendedPropertyTableDefinitions": [
{
"tableName": "string",
"tableAlias": "string",
"tableOrder": 0,
"relationshipType": "OneToOne",
"featureServiceProperties": {
"itemId": "string",
"itemType": "SurveyForm",
"layerId": "string",
"portalType": "Current",
"portalUrl": "string",
"featureServiceUniqueId": "string",
"secure": true
},
"extendedPropertyDefinitions": [
{
"propertyName": "string",
"propertyAlias": "string",
"propertyOrder": 0,
"dataType": "String",
"defaultValue": {},
"fieldLength": 0,
"required": true,
"editable": true,
"visible": true,
"domain": {
"type": "codedValue",
"codedValues": [
{
"code": "string",
"name": "string"
}
],
"range": [
"string"
]
}
}
],
"updateExisting": true,
"associateToExisting": true,
"isAssociated": true
}
],
"lastUpdatedBy": "string",
"lastUpdatedDate": "2019-08-24T14:15:22Z"
}
Properties
Name | Type | Required |
---|---|---|
job | string¦null | |
job | string | |
category | string¦null | |
default | integer(int32)¦null | |
default | string¦null | |
default | string(date-time)¦null | |
default | string(date-time)¦null | |
job | string¦null | |
diagram | string | |
diagram | string | |
diagram | string¦null | |
default | string | |
default | AssignedType | |
description | string¦null | |
default | string¦null | |
state | string | |
default | string¦null | |
default | string¦null | |
default | string¦null | |
activities | [Activity]¦null | |
extended | [ExtendedPropertyTableDefinition]¦null | |
last | string¦null | |
last | string(date-time)¦null |
Enumerated values
jobStartDateType
CreationDate
SpecificDate
state
Draft
Active
Automated
Retired
JobTemplateDescription
Example
{
"jobTemplateId": "string",
"jobTemplateName": "string",
"description": "string",
"category": "string",
"diagramId": "string",
"diagramName": "string",
"state": "Draft"
}
Properties
Name | Type | Required |
---|---|---|
job | string | |
job | string | |
description | string¦null | |
category | string¦null | |
diagram | string¦null | |
diagram | string¦null | |
state | string |
Enumerated values
state
Draft
Active
Automated
Retired
JsonDetailsType
Example
[
{
"path": "string",
"errors": [
"string"
]
}
]
Properties
Name | Type | Required |
---|---|---|
path | string | |
errors | [string] |
KeyValues
Example
{
"key": "string",
"value": "string",
"isEnabled": true
}
Properties
Name | Type | Required |
---|---|---|
key | string | |
value | string | |
is | boolean |
Location
Example
{
"geometryType": "Multipoint",
"geometry": "string"
}
Properties
Name | Type | Required |
---|---|---|
geometry | string¦null | |
geometry | string¦null |
Enumerated values
geometryType
Multipoint
Polyline
Polygon
LocationBody
Example
{
"location": {
"geometryType": "Multipoint",
"geometry": "string"
}
}
Properties
Name | Type | Required |
---|---|---|
location | Location |
Log
Example
{
"logLevel": "WARN",
"message": "string",
"jobId": "string",
"stepId": "string",
"createdDate": "2019-08-24T14:15:22Z",
"createdUser": "string"
}
Properties
Name | Type | Required |
---|---|---|
log | string | |
message | string | |
job | string¦null | |
step | string¦null | |
created | string(date-time)¦null | |
created | string¦null |
Enumerated values
logLevel
WARN
ERROR
Lookup
Example
{
"lookupName": "string",
"value": 0
}
Properties
Name | Type | Required |
---|---|---|
lookup | string | |
value | integer(int32) |
Lookups
Example
{
"lookups": [
{
"lookupName": "string",
"value": 0
}
]
}
Properties
Name | Type | Required |
---|---|---|
lookups | [Lookup] |
Point
Example
{
"x": 0,
"y": 0
}
Properties
Name | Type | Required |
---|---|---|
x | integer(int32) | |
y | integer(int32) |
PropertyEntry
Example
{
"propertyName": "string",
"value": "string"
}
Properties
Name | Type | Required |
---|---|---|
property | string | |
value | string¦null |
PropertyResponse
Example
{
"identifier": "string",
"value": "string",
"dataType": "string",
"uniqueId": "string"
}
Properties
Name | Type | Required |
---|---|---|
identifier | string | |
value | string¦null | |
data | string¦null | |
unique | string¦null |
QueryResultFieldDefinition
Example
{
"name": "string",
"fieldType": "String"
}
Properties
Name | Type | Required |
---|---|---|
name | string | |
field | string |
Enumerated values
fieldType
String
Integer
DateTime
Boolean
Double
RelatedPropertyAdd
Example
{
"tableName": "string",
"entries": [
{
"properties": [
{
"propertyName": "string",
"value": "string"
}
]
}
]
}
Properties
Name | Type | Required |
---|---|---|
table | string | |
entries | [RelatedPropertyAddEntry] |
RelatedPropertyAddEntry
Example
{
"properties": [
{
"propertyName": "string",
"value": "string"
}
]
}
Properties
Name | Type | Required |
---|---|---|
properties | [PropertyEntry] |
RelatedPropertyDelete
Example
{
"tableName": "string",
"ids": [
"string"
]
}
Properties
Name | Type | Required |
---|---|---|
table | string | |
ids | [string] |
RelatedPropertyEdits
Example
{
"adds": [
{
"tableName": "string",
"entries": [
{
"properties": [
{
"propertyName": "string",
"value": "string"
}
]
}
]
}
],
"deletes": [
{
"tableName": "string",
"ids": [
"string"
]
}
],
"updates": [
{
"tableName": "string",
"entries": [
{
"id": "string",
"properties": [
{
"propertyName": "string",
"value": "string"
}
]
}
]
}
]
}
Properties
Name | Type | Required |
---|---|---|
adds | [RelatedPropertyAdd]¦null | |
deletes | [RelatedPropertyDelete]¦null | |
updates | [RelatedPropertyUpdate]¦null |
RelatedPropertyUpdate
Example
{
"tableName": "string",
"entries": [
{
"id": "string",
"properties": [
{
"propertyName": "string",
"value": "string"
}
]
}
]
}
Properties
Name | Type | Required |
---|---|---|
table | string | |
entries | [RelatedPropertyUpdateEntry] |
RelatedPropertyUpdateEntry
Example
{
"id": "string",
"properties": [
{
"propertyName": "string",
"value": "string"
}
]
}
Properties
Name | Type | Required |
---|---|---|
id | string | |
properties | [PropertyEntry] |
RelationshipType
Example
"OneToOne"
- Type
- string
- Required
- false
- Restrictions
- none
- Default value
- OneToOne
Enumerated values
anonymous
OneToOne
OneToMany
RequestAttachment
Example
{
"folder": "string",
"customName": "string"
}
Properties
Name | Type | Required |
---|---|---|
folder | string¦null | |
custom | string¦null |
RequestAuth
Example
{
"apiKey": {
"key": "string",
"value": "string",
"addedTo": "QueryParams"
},
"credentials": {
"username": "string",
"password": "string",
"token": "string"
},
"authorizationType": "NoAuth",
"tokenRequest": {
"requestType": "GET",
"baseUrl": "string",
"queryParams": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"pathParams": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"headers": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"body": {
"formData": {
"keyValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
},
"urlEncoded": {
"keyValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
},
"raw": {
"content": "string",
"contentType": "string"
}
},
"authorization": {
"apiKey": {
"key": "string",
"value": "string",
"addedTo": "QueryParams"
},
"credentials": {
"username": "string",
"password": "string",
"token": "string"
},
"authorizationType": "NoAuth",
"tokenRequest": {}
},
"attachment": {
"folder": "string",
"customName": "string"
},
"outputValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"isAsync": true,
"retrySettings": {
"retrySeconds": 0,
"maxRetryCount": 0,
"endExpression": "string",
"expressionVariables": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
}
}
}
Properties
Name | Type | Required |
---|---|---|
api | RequestAuthAPIKey | |
credentials | RequestCredentials | |
authorization | string | |
token | WebRequest |
Enumerated values
authorizationType
NoAuth
ApiKey
ApiKeyGenerated
BearerToken
BearerTokenGenerated
BasicAuth
FederatedToken
DigestAuth
RequestAuthAPIKey
Example
{
"key": "string",
"value": "string",
"addedTo": "QueryParams"
}
Properties
Name | Type | Required |
---|---|---|
key | string | |
value | string¦null | |
added | string |
Enumerated values
addedTo
QueryParams
Header
RequestBody
Example
{
"formData": {
"keyValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
},
"urlEncoded": {
"keyValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
},
"raw": {
"content": "string",
"contentType": "string"
}
}
Properties
Name | Type | Required |
---|---|---|
form | RequestBodyKeyValues | |
url | RequestBodyKeyValues | |
raw | RequestRawBody |
RequestBodyKeyValues
Example
{
"keyValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
}
Properties
Name | Type | Required |
---|---|---|
key | [KeyValues] |
RequestCredentials
Example
{
"username": "string",
"password": "string",
"token": "string"
}
Properties
Name | Type | Required |
---|---|---|
username | string¦null | |
password | string¦null | |
token | string¦null |
RequestRawBody
Example
{
"content": "string",
"contentType": "string"
}
Properties
Name | Type | Required |
---|---|---|
content | string | |
content | string |
Role
Example
{
"roleName": "string",
"description": "string",
"privileges": [
"string"
]
}
Properties
Name | Type | Required |
---|---|---|
role | string¦null | |
description | string¦null | |
privileges | [string] |
SavedSearch
Example
{
"searchId": "string",
"name": "string",
"folder": "string",
"definition": {
"q": "string",
"search": "string",
"fields": [
"string"
],
"displayNames": [
"string"
],
"sortFields": [
{
"field": "string",
"sortOrder": "Asc"
}
],
"spatialExtent": "string",
"hasLocation": true,
"start": 0,
"num": 0,
"returnAllRelatedProperties": true
},
"searchType": "Chart",
"colorRamp": "string",
"sortIndex": 0
}
Properties
Name | Type | Required |
---|---|---|
search | string¦null | |
name | string | |
folder | string¦null | |
definition | JobQuery | |
search | string¦null | |
color | string¦null | |
sort | integer(int32)¦null |
Enumerated values
searchType
Chart
Standard
Schedule
Example
{
"scheduleType": "Duration",
"timeDuration": {
"months": 0,
"days": 0,
"hours": 0,
"minutes": 0,
"offset": 0
},
"specificTime": {
"type": "HourOfDay",
"dayOfWeek": 0,
"dayOfMonth": 0,
"month": 0,
"hour": 0,
"minutes": 0,
"offset": 0
},
"expression": "string"
}
Properties
Name | Type | Required |
---|---|---|
schedule | string | |
time | TimeDuration | |
specific | SpecificTime | |
expression | string¦null |
Enumerated values
scheduleType
Duration
SpecificTime
Expression
SortField
Example
{
"field": "string",
"sortOrder": "Asc"
}
Properties
Name | Type | Required |
---|---|---|
field | string | |
sort | string |
Enumerated values
sortOrder
Asc
Desc
SpecificTime
Example
{
"type": "HourOfDay",
"dayOfWeek": 0,
"dayOfMonth": 0,
"month": 0,
"hour": 0,
"minutes": 0,
"offset": 0
}
Properties
Name | Type | Required |
---|---|---|
type | string | |
day | integer(int32)¦null | |
day | integer(int32)¦null | |
month | integer(int32)¦null | |
hour | integer(int32) | |
minutes | integer(int32) | |
offset | integer(int32) |
Enumerated values
type
HourOfDay
NumberOfDays
DayOfWeek
DayOfMonth
MonthOfYear
Status
Example
{
"success": true,
"hasAdvancedLicense": true
}
Properties
Name | Type | Required |
---|---|---|
success | boolean | |
has | boolean |
Step
Example
{
"id": "string",
"name": "string",
"description": "string",
"stepTemplateId": "string",
"automatic": true,
"proceedNext": true,
"canSkip": true,
"position": "string",
"shape": 0,
"color": "string",
"outlineColor": "string",
"labelColor": "string",
"action": {
"actionType": "string",
"args": {}
},
"paths": [
{
"nextStep": "string",
"expression": "string",
"label": "string",
"assignedTo": "string",
"points": [
{
"x": 0,
"y": 0
}
],
"ports": [
"string"
],
"assignedType": "Unassigned",
"status": "string",
"notifications": [
"string"
],
"lineColor": "string",
"labelColor": "string",
"isAssignedToCustomExpression": true,
"forceGroupAssignment": true
}
],
"helpUrl": "string",
"helpText": "string",
"helpLink": "string",
"encodeHelpLink": true,
"schedule": {
"scheduleType": "Duration",
"timeDuration": {
"months": 0,
"days": 0,
"hours": 0,
"minutes": 0,
"offset": 0
},
"specificTime": {
"type": "HourOfDay",
"dayOfWeek": 0,
"dayOfMonth": 0,
"month": 0,
"hour": 0,
"minutes": 0,
"offset": 0
},
"expression": "string"
}
}
Properties
Name | Type | Required |
---|---|---|
id | string | |
name | string | |
description | string¦null | |
step | string¦null | |
automatic | boolean | |
proceed | boolean | |
can | boolean | |
position | string | |
shape | integer(int32) | |
color | string¦null | |
outline | string¦null | |
label | string¦null | |
action | StepAction | |
paths | [StepPath] | |
help | string¦null | |
help | string¦null | |
help | string¦null | |
encode | boolean¦null | |
schedule | Schedule |
StepAction
Example
{
"actionType": "string",
"args": {}
}
Properties
Name | Type | Required |
---|---|---|
action | string | |
args | object¦null |
StepOutputs
Example
{
"outputs": [
{
"value": "string",
"name": "string",
"dataType": "string",
"isEncoded": true
}
],
"returnValue": "string",
"isUserSpecifiedReturnValue": true,
"comment": "string"
}
Properties
Name | Type | Required |
---|---|---|
outputs | [DefaultStepOutput]¦null | |
return | string¦null | |
is | boolean¦null | |
comment | string¦null |
StepPath
Example
{
"nextStep": "string",
"expression": "string",
"label": "string",
"assignedTo": "string",
"points": [
{
"x": 0,
"y": 0
}
],
"ports": [
"string"
],
"assignedType": "Unassigned",
"status": "string",
"notifications": [
"string"
],
"lineColor": "string",
"labelColor": "string",
"isAssignedToCustomExpression": true,
"forceGroupAssignment": true
}
Properties
Name | Type | Required |
---|---|---|
next | string | |
expression | string¦null | |
label | string¦null | |
assigned | string¦null | |
points | [Point] | |
ports | [string] | |
assigned | AssignedType | |
status | string¦null | |
notifications | [string] | |
line | string¦null | |
label | string¦null | |
is | boolean¦null | |
force | boolean¦null |
Success
Example
{
"success": true
}
Properties
Name | Type | Required |
---|---|---|
success | boolean |
SuccessResponse
Example
{
"success": true,
"message": "string",
"name": "UnableToDetermineHostingServer"
}
Properties
Name | Type | Required |
---|---|---|
success | boolean | |
message | string¦null | |
name | string¦null |
Enumerated values
name
UnableToDetermineHostingServer
InvalidHostingServerArguments
UnableToGetHostingServerFromPortal
InvalidConfiguration
UnableToConnectDirectlyToDatastore
UnableToGetDatastoreConnection
SourceSchemaChangesNotAllowed
InvalidPortalItemUrl
InvalidFirstStep
InvalidUserType
InvalidDiagramNameDuplicate
InvalidDiagramNameDuplicateUpdate
InvalidDiagramIdDuplicate
InvalidDiagramName
InvalidDiagramId
InvalidDiagramUnexpectedDecentralizedDataSources
InvalidDiagramUnexpectedCentralizedDataReferences
InvalidDiagramDuplicateDecentralizedDataSource
InvalidDiagramDuplicateCentralizedDataReference
InvalidDataSourceConfiguration
InvalidJobTemplateName
JobTemplateNotFound
JobTemplateInsufficientPrivilegesExtProperties
JobTemplateNotCreated
JobTemplateNameNotUnique
JobTemplateDuplicateId
JobTemplateExtPropertiesNotAllUpdated
JobTemplateNotDeleted
JobTemplatesNotDeleted
JobTemplateNotDeletedUsedInJobs
JobNotCreatedInvalidTemplateState
JobTemplateInvalidFinalJobStatus
JobTemplateInvalidInitialJobStatus
ExtPropertiesMissingAssociation
ExtPropertiesDuplicateTableNames
ExtPropertiesImportFailed
ExtPropertyTableMissingProperties
ExtPropertyTablesNotDeleted
ExtPropertyTableNameNotFound
ExtPropertyFeatureServiceIdInvalid
JobTemplateFailedInvalidExtProps
UnableToCreateExtPropTables
JobTemplateExtPropsNotUpdated
ExtPropsUnableToCreateDuplicateDetected
ExtPropsNotUpdated
ExtProps1MNotUpdated
InvalidDomainNameInvalid
InvalidDomainDataTypeInvalid
InvalidDomainFieldLengthRequired
InvalidDomainValueLength
AutomationUpdatesFailed
AutomationDetailsNotFound
AutomationScheduleInvalid
InvalidHoldArguments
AssignmentFailedStepNotUpdated
AssignmentFailedStepNotCurrent
AssignmentFailedUserNotFound
AssignmentFailedGroupNotFound
AssignmentFailedInvalidUsername
AssignmentFailedInvalidGroupId
AssignmentFailedMultipleCurrentSteps
AssignmentFailedNoCurrentStep
AssignmentFailedNoAssignPrivileges
AssignmentFailedInvalidIndividualJobAssign
AssignmentFailedInvalidGroupJobAssign
AssignmentFailedUnknown
AssignmentFailedJobClosed
AssignmentFailedStepRunning
AssignmentFailedStepHeld
JobIdNotFound
JobIdsNotFound
JobNotFoundForDelete
JobNotFoundForUpgrade
JobLocationNotFound
JobLocationNoUpdatesFound
CreateJobNegative
CreateJobTooManyJobs
InvalidJobIdLength
CreateJobCannotSpecifyNumJobsWithJobId
CreateJobCannotSpecifyNumJobsWithArcadeList
CreateJobRecursiveCreation
JobNotAssignedOrOwnedByCurrentUser
JobUpdateFailedJobClosed
JobUpdateFailedJobRunning
JobUpdateFailedImproperFormat
JobUpdateFailedInvalidField
JobUpdateFailedInsufficientPrivileges
InvalidDataReferenceId
InvalidDataSourceName
InvalidVersionNameAndGuid
VersionsNotFound
ItemIdNotFound
DataSourceNotFound
DataSourceNotFoundArcade
DataSourceNotFoundSelectedSources
DataSourceUrlNotFound
DataSourcePrivateUrlNotFound
InvalidJobQueryOrSearch
InvalidJobQuery
DiagramNotFound
MissingPrivileges
NotAllowedToUpgrade
ClaimVersionFailed
VersionCouldNotBeLocated
VersionFingerprintDoesNotExist
VersionFingerprintIsInvalid
AttachmentStepNotActive
ExecuteProGpToolboxNotFound
ExportFailed
ExportFailedJobTemplatesNotFound
ExportFailedDiagramsNotFound
ExportFailedMissingDiagramIds
ExportIdNotFound
ExportDirectoryInvalidConfiguration
ImportFailed
ImportFailedInvalidMappingFile
ImportFailedEmptyRequiredField
ImportFailedMissingTargetGroupId
ImportFailedOverwriteConfigurationWithPreserveValueFlag
ImportFailedInvalidPassphrase
ImportFailedMergeWithDecentralizedDiagram
ImportFailedCentralizedDataReferenceNotDefined
NoConfigFile
ConfigNewerSchema
CorruptConfiguration
ImportFailedJobsExist
JobsExistFailed
JobTemplateAutomationsNotAllImported
JobTemplateAutomationsNoneImported
JsonTransformFailed
ExtractChangesFailed
ExtractChangesFailedToGetResultUrl
WebsocketTokenError
InvalidToken
FailedToDeleteJobProgress
FailedToUpdateJobProgress
FailedToUploadFilePart
FailedToCommitUpload
FailedToRegisterUpload
FailedToUploadItem
FileTooLarge
AsyncInvalidStatusUrl
AsyncStatusTimeout
CurveGeometryNotSupported
GeometryCannotBeParsedToType
GeometryCannotBeParsed
ActivityRequiresAdvancedLicenseRole
ActivityInvalidMultipleJobs
ActionTypeNotSupportedWithActivity
ItemCreationStatusDoesNotExist
ItemCreationInsufficientPrivileges
ItemCreationOnlineOrgRestrictedState
ItemCreationFailed
ItemCreationFailedInvalidItem
ItemCreationInProgress
UnableToTransformViewJson
EmailSecretKeyNotFound
EmailRecipientsNotDefined
EmailSubjectInvalid
EmailBodyInvalid
EmailConfigurationInvalidForCustomSmtpProvider
EmailConfigurationInvalidForEnterprise
EmailConfigurationInvalidForOnline
EmailSendNotificationFailed
SmtpServerInvalid
SmtpPortInvalid
SmtpDefaultSenderEmailInvalid
WebRequestFailed
WebRequestBodyTooLong
WebRequestFailedToSaveAttachmentTooLong
WebRequestFailedToParseOutputsResponseTooLong
WebRequestUrlValidationEmptyUrl
WebRequestUrlValidationNotAllowed
SchemaUpgradeRequired
SchemaUpgradeRequiredToUseFeature
InvalidTimestampFormat
CleanupLogsFailed
ItemNotFound
JobArchived
ArchiveFailedToParse
ArchiveFailed
WebhooksUnsecureSettingDisabled
WebhooksMissingSignatureFormat
WebhooksMissingHeaderSecurityType
SchemaUpgradeFailed
UnableToCreateRelationship
PortalTaskLimitExceeded
PortalUnableToRetrieveWorkflowUrl
PortalUnableToRetrieveItem
UpgradeErrorAllClosed
UpgradeErrorMissingDiagram
UpgradeErrorRunning
UpgradeErrorRunningClosedMissing
UpgradeErrorMultiple
UpgradeErrorUpdateFailed
DeleteErrorRunning
DeleteError
CloseErrorRunning
ReopenError
ReopenErrorNoStep
ReopenErrorUpdateFailed
CloseErrorNoJobsClosed
CallFailedWithError
CallFailedWithMultipleErrors
CallFailedWithSuccessFalse
FeatureServiceCallFailedWithError
FeatureServiceCallFailedWithMultipleErrors
FeatureServiceCallFailedWithSuccessFalse
ResponseUnableToReadJson
ResponseFailed
UnableToReadViewJson
UnableToOpenViewLayerDefinition
UnableToCreateViewsInService
UnableToAddLocationLayersToView
NotAllViewsAdded
UnableToRecreateViews
UnableToRecreateLocationView
UnableToRecreateExtPropSearchView
UnableToRemoveLocationLayersFromView
UnableToRemoveViews
UnableToRemoveAllViews
UnableToRemoveExtPropSearchView
UnableToRetrieveCurrentUserInfo
UnableToGetLatestJobProgress
UnableToGetHoldFromJobProgress
InvalidDatastoreResponseFromFeatureLayer
InvalidDatastoreResponseMissingField
InvalidDatastoreResponse
InvalidDatastoreResponseCount
InvalidDatastoreResponseFromAddFeatures
UnableToApplyEdits
UnableToModifyEditorTracking
UnableToModifyOwnershipAccessControl
UnableToUpdateSourceSchemaChangesAllowed
UnableToCopyFields
UnableToUpdateSchemaVersionSetting
UnableToSaveSearch
UnableToUpdateSearch
UnableToSaveTemplate
UnableToUpdateTemplate
UnableToAddJobComment
InvalidFeatureLayer
FailedToAddNewLayers
FailedToCreateSchema
FailedToCreateSchemaViews
FailedToLoadData
WorkflowSchemaHasUnexpectedRelatedItems
UpgradeSchemaPartialSuccess
TableDefinition
Example
{
"tableName": "string",
"tableAlias": "string",
"relationshipType": "OneToOne",
"featureServiceProperties": {
"itemId": "string",
"itemType": "SurveyForm",
"layerId": "string",
"portalType": "Current",
"portalUrl": "string",
"featureServiceUniqueId": "string",
"secure": true
},
"extendedPropertyDefinitions": [
{
"propertyName": "string",
"propertyAlias": "string",
"propertyOrder": 0,
"dataType": "String",
"defaultValue": {},
"fieldLength": 0,
"required": true,
"editable": true,
"visible": true,
"domain": {
"type": "codedValue",
"codedValues": [
{
"code": "string",
"name": "string"
}
],
"range": [
"string"
]
}
}
],
"jobTemplates": [
"string"
]
}
Properties
Name | Type | Required |
---|---|---|
table | string | |
table | string | |
relationship | RelationshipType | |
feature | FeatureServiceProperties | |
extended | [ExtendedPropertyDefinition] | |
job | [string] |
TableDefinitionsResult
Example
{
"tableDefinitions": [
{
"tableName": "string",
"tableAlias": "string",
"relationshipType": "OneToOne",
"featureServiceProperties": {
"itemId": "string",
"itemType": "SurveyForm",
"layerId": "string",
"portalType": "Current",
"portalUrl": "string",
"featureServiceUniqueId": "string",
"secure": true
},
"extendedPropertyDefinitions": [
{
"propertyName": "string",
"propertyAlias": "string",
"propertyOrder": 0,
"dataType": "String",
"defaultValue": {},
"fieldLength": 0,
"required": true,
"editable": true,
"visible": true,
"domain": {
"type": "codedValue",
"codedValues": [
{
"code": "string",
"name": "string"
}
],
"range": [
"string"
]
}
}
],
"jobTemplates": [
"string"
]
}
]
}
Properties
Name | Type | Required |
---|---|---|
table | [TableDefinition] |
Template
Example
{
"templateId": "string",
"templateName": "string",
"templateDetails": "string"
}
Properties
Name | Type | Required |
---|---|---|
template | string¦null | |
template | string | |
template | string |
TemplateDescription
Example
{
"templateId": "string",
"templateName": "string"
}
Properties
Name | Type | Required |
---|---|---|
template | string | |
template | string |
TestWebRequest
Example
{
"webRequest": {
"requestType": "GET",
"baseUrl": "string",
"queryParams": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"pathParams": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"headers": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"body": {
"formData": {
"keyValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
},
"urlEncoded": {
"keyValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
},
"raw": {
"content": "string",
"contentType": "string"
}
},
"authorization": {
"apiKey": {
"key": "string",
"value": "string",
"addedTo": "QueryParams"
},
"credentials": {
"username": "string",
"password": "string",
"token": "string"
},
"authorizationType": "NoAuth",
"tokenRequest": {}
},
"attachment": {
"folder": "string",
"customName": "string"
},
"outputValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"isAsync": true,
"retrySettings": {
"retrySeconds": 0,
"maxRetryCount": 0,
"endExpression": "string",
"expressionVariables": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
}
},
"jobId": "string"
}
Properties
Name | Type | Required |
---|---|---|
web | WebRequest | |
job | string¦null |
TimeDuration
Example
{
"months": 0,
"days": 0,
"hours": 0,
"minutes": 0,
"offset": 0
}
Properties
Name | Type | Required |
---|---|---|
months | integer(int32)¦null | |
days | integer(int32)¦null | |
hours | integer(int32)¦null | |
minutes | integer(int32)¦null | |
offset | integer(int32) |
UpdateAutomationsResult
Example
{
"success": true,
"message": "string",
"automationIds": [
"string"
]
}
Properties
Name | Type | Required |
---|---|---|
success | boolean | |
message | string | |
automation | [string] |
UpdateDiagramBody
Example
{
"deleteDraft": true,
"diagram": {
"diagramId": "string",
"diagramName": "string",
"description": "string",
"active": true,
"initialStepId": "string",
"initialStepName": "string",
"steps": [
{
"id": "string",
"name": "string",
"description": "string",
"stepTemplateId": "string",
"automatic": true,
"proceedNext": true,
"canSkip": true,
"position": "string",
"shape": 0,
"color": "string",
"outlineColor": "string",
"labelColor": "string",
"action": {
"actionType": "string",
"args": {}
},
"paths": [
{
"nextStep": "string",
"expression": "string",
"label": "string",
"assignedTo": "string",
"points": [
{
"x": 0,
"y": 0
}
],
"ports": [
"string"
],
"assignedType": "Unassigned",
"status": "string",
"notifications": [
"string"
],
"lineColor": "string",
"labelColor": "string",
"isAssignedToCustomExpression": true,
"forceGroupAssignment": true
}
],
"helpUrl": "string",
"helpText": "string",
"helpLink": "string",
"encodeHelpLink": true,
"schedule": {
"scheduleType": "Duration",
"timeDuration": {
"months": 0,
"days": 0,
"hours": 0,
"minutes": 0,
"offset": 0
},
"specificTime": {
"type": "HourOfDay",
"dayOfWeek": 0,
"dayOfMonth": 0,
"month": 0,
"hour": 0,
"minutes": 0,
"offset": 0
},
"expression": "string"
}
}
],
"dataSources": [
{
"name": "string",
"url": "string",
"sourceType": "string"
}
],
"centralizedDataReferences": [
{}
],
"annotations": [
{
"position": "string",
"color": "string",
"outlineColor": "string",
"labelColor": "string",
"text": "string"
}
],
"displayGrid": true,
"useCentralizedDataReferences": true
}
}
Properties
Name | Type | Required |
---|---|---|
delete | boolean | |
diagram | WorkflowDiagram |
UpgradedDiagramResponse
Example
{
"transformedDiagram": {
"diagramId": "string",
"diagramVersion": 0,
"diagramName": "string",
"description": "string",
"initialStepId": "string",
"initialStepName": "string",
"steps": [
{
"id": "string",
"name": "string",
"description": "string",
"stepTemplateId": "string",
"automatic": true,
"proceedNext": true,
"canSkip": true,
"position": "string",
"shape": 0,
"color": "string",
"outlineColor": "string",
"labelColor": "string",
"action": {
"actionType": "string",
"args": {}
},
"paths": [
{
"nextStep": "string",
"expression": "string",
"label": "string",
"assignedTo": "string",
"points": [
{
"x": 0,
"y": 0
}
],
"ports": [
"string"
],
"assignedType": "Unassigned",
"status": "string",
"notifications": [
"string"
],
"lineColor": "string",
"labelColor": "string",
"isAssignedToCustomExpression": true,
"forceGroupAssignment": true
}
],
"helpUrl": "string",
"helpText": "string",
"helpLink": "string",
"encodeHelpLink": true,
"schedule": {
"scheduleType": "Duration",
"timeDuration": {
"months": 0,
"days": 0,
"hours": 0,
"minutes": 0,
"offset": 0
},
"specificTime": {
"type": "HourOfDay",
"dayOfWeek": 0,
"dayOfMonth": 0,
"month": 0,
"hour": 0,
"minutes": 0,
"offset": 0
},
"expression": "string"
}
}
],
"dataSources": [
{
"name": "string",
"url": "string",
"sourceType": "string"
}
],
"centralizedDataReferences": [
{}
],
"annotations": [
{
"position": "string",
"color": "string",
"outlineColor": "string",
"labelColor": "string",
"text": "string"
}
],
"displayGrid": true,
"useCentralizedDataReferences": true
},
"modifiedStepIds": [
"string"
],
"failedStepIds": [
"string"
],
"modifiedDataSourceNames": [
"string"
],
"failedDataSourceNames": [
"string"
]
}
Properties
Name | Type | Required |
---|---|---|
transformed | Diagram | |
modified | [string] | |
failed | [string] | |
modified | [string] | |
failed | [string] |
User
Example
{
"username": "string",
"fullName": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"groups": [
"string"
],
"groupsOwned": [
"string"
],
"roles": [
"string"
],
"privileges": [
"string"
],
"thumbnail": "string"
}
Properties
Name | Type | Required |
---|---|---|
username | string | |
full | string | |
first | string¦null | |
last | string¦null | |
email | string¦null | |
groups | [string] | |
groups | [string]¦null | |
roles | [string]¦null | |
privileges | [string]¦null | |
thumbnail | string¦null |
UserDescription
Example
{
"username": "string",
"fullName": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"thumbnail": "string",
"isAssignable": true
}
Properties
Name | Type | Required |
---|---|---|
username | string | |
full | string | |
first | string¦null | |
last | string¦null | |
email | string¦null | |
thumbnail | string¦null | |
is | boolean |
Version
Example
{
"dataSourceName": "string",
"versionName": "string",
"versionGuid": "string",
"workflowAdministered": true
}
Properties
Name | Type | Required |
---|---|---|
data | string | |
version | string¦null | |
version | string¦null | |
workflow | boolean¦null |
WebRequest
Example
{
"requestType": "GET",
"baseUrl": "string",
"queryParams": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"pathParams": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"headers": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"body": {
"formData": {
"keyValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
},
"urlEncoded": {
"keyValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
},
"raw": {
"content": "string",
"contentType": "string"
}
},
"authorization": {
"apiKey": {
"key": "string",
"value": "string",
"addedTo": "QueryParams"
},
"credentials": {
"username": "string",
"password": "string",
"token": "string"
},
"authorizationType": "NoAuth",
"tokenRequest": {
"requestType": "GET",
"baseUrl": "string",
"queryParams": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"pathParams": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"headers": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"body": {
"formData": {
"keyValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
},
"urlEncoded": {
"keyValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
},
"raw": {
"content": "string",
"contentType": "string"
}
},
"authorization": {},
"attachment": {
"folder": "string",
"customName": "string"
},
"outputValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"isAsync": true,
"retrySettings": {
"retrySeconds": 0,
"maxRetryCount": 0,
"endExpression": "string",
"expressionVariables": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
}
}
},
"attachment": {
"folder": "string",
"customName": "string"
},
"outputValues": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"isAsync": true,
"retrySettings": {
"retrySeconds": 0,
"maxRetryCount": 0,
"endExpression": "string",
"expressionVariables": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
}
}
Properties
Name | Type | Required |
---|---|---|
request | string | |
base | string | |
query | [KeyValues]¦null | |
path | [KeyValues]¦null | |
headers | [KeyValues]¦null | |
body | RequestBody | |
authorization | RequestAuth | |
attachment | RequestAttachment | |
output | [KeyValues]¦null | |
is | boolean | |
retry | WebRequestRetrySettings |
Enumerated values
requestType
GET
POST
PUT
DELETE
HEAD
PATCH
OPTIONS
WebRequestParsed
Example
{
"headers": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"body": "string"
}
Properties
Name | Type | Required |
---|---|---|
headers | [KeyValues] | |
body | string¦null |
WebRequestResponse
Example
{
"status": 0,
"body": "string",
"requestUrl": "string",
"requestDetails": {
"headers": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"body": "string"
},
"headers": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
],
"outputs": {
"outputs": [
{
"value": "string",
"name": "string",
"dataType": "string",
"isEncoded": true
}
],
"returnValue": "string",
"isUserSpecifiedReturnValue": true,
"comment": "string"
}
}
Properties
Name | Type | Required |
---|---|---|
status | integer(int32) | |
body | string | |
request | string | |
request | WebRequestParsed | |
headers | [KeyValues] | |
outputs | StepOutputs |
WebRequestRetrySettings
Example
{
"retrySeconds": 0,
"maxRetryCount": 0,
"endExpression": "string",
"expressionVariables": [
{
"key": "string",
"value": "string",
"isEnabled": true
}
]
}
Properties
Name | Type | Required |
---|---|---|
retry | integer(int64) | |
max | integer(int32) | |
end | string | |
expression | [KeyValues]¦null |
WorkflowDiagram
Example
{
"diagramId": "string",
"diagramName": "string",
"description": "string",
"active": true,
"initialStepId": "string",
"initialStepName": "string",
"steps": [
{
"id": "string",
"name": "string",
"description": "string",
"stepTemplateId": "string",
"automatic": true,
"proceedNext": true,
"canSkip": true,
"position": "string",
"shape": 0,
"color": "string",
"outlineColor": "string",
"labelColor": "string",
"action": {
"actionType": "string",
"args": {}
},
"paths": [
{
"nextStep": "string",
"expression": "string",
"label": "string",
"assignedTo": "string",
"points": [
{
"x": 0,
"y": 0
}
],
"ports": [
"string"
],
"assignedType": "Unassigned",
"status": "string",
"notifications": [
"string"
],
"lineColor": "string",
"labelColor": "string",
"isAssignedToCustomExpression": true,
"forceGroupAssignment": true
}
],
"helpUrl": "string",
"helpText": "string",
"helpLink": "string",
"encodeHelpLink": true,
"schedule": {
"scheduleType": "Duration",
"timeDuration": {
"months": 0,
"days": 0,
"hours": 0,
"minutes": 0,
"offset": 0
},
"specificTime": {
"type": "HourOfDay",
"dayOfWeek": 0,
"dayOfMonth": 0,
"month": 0,
"hour": 0,
"minutes": 0,
"offset": 0
},
"expression": "string"
}
}
],
"dataSources": [
{
"name": "string",
"url": "string",
"sourceType": "string"
}
],
"centralizedDataReferences": [
{}
],
"annotations": [
{
"position": "string",
"color": "string",
"outlineColor": "string",
"labelColor": "string",
"text": "string"
}
],
"displayGrid": true,
"useCentralizedDataReferences": true
}
Properties
Name | Type | Required |
---|---|---|
diagram | string¦null | |
diagram | string | |
description | string¦null | |
active | boolean | |
initial | string¦null | |
initial | string¦null | |
steps | [Step] | |
data | [DataSourceDecentralized] | |
centralized | [AbstractCentralizedDataReference] | |
annotations | [Annotation] | |
display | boolean | |
use | boolean |
WorkflowDiagramDescription
Example
{
"diagramId": "string",
"diagramName": "string",
"description": "string",
"active": true,
"draft": true
}
Properties
Name | Type | Required |
---|---|---|
diagram | string | |
diagram | string | |
description | string¦null | |
active | boolean | |
draft | boolean |
WorkflowExceptionDTO
Example
{
"error": {
"message": "string",
"type": "string",
"name": "UnableToDetermineHostingServer",
"details": [
"string"
]
}
}
Properties
Name | Type | Required |
---|---|---|
error | ErrorDTO |
WorkflowJsonExceptionDTO
Example
{
"error": {
"message": "string",
"type": "string",
"details": [
{
"path": "string",
"errors": [
"string"
]
}
]
}
}
Properties
Name | Type | Required |
---|---|---|
error | DetailedErrorDTO |