ArcGIS Workflow Manager WebSocket Message API enable your applications to receive notifications of job data updates using WebSockets. This allows your applications to get automatic updates from Workflow Manager Server for your jobs and steps instead of making repeated requests to server for updated information.
The WebSocket protocol enables two-way low-latency communication between a client and Workflow Manager Server. It accomplishes this by establishing persistent socket connections between server and client where the server sends data to connected clients.
Allows you to connect to Workflow Manager Server using secure websockets (wss).
An organization id. For Enterprise deployments, use workflow.
A workflow item id, which represents a single instance of Workflow Manager.
Refer to workflow items.
Publish messages to server to subscribe and unsubscribe to job notifications. Reply to server with information for steps that require user interactions.
Accepts one of the following messages:
Subscribe to the server to be able to receive messages for jobs.
{
"msgType": "subscribe",
"jobIds": [
"AWJU2U6o3PFyCS7Xe5xJ"
],
"token": "token123"
}
Unsubscribe to the server to stop receiving messages for jobs. Specify either 'all' or 'jobIds' in the request.
{
"msgType": "unsubscribe",
"all": true,
"jobIds": [
"AWJU2U6o3PFyCS7Xe5xJ"
],
"token": "token123"
}
Reply to server for the Define Location step with information to indicate whether the job location was created / updated successfully or if there was an error opening the job map.
This is the response for the defineLocationStepInfoRequired message. It indicates whether the job location was created / updated successfully or if there was an error opening the job location map. The request includes the job Id, step Id, whether the step ran successfully, and the location defined in the step.
{
"msgType": "StepInfoResponse",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"failed": false,
"location": "{\"x\":321313.26353361784,\"y\":135782.83633019309,\"z\":0.00010000000474974513,\"m\":null,\"spatialReference\":{\"wkid\":102968,\"latestWkid\":6497}} "
},
"token": "token123"
}
Reply to server for the Add Attachment step with information to indicate that the step is done running. The request includes the job Id and step Id.
This is the response for the addAttachmentStepInfoRequired message.
{
"msgType": "StepInfoResponse",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88"
},
"token": "token123"
}
Reply to server with information indicating whether the Manual step was completed successfully. The request includes the job Id, step Id, the manualResponse, and a comment if the step is configured to allow a comment.
This is the response for the manualStepInfoRequired message.
{
"msgType": "StepInfoResponse",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"manualResponse": true,
"comment": "This is a step comment."
},
"token": "token123"
}
Reply to server for the Open Web Page step with information to indicate that the web app or the web page was opened successfully. The request includes the job Id, step Id, and the openWebPageResponse.
This is the response for the openWebPageStepInfoRequired message.
{
"msgType": "StepInfoResponse",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"openAppResponse": true,
"url": "https://host.domain.com/portal/apps/webappviewer/index.html?id=0cb9b6a808354d9bae4dd8d6cbf0a656"
},
"token": "token123"
}
Reply to server for the Run Pro GP Tool step with user input values when running the GP tool in ArcGIS Pro. The request includes the job Id, step Id, and updated property responses from the user for the configured input parameters.
This is the response for the proGPStepInfoRequired message.
{
"msgType": "StepInfoResponse",
"message": [
{
"identifier": "in_ParamName",
"value": "5"
}
],
"token": "token123"
}
Reply to server for the Open Pro Project Items step with information to indicate that the Pro project items were opened successfully. The request includes the job Id, step Id, the proMappingResponse, and comment if the step is configured to include a comment.
This is the response for the proProjectItemsStepInfoResponse message.
{
"msgType": "StepInfoResponse",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"proMappingResponse": true,
"comment": "This is a step comment."
},
"token": "token123"
}
Reply to server providing more information to process the Question step. The request includes the job Id, step Id, the value of response to the question, and comment if the step is configured to include a comment.
This is the response for the questionStepInfoRequired message.
{
"msgType": "StepInfoResponse",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"questionResponse": 0,
"comment": "This is a step comment."
},
"token": "token123"
}
Reply to server for a Survey123 step with information to indicate that the step was completed successfully. The request includes the job Id, step Id, and the survey123Response.
This is the response for the survey123StepInfoRequired message.
{
"msgType": "StepInfoResponse",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"surveyResponses": [
{
"portalType": "ArcGISOnline",
"portalUrl": "undefined",
"surveyid": "d11e6ef470a54078a8eaa75b49e09dea",
"surveyMode": "View"
}
]
},
"token": "token123"
}
Reply to server for Update Job Properties step or Run GP Service step with visible parameters.
For Update Job Properties step, provide values for basic properties or extended properties in the job that need to be updated.
For Run GP Service step, provide values for visible parameters configured in the step. The values provided will override the default values configured in the step. The request includes the job Id, step Id, property responses for the properties to be updated, and comment if the step is configured to allow a comment.
This is the response for the updateJobPropertiesStepInfoRequired message.
{
"msgType": "StepInfoResponse",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"propertyResponses": [
{
"identifier": "employee.employee_id",
"value": "3245"
}
],
"comment": "This is a step comment."
},
"token": "token123"
}
Reply to server for Update 1-M Job Properties step. Provide values for related properties in the job that need to be updated.
The request includes the job Id, step Id, property responses for the properties to be updated, and comment if the step is configured to allow a comment.
This is the response for the updateJobProperties1MStepInfoRequired message.
{
"msgType": "StepInfoResponse",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"propertyResponses": [
{
"identifier": "employee.employee_id",
"value": "3245"
}
],
"comment": "This is a step comment."
},
"token": "token123"
}
Subscribe to all the messages below by publishing a subscribeJobNotification message for jobs to server.
Accepts one of the following messages:
The job state message is returned after subscribing to the job notification. It includes basic job state information including job status, the percentage complete of the job, job template and diagram being used in the job, assignment and current step state. Step state information is returned when there are one or more current steps running.
{
"msgType": "JobState",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"jobStatus": "Ready to Work",
"percentComplete": 0,
"jobTemplateName": "Data Edits",
"diagramId": "AV9un3sM4dGEE_4h1L6f",
"diagramVersion": 1,
"stepStates": [
{
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"assignedTo": "wmxuser",
"assignedType": "User",
"stepName": "Start",
"canSkip": true,
"message": {
"msgType": "StepPaused",
"message": {
"jobId": "AV-Af95cOmKgBUcGOkCq",
"stepIds": [
"8b085b1d-b5d9-4d08-859b-96ac6151adf5"
]
}
}
}
]
},
"timestamp": 608353511127567
}
The job updated notification message is returned when job's basic or extended property is updated.
The response includes the jobId and property information added, updated and deleted in the job.
{
"msgType": "JobUpdated",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"properties": {
"jobProperties": [
{
"propertyName": "name",
"value": "Charlotte Jones"
}
],
"extendedProperties": [
{
"tableName": "employees",
"properties": [
{
"propertyName": "name",
"value": "Charlotte Jones"
}
]
}
],
"relatedProperties": {
"adds": [
{
"tableName": "employees",
"entries": [
{
"id": "QshozoqbRASVLV-nMZu9Fw",
"properties": [
{
"propertyName": "name",
"value": "Charlotte Jones"
}
]
}
]
}
],
"updates": [
{
"tableName": "employees",
"entries": [
{
"id": "QshozoqbRASVLV-nMZu9Fw",
"properties": [
{
"propertyName": "name",
"value": "Charlotte Jones"
}
]
}
]
}
],
"deletes": [
{
"tableName": "employees",
"ids": [
"zd8PbkceTvmsV_j62wTKug"
]
}
]
}
}
},
"timestamp": 608353511127567
}
This message is returned when a comment is added to a job.
The response includes the comment, comment ID, job ID, and the user who added the comment.
{
"msgType": "JobCommentUpdated",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"adds": [
{
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"comment": "This is a new job comment",
"commentId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"lastModified": 838992531000,
"lastModifiedBy": "admin"
}
]
},
"timestamp": 608353511127567
}
This message is returned when an attachment is added, updated or deleted in an existing job.
The message includes the attachment update type, attachment alias, folder, attachment ID, and last modified user and timestamp.
{
"msgType": "JobAttachmentUpdated",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"adds": [
{
"alias": "Attachment 1",
"folder": "Attachment Folder",
"id": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"url": "http://www.google.com",
"lastModified": 638991231000,
"lastModifiedBy": "admin"
}
],
"updates": [
{
"alias": "Attachment 2",
"folder": "Attachment Folder",
"id": "b0eac649-3d0f-4f8e-03a3-90440wefgtd8",
"url": "http://www.esri.com",
"lastModified": 638991231870,
"lastModifiedBy": "admin"
}
],
"deletes": [
"e0ebb649-30df-4f9e-03a3-904424b3ba9"
]
},
"timestamp": 608353511127567
}
This message is returned when a location is added, updated, or deleted from an existing job.
{
"msgType": "JobLocationUpdated",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"updateType": "LocationAdded"
},
"timestamp": 608353511127567
}
The message returned when one or more steps have started on a job.
{
"msgType": "StepStarted",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepIds": [
"c0eaa649-3d0f-4f9e-03a3-90440e4b3b88"
]
},
"timestamp": 608353511127567
}
The message returned when one or more steps have been started and running in progress on a job. This message is returned after the stepStarted message. For question step, this message is returned after StepInfoResponse is provided and the question step has proceeded.
{
"msgType": "StepProgress",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepIds": [
"c0eaa649-3d0f-4f9e-03a3-90440e4b3b88"
],
"msgCode": "StepRunning",
"msg": "Running...",
"allowedActions": 6
},
"timestamp": 608353511127567
}
The message returned when the processing for one or more automated steps have been cancelled on a job. The cancelled step can be run again, or finished if the step is configured such that it can be skipped.
{
"msgType": "StepCancelled",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepIds": [
"c0eaa649-3d0f-4f9e-03a3-90440e4b3b88"
]
},
"timestamp": 608353511127567
}
The message returned when one or more steps have been paused on a job. The paused step can be run again or finished.
{
"msgType": "StepPaused",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepIds": [
"c0eaa649-3d0f-4f9e-03a3-90440e4b3b88"
]
},
"timestamp": 608353511127567
}
The message returned when the processing for automated steps is stopping or a step is being paused on a job. The message returns one or more steps that are stopping.
{
"msgType": "StepStopping",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepIds": [
"c0eaa649-3d0f-4f9e-03a3-90440e4b3b88"
]
},
"timestamp": 608353511127567
}
The message returned when one or more automated steps are stopped on a job. If the step is set to proceed to next, it will move to the next step in the diagram. If the step is not set to proceed to next, the step can be manually finished.
{
"msgType": "StepStopped",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"msgCode": "StepFinished",
"msg": "Step Finished"
},
"timestamp": 608353511127567
}
The message returned when a step has stopped with a warning message. The message returns the step stopped with warning message and if can proceed.
{
"msgType": "StepWarningStopped",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"msgCode": "NoMatchingPaths",
"msg": "No paths match return code",
"proceed": false
},
"timestamp": 608353511127567
}
The message returned when one or more steps have finished on a job. The message returns one or more current steps the job has moved to and the job status.
{
"msgType": "StepFinished",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepIds": [
"c0eaa649-3d0f-4f9e-03a3-90440e4b3b88"
],
"currentSteps": [
{
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"assignedTo": "wmxuser",
"assignedType": "User",
"stepName": "Start",
"canSkip": true
}
],
"jobStatus": "Ready to Work"
},
"timestamp": 608353511127567
}
The message returned when a step has been reassigned. The message returns the step that is reassigned and the new assignment.
{
"msgType": "StepReassigned",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"msgType": "StepReassigned",
"assignedTo": "username",
"assignedType": "User"
},
"timestamp": 608353511127567
}
The error returned if an invalid response is provided to a step in a job.
{
"msgType": "StepError",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"msgCode": "QuestionFailed",
"msg": "Question Step Failed"
},
"timestamp": 608353511127567
}
The error returned when a response is sent to a step that is not running in a job.
{
"msgType": "Error",
"message": {
"error": {
"message": "The specified step is not waiting for a response on the job",
"type": "InvalidDiagramException"
}
},
"timestamp": 608353511127567
}
Request from server for a response for the Add Attachment step. The request consists of the job Id, step Id, user prompt, attachment folder, accepted attachment type including embedded and linked, accepted embedded file types, whether the user can view existing attachments, whether the user can edit existing attachments, and information about existing attachments on the job.
The step is in the running state until an addAttachmentStepInfoResponse message is sent to server, then execution of the job will continue.
{
"msgType": "StepInfoRequired",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"msgCode": "StepRunning",
"msg": "Running",
"allowedActions": 6,
"userPrompt": "Please add attachments",
"helpText": "Make sure to zip shapefiles before attaching",
"folder": "AttachmentFolder",
"acceptEmbedded": true,
"acceptLinked": false,
"acceptedFileTypes": ".pdf,.txt",
"viewExisting": true,
"editExisting": false,
"attachments": [
{
"alias": "Thisisapdf",
"attachmentId": "419FC1F6-E050-4916-BD36-FB5759F3E563",
"lastModified": "2020-04-20T05:08:20Z",
"uri": "https://www.esri.com/en-us/home"
}
]
},
"timestamp": 608353511127567
}
Requests from server for information on creating / updating a job location for the Define Location step. The request consists of the job Id, step Id, job location map and geometry type used in the define location step.
The step is in the running state until a defineLocationStepInfoResponse message is sent to server, then execution of the job will continue.
{
"msgType": "StepInfoRequired",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"msgCode": "StepRunning",
"msg": "Running",
"allowedActions": 6,
"helpText": "Double check the pop up for the correct id",
"locationMap": [
{
"name": "OilAndGas_MapX",
"itemType": "Map",
"repointVersion": false,
"resetVersion": false,
"exportToPortal": false
}
],
"geometryType": "Polygon",
"prompt": "Define job's location",
"webMapUrl": "https://www.arcgis.com/home/item.html?id=b6d2a1a1a782497a8453006189a270fa",
"methodType": "SelectAndDraw",
"zoomToSearchText": "Redlands"
},
"timestamp": 608353511127567
}
Requests from server for more information required to process the Manual step. The request includes the job Id, step Id and user prompt.
The step is in the running state until a manualStepInfoResponse message is sent to server, then execution of the job will continue.
{
"msgType": "StepInfoRequired",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"msgCode": "StepRunning",
"msg": "Running",
"allowedActions": 6,
"helpText": "Make sure to zip shapefiles",
"userPrompt": "Create a data backup",
"canComment": true,
"commentRequired": true
},
"timestamp": 608353511127567
}
Request from server for information about the web application or web page to be opened by the Open Web Page step. The request consists of the job Id, step Id and the application url of the web app or page to be opened.
The step is in the running state until an openWebPageStepInfoResponse message is sent to server, then execution of the job will continue.
{
"msgType": "StepInfoRequired",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"msgCode": "StepRunning",
"msg": "Running",
"allowedActions": 6,
"appUrl": "https://host.domain.com/portal/apps/webappviewer/index.html?id=0cb9b6a808354d9bae4dd8d6cbf0a656",
"openInNewBrowser": true
},
"timestamp": 608353511127567
}
Request from server for more information for the Run Pro GP Tool step. This request is sent if the step is configured to allow users to define parameter values before the GP tool is run. The request consists of the job Id, step Id, and Pro GP tool's information and parameters.
The step is in the running state until a proGPStepInfoResponse message is sent to server, then execution of the job will continue.
{
"msgType": "StepInfoRequired",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"msgCode": "StepRunning",
"msg": "Running",
"allowedActions": 6,
"helpText": "Text containing guidance for step execution",
"userPrompt": "Please run the Pro GP Step",
"ToolboxType": "System",
"Toolbox": "management",
"ToolName": "GetCount",
"Visible": true,
"isGPLogAttached": false,
"parameters": [
{
"name": "out_name",
"value": "newfolder"
}
]
},
"timestamp": 608353511127567
}
Requests information for an **Open Pro Project Items** step.
Request from server for more information for the Open Pro Project Items step. The request consists of the job Id, step Id, and Pro project items to open.
The step is in the running state until a proProjectItemsStepInfoResponse message is sent to server, then execution of the job will continue.
{
"msgType": "StepInfoRequired",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"msgCode": "StepRunning",
"msg": "Running",
"allowedActions": 6,
"helpText": "The step help text",
"userPrompt": "Please open Pro project and items in the project",
"projectInfo": {
"type": "Portal",
"path": "c:\\data\\ArcGISProject",
"portalType": "Other",
"portalUrl": "https://host.domain.com/portal",
"itemId": "47452c0657b443378eabcbbeeabc02bf",
"itemAlias": "ArcGIS Pro Mapping Project",
"itemDownloadFilename": "JOB_1.pitemx"
},
"openProItems": [
{
"name": "OilAndGas_MapX",
"itemType": "Map",
"repointVersion": true,
"resetVersion": true,
"closeItem": true
}
],
"comment": "This is a step comment.",
"activeVersions": [
{
"name": "admin.JOB_17",
"url": "https://host.domain.com/server/rest/services/Gas_Utility_Network/FeatureServer",
"layerItemId": "28e30fb136546ae974fde87def16e78",
"versionId": "E373F997-150C-40D5-933F-8EE2FF2D8272"
}
],
"zoomToLocation": false,
"proCommands": [
"esri_mapping_gotoXYControl"
],
"closeProProject": true,
"restrictEdits": {
"operator": "Intersect",
"bufferDistance": 10
},
"canComment": true,
"commentRequired": true
},
"timestamp": 608353511127567
}
Request from server for more information required by the Question step to be able to process the step. The request includes the job Id, step Id, the question to be answered, and the possible responses.
The step is in the running state until a questionStepInfoResponse message is sent to server, then execution of the job will continue.
{
"msgType": "StepInfoRequired",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"msgCode": "StepRunning",
"msg": "Running",
"allowedActions": 6,
"helpText": "Select yes if this has already been reviewed.",
"question": "Are more edits required?",
"questionResponses": [
{
"name": "Yes",
"value": 1
}
],
"canComment": true,
"commentRequired": true
},
"timestamp": 608353511127567
}
Request from server for survey information for the Survey123 step. Allow the user to interact and complete the survey configured in the step. The request consists of the job Id, step Id, the name and form id of the survey to be opened, location of the survey, and whether the survey is editable.
The step is in the running state until a survey123StepInfoResponse message is sent to server, then execution of the job will continue.
{
"msgType": "StepInfoRequired",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"msgCode": "StepRunning",
"msg": "Running",
"allowedActions": 6,
"helpText": "Check page 3 for the PO",
"name": "Survey1",
"portalType": "ArcGISOnline",
"surveyId": "d11e6ef470a54078a8eaa75b49e09dea",
"surveyMode": "View",
"surveyRecordType": "Latest",
"relationshipType": "OneToOne"
},
"timestamp": 608353511127567
}
Request from server for information about updating basic and/or extended properties for a job in the Update Job Properties step. The request consists of the job Id, step Id, user prompt and properties.
The step is in the running state until an updateJobPropertiesStepInfoResponse message is sent to server, then execution of the job will continue.
{
"msgType": "StepInfoRequired",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"jobTemplateId": "RURJ-eDZR7e0mzfAjMOCPg",
"msgCode": "StepRunning",
"msg": "Running",
"allowedActions": 6,
"helpText": "Check page 3 for the PO",
"prompt": "Please update the following values",
"properties": [
{
"identifier": "employee.employee_id",
"alias": "emp_id",
"required": false,
"value": false,
"dataType": "boolean",
"editable": "true/false",
"domainType": "codedValue",
"order": 1,
"fieldLength": 100
}
],
"canComment": true,
"commentRequired": true
},
"timestamp": 608353511127567
}
Request from server for information about updating related properties for a job in the Update 1-M Job Properties step. The request consists of the job Id, step Id, user prompt and properties.
The step is in the running state until an updateJobProperties1MStepInfoResponse message is sent to server, then execution of the job will continue.
{
"msgType": "StepInfoRequired",
"message": {
"jobId": "AWJU2U6o3PFyCS7Xe5xJ",
"stepId": "c0eaa649-3d0f-4f9e-03a3-90440e4b3b88",
"jobTemplateId": "RURJ-eDZR7e0mzfAjMOCPg",
"msgCode": "StepRunning",
"msg": "Running",
"allowedActions": 6,
"helpText": "Check page 3 for the PO",
"prompt": "Please update the following values",
"properties": [
{
"identifier": "employee.employee_id",
"alias": "emp_id",
"required": false,
"value": false,
"dataType": "boolean",
"editable": "true/false",
"domainType": "codedValue",
"order": 1,
"fieldLength": 100
}
],
"stepMode": "Create",
"canComment": true,
"commentRequired": true
},
"timestamp": 608353511127567
}
Subscribe to the server to be able to receive messages for jobs.
Unsubscribe to the server to stop receiving messages for jobs. Specify either 'all' or 'jobIds' in the request.
The job state message is returned after subscribing to the job notification. It includes basic job state information including job status, the percentage complete of the job, job template and diagram being used in the job, assignment and current step state. Step state information is returned when there are one or more current steps running.
The job updated notification message is returned when job's basic or extended property is updated.
The response includes the jobId and property information added, updated and deleted in the job.
This message is returned when a comment is added to a job.
The response includes the comment, comment ID, job ID, and the user who added the comment.
This message is returned when an attachment is added, updated or deleted in an existing job.
The message includes the attachment update type, attachment alias, folder, attachment ID, and last modified user and timestamp.
This message is returned when a location is added, updated, or deleted from an existing job.
The message returned when one or more steps have started on a job.
The message returned when one or more steps have been started and running in progress on a job. This message is returned after the stepStarted message. For question step, this message is returned after StepInfoResponse is provided and the question step has proceeded.
The message returned when the processing for one or more automated steps have been cancelled on a job. The cancelled step can be run again, or finished if the step is configured such that it can be skipped.
The message returned when one or more steps have been paused on a job. The paused step can be run again or finished.
The message returned when the processing for automated steps is stopping or a step is being paused on a job. The message returns one or more steps that are stopping.
The message returned when one or more automated steps are stopped on a job. If the step is set to proceed to next, it will move to the next step in the diagram. If the step is not set to proceed to next, the step can be manually finished.
The message returned when a step has stopped with a warning message. The message returns the step stopped with warning message and if can proceed.
The message returned when one or more steps have finished on a job. The message returns one or more current steps the job has moved to and the job status.
The message returned when a step has been reassigned. The message returns the step that is reassigned and the new assignment.
The message returned when one or more steps are on hold on a job. If step is on a scheduled hold, the message also returns the scheduled release timestamp.
The message returned when a step hold or dependency has been released on a job. If there are multiple holds or dependencies on a step, this message will only be sent when all holds and dependencies have been released.
The error returned if an invalid response is provided to a step in a job.
The error returned when a response is sent to a step that is not running in a job.
Request from server for a response for the Add Attachment step. The request consists of the job Id, step Id, user prompt, attachment folder, accepted attachment type including embedded and linked, accepted embedded file types, whether the user can view existing attachments, whether the user can edit existing attachments, and information about existing attachments on the job.
The step is in the running state until an addAttachmentStepInfoResponse message is sent to server, then execution of the job will continue.
Reply to server for the Add Attachment step with information to indicate that the step is done running. The request includes the job Id and step Id.
This is the response for the addAttachmentStepInfoRequired message.
Requests from server for information on creating / updating a job location for the Define Location step. The request consists of the job Id, step Id, job location map and geometry type used in the define location step.
The step is in the running state until a defineLocationStepInfoResponse message is sent to server, then execution of the job will continue.
Reply to server for the Define Location step with information to indicate whether the job location was created / updated successfully or if there was an error opening the job map.
This is the response for the defineLocationStepInfoRequired message. It indicates whether the job location was created / updated successfully or if there was an error opening the job location map. The request includes the job Id, step Id, whether the step ran successfully, and the location defined in the step.
Requests from server for more information required to process the Manual step. The request includes the job Id, step Id and user prompt.
The step is in the running state until a manualStepInfoResponse message is sent to server, then execution of the job will continue.
Reply to server with information indicating whether the Manual step was completed successfully. The request includes the job Id, step Id, the manualResponse, and a comment if the step is configured to allow a comment.
This is the response for the manualStepInfoRequired message.
Request from server for information about the web application or web page to be opened by the Open Web Page step. The request consists of the job Id, step Id and the application url of the web app or page to be opened.
The step is in the running state until an openWebPageStepInfoResponse message is sent to server, then execution of the job will continue.
Reply to server for the Open Web Page step with information to indicate that the web app or the web page was opened successfully. The request includes the job Id, step Id, and the openWebPageResponse.
This is the response for the openWebPageStepInfoRequired message.
Request from server for more information for the Run Pro GP Tool step. This request is sent if the step is configured to allow users to define parameter values before the GP tool is run. The request consists of the job Id, step Id, and Pro GP tool's information and parameters.
The step is in the running state until a proGPStepInfoResponse message is sent to server, then execution of the job will continue.
Reply to server for the Run Pro GP Tool step with user input values when running the GP tool in ArcGIS Pro. The request includes the job Id, step Id, and updated property responses from the user for the configured input parameters.
This is the response for the proGPStepInfoRequired message.
Requests information for an **Open Pro Project Items** step.
Request from server for more information for the Open Pro Project Items step. The request consists of the job Id, step Id, and Pro project items to open.
The step is in the running state until a proProjectItemsStepInfoResponse message is sent to server, then execution of the job will continue.
Reply to server for the Open Pro Project Items step with information to indicate that the Pro project items were opened successfully. The request includes the job Id, step Id, the proMappingResponse, and comment if the step is configured to include a comment.
This is the response for the proProjectItemsStepInfoResponse message.
Request from server for more information required by the Question step to be able to process the step. The request includes the job Id, step Id, the question to be answered, and the possible responses.
The step is in the running state until a questionStepInfoResponse message is sent to server, then execution of the job will continue.
Reply to server providing more information to process the Question step. The request includes the job Id, step Id, the value of response to the question, and comment if the step is configured to include a comment.
This is the response for the questionStepInfoRequired message.
Request from server for survey information for the Survey123 step. Allow the user to interact and complete the survey configured in the step. The request consists of the job Id, step Id, the name and form id of the survey to be opened, location of the survey, and whether the survey is editable.
The step is in the running state until a survey123StepInfoResponse message is sent to server, then execution of the job will continue.
Reply to server for a Survey123 step with information to indicate that the step was completed successfully. The request includes the job Id, step Id, and the survey123Response.
This is the response for the survey123StepInfoRequired message.
Request from server for information about updating basic and/or extended properties for a job in the Update Job Properties step. The request consists of the job Id, step Id, user prompt and properties.
The step is in the running state until an updateJobPropertiesStepInfoResponse message is sent to server, then execution of the job will continue.
Reply to server for Update Job Properties step or Run GP Service step with visible parameters.
For Update Job Properties step, provide values for basic properties or extended properties in the job that need to be updated.
For Run GP Service step, provide values for visible parameters configured in the step. The values provided will override the default values configured in the step. The request includes the job Id, step Id, property responses for the properties to be updated, and comment if the step is configured to allow a comment.
This is the response for the updateJobPropertiesStepInfoRequired message.
Request from server for information about updating related properties for a job in the Update 1-M Job Properties step. The request consists of the job Id, step Id, user prompt and properties.
The step is in the running state until an updateJobProperties1MStepInfoResponse message is sent to server, then execution of the job will continue.
Reply to server for Update 1-M Job Properties step. Provide values for related properties in the job that need to be updated.
The request includes the job Id, step Id, property responses for the properties to be updated, and comment if the step is configured to allow a comment.
This is the response for the updateJobProperties1MStepInfoRequired message.
Information about all the versions associated with the job.
Detailed information for the addAttachmentStepInfoRequired message.
Detailed response for the addAttachmentStepInfoResponse message.
Information for the added job attachment.
Information for the job comment.
Information for newly added job related properties.
A bit flag enum that indicates the actions that can be taken. CanCancel = 1, CanPause = 2, CanFinish = 4. For example, a value of 6 would indicate CanPause and CanFinish.
Indicates if a comment can be added to a step.
The comment added to the step.
Indicates if a comment is required for the step.
The message returned from the current step.
Detailed information for the defineLocationStepInfoRequired message.
Detailed response for the defineLocationStepInfoResponse message.
Information for the deleted job attachment.
Information for deleted related job properties.
The exception error message returned by server.
The message returned when extended job properties are updated.
The step help.
The array of job attachment Ids.
The Id of the job.
The message returned when basic job properties are updated.
The message returned for job state.
The message returned for the state of the current step in the job.
The Id of the job template.
The message returned for the job properties updated in the job.
The updated properties returned from the JobUpdated notification message.
The location map used when running a define location step.
List of possible message types when sending or receiving messages.
GP parameters that need to be updated.
Properties in the extended properties table that need to be updated.
Values for properties to be provided by the user.
An array of question responses used in the Question step.
The message of one or more finished steps.
The Id of the step.
The array of step Ids.
The status of step execution.
Type of message received.
Type of message sent.
The message for steps in progress.
The message for a stopped step.
The warning message for a step that has stopped but cannot proceed.
The message for a step that has been reassignment.
Values for survey response properties updated by a user.
The table name of the extended properties or related properties referenced in JobUpdated message.
The timestamp of step execution.
Access token generated by Portal to authenticate the user.
Information for the updated job attachment. The update types include add, update and delete and only one type is specified at a time.
Information for the job comment.
Information for the added, updated, or deleted job location.
Detailed information for the updateJobPropertiesStepInfoRequired message.
Detailed information for the updateJobPropertiesStepInfoResponse and proGPStepInfoResponse messages.
Information for the updated job attachment.
Information for updated job related properties in JobUpdated message.
Detailed response for the updateJobProperties1MStepInfoResponse message.
The step user prompt.