createWorkflowItem

Click to copy

Creates a Workflow Manager item

Creates a Workflow Manager item that stores all the configuration information and location data in the data store on Portal. This can be run by any user assigned to the administrator role in Portal. For users that do not belong to the administrator role, the following privileges are required to run Create Workflow Item:

General Privileges:

  • Members: View
  • Groups: Create, update, and delete; View groups shared with the organization
  • Content: Create, update, and delete; Publish hosted feature layers; View content shared with the organization
  • Sharing: Share with groups; Make groups visible to portal

Create Workflow Item process will:

  • Create a Workflow Manager item in the data store on portal. This item consists of all the Workflow Manager system tables and will store all the data related to Workflow Manager.
  • Create database views in the Workflow Manager item.
  • Load basic roles in the roles table in the item.
  • Create a WorkflowLocations feature service view that consists of location data. These views are read only and are shared with the organization.
  • Create a Workflow Manager Admin group and adds the user as a member.

Body:

ParameterDescriptionData Type
asyncOptional. It is set to false by default. If set to true, the workflow item is created asynchronously and returns itemId and status. The item creation status can be checked on creationStatus endpoint.Boolean

Body parameter

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

Query parameters

NameTypeRequired

name

string

token

string

Path parameters

NameTypeRequired

orgId

string

Examples

Request

Use dark colors for code blocksCopy
1
2
3
4
5
# You can also use wget
curl -X POST /{orgId}/admin/createWorkflowItem?name=string \
  -H 'Content-Type: application/json' \
  -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
8
9
10
11
12
{
  "success": true,
  "itemId": "string",
  "status": "Executing",
  "error": {
    "message": "string",
    "name": "UnableToDetermineHostingServer",
    "details": [
      "string"
    ]
  }
}
StatusMeaningDescriptionSchema

200

OK

The item ID and the item creation status of the newly created item.

CreateItemResponse

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.