Resources and operations

The Workflow Manager REST API is a hierarchy of resources and operations that can be grouped by jobs and configuration.

Jobs

A job is a single unit of work in the Workflow Manager system. In some organizations, a job might be known as a work order or a task. It can be assigned to a person, many people, or a group, and scheduled for completion by a certain date. It includes the workflow steps to complete and the job's details, outlining its scope. It can also contain additional help for completing steps, attachments, the job's location, and associations to spatial data. Many jobs of the same type can be created in the system.

Create jobs

Create one or more jobs.

Search and statistics

Search for jobs and monitor the status of work using job statistics.

Job properties

Manage the properties of a job.

Attachments

Manage job attachments.

Comments and history

Job comments can be viewed and added to a job to facilitate job specific communications between Workflow Manager users and groups.

Job history is a log of job actions, such as running steps or managing job attachments and job properties.

Job locations

Manage locations for jobs. Identify locations where work needs to be performed for jobs. A job location can be defined as a point, line, or polygon.

Job actions

Execute one or more steps in a job.

Actions supported include: Run, Finish, Stop, SetCurrentStep, Hold, ReleaseHold, RefreshStatus.

Manage jobs

Upgrade, close, reopen, and delete jobs.

Configuration

Configuration resources and operations allow workflow item administrators to create and manage workflow diagrams, job templates, and system settings.

Workflow items

Workflow items are single instances of Workflow Manager that allow groups in your organization to performing different types of work. Your organization may have multiple workflow items in your Workflow Manager deployment.

Users, groups, and roles

The ability of users to access work and the functionality displayed in workflow items depends on the privileges contained in the roles assigned to the groups to which Workflow Manager users belong.

Users

Groups

Roles

Job templates

A job template is a predefined collection of properties that serve as the starting point for different types of jobs that can be performed in Workflow Manager. Every job in Workflow Manager is created from a job template. When jobs are created, they use the workflow diagram, job properties, and extended properties defined in the job template as the starting point of the work.

Job template sharing

Choose workflow item groups that you want to allow to use a job template for creating and working with jobs.

Job template automation

Schedule recurring jobs for tasks that needs to be performed on a regular basis. Job template automation can be used to automatically create jobs.

This functionality requires a license for the ArcGIS Workflow Manager Server Advanced role.

Extended properties table definitions

Extended properties tables allow organizations to store additional properties or associate external data with jobs to meet specific business needs.

Workflow diagrams

Workflow diagrams allow you to create a visual representation of a business process that consists of steps and paths. It represents the process that a job will follow from start to finish.

Searches

Shared searches allow workflow item administrators to create custom searches and share them with all workflow item users or specific groups.

Settings

User defined settings provide a secure way for workflow item administrators to store information, such as credentials for a web request or commonly-used file paths. User defined settings can be retrieved and used in your workflows as dynamic job properties.

Lookup tables

Manage lookup tables such as priorities, statuses, or user defined lookup tables. Priorities allow you to assign levels of importance to jobs. Status types describe the possible states or stages that a job moves through when it's running. You can add custom priorities or status types to match your existing business processes or to make them more appropriate for your locale.

Templates

Manage templates such as email templates. Email templates can be used in combination with job activities to send email notifications when specific job activities are performed.

Arcade expression evaluator

The Arcade expression evaluator allows you to test ArcGIS Arcade expressions to ensure that the values returned by the expression are what you expect.

Learn more about dynamic job properties.

Web hooks

Configure webhooks for ArcGIS Survey123 surveys to automatically create jobs in ArcGIS Workflow Manager when surveys are submitted.

This functionality requires a license for the ArcGIS Workflow Manager Server Advanced role.

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