---
title: "Workflow"
description: "Enhance your development by integrating our language drivers with Workflow methods and features. (Gitana 4.0)"
product: "Gitana"
version: "4.0"
url: "/documentation/gitana/4.0/reference/types/workflow"
---

# <a id="top"></a>Workflow

An Object

1.  [Platform](/documentation/gitana/4.0/reference/types/platform.md)
2.  [Workflow](/documentation/gitana/4.0/reference/types/workflow.md)

##### Table of Contents

- [Overview](#top "Overview")
- [Parent](#parent "Parent")
- [Properties](#properties "Properties")
- [Methods](#methods "Methods")
- [Schema](#schema "Schema")

> **Note:** Drop in one of our language drivers to accelerate your development.  
> Here are links to some of our popular [Cookbooks](/documentation/gitana/4.0/developers/cookbooks/overview.md) to help you get started!
> 
> - [C#](/documentation/gitana/4.0/developers/cookbooks/csharp.md)
> - [Go](/documentation/gitana/4.0/developers/cookbooks/go.md)
> - [Java](/documentation/gitana/4.0/developers/cookbooks/java.md)
> - [JavaScript](/documentation/gitana/4.0/developers/cookbooks/javascript2.md)
> - [PHP](/documentation/gitana/4.0/developers/cookbooks/php.md)
> - [Python](/documentation/gitana/4.0/developers/cookbooks/python.md)
> - [Ruby](/documentation/gitana/4.0/developers/cookbooks/ruby.md)

## <a id="parent"></a>Parent

This Workflow is contained within a [Platform](/documentation/gitana/4.0/reference/types/platform.md).

## <a id="properties"></a>Properties

The following properties are available:

| Property | Type | Default | Read-Only | Description |
| --- | --- | --- | --- | --- |
| \_doc | string |  | No | The primary ID |
| \_system | object |  | No | Metadata maintained by the system |

## <a id="methods"></a>Methods

The following methods are available:

- [Add Resources](#post-workflow-instances-workflowid-resources-add "Add Resources")
- [Check Permission](#post-workflow-instances-workflowid-permissions-permissionid-check "Check Permission")
- [Check Single Authority](#post-workflow-instances-workflowid-authorities-authorityid-check "Check Single Authority")
- [Check multiple Authorities](#post-workflow-instances-authorities-check "Check multiple Authorities")
- [Check multiple Permissions](#post-workflow-instances-permissions-check "Check multiple Permissions")
- [Create Workflow](#post-workflow-instances "Create Workflow")
- [Delete Workflow](#post-workflow-instances-workflowid-delete "Delete Workflow")
- [Delete Workflow](#delete-workflow-instances-workflowid "Delete Workflow")
- [Export Workflow](#post-workflow-instances-workflowid-export "Export Workflow")
- [Grant Authority](#post-workflow-instances-workflowid-authorities-authorityid-grant "Grant Authority")
- [Import Workflow](#post-workflow-instances-workflowid-import "Import Workflow")
- [List Requirements](#get-workflow-models-modelid-requirements "List Requirements")
- [List Resources](#get-workflow-instances-workflowid-resources "List Resources")
- [Lists Workflow](#get-workflow-instances "Lists Workflow")
- [Queries for Workflow](#post-workflow-instances-query "Queries for Workflow")
- [Read ACL](#get-workflow-instances-workflowid-acl-list "Read ACL")
- [Read ACL for Principal](#get-workflow-instances-workflowid-acl "Read ACL for Principal")
- [Read Authorities Report](#post-workflow-instances-workflowid-authorities "Read Authorities Report")
- [Read History Instance](#get-workflow-instances-workflowid-history "Read History Instance")
- [Read Resource](#get-workflow-instances-workflowid-resources-resourceid "Read Resource")
- [Read Workflow](#get-workflow-instances-workflowid "Read Workflow")
- [Remove Resource](#post-workflow-instances-workflowid-resources-resourceid-remove "Remove Resource")
- [Removeall Resources](#post-workflow-instances-workflowid-resources-removeall "Removeall Resources")
- [Resume Instance](#post-workflow-instances-workflowid-resume "Resume Instance")
- [Revoke Authority](#post-workflow-instances-workflowid-authorities-authorityid-revoke "Revoke Authority")
- [Start Instance](#post-workflow-instances-workflowid-start "Start Instance")
- [Suspend Instance](#post-workflow-instances-workflowid-suspend "Suspend Instance")
- [Terminate Instance](#post-workflow-instances-workflowid-terminate "Terminate Instance")
- [Update Workflow](#put-workflow-instances-workflowid "Update Workflow")
- [Update Workflow](#post-workflow-instances-workflowid-update "Update Workflow")

### <a id="post-workflow-instances-workflowid-resources-add"></a>Add Resources

POST /workflow/instances/{workflowId}/resources/add

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |
| reference | true | string |  |

### <a id="post-workflow-instances-workflowid-permissions-permissionid-check"></a>Check Permission

Checks whether one or more authorities against the specified workflow are granted for a given set of users

POST /workflow/instances/{workflowId}/permissions/{permissionId}/check

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |
| permissionId | true | string | The ID of the permission |
| id | true | string |  |

#### Response

```json
{
  "$ref": "#/components/schemas/checkPermission"
}
```

### <a id="post-workflow-instances-workflowid-authorities-authorityid-check"></a>Check Single Authority

Checks whether a single authority is granted against the specified workflow for the given user

POST /workflow/instances/{workflowId}/authorities/{authorityId}/check

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |
| authorityId | true | string | The ID or authority key for the authority |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Check",
  "extends": "status",
  "properties": {
    "check": {
      "type": "boolean"
    },
    "ok": null
  }
}
```

### <a id="post-workflow-instances-authorities-check"></a>Check multiple Authorities

Checks whether one or more authorities against the specified workflow are granted for a given set of users

POST /workflow/instances/authorities/check

#### Parameters

This function has no parameters.

#### Response

```json
{
  "type": "object",
  "description": "Check Multiple Authorities Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "authorityId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}
```

### <a id="post-workflow-instances-permissions-check"></a>Check multiple Permissions

Checks whether one or more permissions against the specified workflow are granted for a given set of users

POST /workflow/instances/permissions/check

#### Parameters

This function has no parameters.

#### Response

```json
{
  "type": "object",
  "description": "Check Multiple Permissions Out",
  "properties": {
    "checks": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "permissionedId": {
            "type": "string"
          },
          "principalId": {
            "type": "string"
          },
          "permissionId": {
            "type": "string"
          },
          "result": {
            "type": "boolean"
          }
        }
      }
    }
  }
}
```

### <a id="post-workflow-instances"></a>Create Workflow

Creates a new Workflow

POST /workflow/instances

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| modelId | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-workflow-instances-workflowid-delete"></a>Delete Workflow

Deletes an existing Workflow

POST /workflow/instances/{workflowId}/delete

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="delete-workflow-instances-workflowid"></a>Delete Workflow

Deletes an existing Workflow

DELETE /workflow/instances/{workflowId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-workflow-instances-workflowid-export"></a>Export Workflow

Starts an export job for this resource

POST /workflow/instances/{workflowId}/export

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |
| groupId | false | string | The Group ID to be assigned to the exported archive |
| artifactId | false | string | The Artifact ID to be assigned to the exported archive |
| versionId | false | string | The Version ID to be assigned to the exported archive |
| vaultId | false | string | The ID of the vault where the exported archive should be saved |
| schedule | false | string | Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous') |

#### Response

```json
{
  "type": "object",
  "description": "Export Configuration",
  "properties": {
    "startDate": {
      "type": "object",
      "description": "Only include objects whose modification date is after this time (epoch millis). This is used for partial or rolling exports."
    },
    "endDate": {
      "type": "object",
      "description": "Only include objects whose modification date is before this time (epoch millis). This is used for partial or rolling exports."
    },
    "startChangeset": {
      "type": "string",
      "description": "Only include data that is relevant to changesets at or beyond the specified changeset."
    },
    "endChangeset": {
      "type": "string",
      "description": "Only include data that is relevant to changesets at or before the specified changeset."
    },
    "includeACLs": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include ACLs during export."
    },
    "includeTeams": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Teams during export."
    },
    "includeActivities": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Activities during export."
    },
    "includeBinaries": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Binaries for data stores during export."
    },
    "includeAttachments": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Attachments for Attachables during export."
    },
    "artifactDependencies": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "artifactIncludes": {
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "forceIncludes": {
      "type": "boolean"
    }
  }
}
```

### <a id="post-workflow-instances-workflowid-authorities-authorityid-grant"></a>Grant Authority

Grants an authority against the specified workflow to a given user

POST /workflow/instances/{workflowId}/authorities/{authorityId}/grant

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |
| authorityId | true | string | The ID or authority key for the authority |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-workflow-instances-workflowid-import"></a>Import Workflow

Starts an import job for this resource

POST /workflow/instances/{workflowId}/import

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |
| groupId | false | string | The Group ID to be assigned to the exported archive |
| artifactId | false | string | The Artifact ID to be assigned to the exported archive |
| versionId | false | string | The Version ID to be assigned to the exported archive |
| vaultId | false | string | The ID of the vault where the exported archive should be saved |
| schedule | false | string | Whether to run the job immediately or in the background (either 'synchronous' or 'asynchronous') |

#### Response

```json
{
  "type": "object",
  "description": "Import Configuration",
  "properties": {
    "includeACLs": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include ACLs during import."
    },
    "includeTeams": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Teams during import."
    },
    "includeActivities": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Activities during import."
    },
    "includeBinaries": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Binaries for data stores during import."
    },
    "includeAttachments": {
      "type": "boolean",
      "default": true,
      "description": "Whether to include Attachments for Attachables during import."
    },
    "strategy": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "default": "CLONE",
      "description": "Either CLONE or COPY_EVERYTHING. Use CLONE to keep the same IDs on import. Use COPY_EVERYTHING to generate all new IDs for all entries on every import."
    },
    "substitutions": {
      "type": "string"
    }
  }
}
```

### <a id="get-workflow-models-modelid-requirements"></a>List Requirements

GET /workflow/models/{modelId}/requirements

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| modelId | true | string |  |

### <a id="get-workflow-instances-workflowid-resources"></a>List Resources

GET /workflow/instances/{workflowId}/resources

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |

### <a id="get-workflow-instances"></a>Lists Workflow

Retrieves a list of Workflow instances

GET /workflow/instances

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| sort | false | object | Defines how to sort fields in the result set |
| skip | false | number | Skips the result set cursor ahead the specified number of records |
| limit | false | number | Specifies the number of records to be handed back in the result set |

This method supports pagination.

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_workflow"
      }
    }
  }
}
```

### <a id="post-workflow-instances-query"></a>Queries for Workflow

Queries for instances of type Workflow

POST /workflow/instances/query

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| sort | false | object | Defines how to sort fields in the result set |
| skip | false | number | Skips the result set cursor ahead the specified number of records |
| limit | false | number | Specifies the number of records to be handed back in the result set |

This method supports pagination.

#### Response

```json
{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_workflow"
      }
    }
  }
}
```

### <a id="get-workflow-instances-workflowid-acl-list"></a>Read ACL

Read the Access Control List for the specified workflow

GET /workflow/instances/{workflowId}/acl/list

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Result Map of ACL entries",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "_doc": {
            "type": "string",
            "title": "Principal ID"
          },
          "name": {
            "type": "string",
            "title": "Principal Name"
          },
          "type": {
            "type": "string",
            "title": "Principal Type"
          },
          "domainId": {
            "type": "string"
          },
          "domainQualifiedId": {
            "type": "string"
          },
          "domainQualifiedName": {
            "type": "string"
          },
          "principalId": {
            "type": "string",
            "title": "Principal ID"
          },
          "userEmail": {
            "type": "string"
          },
          "userFirstName": {
            "type": "string"
          },
          "userLastName": {
            "type": "string"
          },
          "authorities": {
            "type": "array",
            "title": "Authorities",
            "items": {
              "type": "string",
              "title": "Authority Key"
            }
          }
        }
      }
    }
  }
}
```

### <a id="get-workflow-instances-workflowid-acl"></a>Read ACL for Principal

Reads the ACL for a client and specific actor

GET /workflow/instances/{workflowId}/acl

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Result Map of Authority Keys",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "type": "string",
        "description": "Authority Key"
      }
    }
  }
}
```

### <a id="post-workflow-instances-workflowid-authorities"></a>Read Authorities Report

Read the Authorities Report for the specified workflow

POST /workflow/instances/{workflowId}/authorities

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Authority Report",
  "properties": {
    "principalId": {
      "type": "object",
      "properties": {
        "id": {
          "type": "object",
          "properties": {
            "role-key": {
              "type": "string"
            },
            "principal": {
              "type": "string"
            },
            "permissioned": {
              "type": "string"
            },
            "inheritsFrom": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "principal": {
                  "type": "string"
                },
                "permissioned": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
```

### <a id="get-workflow-instances-workflowid-history"></a>Read History Instance

GET /workflow/instances/{workflowId}/history

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |

### <a id="get-workflow-instances-workflowid-resources-resourceid"></a>Read Resource

GET /workflow/instances/{workflowId}/resources/{resourceId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |
| resourceId | true | string |  |

### <a id="get-workflow-instances-workflowid"></a>Read Workflow

Reads an instance of a Workflow

GET /workflow/instances/{workflowId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |

#### Response

```json
{
  "type": "object",
  "extends": "document",
  "description": "Workflow",
  "container": "platform",
  "properties": {
    "_doc": null,
    "_system": null
  }
}
```

### <a id="post-workflow-instances-workflowid-resources-resourceid-remove"></a>Remove Resource

POST /workflow/instances/{workflowId}/resources/{resourceId}/remove

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |
| resourceId | true | string |  |

### <a id="post-workflow-instances-workflowid-resources-removeall"></a>Removeall Resources

POST /workflow/instances/{workflowId}/resources/removeall

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |

### <a id="post-workflow-instances-workflowid-resume"></a>Resume Instance

POST /workflow/instances/{workflowId}/resume

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |

### <a id="post-workflow-instances-workflowid-authorities-authorityid-revoke"></a>Revoke Authority

Revokes an authority against the specified workflow from a given user

POST /workflow/instances/{workflowId}/authorities/{authorityId}/revoke

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |
| authorityId | true | string | The ID or authority key for the authority |
| id | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-workflow-instances-workflowid-start"></a>Start Instance

POST /workflow/instances/{workflowId}/start

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |

### <a id="post-workflow-instances-workflowid-suspend"></a>Suspend Instance

POST /workflow/instances/{workflowId}/suspend

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |

### <a id="post-workflow-instances-workflowid-terminate"></a>Terminate Instance

POST /workflow/instances/{workflowId}/terminate

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |

### <a id="put-workflow-instances-workflowid"></a>Update Workflow

Updates an existing Workflow

PUT /workflow/instances/{workflowId}

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

### <a id="post-workflow-instances-workflowid-update"></a>Update Workflow

Updates an existing Workflow

POST /workflow/instances/{workflowId}/update

#### Parameters

| Name | Required | Type | Description |
| --- | --- | --- | --- |
| workflowId | true | string |  |

#### Response

```json
{
  "type": "object",
  "description": "Status of Operation",
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Indicates whether the operation succeeded or not"
    }
  }
}
```

## <a id="schema"></a>Schema

```json

{
  "type": "object",
  "extends": "document",
  "description": "Workflow",
  "container": "platform",
  "properties": {
    "_doc": null,
    "_system": null
  },
  "id": "workflow"
}
```