Types

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

name

string

url

string

privateUrl

string¦null

layerItemId

string

versionId

string

replicaName

string¦null

replicaId

string¦null

replicaLocation

string¦null

proReplicaLocation

string¦null

Activity

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

Properties

NameTypeRequired

typeName

string

actionName

string

templateId

string

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
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

position

string

color

string¦null

outlineColor

string¦null

labelColor

string¦null

text

string

Anything

Example
Use dark colors for code blocksCopy
1
{}

Properties

NameTypeRequired

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

context

expression

string

parseMode

string

contextType

string

Enumerated Values
parseMode
Standard
Click to copy
URL
Click to copy
Query
Click to copy
BaseContext
Click to copy
JobContext
Click to copy

ArcadeExpressionContext

Example
Use dark colors for code blocksCopy
1
{}

Properties

NameTypeRequired

ArcadeExpressionResult

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

The result of evaluating an arcade expression

Properties

NameTypeRequired

result

string

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

assignedTo

string¦null

assignedType

AutomationAdd

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

Properties

NameTypeRequired

automationName

string

automationType

string

enabled

boolean

details

string

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

automationId

string

automationName

string

automationType

string

createdBy

string¦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

automationId

string

automationName

string

automationType

string

createdBy

string¦null

enabled

boolean

details

string

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

updates

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

automationId

string

automationName

string¦null

enabled

boolean¦null

details

string¦null

CodedValue

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

Properties

NameTypeRequired

code

string

name

string

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

success

boolean¦null

itemId

string¦null

status

string

error

Enumerated Values
status
Executing
Click to copy
Succeeded
Click to copy
Failed
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,
  "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

numberOfJobs

number(integer)

jobName

string

startDate

string(date-time)

dueDate

string(date-time)

priority

string

description

string

ownedBy

string

assignedType

assignedTo

string

percentComplete

number(double)

jobStatus

string

notes

string

parentJob

string

location

extendedProperties

relatedProperties

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]

message

string¦null

autoExecuted

boolean¦null

CreateSavedSearchResponse

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

Properties

NameTypeRequired

searchId

string

CreateWorkflowItemParameters

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

Properties

NameTypeRequired

async

boolean

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

stepId

string¦null

assignedTo

string¦null

assignedType

stepName

string¦null

canSkip

boolean¦null

manualHold

boolean¦null

holdScheduledRelease

string(date-time)¦null

dependencies

boolean¦null

DataSource

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

Properties

NameTypeRequired

name

string

url

string

sourceType

string

DataStoreSettingValue

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

Properties

NameTypeRequired

propName

string

value

string¦null

encrypted

boolean

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

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

value

string¦null

name

string¦null

dataType

string¦null

isEncoded

boolean¦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

message

string

type

string

details

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
{
  "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"
    }
  ],
  "annotations": [
    {
      "position": "string",
      "color": "string",
      "outlineColor": "string",
      "labelColor": "string",
      "text": "string"
    }
  ],
  "displayGrid": true
}

Properties

NameTypeRequired

diagramId

string

diagramVersion

number

diagramName

string

description

string

initialStepId

string

initialStepName

string

steps

dataSources

annotations

displayGrid

boolean

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

message

string

type

string

name

string¦null

details

[string]¦null

Enumerated Values
name
UnableToDetermineHostingServer
Click to copy
InvalidHostingServerArguments
Click to copy
InvalidConfiguration
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
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
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
CreateJobNegative
Click to copy
CreateJobTooManyJobs
Click to copy
InvalidJobIdLength
Click to copy
CreateJobCannotSpecifyNumJobsWithJobId
Click to copy
CreateJobCannotSpecifyNumJobsWithArcadeList
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
InvalidDataSourceName
Click to copy
InvalidVersionNameAndGuid
Click to copy
VersionsNotFound
Click to copy
ItemIdNotFound
Click to copy
DataSourceNotFound
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
ExportFailed
Click to copy
ExportFailedJobTemplatesNotFound
Click to copy
ExportFailedDiagramsNotFound
Click to copy
ExportFailedMissingDiagramIds
Click to copy
ImportFailed
Click to copy
ImportFailedInvalidPassphrase
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
WebsocketTokenError
Click to copy
InvalidToken
Click to copy
FailedToDeleteJobProgress
Click to copy
FailedToUploadFilePart
Click to copy
FailedToCommitUpload
Click to copy
FailedToRegisterUpload
Click to copy
FailedToUploadItem
Click to copy
FileTooLarge
Click to copy
CurveGeometryNotSupported
Click to copy
GeometryCannotBeParsedToType
Click to copy
GeometryCannotBeParsed
Click to copy
ActivityRequiresAdvancedLicenseRole
Click to copy
ActionTypeNotSupportedWithActivity
Click to copy
ItemCreationStatusDoesNotExist
Click to copy
ItemCreationInsufficientPrivileges
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

ErrorInfo

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

Properties

NameTypeRequired

message

string

name

string¦null

details

[string]¦null

Enumerated Values
name
UnableToDetermineHostingServer
Click to copy
InvalidHostingServerArguments
Click to copy
InvalidConfiguration
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
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
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
CreateJobNegative
Click to copy
CreateJobTooManyJobs
Click to copy
InvalidJobIdLength
Click to copy
CreateJobCannotSpecifyNumJobsWithJobId
Click to copy
CreateJobCannotSpecifyNumJobsWithArcadeList
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
InvalidDataSourceName
Click to copy
InvalidVersionNameAndGuid
Click to copy
VersionsNotFound
Click to copy
ItemIdNotFound
Click to copy
DataSourceNotFound
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
ExportFailed
Click to copy
ExportFailedJobTemplatesNotFound
Click to copy
ExportFailedDiagramsNotFound
Click to copy
ExportFailedMissingDiagramIds
Click to copy
ImportFailed
Click to copy
ImportFailedInvalidPassphrase
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
WebsocketTokenError
Click to copy
InvalidToken
Click to copy
FailedToDeleteJobProgress
Click to copy
FailedToUploadFilePart
Click to copy
FailedToCommitUpload
Click to copy
FailedToRegisterUpload
Click to copy
FailedToUploadItem
Click to copy
FileTooLarge
Click to copy
CurveGeometryNotSupported
Click to copy
GeometryCannotBeParsedToType
Click to copy
GeometryCannotBeParsed
Click to copy
ActivityRequiresAdvancedLicenseRole
Click to copy
ActionTypeNotSupportedWithActivity
Click to copy
ItemCreationStatusDoesNotExist
Click to copy
ItemCreationInsufficientPrivileges
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

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

includeOtherConfiguration

boolean¦null

passphrase

string¦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

propertyName

string

propertyAlias

string

propertyOrder

number(integer)

dataType

defaultValue

object

fieldLength

number(integer)

required

boolean

editable

boolean

visible

boolean

domain

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

type

string

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

tableName

string

tableAlias

string

tableOrder

integer(int32)

relationshipType

featureServiceProperties

extendedPropertyDefinitions

updateExisting

boolean¦null

associateToExisting

boolean¦null

isAssociated

boolean¦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

itemId

string

itemType

string¦null

layerId

string

portalType

string¦null

portalUrl

string¦null

featureServiceUniqueId

string

secure

boolean¦null

Enumerated Values
itemType
SurveyForm
Click to copy
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

found

boolean

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
{
  "id": "string",
  "name": "string",
  "isAssignable": true
}

Properties

NameTypeRequired

id

string

name

string

isAssignable

boolean

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

adds

deletes

GroupedValue

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

Properties

NameTypeRequired

value

string¦null

count

integer(int32)

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

jobId

string

stepId

string

holdId

string

setBy

string

setDate

string(date-time)

scheduledRelease

string(date-time)¦null

releasedBy

string¦null

releasedDate

string(date-time)¦null

dependentJobId

string¦null

dependentStepId

string¦null

ItemDetails

Example
Use dark colors for code blocksCopy
1
2
3
4
5
6
{
  "itemVersion": "string",
  "upgradeAvailable": true,
  "allowUnsecureWebhooks": true,
  "customSMTP": true
}

Properties

NameTypeRequired

itemVersion

string

upgradeAvailable

boolean

allowUnsecureWebhooks

boolean

customSMTP

boolean

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,
  "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

jobId

string¦null

jobName

string¦null

ownedBy

string¦null

createdBy

string¦null

notes

string¦null

description

string¦null

createdDate

string(date-time)¦null

startDate

string(date-time)¦null

startedDate

string(date-time)¦null

dueDate

string(date-time)¦null

endDate

string(date-time)¦null

parentJob

string¦null

percentComplete

number(double)

priority

string

diagramId

string

diagramVersion

integer(int32)

diagramName

string

currentSteps

jobStatus

string

jobTemplateId

string

jobTemplateName

string

extendedProperties

relatedProperties

holds

[Hold]¦null

activeVersions

hasLocation

integer(int32)¦null

parentJobRefId

string¦null

closed

boolean

archived

boolean¦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

type

string

stepIds

[string]¦null

holdScheduledRelease

string(date-time)¦null

dependentJobId

string¦null

dependentStepId

string¦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

success

boolean

stepResponses

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

stepId

string

status

string

statusDescription

string

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

jobId

string

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

id

string

alias

string¦null

folder

string¦null

url

string¦null

lastModifiedBy

string¦null

lastModified

string(date-time)¦null

JobAttachmentLinked

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

Properties

NameTypeRequired

url

string

alias

string

folder

string¦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

stepId

string¦null

JobAttachmentLinkedResult

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

Properties

NameTypeRequired

alias

string

attachmentId

string

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

jobId

string

comment

string

commentId

string¦null

lastModifiedBy

string¦null

lastModified

string(date-time)¦null

JobCommentArg

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

Properties

NameTypeRequired

comment

string

JobExtendedProperty

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

Properties

NameTypeRequired

propertyName

string

value

object

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

tableName

string

featureServiceProperties

properties

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

date

string(date-time)¦null

jobId

string

stepId

string¦null

username

string

action

string

result

string¦null

startDate

string(date-time)¦null

endDate

string(date-time)¦null

durationSeconds

integer(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

type

string

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
{
  "allowRunningStepId": "string",
  "jobName": "string",
  "startDate": "2019-08-24T14:15:22Z",
  "dueDate": "2019-08-24T14:15:22Z",
  "priority": "string",
  "description": "string",
  "ownedBy": "string",
  "percentComplete": 0,
  "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": [
              {}
            ]
          }
        ]
      }
    ],
    "deletes": [
      {
        "tableName": "string",
        "ids": [
          "string"
        ]
      }
    ],
    "updates": [
      {
        "tableName": "string",
        "entries": [
          {
            "id": "string",
            "properties": [
              {}
            ]
          }
        ]
      }
    ]
  }
}

Properties

NameTypeRequired

allowRunningStepId

string

jobName

string

startDate

string(date-time)

dueDate

string(date-time)

priority

string

description

string

ownedBy

string

percentComplete

number(double)

jobStatus

string

notes

string

parentJob

string

versions

extendedProperties

relatedProperties

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
{
  "q": "string",
  "search": "string",
  "fields": [
    "string"
  ],
  "displayNames": [
    "string"
  ],
  "sortFields": [
    {
      "field": "string",
      "sortOrder": "Asc"
    }
  ],
  "spatialExtent": "string",
  "hasLocation": true,
  "start": 0,
  "num": 0
}

Properties

NameTypeRequired

q

string¦null

search

string¦null

fields

[string]¦null

displayNames

[string]¦null

sortFields

[SortField]¦null

spatialExtent

string¦null

hasLocation

boolean¦null

start

integer(int32)

num

integer(int32)

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

q

string

fields

results

[array]

start

integer(int32)

nextStart

integer(int32)

num

integer(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

id

string

createdDate

string(date-time)

properties

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

tableName

string

featureServiceProperties

entries

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

total

integer(int32)

groupBy

string¦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

q

string¦null

search

string¦null

groupBy

string¦null

spatialExtent

string¦null

hasLocation

boolean¦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
{
  "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": [
              {}
            ],
            "range": [
              "string"
            ]
          }
        }
      ],
      "updateExisting": true,
      "associateToExisting": true,
      "isAssociated": true
    }
  ],
  "lastUpdatedBy": "string",
  "lastUpdatedDate": "2019-08-24T14:15:22Z"
}

Properties

NameTypeRequired

jobTemplateId

string¦null

jobTemplateName

string

category

string¦null

defaultJobDuration

integer(int32)¦null

defaultAssignedTo

string¦null

defaultDueDate

string(date-time)¦null

defaultStartDate

string(date-time)¦null

jobStartDateType

string¦null

diagramId

string

diagramName

string

diagramThumbnail

string¦null

defaultPriorityName

string

defaultAssignedType

description

string¦null

defaultDescription

string¦null

state

string

defaultJobName

string¦null

defaultFinalStatus

string¦null

defaultStatus

string¦null

activities

[Activity]¦null

extendedPropertyTableDefinitions

lastUpdatedBy

string¦null

lastUpdatedDate

string(date-time)¦null

Enumerated Values
jobStartDateType
CreationDate
Click to copy
SpecificDate
Click to copy
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

jobTemplateId

string

jobTemplateName

string

description

string¦null

category

string¦null

diagramId

string¦null

diagramName

string¦null

state

string

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

path

string

errors

[string]

KeyValues

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

Properties

NameTypeRequired

key

string

value

string

isEnabled

boolean

Location

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

Properties

NameTypeRequired

geometryType

string¦null

geometry

string¦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

location

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