Skip to content

Types

AbstractCentralizedDataReference

AbstractDiagramDetails

ActiveVersion

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
{
  "name": "string",
  "url": "string",
  "privateUrl": "string",
  "layerItemId": "string",
  "versionId": "string",
  "replicaName": "string",
  "replicaId": "string",
  "replicaLocation": "string",
  "proReplicaLocation": "string"
}

Properties

NameTypeRequired
namestring
urlstring
privateUrlstring¦null
layerItemIdstring
versionIdstring
replicaNamestring¦null
replicaIdstring¦null
replicaLocationstring¦null
proReplicaLocationstring¦null

Activity

Example
Use dark colors for code blocksCopy
1
2
3
4
5
{
  "typeName": "CloseJob",
  "actionName": "Email",
  "templateId": "string"
}

Properties

NameTypeRequired
typeNamestring
actionNamestring
templateIdstring

Enumerated values

typeName
CloseJob
Click to copy
CreateJob
Click to copy
AddComment
Click to copy
AssignJob
Click to copy
SetCurrentStep
Click to copy
DeleteJob
Click to copy
actionName
Email
Click to copy
WebRequest
Click to copy

Annotation

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
  "position": "string",
  "color": "string",
  "outlineColor": "string",
  "labelColor": "string",
  "text": "string"
}

Properties

NameTypeRequired
positionstring
colorstring¦null
outlineColorstring¦null
labelColorstring¦null
textstring

Anything

ArcadeExpression

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "context": {
    "jobId": "string"
  },
  "expression": "string",
  "parseMode": "Standard",
  "contextType": "BaseContext"
}

Properties

NameTypeRequired
contextJobArcadeExpressionContext
expressionstring
parseModestring
contextTypestring

Enumerated values

parseMode
Standard
Click to copy
URL
Click to copy
Query
Click to copy
contextType
BaseContext
Click to copy
JobContext
Click to copy

ArcadeExpressionContext

ArcadeExpressionResult

Example
Use dark colors for code blocksCopy
1
2
3
{
  "result": "string"
}

The result of evaluating an arcade expression

Properties

NameTypeRequired
resultstring

AssignedType

Example
Use dark colors for code blocksCopy
1
"Unassigned"
Type
string
Required
false
Restrictions
none
Default value
Unassigned

Enumerated values

anonymous
Unassigned
Click to copy
Group
Click to copy
User
Click to copy

AssignmentBody

Example
Use dark colors for code blocksCopy
1
2
3
4
{
  "assignedTo": "string",
  "assignedType": "Unassigned"
}

Properties

NameTypeRequired
assignedTostring¦null
assignedTypeAssignedType

AutomationAdd

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
{
  "automationName": "string",
  "automationType": "Scheduled",
  "enabled": true,
  "details": "string"
}

Properties

NameTypeRequired
automationNamestring
automationTypestring
enabledboolean
detailsstring

Enumerated values

automationType
Scheduled
Click to copy
Webhook
Click to copy

AutomationBasic

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
{
  "automationId": "string",
  "automationName": "string",
  "automationType": "Scheduled",
  "createdBy": "string"
}

Properties

NameTypeRequired
automationIdstring
automationNamestring
automationTypestring
createdBystring¦null

Enumerated values

automationType
Scheduled
Click to copy
Webhook
Click to copy

AutomationDetails

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "automationId": "string",
  "automationName": "string",
  "automationType": "Scheduled",
  "createdBy": "string",
  "enabled": true,
  "details": "string"
}

Properties

NameTypeRequired
automationIdstring
automationNamestring
automationTypestring
createdBystring¦null
enabledboolean
detailsstring

Enumerated values

automationType
Scheduled
Click to copy
Webhook
Click to copy

AutomationRequestBody

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "adds": [
    {
      "automationName": "string",
      "automationType": "Scheduled",
      "enabled": true,
      "details": "string"
    }
  ],
  "updates": [
    {
      "automationId": "string",
      "automationName": "string",
      "enabled": true,
      "details": "string"
    }
  ],
  "deletes": [
    "string"
  ]
}

Properties

NameTypeRequired
adds[AutomationAdd]¦null
updates[AutomationUpdate]¦null
deletes[string]¦null

AutomationUpdate

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
{
  "automationId": "string",
  "automationName": "string",
  "enabled": true,
  "details": "string"
}

Properties

NameTypeRequired
automationIdstring
automationNamestring¦null
enabledboolean¦null
detailsstring¦null

CodedValue

Example
Use dark colors for code blocksCopy
1
2
3
4
{
  "code": "string",
  "name": "string"
}

Properties

NameTypeRequired
codestring
namestring

CreateItemResponse

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
{
  "success": true,
  "itemId": "string",
  "status": "Executing",
  "error": {
    "message": "string",
    "name": "UnableToDetermineHostingServer",
    "details": [
      "string"
    ]
  }
}

Properties

NameTypeRequired
successboolean¦null
itemIdstring¦null
statusstring
errorErrorInfo

Enumerated values

status
Executing
Click to copy
Succeeded
Click to copy
Failed
Click to copy
Upgrading
Click to copy

CreateJobOverrides

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
{
  "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

NameTypeRequired
numberOfJobsnumber(integer)
jobNamestring
startDatestring(date-time)
dueDatestring(date-time)
prioritystring
descriptionstring
ownedBystring
assignedTypeAssignedType
assignedTostring
percentCompletenumber(double)
jobStatusstring
notesstring
parentJobstring
locationLocation
extendedProperties[PropertyResponse]
relatedProperties[RelatedPropertyAdd]

CreateJobsResponse

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
  "jobIds": [
    "string"
  ],
  "message": "string",
  "autoExecuted": true
}

Properties

NameTypeRequired
jobIds[string]
messagestring¦null
autoExecutedboolean¦null

CreateSavedSearchResponse

Example
Use dark colors for code blocksCopy
1
2
3
{
  "searchId": "string"
}

Properties

NameTypeRequired
searchIdstring

CreateWorkflowItemParameters

Example
Use dark colors for code blocksCopy
1
2
3
{
  "async": true
}

Properties

NameTypeRequired
asyncboolean

CurrentStep

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
{
  "stepId": "string",
  "assignedTo": "string",
  "assignedType": "Unassigned",
  "stepName": "string",
  "canSkip": true,
  "manualHold": true,
  "holdScheduledRelease": "2019-08-24T14:15:22Z",
  "dependencies": true
}

Properties

NameTypeRequired
stepIdstring¦null
assignedTostring¦null
assignedTypeAssignedType
stepNamestring¦null
canSkipboolean¦null
manualHoldboolean¦null
holdScheduledReleasestring(date-time)¦null
dependenciesboolean¦null

DataSourceDecentralized

Example
Use dark colors for code blocksCopy
1
2
3
4
5
{
  "name": "string",
  "url": "string",
  "sourceType": "string"
}

Properties

NameTypeRequired
namestring
urlstring
sourceTypestring

DataStoreSettings

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
{
  "settings": [
    {
      "propName": "string",
      "value": "string",
      "encrypted": true
    }
  ]
}

Properties

NameTypeRequired
settings[DataStoreSettingValue]

DataStoreSettingValue

Example
Use dark colors for code blocksCopy
1
2
3
4
5
{
  "propName": "string",
  "value": "string",
  "encrypted": true
}

Properties

NameTypeRequired
propNamestring
valuestring¦null
encryptedboolean

DataStoreWorkflowDiagram

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
  "diagramId": "string",
  "diagramVersion": 0,
  "diagramName": "string",
  "description": "string",
  "diagramDetails": {}
}

Properties

NameTypeRequired
diagramIdstring
diagramVersioninteger(int32)
diagramNamestring
descriptionstring¦null
diagramDetailsAbstractDiagramDetails

DataType

Example
Use dark colors for code blocksCopy
1
"String"
Type
string
Required
false
Restrictions
none
Default value
String

Enumerated values

anonymous
String
Click to copy
Integer
Click to copy
DateTime
Click to copy
DateOnly
Click to copy
TimeOnly
Click to copy
TimestampOffset
Click to copy
Boolean
Click to copy
Double
Click to copy
Unknown
Click to copy

DefaultStepOutput

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
{
  "value": "string",
  "name": "string",
  "dataType": "string",
  "isEncoded": true
}

Properties

NameTypeRequired
valuestring¦null
namestring¦null
dataTypestring¦null
isEncodedboolean¦null

DetailedErrorDTO

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
{
  "message": "string",
  "type": "string",
  "details": [
    {
      "path": "string",
      "errors": [
        "string"
      ]
    }
  ]
}

Properties

NameTypeRequired
messagestring
typestring
detailsJsonDetailsType

Diagram

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
{
  "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

NameTypeRequired
diagramIdstring
diagramVersionnumber
diagramNamestring
descriptionstring
initialStepIdstring
initialStepNamestring
steps[Step]
dataSources[DataSourceDecentralized]
centralizedDataReferences[AbstractCentralizedDataReference]
annotations[Annotation]
displayGridboolean
useCentralizedDataReferencesboolean

ErrorDTO

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "message": "string",
  "type": "string",
  "name": "UnableToDetermineHostingServer",
  "details": [
    "string"
  ]
}

Properties

NameTypeRequired
messagestring
typestring
namestring¦null
details[string]¦null

Enumerated values

name
UnableToDetermineHostingServer
Click to copy
InvalidHostingServerArguments
Click to copy
UnableToGetHostingServerFromPortal
Click to copy
InvalidConfiguration
Click to copy
UnableToConnectDirectlyToDatastore
Click to copy
UnableToGetDatastoreConnection
Click to copy
SourceSchemaChangesNotAllowed
Click to copy
InvalidPortalItemUrl
Click to copy
InvalidFirstStep
Click to copy
InvalidUserType
Click to copy
InvalidDiagramNameDuplicate
Click to copy
InvalidDiagramNameDuplicateUpdate
Click to copy
InvalidDiagramIdDuplicate
Click to copy
InvalidDiagramName
Click to copy
InvalidDiagramId
Click to copy
InvalidDiagramUnexpectedDecentralizedDataSources
Click to copy
InvalidDiagramUnexpectedCentralizedDataReferences
Click to copy
InvalidDiagramDuplicateDecentralizedDataSource
Click to copy
InvalidDiagramDuplicateCentralizedDataReference
Click to copy
InvalidDataSourceConfiguration
Click to copy
InvalidJobTemplateName
Click to copy
JobTemplateNotFound
Click to copy
JobTemplateInsufficientPrivilegesExtProperties
Click to copy
JobTemplateNotCreated
Click to copy
JobTemplateNameNotUnique
Click to copy
JobTemplateDuplicateId
Click to copy
JobTemplateExtPropertiesNotAllUpdated
Click to copy
JobTemplateNotDeleted
Click to copy
JobTemplatesNotDeleted
Click to copy
JobTemplateNotDeletedUsedInJobs
Click to copy
JobNotCreatedInvalidTemplateState
Click to copy
JobTemplateInvalidFinalJobStatus
Click to copy
JobTemplateInvalidInitialJobStatus
Click to copy
ExtPropertiesMissingAssociation
Click to copy
ExtPropertiesDuplicateTableNames
Click to copy
ExtPropertiesImportFailed
Click to copy
ExtPropertyTableMissingProperties
Click to copy
ExtPropertyTablesNotDeleted
Click to copy
ExtPropertyTableNameNotFound
Click to copy
ExtPropertyFeatureServiceIdInvalid
Click to copy
JobTemplateFailedInvalidExtProps
Click to copy
UnableToCreateExtPropTables
Click to copy
JobTemplateExtPropsNotUpdated
Click to copy
ExtPropsUnableToCreateDuplicateDetected
Click to copy
ExtPropsNotUpdated
Click to copy
ExtProps1MNotUpdated
Click to copy
InvalidDomainNameInvalid
Click to copy
InvalidDomainDataTypeInvalid
Click to copy
InvalidDomainFieldLengthRequired
Click to copy
InvalidDomainValueLength
Click to copy
AutomationUpdatesFailed
Click to copy
AutomationDetailsNotFound
Click to copy
AutomationScheduleInvalid
Click to copy
InvalidHoldArguments
Click to copy
AssignmentFailedStepNotUpdated
Click to copy
AssignmentFailedStepNotCurrent
Click to copy
AssignmentFailedUserNotFound
Click to copy
AssignmentFailedGroupNotFound
Click to copy
AssignmentFailedInvalidUsername
Click to copy
AssignmentFailedInvalidGroupId
Click to copy
AssignmentFailedMultipleCurrentSteps
Click to copy
AssignmentFailedNoCurrentStep
Click to copy
AssignmentFailedNoAssignPrivileges
Click to copy
AssignmentFailedInvalidIndividualJobAssign
Click to copy
AssignmentFailedInvalidGroupJobAssign
Click to copy
AssignmentFailedUnknown
Click to copy
AssignmentFailedJobClosed
Click to copy
AssignmentFailedStepRunning
Click to copy
AssignmentFailedStepHeld
Click to copy
JobIdNotFound
Click to copy
JobIdsNotFound
Click to copy
JobNotFoundForDelete
Click to copy
JobNotFoundForUpgrade
Click to copy
JobLocationNotFound
Click to copy
JobLocationNoUpdatesFound
Click to copy
CreateJobNegative
Click to copy
CreateJobTooManyJobs
Click to copy
InvalidJobIdLength
Click to copy
CreateJobCannotSpecifyNumJobsWithJobId
Click to copy
CreateJobCannotSpecifyNumJobsWithArcadeList
Click to copy
CreateJobRecursiveCreation
Click to copy
JobNotAssignedOrOwnedByCurrentUser
Click to copy
JobUpdateFailedJobClosed
Click to copy
JobUpdateFailedJobRunning
Click to copy
JobUpdateFailedImproperFormat
Click to copy
JobUpdateFailedInvalidField
Click to copy
JobUpdateFailedInsufficientPrivileges
Click to copy
InvalidDataReferenceId
Click to copy
InvalidDataSourceName
Click to copy
InvalidVersionNameAndGuid
Click to copy
VersionsNotFound
Click to copy
ItemIdNotFound
Click to copy
DataSourceNotFound
Click to copy
DataSourceNotFoundArcade
Click to copy
DataSourceNotFoundSelectedSources
Click to copy
DataSourceUrlNotFound
Click to copy
DataSourcePrivateUrlNotFound
Click to copy
InvalidJobQueryOrSearch
Click to copy
InvalidJobQuery
Click to copy
DiagramNotFound
Click to copy
MissingPrivileges
Click to copy
NotAllowedToUpgrade
Click to copy
ClaimVersionFailed
Click to copy
VersionCouldNotBeLocated
Click to copy
VersionFingerprintDoesNotExist
Click to copy
VersionFingerprintIsInvalid
Click to copy
AttachmentStepNotActive
Click to copy
ExecuteProGpToolboxNotFound
Click to copy
ExportFailed
Click to copy
ExportFailedJobTemplatesNotFound
Click to copy
ExportFailedDiagramsNotFound
Click to copy
ExportFailedMissingDiagramIds
Click to copy
ExportIdNotFound
Click to copy
ExportDirectoryInvalidConfiguration
Click to copy
ImportFailed
Click to copy
ImportFailedInvalidMappingFile
Click to copy
ImportFailedEmptyRequiredField
Click to copy
ImportFailedMissingTargetGroupId
Click to copy
ImportFailedOverwriteConfigurationWithPreserveValueFlag
Click to copy
ImportFailedInvalidPassphrase
Click to copy
ImportFailedMergeWithDecentralizedDiagram
Click to copy
ImportFailedCentralizedDataReferenceNotDefined
Click to copy
NoConfigFile
Click to copy
ConfigNewerSchema
Click to copy
CorruptConfiguration
Click to copy
ImportFailedJobsExist
Click to copy
JobsExistFailed
Click to copy
JobTemplateAutomationsNotAllImported
Click to copy
JobTemplateAutomationsNoneImported
Click to copy
JsonTransformFailed
Click to copy
ExtractChangesFailed
Click to copy
ExtractChangesFailedToGetResultUrl
Click to copy
WebsocketTokenError
Click to copy
InvalidToken
Click to copy
FailedToDeleteJobProgress
Click to copy
FailedToUpdateJobProgress
Click to copy
FailedToUploadFilePart
Click to copy
FailedToCommitUpload
Click to copy
FailedToRegisterUpload
Click to copy
FailedToUploadItem
Click to copy
FileTooLarge
Click to copy
AsyncInvalidStatusUrl
Click to copy
AsyncStatusTimeout
Click to copy
CurveGeometryNotSupported
Click to copy
GeometryCannotBeParsedToType
Click to copy
GeometryCannotBeParsed
Click to copy
ActivityRequiresAdvancedLicenseRole
Click to copy
ActivityInvalidMultipleJobs
Click to copy
ActionTypeNotSupportedWithActivity
Click to copy
ItemCreationStatusDoesNotExist
Click to copy
ItemCreationInsufficientPrivileges
Click to copy
ItemCreationOnlineOrgRestrictedState
Click to copy
ItemCreationFailed
Click to copy
ItemCreationFailedInvalidItem
Click to copy
ItemCreationInProgress
Click to copy
UnableToTransformViewJson
Click to copy
EmailSecretKeyNotFound
Click to copy
EmailRecipientsNotDefined
Click to copy
EmailSubjectInvalid
Click to copy
EmailBodyInvalid
Click to copy
EmailConfigurationInvalidForCustomSmtpProvider
Click to copy
EmailConfigurationInvalidForEnterprise
Click to copy
EmailConfigurationInvalidForOnline
Click to copy
EmailSendNotificationFailed
Click to copy
SmtpServerInvalid
Click to copy
SmtpPortInvalid
Click to copy
SmtpDefaultSenderEmailInvalid
Click to copy
WebRequestFailed
Click to copy
WebRequestBodyTooLong
Click to copy
WebRequestFailedToSaveAttachmentTooLong
Click to copy
WebRequestFailedToParseOutputsResponseTooLong
Click to copy
WebRequestUrlValidationEmptyUrl
Click to copy
WebRequestUrlValidationNotAllowed
Click to copy
SchemaUpgradeRequired
Click to copy
SchemaUpgradeRequiredToUseFeature
Click to copy
InvalidTimestampFormat
Click to copy
CleanupLogsFailed
Click to copy
ItemNotFound
Click to copy
JobArchived
Click to copy
ArchiveFailedToParse
Click to copy
ArchiveFailed
Click to copy
WebhooksUnsecureSettingDisabled
Click to copy
WebhooksMissingSignatureFormat
Click to copy
WebhooksMissingHeaderSecurityType
Click to copy
SchemaUpgradeFailed
Click to copy
UnableToCreateRelationship
Click to copy
PortalTaskLimitExceeded
Click to copy
PortalUnableToRetrieveWorkflowUrl
Click to copy
PortalUnableToRetrieveItem
Click to copy
UpgradeErrorAllClosed
Click to copy
UpgradeErrorMissingDiagram
Click to copy
UpgradeErrorRunning
Click to copy
UpgradeErrorRunningClosedMissing
Click to copy
UpgradeErrorMultiple
Click to copy
UpgradeErrorUpdateFailed
Click to copy
DeleteErrorRunning
Click to copy
DeleteError
Click to copy
CloseErrorRunning
Click to copy
ReopenError
Click to copy
ReopenErrorNoStep
Click to copy
ReopenErrorUpdateFailed
Click to copy
CloseErrorNoJobsClosed
Click to copy
CallFailedWithError
Click to copy
CallFailedWithMultipleErrors
Click to copy
CallFailedWithSuccessFalse
Click to copy
FeatureServiceCallFailedWithError
Click to copy
FeatureServiceCallFailedWithMultipleErrors
Click to copy
FeatureServiceCallFailedWithSuccessFalse
Click to copy
ResponseUnableToReadJson
Click to copy
ResponseFailed
Click to copy
UnableToReadViewJson
Click to copy
UnableToOpenViewLayerDefinition
Click to copy
UnableToCreateViewsInService
Click to copy
UnableToAddLocationLayersToView
Click to copy
NotAllViewsAdded
Click to copy
UnableToRecreateViews
Click to copy
UnableToRecreateLocationView
Click to copy
UnableToRecreateExtPropSearchView
Click to copy
UnableToRemoveLocationLayersFromView
Click to copy
UnableToRemoveViews
Click to copy
UnableToRemoveAllViews
Click to copy
UnableToRemoveExtPropSearchView
Click to copy
UnableToRetrieveCurrentUserInfo
Click to copy
UnableToGetLatestJobProgress
Click to copy
UnableToGetHoldFromJobProgress
Click to copy
InvalidDatastoreResponseFromFeatureLayer
Click to copy
InvalidDatastoreResponseMissingField
Click to copy
InvalidDatastoreResponse
Click to copy
InvalidDatastoreResponseCount
Click to copy
InvalidDatastoreResponseFromAddFeatures
Click to copy
UnableToApplyEdits
Click to copy
UnableToModifyEditorTracking
Click to copy
UnableToModifyOwnershipAccessControl
Click to copy
UnableToUpdateSourceSchemaChangesAllowed
Click to copy
UnableToCopyFields
Click to copy
UnableToUpdateSchemaVersionSetting
Click to copy
UnableToSaveSearch
Click to copy
UnableToUpdateSearch
Click to copy
UnableToSaveTemplate
Click to copy
UnableToUpdateTemplate
Click to copy
UnableToAddJobComment
Click to copy
InvalidFeatureLayer
Click to copy
FailedToAddNewLayers
Click to copy
FailedToCreateSchema
Click to copy
FailedToCreateSchemaViews
Click to copy
FailedToLoadData
Click to copy
WorkflowSchemaHasUnexpectedRelatedItems
Click to copy
UpgradeSchemaPartialSuccess
Click to copy

ErrorInfo

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
  "message": "string",
  "name": "UnableToDetermineHostingServer",
  "details": [
    "string"
  ]
}

Properties

NameTypeRequired
messagestring
namestring¦null
details[string]¦null

Enumerated values

name
UnableToDetermineHostingServer
Click to copy
InvalidHostingServerArguments
Click to copy
UnableToGetHostingServerFromPortal
Click to copy
InvalidConfiguration
Click to copy
UnableToConnectDirectlyToDatastore
Click to copy
UnableToGetDatastoreConnection
Click to copy
SourceSchemaChangesNotAllowed
Click to copy
InvalidPortalItemUrl
Click to copy
InvalidFirstStep
Click to copy
InvalidUserType
Click to copy
InvalidDiagramNameDuplicate
Click to copy
InvalidDiagramNameDuplicateUpdate
Click to copy
InvalidDiagramIdDuplicate
Click to copy
InvalidDiagramName
Click to copy
InvalidDiagramId
Click to copy
InvalidDiagramUnexpectedDecentralizedDataSources
Click to copy
InvalidDiagramUnexpectedCentralizedDataReferences
Click to copy
InvalidDiagramDuplicateDecentralizedDataSource
Click to copy
InvalidDiagramDuplicateCentralizedDataReference
Click to copy
InvalidDataSourceConfiguration
Click to copy
InvalidJobTemplateName
Click to copy
JobTemplateNotFound
Click to copy
JobTemplateInsufficientPrivilegesExtProperties
Click to copy
JobTemplateNotCreated
Click to copy
JobTemplateNameNotUnique
Click to copy
JobTemplateDuplicateId
Click to copy
JobTemplateExtPropertiesNotAllUpdated
Click to copy
JobTemplateNotDeleted
Click to copy
JobTemplatesNotDeleted
Click to copy
JobTemplateNotDeletedUsedInJobs
Click to copy
JobNotCreatedInvalidTemplateState
Click to copy
JobTemplateInvalidFinalJobStatus
Click to copy
JobTemplateInvalidInitialJobStatus
Click to copy
ExtPropertiesMissingAssociation
Click to copy
ExtPropertiesDuplicateTableNames
Click to copy
ExtPropertiesImportFailed
Click to copy
ExtPropertyTableMissingProperties
Click to copy
ExtPropertyTablesNotDeleted
Click to copy
ExtPropertyTableNameNotFound
Click to copy
ExtPropertyFeatureServiceIdInvalid
Click to copy
JobTemplateFailedInvalidExtProps
Click to copy
UnableToCreateExtPropTables
Click to copy
JobTemplateExtPropsNotUpdated
Click to copy
ExtPropsUnableToCreateDuplicateDetected
Click to copy
ExtPropsNotUpdated
Click to copy
ExtProps1MNotUpdated
Click to copy
InvalidDomainNameInvalid
Click to copy
InvalidDomainDataTypeInvalid
Click to copy
InvalidDomainFieldLengthRequired
Click to copy
InvalidDomainValueLength
Click to copy
AutomationUpdatesFailed
Click to copy
AutomationDetailsNotFound
Click to copy
AutomationScheduleInvalid
Click to copy
InvalidHoldArguments
Click to copy
AssignmentFailedStepNotUpdated
Click to copy
AssignmentFailedStepNotCurrent
Click to copy
AssignmentFailedUserNotFound
Click to copy
AssignmentFailedGroupNotFound
Click to copy
AssignmentFailedInvalidUsername
Click to copy
AssignmentFailedInvalidGroupId
Click to copy
AssignmentFailedMultipleCurrentSteps
Click to copy
AssignmentFailedNoCurrentStep
Click to copy
AssignmentFailedNoAssignPrivileges
Click to copy
AssignmentFailedInvalidIndividualJobAssign
Click to copy
AssignmentFailedInvalidGroupJobAssign
Click to copy
AssignmentFailedUnknown
Click to copy
AssignmentFailedJobClosed
Click to copy
AssignmentFailedStepRunning
Click to copy
AssignmentFailedStepHeld
Click to copy
JobIdNotFound
Click to copy
JobIdsNotFound
Click to copy
JobNotFoundForDelete
Click to copy
JobNotFoundForUpgrade
Click to copy
JobLocationNotFound
Click to copy
JobLocationNoUpdatesFound
Click to copy
CreateJobNegative
Click to copy
CreateJobTooManyJobs
Click to copy
InvalidJobIdLength
Click to copy
CreateJobCannotSpecifyNumJobsWithJobId
Click to copy
CreateJobCannotSpecifyNumJobsWithArcadeList
Click to copy
CreateJobRecursiveCreation
Click to copy
JobNotAssignedOrOwnedByCurrentUser
Click to copy
JobUpdateFailedJobClosed
Click to copy
JobUpdateFailedJobRunning
Click to copy
JobUpdateFailedImproperFormat
Click to copy
JobUpdateFailedInvalidField
Click to copy
JobUpdateFailedInsufficientPrivileges
Click to copy
InvalidDataReferenceId
Click to copy
InvalidDataSourceName
Click to copy
InvalidVersionNameAndGuid
Click to copy
VersionsNotFound
Click to copy
ItemIdNotFound
Click to copy
DataSourceNotFound
Click to copy
DataSourceNotFoundArcade
Click to copy
DataSourceNotFoundSelectedSources
Click to copy
DataSourceUrlNotFound
Click to copy
DataSourcePrivateUrlNotFound
Click to copy
InvalidJobQueryOrSearch
Click to copy
InvalidJobQuery
Click to copy
DiagramNotFound
Click to copy
MissingPrivileges
Click to copy
NotAllowedToUpgrade
Click to copy
ClaimVersionFailed
Click to copy
VersionCouldNotBeLocated
Click to copy
VersionFingerprintDoesNotExist
Click to copy
VersionFingerprintIsInvalid
Click to copy
AttachmentStepNotActive
Click to copy
ExecuteProGpToolboxNotFound
Click to copy
ExportFailed
Click to copy
ExportFailedJobTemplatesNotFound
Click to copy
ExportFailedDiagramsNotFound
Click to copy
ExportFailedMissingDiagramIds
Click to copy
ExportIdNotFound
Click to copy
ExportDirectoryInvalidConfiguration
Click to copy
ImportFailed
Click to copy
ImportFailedInvalidMappingFile
Click to copy
ImportFailedEmptyRequiredField
Click to copy
ImportFailedMissingTargetGroupId
Click to copy
ImportFailedOverwriteConfigurationWithPreserveValueFlag
Click to copy
ImportFailedInvalidPassphrase
Click to copy
ImportFailedMergeWithDecentralizedDiagram
Click to copy
ImportFailedCentralizedDataReferenceNotDefined
Click to copy
NoConfigFile
Click to copy
ConfigNewerSchema
Click to copy
CorruptConfiguration
Click to copy
ImportFailedJobsExist
Click to copy
JobsExistFailed
Click to copy
JobTemplateAutomationsNotAllImported
Click to copy
JobTemplateAutomationsNoneImported
Click to copy
JsonTransformFailed
Click to copy
ExtractChangesFailed
Click to copy
ExtractChangesFailedToGetResultUrl
Click to copy
WebsocketTokenError
Click to copy
InvalidToken
Click to copy
FailedToDeleteJobProgress
Click to copy
FailedToUpdateJobProgress
Click to copy
FailedToUploadFilePart
Click to copy
FailedToCommitUpload
Click to copy
FailedToRegisterUpload
Click to copy
FailedToUploadItem
Click to copy
FileTooLarge
Click to copy
AsyncInvalidStatusUrl
Click to copy
AsyncStatusTimeout
Click to copy
CurveGeometryNotSupported
Click to copy
GeometryCannotBeParsedToType
Click to copy
GeometryCannotBeParsed
Click to copy
ActivityRequiresAdvancedLicenseRole
Click to copy
ActivityInvalidMultipleJobs
Click to copy
ActionTypeNotSupportedWithActivity
Click to copy
ItemCreationStatusDoesNotExist
Click to copy
ItemCreationInsufficientPrivileges
Click to copy
ItemCreationOnlineOrgRestrictedState
Click to copy
ItemCreationFailed
Click to copy
ItemCreationFailedInvalidItem
Click to copy
ItemCreationInProgress
Click to copy
UnableToTransformViewJson
Click to copy
EmailSecretKeyNotFound
Click to copy
EmailRecipientsNotDefined
Click to copy
EmailSubjectInvalid
Click to copy
EmailBodyInvalid
Click to copy
EmailConfigurationInvalidForCustomSmtpProvider
Click to copy
EmailConfigurationInvalidForEnterprise
Click to copy
EmailConfigurationInvalidForOnline
Click to copy
EmailSendNotificationFailed
Click to copy
SmtpServerInvalid
Click to copy
SmtpPortInvalid
Click to copy
SmtpDefaultSenderEmailInvalid
Click to copy
WebRequestFailed
Click to copy
WebRequestBodyTooLong
Click to copy
WebRequestFailedToSaveAttachmentTooLong
Click to copy
WebRequestFailedToParseOutputsResponseTooLong
Click to copy
WebRequestUrlValidationEmptyUrl
Click to copy
WebRequestUrlValidationNotAllowed
Click to copy
SchemaUpgradeRequired
Click to copy
SchemaUpgradeRequiredToUseFeature
Click to copy
InvalidTimestampFormat
Click to copy
CleanupLogsFailed
Click to copy
ItemNotFound
Click to copy
JobArchived
Click to copy
ArchiveFailedToParse
Click to copy
ArchiveFailed
Click to copy
WebhooksUnsecureSettingDisabled
Click to copy
WebhooksMissingSignatureFormat
Click to copy
WebhooksMissingHeaderSecurityType
Click to copy
SchemaUpgradeFailed
Click to copy
UnableToCreateRelationship
Click to copy
PortalTaskLimitExceeded
Click to copy
PortalUnableToRetrieveWorkflowUrl
Click to copy
PortalUnableToRetrieveItem
Click to copy
UpgradeErrorAllClosed
Click to copy
UpgradeErrorMissingDiagram
Click to copy
UpgradeErrorRunning
Click to copy
UpgradeErrorRunningClosedMissing
Click to copy
UpgradeErrorMultiple
Click to copy
UpgradeErrorUpdateFailed
Click to copy
DeleteErrorRunning
Click to copy
DeleteError
Click to copy
CloseErrorRunning
Click to copy
ReopenError
Click to copy
ReopenErrorNoStep
Click to copy
ReopenErrorUpdateFailed
Click to copy
CloseErrorNoJobsClosed
Click to copy
CallFailedWithError
Click to copy
CallFailedWithMultipleErrors
Click to copy
CallFailedWithSuccessFalse
Click to copy
FeatureServiceCallFailedWithError
Click to copy
FeatureServiceCallFailedWithMultipleErrors
Click to copy
FeatureServiceCallFailedWithSuccessFalse
Click to copy
ResponseUnableToReadJson
Click to copy
ResponseFailed
Click to copy
UnableToReadViewJson
Click to copy
UnableToOpenViewLayerDefinition
Click to copy
UnableToCreateViewsInService
Click to copy
UnableToAddLocationLayersToView
Click to copy
NotAllViewsAdded
Click to copy
UnableToRecreateViews
Click to copy
UnableToRecreateLocationView
Click to copy
UnableToRecreateExtPropSearchView
Click to copy
UnableToRemoveLocationLayersFromView
Click to copy
UnableToRemoveViews
Click to copy
UnableToRemoveAllViews
Click to copy
UnableToRemoveExtPropSearchView
Click to copy
UnableToRetrieveCurrentUserInfo
Click to copy
UnableToGetLatestJobProgress
Click to copy
UnableToGetHoldFromJobProgress
Click to copy
InvalidDatastoreResponseFromFeatureLayer
Click to copy
InvalidDatastoreResponseMissingField
Click to copy
InvalidDatastoreResponse
Click to copy
InvalidDatastoreResponseCount
Click to copy
InvalidDatastoreResponseFromAddFeatures
Click to copy
UnableToApplyEdits
Click to copy
UnableToModifyEditorTracking
Click to copy
UnableToModifyOwnershipAccessControl
Click to copy
UnableToUpdateSourceSchemaChangesAllowed
Click to copy
UnableToCopyFields
Click to copy
UnableToUpdateSchemaVersionSetting
Click to copy
UnableToSaveSearch
Click to copy
UnableToUpdateSearch
Click to copy
UnableToSaveTemplate
Click to copy
UnableToUpdateTemplate
Click to copy
UnableToAddJobComment
Click to copy
InvalidFeatureLayer
Click to copy
FailedToAddNewLayers
Click to copy
FailedToCreateSchema
Click to copy
FailedToCreateSchemaViews
Click to copy
FailedToLoadData
Click to copy
WorkflowSchemaHasUnexpectedRelatedItems
Click to copy
UpgradeSchemaPartialSuccess
Click to copy

ExportSettings

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
{
  "jobTemplateIds": [
    "string"
  ],
  "diagramIds": [
    "string"
  ],
  "includeOtherConfiguration": true,
  "passphrase": "string"
}

Properties

NameTypeRequired
jobTemplateIds[string]¦null
diagramIds[string]¦null
includeOtherConfigurationboolean¦null
passphrasestring¦null

ExtendedPropertyDefinition

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
  "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

NameTypeRequired
propertyNamestring
propertyAliasstring
propertyOrdernumber(integer)
dataTypeDataType
defaultValueobject
fieldLengthnumber(integer)
requiredboolean
editableboolean
visibleboolean
domainExtendedPropertyDomain

ExtendedPropertyDomain

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
{
  "type": "codedValue",
  "codedValues": [
    {
      "code": "string",
      "name": "string"
    }
  ],
  "range": [
    "string"
  ]
}

Properties

NameTypeRequired
typestring
codedValues[CodedValue]¦null
range[string]¦null

Enumerated values

type
codedValue
Click to copy
range
Click to copy

ExtendedPropertyTableDefinition

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
{
  "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

NameTypeRequired
tableNamestring
tableAliasstring
tableOrderinteger(int32)
relationshipTypeRelationshipType
featureServicePropertiesFeatureServiceProperties
extendedPropertyDefinitions[ExtendedPropertyDefinition]
updateExistingboolean¦null
associateToExistingboolean¦null
isAssociatedboolean¦null

FeatureServiceProperties

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
{
  "itemId": "string",
  "itemType": "SurveyForm",
  "layerId": "string",
  "portalType": "Current",
  "portalUrl": "string",
  "featureServiceUniqueId": "string",
  "secure": true
}

Properties

NameTypeRequired
itemIdstring
itemTypestring¦null
layerIdstring
portalTypestring¦null
portalUrlstring¦null
featureServiceUniqueIdstring
secureboolean¦null

Enumerated values

itemType
SurveyForm
Click to copy
portalType
Current
Click to copy
ArcGISOnline
Click to copy
Other
Click to copy

Found

Example
Use dark colors for code blocksCopy
1
2
3
{
  "found": true
}

Properties

NameTypeRequired
foundboolean

GetLogsResponse

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
{
  "logs": [
    {
      "logLevel": "WARN",
      "message": "string",
      "jobId": "string",
      "stepId": "string",
      "createdDate": "2019-08-24T14:15:22Z",
      "createdUser": "string"
    }
  ]
}

Properties

NameTypeRequired
logs[Log]

Group

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
{
  "id": "string",
  "name": "string",
  "isAssignable": true,
  "thumbnail": "string"
}

Properties

NameTypeRequired
idstring
namestring
isAssignableboolean
thumbnailstring¦null

GroupedValue

Example
Use dark colors for code blocksCopy
1
2
3
4
{
  "value": "string",
  "count": 0
}

Properties

NameTypeRequired
valuestring¦null
countinteger(int32)

groupIds

Example
Use dark colors for code blocksCopy
1
2
3
4
5
{
  "groupIds": [
    "string"
  ]
}

A list of group IDs

Properties

NameTypeRequired
groupIds[string]

GroupRoleMembership

Example
Use dark colors for code blocksCopy
1
2
3
4
5
{
  "roles": [
    "string"
  ]
}

Properties

NameTypeRequired
roles[string]

GroupRoleMembershipChanges

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
{
  "adds": {
    "roles": [
      "string"
    ]
  },
  "deletes": {
    "roles": [
      "string"
    ]
  }
}

Properties

NameTypeRequired
addsGroupRoleMembership
deletesGroupRoleMembership

Hold

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
{
  "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

NameTypeRequired
jobIdstring
stepIdstring
holdIdstring
setBystring
setDatestring(date-time)
scheduledReleasestring(date-time)¦null
releasedBystring¦null
releasedDatestring(date-time)¦null
dependentJobIdstring¦null
dependentStepIdstring¦null

ItemDetails

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "itemVersion": "string",
  "upgradeAvailable": true,
  "isOldestAllowedVersion": true,
  "allowUnsecureWebhooks": true,
  "customSMTP": true,
  "settings": [
    {
      "propName": "string",
      "value": "string",
      "encrypted": true
    }
  ]
}

Properties

NameTypeRequired
itemVersionstring
upgradeAvailableboolean
isOldestAllowedVersionboolean
allowUnsecureWebhooksboolean
customSMTPboolean
settings[DataStoreSettingValue]¦null

Job

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
{
  "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

NameTypeRequired
jobIdstring¦null
jobNamestring¦null
ownedBystring¦null
createdBystring¦null
notesstring¦null
descriptionstring¦null
createdDatestring(date-time)¦null
startDatestring(date-time)¦null
startedDatestring(date-time)¦null
dueDatestring(date-time)¦null
endDatestring(date-time)¦null
parentJobstring¦null
percentCompletenumber(double)
prioritystring
diagramIdstring
diagramVersioninteger(int32)
diagramNamestring
currentSteps[CurrentStep]
jobStatusstring
jobTemplateIdstring
jobTemplateNamestring
extendedProperties[JobExtendedPropertyTable]¦null
relatedProperties[JobRelatedPropertyTable]¦null
holds[Hold]¦null
activeVersions[ActiveVersion]
hasLocationinteger(int32)¦null
parentJobRefIdstring¦null
closedboolean
archivedboolean¦null

JobActionBody

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
{
  "type": "Finish",
  "stepIds": [
    "string"
  ],
  "holdScheduledRelease": "2019-08-24T14:15:22Z",
  "dependentJobId": "string",
  "dependentStepId": "string"
}

Properties

NameTypeRequired
typestring
stepIds[string]¦null
holdScheduledReleasestring(date-time)¦null
dependentJobIdstring¦null
dependentStepIdstring¦null

Enumerated values

type
Finish
Click to copy
Run
Click to copy
Stop
Click to copy
SetCurrentStep
Click to copy
Hold
Click to copy
ReleaseHold
Click to copy
RefreshStatus
Click to copy

JobActionResponse

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
{
  "success": true,
  "stepResponses": [
    {
      "stepId": "string",
      "status": "Success",
      "statusDescription": "The step was started running"
    }
  ]
}

Properties

NameTypeRequired
successboolean
stepResponses[JobActionStepResponse]

JobActionStepResponse

Example
Use dark colors for code blocksCopy
1
2
3
4
5
{
  "stepId": "string",
  "status": "Success",
  "statusDescription": "The step was started running"
}

Properties

NameTypeRequired
stepIdstring
statusstring
statusDescriptionstring

Enumerated values

status
Success
Click to copy
NoStartedStep
Click to copy
NoActiveStep
Click to copy
AlreadyExecuting
Click to copy
AssignedToDifferentUser
Click to copy
JobClosed
Click to copy
StepNotCurrent
Click to copy
NoMatchingPaths
Click to copy
NotRunning
Click to copy
WaitingForInfo
Click to copy
Held
Click to copy
NotHeld
Click to copy
StepNotInDiagram
Click to copy
StepNotAuto
Click to copy

JobActionStepStatus

Example
Use dark colors for code blocksCopy
1
"Success"
Type
string
Required
false
Restrictions
none
Default value
Success

Enumerated values

anonymous
Success
Click to copy
NoActiveStep
Click to copy
AlreadyExecuting
Click to copy
AssignedToDifferentUser
Click to copy
JobClosed
Click to copy
StepNotCurrent
Click to copy
NoStartedStep
Click to copy
NoMatchingPaths
Click to copy
NotRunning
Click to copy

JobActionType

Example
Use dark colors for code blocksCopy
1
"Run"
Type
string
Required
false
Restrictions
none
Default value
Run

Enumerated values

anonymous
Run
Click to copy
Finish
Click to copy
Stop
Click to copy

JobArcadeExpressionContext

Example
Use dark colors for code blocksCopy
1
2
3
{
  "jobId": "string"
}

Properties

NameTypeRequired
jobIdstring

JobAttachmentDescription

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "id": "string",
  "alias": "string",
  "folder": "string",
  "url": "string",
  "lastModifiedBy": "string",
  "lastModified": "2019-08-24T14:15:22Z"
}

Properties

NameTypeRequired
idstring
aliasstring¦null
folderstring¦null
urlstring¦null
lastModifiedBystring¦null
lastModifiedstring(date-time)¦null

JobAttachmentLinked

Example
Use dark colors for code blocksCopy
1
2
3
4
5
{
  "url": "string",
  "alias": "string",
  "folder": "string"
}

Properties

NameTypeRequired
urlstring
aliasstring
folderstring¦null

JobAttachmentLinkedBody

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
{
  "attachments": [
    {
      "url": "string",
      "alias": "string",
      "folder": "string"
    }
  ],
  "stepId": "string"
}

Properties

NameTypeRequired
attachments[JobAttachmentLinked]
stepIdstring¦null

JobAttachmentLinkedResult

Example
Use dark colors for code blocksCopy
1
2
3
4
{
  "alias": "string",
  "attachmentId": "string"
}

Properties

NameTypeRequired
aliasstring
attachmentIdstring

JobComment

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
  "jobId": "string",
  "comment": "string",
  "commentId": "string",
  "lastModifiedBy": "string",
  "lastModified": "2019-08-24T14:15:22Z"
}

Properties

NameTypeRequired
jobIdstring
commentstring
commentIdstring¦null
lastModifiedBystring¦null
lastModifiedstring(date-time)¦null

JobCommentArg

Example
Use dark colors for code blocksCopy
1
2
3
{
  "comment": "string"
}

Properties

NameTypeRequired
commentstring

JobExtendedProperty

Example
Use dark colors for code blocksCopy
1
2
3
4
{
  "propertyName": "string",
  "value": {}
}

Properties

NameTypeRequired
propertyNamestring
valueobject

JobExtendedPropertyTable

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "tableName": "string",
  "featureServiceProperties": {
    "itemId": "string",
    "itemType": "SurveyForm",
    "layerId": "string",
    "portalType": "Current",
    "portalUrl": "string",
    "featureServiceUniqueId": "string",
    "secure": true
  },
  "properties": [
    {
      "propertyName": "string",
      "value": {}
    }
  ]
}

Properties

NameTypeRequired
tableNamestring
featureServicePropertiesFeatureServiceProperties
properties[JobExtendedProperty]

JobHistory

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
{
  "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

NameTypeRequired
datestring(date-time)¦null
jobIdstring
stepIdstring¦null
usernamestring
actionstring
resultstring¦null
startDatestring(date-time)¦null
endDatestring(date-time)¦null
durationSecondsinteger(int64)¦null

Enumerated values

action
Activated
Click to copy
Deactivated
Click to copy
Started
Click to copy
Paused
Click to copy
Finished
Click to copy
Completed
Click to copy
Error
Click to copy
Cancelled
Click to copy
Reassigned
Click to copy
Upgraded
Click to copy
Updated
Click to copy
Created
Click to copy
Deleted
Click to copy
Closed
Click to copy
Added
Click to copy
DependencyAdded
Click to copy
Held
Click to copy
HoldReleased
Click to copy
Reopened
Click to copy
Reactivated
Click to copy

JobManageBody

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
{
  "type": "Close",
  "jobIds": [
    "string"
  ]
}

Properties

NameTypeRequired
typestring
jobIds[string]

Enumerated values

type
Close
Click to copy
Delete
Click to copy
Upgrade
Click to copy
Reopen
Click to copy

JobOverrides

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
{
  "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

NameTypeRequired
allowRunningStepIdstring
jobNamestring
startDatestring(date-time)
dueDatestring(date-time)
prioritystring
descriptionstring
ownedBystring
percentCompletenumber(double)
jobStatusstring
notesstring
parentJobstring
versions[Version]
extendedProperties[PropertyResponse]
relatedPropertiesRelatedPropertyEdits

JobQuery

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
  "q": "string",
  "search": "string",
  "fields": [
    "string"
  ],
  "displayNames": [
    "string"
  ],
  "sortFields": [
    {
      "field": "string",
      "sortOrder": "Asc"
    }
  ],
  "spatialExtent": "string",
  "hasLocation": true,
  "start": 0,
  "num": 0,
  "returnAllRelatedProperties": true
}

Properties

NameTypeRequired
qstring¦null
searchstring¦null
fields[string]¦null
displayNames[string]¦null
sortFields[SortField]¦null
spatialExtentstring¦null
hasLocationboolean¦null
startinteger(int32)
numinteger(int32)
returnAllRelatedPropertiesboolean¦null

JobQueryResult

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
  "q": "string",
  "fields": [
    {
      "name": "string",
      "fieldType": "String"
    }
  ],
  "results": [
    [
      {}
    ]
  ],
  "start": 0,
  "nextStart": 0,
  "num": 0
}

Properties

NameTypeRequired
qstring
fields[QueryResultFieldDefinition]
results[[Anything]]
startinteger(int32)
nextStartinteger(int32)
numinteger(int32)

JobRelatedPropertyEntry

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
{
  "id": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "properties": [
    {
      "propertyName": "string",
      "value": {}
    }
  ]
}

Properties

NameTypeRequired
idstring
createdDatestring(date-time)
properties[JobExtendedProperty]

JobRelatedPropertyTable

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
  "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

NameTypeRequired
tableNamestring
featureServicePropertiesFeatureServiceProperties
entries[JobRelatedPropertyEntry]

JobStatistics

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
{
  "total": 0,
  "groupBy": "string",
  "groupedValues": [
    {
      "value": "string",
      "count": 0
    }
  ]
}

Properties

NameTypeRequired
totalinteger(int32)
groupBystring¦null
groupedValues[GroupedValue]¦null

JobStatisticsQuery

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
  "q": "string",
  "search": "string",
  "groupBy": "string",
  "spatialExtent": "string",
  "hasLocation": true
}

Properties

NameTypeRequired
qstring¦null
searchstring¦null
groupBystring¦null
spatialExtentstring¦null
hasLocationboolean¦null

JobTemplate

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
{
  "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

NameTypeRequired
jobTemplateIdstring¦null
jobTemplateNamestring
categorystring¦null
defaultJobDurationinteger(int32)¦null
defaultAssignedTostring¦null
defaultDueDatestring(date-time)¦null
defaultStartDatestring(date-time)¦null
jobStartDateTypestring¦null
diagramIdstring
diagramNamestring
diagramThumbnailstring¦null
defaultPriorityNamestring
defaultAssignedTypeAssignedType
descriptionstring¦null
defaultDescriptionstring¦null
statestring
defaultJobNamestring¦null
defaultFinalStatusstring¦null
defaultStatusstring¦null
activities[Activity]¦null
extendedPropertyTableDefinitions[ExtendedPropertyTableDefinition]¦null
lastUpdatedBystring¦null
lastUpdatedDatestring(date-time)¦null

Enumerated values

jobStartDateType
CreationDate
Click to copy
SpecificDate
Click to copy
state
Draft
Click to copy
Active
Click to copy
Automated
Click to copy
Retired
Click to copy

JobTemplateDescription

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
{
  "jobTemplateId": "string",
  "jobTemplateName": "string",
  "description": "string",
  "category": "string",
  "diagramId": "string",
  "diagramName": "string",
  "state": "Draft"
}

Properties

NameTypeRequired
jobTemplateIdstring
jobTemplateNamestring
descriptionstring¦null
categorystring¦null
diagramIdstring¦null
diagramNamestring¦null
statestring

Enumerated values

state
Draft
Click to copy
Active
Click to copy
Automated
Click to copy
Retired
Click to copy

JsonDetailsType

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
[
  {
    "path": "string",
    "errors": [
      "string"
    ]
  }
]

Properties

NameTypeRequired
pathstring
errors[string]

KeyValues

Example
Use dark colors for code blocksCopy
1
2
3
4
5
{
  "key": "string",
  "value": "string",
  "isEnabled": true
}

Properties

NameTypeRequired
keystring
valuestring
isEnabledboolean

Location

Example
Use dark colors for code blocksCopy
1
2
3
4
{
  "geometryType": "Multipoint",
  "geometry": "string"
}

Properties

NameTypeRequired
geometryTypestring¦null
geometrystring¦null

Enumerated values

geometryType
Multipoint
Click to copy
Polyline
Click to copy
Polygon
Click to copy

LocationBody

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
{
  "location": {
    "geometryType": "Multipoint",
    "geometry": "string"
  }
}

Properties

NameTypeRequired
locationLocation

Log

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "logLevel": "WARN",
  "message": "string",
  "jobId": "string",
  "stepId": "string",
  "createdDate": "2019-08-24T14:15:22Z",
  "createdUser": "string"
}

Properties

NameTypeRequired
logLevelstring
messagestring
jobIdstring¦null
stepIdstring¦null
createdDatestring(date-time)¦null
createdUserstring¦null

Enumerated values

logLevel
WARN
Click to copy
ERROR
Click to copy

Lookup

Example
Use dark colors for code blocksCopy
1
2
3
4
{
  "lookupName": "string",
  "value": 0
}

Properties

NameTypeRequired
lookupNamestring
valueinteger(int32)

Lookups

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "lookups": [
    {
      "lookupName": "string",
      "value": 0
    }
  ]
}

Properties

NameTypeRequired
lookups[Lookup]

Point

Example
Use dark colors for code blocksCopy
1
2
3
4
{
  "x": 0,
  "y": 0
}

Properties

NameTypeRequired
xinteger(int32)
yinteger(int32)

PropertyEntry

Example
Use dark colors for code blocksCopy
1
2
3
4
{
  "propertyName": "string",
  "value": "string"
}

Properties

NameTypeRequired
propertyNamestring
valuestring¦null

PropertyResponse

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
{
  "identifier": "string",
  "value": "string",
  "dataType": "string",
  "uniqueId": "string"
}

Properties

NameTypeRequired
identifierstring
valuestring¦null
dataTypestring¦null
uniqueIdstring¦null

QueryResultFieldDefinition

Example
Use dark colors for code blocksCopy
1
2
3
4
{
  "name": "string",
  "fieldType": "String"
}

Properties

NameTypeRequired
namestring
fieldTypestring

Enumerated values

fieldType
String
Click to copy
Integer
Click to copy
DateTime
Click to copy
Boolean
Click to copy
Double
Click to copy

RelatedPropertyAdd

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "tableName": "string",
  "entries": [
    {
      "properties": [
        {
          "propertyName": "string",
          "value": "string"
        }
      ]
    }
  ]
}

Properties

NameTypeRequired
tableNamestring
entries[RelatedPropertyAddEntry]

RelatedPropertyAddEntry

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "properties": [
    {
      "propertyName": "string",
      "value": "string"
    }
  ]
}

Properties

NameTypeRequired
properties[PropertyEntry]

RelatedPropertyDelete

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
{
  "tableName": "string",
  "ids": [
    "string"
  ]
}

Properties

NameTypeRequired
tableNamestring
ids[string]

RelatedPropertyEdits

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
  "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

NameTypeRequired
adds[RelatedPropertyAdd]¦null
deletes[RelatedPropertyDelete]¦null
updates[RelatedPropertyUpdate]¦null

RelatedPropertyUpdate

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "tableName": "string",
  "entries": [
    {
      "id": "string",
      "properties": [
        {
          "propertyName": "string",
          "value": "string"
        }
      ]
    }
  ]
}

Properties

NameTypeRequired
tableNamestring
entries[RelatedPropertyUpdateEntry]

RelatedPropertyUpdateEntry

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
{
  "id": "string",
  "properties": [
    {
      "propertyName": "string",
      "value": "string"
    }
  ]
}

Properties

NameTypeRequired
idstring
properties[PropertyEntry]

RelationshipType

Example
Use dark colors for code blocksCopy
1
"OneToOne"
Type
string
Required
false
Restrictions
none
Default value
OneToOne

Enumerated values

anonymous
OneToOne
Click to copy
OneToMany
Click to copy

RequestAttachment

Example
Use dark colors for code blocksCopy
1
2
3
4
{
  "folder": "string",
  "customName": "string"
}

Properties

NameTypeRequired
folderstring¦null
customNamestring¦null

RequestAuth

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
{
  "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

NameTypeRequired
apiKeyRequestAuthAPIKey
credentialsRequestCredentials
authorizationTypestring
tokenRequestWebRequest

Enumerated values

authorizationType
NoAuth
Click to copy
ApiKey
Click to copy
ApiKeyGenerated
Click to copy
BearerToken
Click to copy
BearerTokenGenerated
Click to copy
BasicAuth
Click to copy
FederatedToken
Click to copy
DigestAuth
Click to copy

RequestAuthAPIKey

Example
Use dark colors for code blocksCopy
1
2
3
4
5
{
  "key": "string",
  "value": "string",
  "addedTo": "QueryParams"
}

Properties

NameTypeRequired
keystring
valuestring¦null
addedTostring

Enumerated values

addedTo
QueryParams
Click to copy
Header
Click to copy

RequestBody

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
  "formData": {
    "keyValues": [
      {
        "key": "string",
        "value": "string",
        "isEnabled": true
      }
    ]
  },
  "urlEncoded": {
    "keyValues": [
      {
        "key": "string",
        "value": "string",
        "isEnabled": true
      }
    ]
  },
  "raw": {
    "content": "string",
    "contentType": "string"
  }
}

Properties

NameTypeRequired
formDataRequestBodyKeyValues
urlEncodedRequestBodyKeyValues
rawRequestRawBody

RequestBodyKeyValues

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
{
  "keyValues": [
    {
      "key": "string",
      "value": "string",
      "isEnabled": true
    }
  ]
}

Properties

NameTypeRequired
keyValues[KeyValues]

RequestCredentials

Example
Use dark colors for code blocksCopy
1
2
3
4
5
{
  "username": "string",
  "password": "string",
  "token": "string"
}

Properties

NameTypeRequired
usernamestring¦null
passwordstring¦null
tokenstring¦null

RequestRawBody

Example
Use dark colors for code blocksCopy
1
2
3
4
{
  "content": "string",
  "contentType": "string"
}

Properties

NameTypeRequired
contentstring
contentTypestring

Role

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
  "roleName": "string",
  "description": "string",
  "privileges": [
    "string"
  ]
}

Properties

NameTypeRequired
roleNamestring¦null
descriptionstring¦null
privileges[string]

SavedSearch

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
  "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

NameTypeRequired
searchIdstring¦null
namestring
folderstring¦null
definitionJobQuery
searchTypestring¦null
colorRampstring¦null
sortIndexinteger(int32)¦null

Enumerated values

searchType
Chart
Click to copy
Standard
Click to copy

Schedule

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "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

NameTypeRequired
scheduleTypestring
timeDurationTimeDuration
specificTimeSpecificTime
expressionstring¦null

Enumerated values

scheduleType
Duration
Click to copy
SpecificTime
Click to copy
Expression
Click to copy

SortField

Example
Use dark colors for code blocksCopy
1
2
3
4
{
  "field": "string",
  "sortOrder": "Asc"
}

Properties

NameTypeRequired
fieldstring
sortOrderstring

Enumerated values

sortOrder
Asc
Click to copy
Desc
Click to copy

SpecificTime

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
{
  "type": "HourOfDay",
  "dayOfWeek": 0,
  "dayOfMonth": 0,
  "month": 0,
  "hour": 0,
  "minutes": 0,
  "offset": 0
}

Properties

NameTypeRequired
typestring
dayOfWeekinteger(int32)¦null
dayOfMonthinteger(int32)¦null
monthinteger(int32)¦null
hourinteger(int32)
minutesinteger(int32)
offsetinteger(int32)

Enumerated values

type
HourOfDay
Click to copy
NumberOfDays
Click to copy
DayOfWeek
Click to copy
DayOfMonth
Click to copy
MonthOfYear
Click to copy

Status

Example
Use dark colors for code blocksCopy
1
2
3
4
{
  "success": true,
  "hasAdvancedLicense": true
}

Properties

NameTypeRequired
successboolean
hasAdvancedLicenseboolean

Step

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
{
  "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

NameTypeRequired
idstring
namestring
descriptionstring¦null
stepTemplateIdstring¦null
automaticboolean
proceedNextboolean
canSkipboolean
positionstring
shapeinteger(int32)
colorstring¦null
outlineColorstring¦null
labelColorstring¦null
actionStepAction
paths[StepPath]
helpUrlstring¦null
helpTextstring¦null
helpLinkstring¦null
encodeHelpLinkboolean¦null
scheduleSchedule

StepAction

Example
Use dark colors for code blocksCopy
1
2
3
4
{
  "actionType": "string",
  "args": {}
}

Properties

NameTypeRequired
actionTypestring
argsobject¦null

StepOutputs

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "outputs": [
    {
      "value": "string",
      "name": "string",
      "dataType": "string",
      "isEncoded": true
    }
  ],
  "returnValue": "string",
  "isUserSpecifiedReturnValue": true,
  "comment": "string"
}

Properties

NameTypeRequired
outputs[DefaultStepOutput]¦null
returnValuestring¦null
isUserSpecifiedReturnValueboolean¦null
commentstring¦null

StepPath

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
  "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

NameTypeRequired
nextStepstring
expressionstring¦null
labelstring¦null
assignedTostring¦null
points[Point]
ports[string]
assignedTypeAssignedType
statusstring¦null
notifications[string]
lineColorstring¦null
labelColorstring¦null
isAssignedToCustomExpressionboolean¦null
forceGroupAssignmentboolean¦null

Success

Example
Use dark colors for code blocksCopy
1
2
3
{
  "success": true
}

Properties

NameTypeRequired
successboolean

SuccessResponse

Example
Use dark colors for code blocksCopy
1
2
3
4
5
{
  "success": true,
  "message": "string",
  "name": "UnableToDetermineHostingServer"
}

Properties

NameTypeRequired
successboolean
messagestring¦null
namestring¦null

Enumerated values

name
UnableToDetermineHostingServer
Click to copy
InvalidHostingServerArguments
Click to copy
UnableToGetHostingServerFromPortal
Click to copy
InvalidConfiguration
Click to copy
UnableToConnectDirectlyToDatastore
Click to copy
UnableToGetDatastoreConnection
Click to copy
SourceSchemaChangesNotAllowed
Click to copy
InvalidPortalItemUrl
Click to copy
InvalidFirstStep
Click to copy
InvalidUserType
Click to copy
InvalidDiagramNameDuplicate
Click to copy
InvalidDiagramNameDuplicateUpdate
Click to copy
InvalidDiagramIdDuplicate
Click to copy
InvalidDiagramName
Click to copy
InvalidDiagramId
Click to copy
InvalidDiagramUnexpectedDecentralizedDataSources
Click to copy
InvalidDiagramUnexpectedCentralizedDataReferences
Click to copy
InvalidDiagramDuplicateDecentralizedDataSource
Click to copy
InvalidDiagramDuplicateCentralizedDataReference
Click to copy
InvalidDataSourceConfiguration
Click to copy
InvalidJobTemplateName
Click to copy
JobTemplateNotFound
Click to copy
JobTemplateInsufficientPrivilegesExtProperties
Click to copy
JobTemplateNotCreated
Click to copy
JobTemplateNameNotUnique
Click to copy
JobTemplateDuplicateId
Click to copy
JobTemplateExtPropertiesNotAllUpdated
Click to copy
JobTemplateNotDeleted
Click to copy
JobTemplatesNotDeleted
Click to copy
JobTemplateNotDeletedUsedInJobs
Click to copy
JobNotCreatedInvalidTemplateState
Click to copy
JobTemplateInvalidFinalJobStatus
Click to copy
JobTemplateInvalidInitialJobStatus
Click to copy
ExtPropertiesMissingAssociation
Click to copy
ExtPropertiesDuplicateTableNames
Click to copy
ExtPropertiesImportFailed
Click to copy
ExtPropertyTableMissingProperties
Click to copy
ExtPropertyTablesNotDeleted
Click to copy
ExtPropertyTableNameNotFound
Click to copy
ExtPropertyFeatureServiceIdInvalid
Click to copy
JobTemplateFailedInvalidExtProps
Click to copy
UnableToCreateExtPropTables
Click to copy
JobTemplateExtPropsNotUpdated
Click to copy
ExtPropsUnableToCreateDuplicateDetected
Click to copy
ExtPropsNotUpdated
Click to copy
ExtProps1MNotUpdated
Click to copy
InvalidDomainNameInvalid
Click to copy
InvalidDomainDataTypeInvalid
Click to copy
InvalidDomainFieldLengthRequired
Click to copy
InvalidDomainValueLength
Click to copy
AutomationUpdatesFailed
Click to copy
AutomationDetailsNotFound
Click to copy
AutomationScheduleInvalid
Click to copy
InvalidHoldArguments
Click to copy
AssignmentFailedStepNotUpdated
Click to copy
AssignmentFailedStepNotCurrent
Click to copy
AssignmentFailedUserNotFound
Click to copy
AssignmentFailedGroupNotFound
Click to copy
AssignmentFailedInvalidUsername
Click to copy
AssignmentFailedInvalidGroupId
Click to copy
AssignmentFailedMultipleCurrentSteps
Click to copy
AssignmentFailedNoCurrentStep
Click to copy
AssignmentFailedNoAssignPrivileges
Click to copy
AssignmentFailedInvalidIndividualJobAssign
Click to copy
AssignmentFailedInvalidGroupJobAssign
Click to copy
AssignmentFailedUnknown
Click to copy
AssignmentFailedJobClosed
Click to copy
AssignmentFailedStepRunning
Click to copy
AssignmentFailedStepHeld
Click to copy
JobIdNotFound
Click to copy
JobIdsNotFound
Click to copy
JobNotFoundForDelete
Click to copy
JobNotFoundForUpgrade
Click to copy
JobLocationNotFound
Click to copy
JobLocationNoUpdatesFound
Click to copy
CreateJobNegative
Click to copy
CreateJobTooManyJobs
Click to copy
InvalidJobIdLength
Click to copy
CreateJobCannotSpecifyNumJobsWithJobId
Click to copy
CreateJobCannotSpecifyNumJobsWithArcadeList
Click to copy
CreateJobRecursiveCreation
Click to copy
JobNotAssignedOrOwnedByCurrentUser
Click to copy
JobUpdateFailedJobClosed
Click to copy
JobUpdateFailedJobRunning
Click to copy
JobUpdateFailedImproperFormat
Click to copy
JobUpdateFailedInvalidField
Click to copy
JobUpdateFailedInsufficientPrivileges
Click to copy
InvalidDataReferenceId
Click to copy
InvalidDataSourceName
Click to copy
InvalidVersionNameAndGuid
Click to copy
VersionsNotFound
Click to copy
ItemIdNotFound
Click to copy
DataSourceNotFound
Click to copy
DataSourceNotFoundArcade
Click to copy
DataSourceNotFoundSelectedSources
Click to copy
DataSourceUrlNotFound
Click to copy
DataSourcePrivateUrlNotFound
Click to copy
InvalidJobQueryOrSearch
Click to copy
InvalidJobQuery
Click to copy
DiagramNotFound
Click to copy
MissingPrivileges
Click to copy
NotAllowedToUpgrade
Click to copy
ClaimVersionFailed
Click to copy
VersionCouldNotBeLocated
Click to copy
VersionFingerprintDoesNotExist
Click to copy
VersionFingerprintIsInvalid
Click to copy
AttachmentStepNotActive
Click to copy
ExecuteProGpToolboxNotFound
Click to copy
ExportFailed
Click to copy
ExportFailedJobTemplatesNotFound
Click to copy
ExportFailedDiagramsNotFound
Click to copy
ExportFailedMissingDiagramIds
Click to copy
ExportIdNotFound
Click to copy
ExportDirectoryInvalidConfiguration
Click to copy
ImportFailed
Click to copy
ImportFailedInvalidMappingFile
Click to copy
ImportFailedEmptyRequiredField
Click to copy
ImportFailedMissingTargetGroupId
Click to copy
ImportFailedOverwriteConfigurationWithPreserveValueFlag
Click to copy
ImportFailedInvalidPassphrase
Click to copy
ImportFailedMergeWithDecentralizedDiagram
Click to copy
ImportFailedCentralizedDataReferenceNotDefined
Click to copy
NoConfigFile
Click to copy
ConfigNewerSchema
Click to copy
CorruptConfiguration
Click to copy
ImportFailedJobsExist
Click to copy
JobsExistFailed
Click to copy
JobTemplateAutomationsNotAllImported
Click to copy
JobTemplateAutomationsNoneImported
Click to copy
JsonTransformFailed
Click to copy
ExtractChangesFailed
Click to copy
ExtractChangesFailedToGetResultUrl
Click to copy
WebsocketTokenError
Click to copy
InvalidToken
Click to copy
FailedToDeleteJobProgress
Click to copy
FailedToUpdateJobProgress
Click to copy
FailedToUploadFilePart
Click to copy
FailedToCommitUpload
Click to copy
FailedToRegisterUpload
Click to copy
FailedToUploadItem
Click to copy
FileTooLarge
Click to copy
AsyncInvalidStatusUrl
Click to copy
AsyncStatusTimeout
Click to copy
CurveGeometryNotSupported
Click to copy
GeometryCannotBeParsedToType
Click to copy
GeometryCannotBeParsed
Click to copy
ActivityRequiresAdvancedLicenseRole
Click to copy
ActivityInvalidMultipleJobs
Click to copy
ActionTypeNotSupportedWithActivity
Click to copy
ItemCreationStatusDoesNotExist
Click to copy
ItemCreationInsufficientPrivileges
Click to copy
ItemCreationOnlineOrgRestrictedState
Click to copy
ItemCreationFailed
Click to copy
ItemCreationFailedInvalidItem
Click to copy
ItemCreationInProgress
Click to copy
UnableToTransformViewJson
Click to copy
EmailSecretKeyNotFound
Click to copy
EmailRecipientsNotDefined
Click to copy
EmailSubjectInvalid
Click to copy
EmailBodyInvalid
Click to copy
EmailConfigurationInvalidForCustomSmtpProvider
Click to copy
EmailConfigurationInvalidForEnterprise
Click to copy
EmailConfigurationInvalidForOnline
Click to copy
EmailSendNotificationFailed
Click to copy
SmtpServerInvalid
Click to copy
SmtpPortInvalid
Click to copy
SmtpDefaultSenderEmailInvalid
Click to copy
WebRequestFailed
Click to copy
WebRequestBodyTooLong
Click to copy
WebRequestFailedToSaveAttachmentTooLong
Click to copy
WebRequestFailedToParseOutputsResponseTooLong
Click to copy
WebRequestUrlValidationEmptyUrl
Click to copy
WebRequestUrlValidationNotAllowed
Click to copy
SchemaUpgradeRequired
Click to copy
SchemaUpgradeRequiredToUseFeature
Click to copy
InvalidTimestampFormat
Click to copy
CleanupLogsFailed
Click to copy
ItemNotFound
Click to copy
JobArchived
Click to copy
ArchiveFailedToParse
Click to copy
ArchiveFailed
Click to copy
WebhooksUnsecureSettingDisabled
Click to copy
WebhooksMissingSignatureFormat
Click to copy
WebhooksMissingHeaderSecurityType
Click to copy
SchemaUpgradeFailed
Click to copy
UnableToCreateRelationship
Click to copy
PortalTaskLimitExceeded
Click to copy
PortalUnableToRetrieveWorkflowUrl
Click to copy
PortalUnableToRetrieveItem
Click to copy
UpgradeErrorAllClosed
Click to copy
UpgradeErrorMissingDiagram
Click to copy
UpgradeErrorRunning
Click to copy
UpgradeErrorRunningClosedMissing
Click to copy
UpgradeErrorMultiple
Click to copy
UpgradeErrorUpdateFailed
Click to copy
DeleteErrorRunning
Click to copy
DeleteError
Click to copy
CloseErrorRunning
Click to copy
ReopenError
Click to copy
ReopenErrorNoStep
Click to copy
ReopenErrorUpdateFailed
Click to copy
CloseErrorNoJobsClosed
Click to copy
CallFailedWithError
Click to copy
CallFailedWithMultipleErrors
Click to copy
CallFailedWithSuccessFalse
Click to copy
FeatureServiceCallFailedWithError
Click to copy
FeatureServiceCallFailedWithMultipleErrors
Click to copy
FeatureServiceCallFailedWithSuccessFalse
Click to copy
ResponseUnableToReadJson
Click to copy
ResponseFailed
Click to copy
UnableToReadViewJson
Click to copy
UnableToOpenViewLayerDefinition
Click to copy
UnableToCreateViewsInService
Click to copy
UnableToAddLocationLayersToView
Click to copy
NotAllViewsAdded
Click to copy
UnableToRecreateViews
Click to copy
UnableToRecreateLocationView
Click to copy
UnableToRecreateExtPropSearchView
Click to copy
UnableToRemoveLocationLayersFromView
Click to copy
UnableToRemoveViews
Click to copy
UnableToRemoveAllViews
Click to copy
UnableToRemoveExtPropSearchView
Click to copy
UnableToRetrieveCurrentUserInfo
Click to copy
UnableToGetLatestJobProgress
Click to copy
UnableToGetHoldFromJobProgress
Click to copy
InvalidDatastoreResponseFromFeatureLayer
Click to copy
InvalidDatastoreResponseMissingField
Click to copy
InvalidDatastoreResponse
Click to copy
InvalidDatastoreResponseCount
Click to copy
InvalidDatastoreResponseFromAddFeatures
Click to copy
UnableToApplyEdits
Click to copy
UnableToModifyEditorTracking
Click to copy
UnableToModifyOwnershipAccessControl
Click to copy
UnableToUpdateSourceSchemaChangesAllowed
Click to copy
UnableToCopyFields
Click to copy
UnableToUpdateSchemaVersionSetting
Click to copy
UnableToSaveSearch
Click to copy
UnableToUpdateSearch
Click to copy
UnableToSaveTemplate
Click to copy
UnableToUpdateTemplate
Click to copy
UnableToAddJobComment
Click to copy
InvalidFeatureLayer
Click to copy
FailedToAddNewLayers
Click to copy
FailedToCreateSchema
Click to copy
FailedToCreateSchemaViews
Click to copy
FailedToLoadData
Click to copy
WorkflowSchemaHasUnexpectedRelatedItems
Click to copy
UpgradeSchemaPartialSuccess
Click to copy

TableDefinition

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
{
  "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

NameTypeRequired
tableNamestring
tableAliasstring
relationshipTypeRelationshipType
featureServicePropertiesFeatureServiceProperties
extendedPropertyDefinitions[ExtendedPropertyDefinition]
jobTemplates[string]

TableDefinitionsResult

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
  "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

NameTypeRequired
tableDefinitions[TableDefinition]

Template

Example
Use dark colors for code blocksCopy
1
2
3
4
5
{
  "templateId": "string",
  "templateName": "string",
  "templateDetails": "string"
}

Properties

NameTypeRequired
templateIdstring¦null
templateNamestring
templateDetailsstring

TemplateDescription

Example
Use dark colors for code blocksCopy
1
2
3
4
{
  "templateId": "string",
  "templateName": "string"
}

Properties

NameTypeRequired
templateIdstring
templateNamestring

TestWebRequest

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
{
  "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

NameTypeRequired
webRequestWebRequest
jobIdstring¦null

TimeDuration

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
  "months": 0,
  "days": 0,
  "hours": 0,
  "minutes": 0,
  "offset": 0
}

Properties

NameTypeRequired
monthsinteger(int32)¦null
daysinteger(int32)¦null
hoursinteger(int32)¦null
minutesinteger(int32)¦null
offsetinteger(int32)

UpdateAutomationsResult

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
  "success": true,
  "message": "string",
  "automationIds": [
    "string"
  ]
}

Properties

NameTypeRequired
successboolean
messagestring
automationIds[string]

UpdateDiagramBody

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
{
  "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

NameTypeRequired
deleteDraftboolean
diagramWorkflowDiagram

UpgradedDiagramResponse

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
{
  "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

NameTypeRequired
transformedDiagramDiagram
modifiedStepIds[string]
failedStepIds[string]
modifiedDataSourceNames[string]
failedDataSourceNames[string]

User

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "username": "string",
  "fullName": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "groups": [
    "string"
  ],
  "groupsOwned": [
    "string"
  ],
  "roles": [
    "string"
  ],
  "privileges": [
    "string"
  ],
  "thumbnail": "string"
}

Properties

NameTypeRequired
usernamestring
fullNamestring
firstNamestring¦null
lastNamestring¦null
emailstring¦null
groups[string]
groupsOwned[string]¦null
roles[string]¦null
privileges[string]¦null
thumbnailstring¦null

UserDescription

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
{
  "username": "string",
  "fullName": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "thumbnail": "string",
  "isAssignable": true
}

Properties

NameTypeRequired
usernamestring
fullNamestring
firstNamestring¦null
lastNamestring¦null
emailstring¦null
thumbnailstring¦null
isAssignableboolean

Version

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
{
  "dataSourceName": "string",
  "versionName": "string",
  "versionGuid": "string",
  "workflowAdministered": true
}

Properties

NameTypeRequired
dataSourceNamestring
versionNamestring¦null
versionGuidstring¦null
workflowAdministeredboolean¦null

WebRequest

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
{
  "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

NameTypeRequired
requestTypestring
baseUrlstring
queryParams[KeyValues]¦null
pathParams[KeyValues]¦null
headers[KeyValues]¦null
bodyRequestBody
authorizationRequestAuth
attachmentRequestAttachment
outputValues[KeyValues]¦null
isAsyncboolean
retrySettingsWebRequestRetrySettings

Enumerated values

requestType
GET
Click to copy
POST
Click to copy
PUT
Click to copy
DELETE
Click to copy
HEAD
Click to copy
PATCH
Click to copy
OPTIONS
Click to copy

WebRequestParsed

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
{
  "headers": [
    {
      "key": "string",
      "value": "string",
      "isEnabled": true
    }
  ],
  "body": "string"
}

Properties

NameTypeRequired
headers[KeyValues]
bodystring¦null

WebRequestResponse

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
  "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

NameTypeRequired
statusinteger(int32)
bodystring
requestUrlstring
requestDetailsWebRequestParsed
headers[KeyValues]
outputsStepOutputs

WebRequestRetrySettings

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
{
  "retrySeconds": 0,
  "maxRetryCount": 0,
  "endExpression": "string",
  "expressionVariables": [
    {
      "key": "string",
      "value": "string",
      "isEnabled": true
    }
  ]
}

Properties

NameTypeRequired
retrySecondsinteger(int64)
maxRetryCountinteger(int32)
endExpressionstring
expressionVariables[KeyValues]¦null

WorkflowDiagram

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
{
  "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

NameTypeRequired
diagramIdstring¦null
diagramNamestring
descriptionstring¦null
activeboolean
initialStepIdstring¦null
initialStepNamestring¦null
steps[Step]
dataSources[DataSourceDecentralized]
centralizedDataReferences[AbstractCentralizedDataReference]
annotations[Annotation]
displayGridboolean
useCentralizedDataReferencesboolean

WorkflowDiagramDescription

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
{
  "diagramId": "string",
  "diagramName": "string",
  "description": "string",
  "active": true,
  "draft": true
}

Properties

NameTypeRequired
diagramIdstring
diagramNamestring
descriptionstring¦null
activeboolean
draftboolean

WorkflowExceptionDTO

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
{
  "error": {
    "message": "string",
    "type": "string",
    "name": "UnableToDetermineHostingServer",
    "details": [
      "string"
    ]
  }
}

Properties

NameTypeRequired
errorErrorDTO

WorkflowJsonExceptionDTO

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
{
  "error": {
    "message": "string",
    "type": "string",
    "details": [
      {
        "path": "string",
        "errors": [
          "string"
        ]
      }
    ]
  }
}

Properties

NameTypeRequired
errorDetailedErrorDTO

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.