FRAMES | NO FRAMES Description | Parameters | Examples | Response
Workflow Manager Service
URL http://<catalog-url>/<serviceName>/WMServer
http://<host>/wmrest/services/<serviceName>/WMServer   (only ArcGIS Server 10.0 for .NET)
Supported Operations Update configProperties  Visible job types
Parent Resource Catalog
Child Resources Jobs  Reports  Users  Groups  Job Type  Data Workspace  Table Relationships  Public Queries  Spatial Notification  Replication  

Description

Workflow Manager services offer access to the information within an ArcGIS Workflow Manager repository. This information is accessible to web applications, mobile applications, and web-aware desktop applications.

The top-level Workflow Manager REST resource contains a variety of configuration properties specific to a Workflow Manager system. This configuration includes job types, priorities, notification types, data workspaces, and job queries.

ArcGIS Server 10.0 for .NET: The REST URL format for Workflow Manager services in ArcGIS Server 10.0 for .NET differs slightly from the standard REST API conventions used elsewhere in ArcGIS Server. The URL format for a Workflow Manager service in the ArcGIS Server 10.0 for .NET is http://<host>/wmrest/services/<serviceName>/WMServer.

The information contained in this top-level REST resource is cached for performance reasons. You must clear the REST cache after making any configuration changes to the ArcGIS Workflow Manager system using the Workflow Manager Administrator application. To clear the cache in ArcGIS 10.1 for Server and in ArcGIS Server 10.0 for Java, use the standard Clear Cache operation. To clear the cache in ArcGIS Server 10.0 for .NET, a slightly different URL must be used: http://<host>/wmrest/admin/cache/clear.

Parameters

Parameter Details
f Description: The response format. The default response format is html.

Values: html | json

Example Usage

Example 1: URL for the "Workflow" service (on ArcGIS 10.1 for Server and ArcGIS Server 10.0 for Java).

http://sampleserver/arcgis/rest/services/Workflow/WMServer

Example 2: URL for the "Workflow" service (on ArcGIS Server 10.0 for .NET).

http://sampleserver/wmrest/services/Workflow/WMServer

JSON Response Syntax

{
  "currentVersion": <currentVersion>,
  "serviceDescription": "<serviceDescription>",
  "configProperties": {
    "<key1>": "<value1>",
    "<key2>": "<value2>",
    ...
  },
  "jobTypes": [
    {
      "id": <jobTypeId1>,
      "name": "<jobTypeName1>",
      "description": "<description1>",
      "category": "<category1>",
      "state": <jobTypeState1>
    },
    {
      "id": <jobTypeId2>,
      "name": "<jobTypeName2>",
      "description": "<description2>",
      "category": "<category2>",
      "state": <jobTypeState2>
    },
    ...
  ],
  "jobStatuses": [
    { "id": <statusId1>, "name": "<statusName1>", "description": "<description1>", "caption": "<caption1>" },
    { "id": <statusId2>, "name": "<statusName2>", "description": "<description2>", "caption": "<caption2>" },
    ...
  ],
  "jobPriorities": [
    { "value": <priorityValue1>, "name": "<priorityName1>", "description": "<description1>" },
    { "value": <priorityValue2>, "name": "<priorityName2>", "description": "<description2>" },
    ...
  ],
  "activityTypes": [
    { "id": <activityTypeId1>, "name": "<activityTypeName1>", "description": "<description1>", "message": "<message1>" },
    { "id": <activityTypeId2>, "name": "<activityTypeName2>", "description": "<description2>", "message": "<message2>" },
    ...
  ],
  "holdTypes": [
    { "id": <holdTypeId1>, "name": "<holdTypeName1>", "description": "<description1>" },
    { "id": <holdTypeId2>, "name": "<holdTypeName2>", "description": "<description2>" },
    ...
  ],
  "notificationTypes": [
    {
      "id": <notificationTypeId1>,
      "type": "<notificationName1>",
      "subject": "<emailSubject1>",
      "message": "<emailMessage1>",
      "senderEmail": "<emailAddress1>",
      "senderName": "<emailSender1>",
      "subscribers": [ "<subscriberEmail11>", "<subscriberEmail12>", ... ],
      "attachJobAttachments": <true | false>  // Added at 10.1
    },
    {
      "id": <notificationTypeId2>,
      "type": "<notificationName2>",
      "subject": "<emailSubject2>",
      "message": "<emailMessage2>",
      "senderEmail": "<emailAddress2>",
      "senderName": "<emailSender2>",
      "subscribers": [ "<subscriberEmail21>", "<subscriberEmail22>", ... ],
      "attachJobAttachments": <true | false>
    },
    ...
  ],
  "privileges": [
    { "id": <privilegeId1>, "name": "<privilegeName1>", "description": "<description1>" },
    { "id": <privilegeId2>, "name": "<privilegeName2>", "description": "<description2>" },
    ...
  ],
  "dataWorkspaces": [
    { "id": "<workspaceId1>", "name": "<workspaceName1>" },
    { "id": "<workspaceId1>", "name": "<workspaceName1>" },
    ...
  ],
  "publicQueries": {
    "id": <containerId1>,
    "name": "<containerName1>",
    "queries": [
      { "id": <queryId11>, "name": "<queryName11>" },
      { "id": <queryId12>, "name": "<queryName12>" },
      ...
    ],
    "containers": [
      {
        "id": <containerId2>,
        "name": "<containerName2>",
        "queries": [
          { "id": <queryId21>, "name": "<queryName21>" },
          { "id": <queryId22>, "name": "<queryName22>" },
          ...
        ],
        "containers": [
          ...
        ]
      },
      ...
    ]
  }
}

JSON Response Example

{
  "currentVersion": 10.1,
  "serviceDescription": "",
  "configProperties": {
    "AOIOVERLAP": "allow",
    "AOISELECTIONCOLOR": "255",
    "AUTOASSIGNJOB": "TRUE",
    ...
    "ZOOMTOAOI": "TRUE"
  },
  "jobTypes": [
    { "id": 1, "name": "Landbase Updates", "description": "Landbase Updates", "category": "Editing Workflows", "state": 1 }
  ],
  "jobStatuses": [
    { "id": 1, "name": "ReadyToWork", "description": "Job is ready to be worked", "caption": "Ready To Work" }
  ],
  "jobPriorities": [
    { "value": 1, "name": "Low", "description": "Low Priority" },
    { "value": 10, "name": "High", "description": "High Priority" }
  ],
  "activityTypes": [
    { "id": 1, "name": "AssignJob", "description": "Assign Job", "message": "Job assigned to [CUR_USER] by [FULLNAMEOF([CUR_NT_USER])]" },
    { "id": 2, "name": "CreateJob", "description": "Create Job", "message": "Job created by [FULLNAMEOF([CUR_NT_USER])]" }
  ],
  "holdTypes": [
    { "id": 1, "name": "Budget Hold", "description": "Fiscal shortage" },
    { "id": 2, "name": "Missing Data", "description": "Missing all necessary data to complete work" }
  ],
  "notificationTypes": [
    {
      "id": 1,
      "type": "AOIUpdated",
      "subject": "Area of Interest updated",
      "message": "Area of Interest for Job [JOB:ID] updated by [SYS:CUR_LOGIN]",
      "senderEmail": "noreply@example.org",
      "senderName": "Workflow Manager",
      "subscribers": [ "gis@example.org", "qa@example.org" ],
      "attachJobAttachments": false
    }
  ],
  "privileges": [
    { "id": 1, "name": "AssignAnyJob", "description": "User can assign any job to any individual at any time" },
    { "id": 2, "name": "CloseJob", "description": "User can close a job when the workflow is complete" }
  ],
  "dataWorkspaces": [
    { "id": "{39FD6B70-DA49-4F91-BD9D-0F2F0A8FEC26}", "name": "QA/QC Workspace" }
  ],
  "publicQueries": {
    "id": 1,
    "name": "Public Queries",
    "queries": [],
    "containers": [
      {
        "id": 2,
        "name": "General Queries",
        "queries": [
          { "id": 10, "name": "All Jobs" },
          { "id": 11, "name": "Unassigned Jobs" }
        ],
        "containers": []
      },
      {
        "id": 3,
        "name": "Personal Queries",
        "queries": [
          { "id": 12, "name": "Jobs assigned to me" },
          { "id": 13, "name": "Jobs with steps assigned to me" }
        ],
        "containers": []
      }
    ]
  }
}