executeSurvey123Hook

Click to copy

Creates a Workflow Manager job from a Survey123 survey submission

Creates a new Workflow Manager job from a submission of a survey in Survey123 using webhooks. The survey must be hosted on the same ArcGIS Enterprise machine as Workflow Manager Server or published to the same organization as Workflow Manager. This functionality requires the user also have permissions to submit the survey in Survey123. This requires the ArcGIS Workflow Manager Server Advanced role for ArcGIS Enterprise or the ArcGIS Workflow Manager Advanced organization extension for ArcGIS Online. The jobCreate privilege is required.

The survey body should be called using Survey123 webhooks. The survey must include the following options:

Trigger Events:

  • New Record Submitted

Event Data:

  • Survey Info
  • Submitted Record
  • Portal Info

Query parameters

NameTypeRequired

token

string

Path parameters

NameTypeRequired

jobTemplateId

string

orgId

string

itemId

string

Examples

Request

Use dark colors for code blocksCopy
1
2
3
4
# You can also use wget
curl -X POST /{orgId}/{itemId}/webhooks/createJobFromSurveyResponse/{jobTemplateId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

Response

200 Response

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

200

OK

List of jobs IDs of the created jobs. If the job's first step is set to run automatically, it returns true for autoExecuted.

CreateJobsResponse

400

Bad Request

error

WorkflowJsonExceptionDTO

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