@arcgis/workflow-manager/README.md

ArcGIS Workflow Manager JavaScript API

# @arcgis/workflow-manager

ArcGIS Workflow Manager JavaScript API

## Features

You can install the module via [npm](https://npmjs.org/) and then use them directly in a framework such as [React](https://reactjs.org/), [Vue.js](https://vuejs.org) or [Angular](https://cli.angular.io/). Or, you can also create your own custom builds with [Webpack](https://webpackjs.org) or [rollup.js](https://rollupjs.org/guide/en/).

## Install

Install the module into your project:

```
npm install --save @arcgis/workflow-manager
```

## Dependencies

This module requires the following peer dependencies.
Depending on your package manager, peer dependencies may need to be installed separately.
Please refer to the `package.json` file for dependency and version information.

- [ArcGIS for JavaScript](https://www.npmjs.com/package/@arcgis/core)
- [RxJS](https://www.npmjs.com/package/rxjs)

## Usage

Get a reference to one of the manager classes and call methods on the manager.
Each manager class is responsible for different operations on Workflow Manager Server.

For example, get a `Job` in the system using `JobsManager`.

Refer to the [ArcGIS Workflow Manager JavaScript API Doc](https://developers.arcgis.com/workflow-manager/javascript/get-started/).

```
import { ConfigInfo, JobsManager, ManagerFactory } from '@arcgis/workflow-manager';
import { Job } from '@arcgis/workflow-manager/support';

// Configure connection properties
const config: ConfigInfo = {
  portalUrl: 'https://domain.hostname.com/portal/', // For ArcGIS Enterprise environments only, not needed for ArcGIS Online environments
  itemId: 'workflowItemId',
  appId: 'myAppId'
};

// Get an instance of JobsManager
const jobsManager = await ManagerFactory.getManager(JobsManager, config);

// Get a job in the Workflow Manager system
const job: Job = await jobsManager.getJob('job123');
```

## Resources

- [ArcGIS Workflow Manager](https://www.esri.com/en-us/arcgis/products/arcgis-workflow-manager/overview)
- [ArcGIS Workflow Manager Developer Doc](https://developers.arcgis.com/workflow-manager/)
- [Workflow Manager Blog](https://community.esri.com/t5/arcgis-workflow-manager-blog/bg-p/arcgis-workflow-manager-blog)

## Issues

- General questions about using this module or the ArcGIS Workflow Manager JavaScript API? See the [Workflow Manager community](https://community.esri.com/t5/arcgis-workflow-manager/ct-p/arcgis-workflow-manager).
- [Technical support](https://support.esri.com/).

## Licensing

COPYRIGHT © 2025 Esri

All rights reserved under the copyright laws of the United States
and applicable international laws, treaties, and conventions.

This material is licensed for use under the [Esri Master License
Agreement (MLA)](https://www.esri.com/content/dam/esrisites/en-us/media/legal/ma-full/ma-full.pdf), and is bound by the terms of that agreement.
You may redistribute and use this code without modification,
provided you adhere to the terms of the MLA and include this
copyright notice.

For additional information, contact:
Environmental Systems Research Institute, Inc.
Attn: Contracts and Legal Services Department
380 New York Street
Redlands, California, USA 92373
USA

email: contracts@esri.com