ActiveVersion
{
"name": "string",
"url": "string",
"privateUrl": "string",
"layerItemId": "string",
"versionId": "string",
"replicaName": "string",
"replicaId": "string",
"replicaLocation": "string",
"proReplicaLocation": "string"
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
Activity
{
"typeName": "CloseJob",
"actionName": "Email",
"templateId": "string"
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
|
Enumerated Values
typeName
Annotation
{
"position": "string",
"color": "string",
"outlineColor": "string",
"labelColor": "string",
"text": "string"
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
ArcadeExpression
{
"context": {
"jobId": "string"
},
"expression": "string",
"parseMode": "Standard",
"contextType": "BaseContext"
}
Properties
Name | Type | Required |
---|---|---|
| ||
|
| |
|
| |
|
|
Enumerated Values
parseMode
ArcadeExpressionResult
{
"result": "string"
}
The result of evaluating an arcade expression
Properties
Name | Type | Required |
---|---|---|
|
|
AssignedType
"Unassigned"
- Type
- string
- Required
- false
- Restrictions
- none
- Default value
- Unassigned
Enumerated Values
anonymous
AssignmentBody
{
"assignedTo": "string",
"assignedType": "Unassigned"
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
AutomationAdd
{
"automationName": "string",
"automationType": "Scheduled",
"enabled": true,
"details": "string"
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
|
Enumerated Values
automationType
AutomationBasic
{
"automationId": "string",
"automationName": "string",
"automationType": "Scheduled",
"createdBy": "string"
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
|
Enumerated Values
automationType
AutomationDetails
{
"automationId": "string",
"automationName": "string",
"automationType": "Scheduled",
"createdBy": "string",
"enabled": true,
"details": "string"
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
Enumerated Values
automationType
AutomationRequestBody
{
"adds": [
{
"automationName": "string",
"automationType": "Scheduled",
"enabled": true,
"details": "string"
}
],
"updates": [
{
"automationId": "string",
"automationName": "string",
"enabled": true,
"details": "string"
}
],
"deletes": [
"string"
]
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
|
AutomationUpdate
{
"automationId": "string",
"automationName": "string",
"enabled": true,
"details": "string"
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
|
CodedValue
{
"code": "string",
"name": "string"
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
|
CreateItemResponse
{
"success": true,
"itemId": "string",
"status": "Executing",
"error": {
"message": "string",
"name": "UnableToDetermineHostingServer",
"details": [
"string"
]
}
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
Enumerated Values
status
CreateJobOverrides
{
"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
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
| ||
|
| |
|
| |
|
| |
|
| |
|
| |
| ||
| ||
|
CreateJobsResponse
{
"jobIds": [
"string"
],
"message": "string",
"autoExecuted": true
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
|
CreateSavedSearchResponse
{
"searchId": "string"
}
Properties
Name | Type | Required |
---|---|---|
|
|
CreateWorkflowItemParameters
{
"async": true
}
Properties
Name | Type | Required |
---|---|---|
|
|
CurrentStep
{
"stepId": "string",
"assignedTo": "string",
"assignedType": "Unassigned",
"stepName": "string",
"canSkip": true,
"manualHold": true,
"holdScheduledRelease": "2019-08-24T14:15:22Z",
"dependencies": true
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
| ||
|
| |
|
| |
|
| |
|
| |
|
|
DataSource
{
"name": "string",
"url": "string",
"sourceType": "string"
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
|
DataStoreSettingValue
{
"propName": "string",
"value": "string",
"encrypted": true
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
|
DataStoreSettings
{
"settings": [
{
"propName": "string",
"value": "string",
"encrypted": true
}
]
}
Properties
Name | Type | Required |
---|---|---|
|
DataType
"String"
- Type
- string
- Required
- false
- Restrictions
- none
- Default value
- String
Enumerated Values
anonymous
DefaultStepOutput
{
"value": "string",
"name": "string",
"dataType": "string",
"isEncoded": true
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
|
DetailedErrorDTO
{
"message": "string",
"type": "string",
"details": [
{
"path": "string",
"errors": [
"string"
]
}
]
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
Diagram
{
"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
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
| ||
| ||
|
|
ErrorDTO
{
"message": "string",
"type": "string",
"name": "UnableToDetermineHostingServer",
"details": [
"string"
]
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
|
Enumerated Values
name
ErrorInfo
{
"message": "string",
"name": "UnableToDetermineHostingServer",
"details": [
"string"
]
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
|
Enumerated Values
name
ExportSettings
{
"jobTemplateIds": [
"string"
],
"diagramIds": [
"string"
],
"includeOtherConfiguration": true,
"passphrase": "string"
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
|
ExtendedPropertyDefinition
{
"propertyName": "string",
"propertyAlias": "string",
"propertyOrder": 0,
"dataType": "String",
"defaultValue": {},
"fieldLength": 0,
"required": true,
"editable": true,
"visible": true,
"domain": {
"type": "codedValue",
"codedValues": [
{
"code": "string",
"name": "string"
}
],
"range": [
"string"
]
}
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
| ||
|
| |
|
| |
|
| |
|
| |
|
| |
|
ExtendedPropertyDomain
{
"type": "codedValue",
"codedValues": [
{
"code": "string",
"name": "string"
}
],
"range": [
"string"
]
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
|
Enumerated Values
type
ExtendedPropertyTableDefinition
{
"tableName": "string",
"tableAlias": "string",
"tableOrder": 0,
"relationshipType": "OneToOne",
"featureServiceProperties": {
"itemId": "string",
"itemType": "SurveyForm",
"layerId": "string",
"portalType": "Current",
"portalUrl": "string",
"featureServiceUniqueId": "string",
"secure": true
},
"extendedPropertyDefinitions": [
{
"propertyName": "string",
"propertyAlias": "string",
"propertyOrder": 0,
"dataType": "String",
"defaultValue": {},
"fieldLength": 0,
"required": true,
"editable": true,
"visible": true,
"domain": {
"type": "codedValue",
"codedValues": [
{
"code": "string",
"name": "string"
}
],
"range": [
"string"
]
}
}
],
"updateExisting": true,
"associateToExisting": true,
"isAssociated": true
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
| ||
| ||
| ||
|
| |
|
| |
|
|
FeatureServiceProperties
{
"itemId": "string",
"itemType": "SurveyForm",
"layerId": "string",
"portalType": "Current",
"portalUrl": "string",
"featureServiceUniqueId": "string",
"secure": true
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
Enumerated Values
itemType
Found
{
"found": true
}
Properties
Name | Type | Required |
---|---|---|
|
|
GetLogsResponse
{
"logs": [
{
"logLevel": "WARN",
"message": "string",
"jobId": "string",
"stepId": "string",
"createdDate": "2019-08-24T14:15:22Z",
"createdUser": "string"
}
]
}
Properties
Name | Type | Required |
---|---|---|
|
|
Group
{
"id": "string",
"name": "string",
"isAssignable": true
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
|
GroupRoleMembership
{
"roles": [
"string"
]
}
Properties
Name | Type | Required |
---|---|---|
|
|
GroupRoleMembershipChanges
{
"adds": {
"roles": [
"string"
]
},
"deletes": {
"roles": [
"string"
]
}
}
Properties
Name | Type | Required |
---|---|---|
| ||
|
GroupedValue
{
"value": "string",
"count": 0
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
|
Hold
{
"jobId": "string",
"stepId": "string",
"holdId": "string",
"setBy": "string",
"setDate": "2019-08-24T14:15:22Z",
"scheduledRelease": "2019-08-24T14:15:22Z",
"releasedBy": "string",
"releasedDate": "2019-08-24T14:15:22Z",
"dependentJobId": "string",
"dependentStepId": "string"
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
ItemDetails
{
"itemVersion": "string",
"upgradeAvailable": true,
"isOldestAllowedVersion": true,
"allowUnsecureWebhooks": true,
"customSMTP": true,
"settings": [
{
"propName": "string",
"value": "string",
"encrypted": true
}
]
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
Job
{
"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
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
| ||
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
| ||
|
| |
|
| |
|
| |
|
|
JobActionBody
{
"type": "Finish",
"stepIds": [
"string"
],
"holdScheduledRelease": "2019-08-24T14:15:22Z",
"dependentJobId": "string",
"dependentStepId": "string"
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
Enumerated Values
type
JobActionResponse
{
"success": true,
"stepResponses": [
{
"stepId": "string",
"status": "Success",
"statusDescription": "The step was started running"
}
]
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
JobActionStepResponse
{
"stepId": "string",
"status": "Success",
"statusDescription": "The step was started running"
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
|
Enumerated Values
status
JobActionStepStatus
"Success"
- Type
- string
- Required
- false
- Restrictions
- none
- Default value
- Success
Enumerated Values
anonymous
JobActionType
"Run"
- Type
- string
- Required
- false
- Restrictions
- none
- Default value
- Run
Enumerated Values
anonymous
JobArcadeExpressionContext
{
"jobId": "string"
}
Properties
Name | Type | Required |
---|---|---|
|
|
JobAttachmentDescription
{
"id": "string",
"alias": "string",
"folder": "string",
"url": "string",
"lastModifiedBy": "string",
"lastModified": "2019-08-24T14:15:22Z"
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
JobAttachmentLinked
{
"url": "string",
"alias": "string",
"folder": "string"
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
|
JobAttachmentLinkedBody
{
"attachments": [
{
"url": "string",
"alias": "string",
"folder": "string"
}
],
"stepId": "string"
}
Properties
Name | Type | Required |
---|---|---|
| ||
|
|
JobAttachmentLinkedResult
{
"alias": "string",
"attachmentId": "string"
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
|
JobComment
{
"jobId": "string",
"comment": "string",
"commentId": "string",
"lastModifiedBy": "string",
"lastModified": "2019-08-24T14:15:22Z"
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
|
JobCommentArg
{
"comment": "string"
}
Properties
Name | Type | Required |
---|---|---|
|
|
JobExtendedProperty
{
"propertyName": "string",
"value": {}
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
|
JobExtendedPropertyTable
{
"tableName": "string",
"featureServiceProperties": {
"itemId": "string",
"itemType": "SurveyForm",
"layerId": "string",
"portalType": "Current",
"portalUrl": "string",
"featureServiceUniqueId": "string",
"secure": true
},
"properties": [
{
"propertyName": "string",
"value": {}
}
]
}
Properties
Name | Type | Required |
---|---|---|
|
| |
| ||
|
JobHistory
{
"date": "2019-08-24T14:15:22Z",
"jobId": "string",
"stepId": "string",
"username": "string",
"action": "Activated",
"result": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"durationSeconds": 0
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|
Enumerated Values
action
JobManageBody
{
"type": "Close",
"jobIds": [
"string"
]
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
|
Enumerated Values
type
JobOverrides
{
"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
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
| ||
|
JobQuery
{
"q": "string",
"search": "string",
"fields": [
"string"
],
"displayNames": [
"string"
],
"sortFields": [
{
"field": "string",
"sortOrder": "Asc"
}
],
"spatialExtent": "string",
"hasLocation": true,
"start": 0,
"num": 0
}
Properties
Name | Type | Required |
---|---|---|
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
| |
|
|