GET /workflows/{workflow_id}

1 min

GET

https://api.cmp.optimizely.com/v3/workflows/{workflow_id}

Experimental Get a workflow by ID.

Path Parameters

workflow_idstringrequired
Example
5fe4925ef8a9378056bf4e37
Description
Unique identifier of the workflow

Responses

200Fetched workflow

WorkflowResponse
- idstringrequired
  Example
  6e7f910551b00a722e04188
  Description
  Unique identifier of the workflow
- namestringrequired
  Example
  The awesome workflow
  Description
  Name of the workflow
- descriptionstringrequired
  Example
  Nice description
  Description
  Description of the workflow
- is_activebooleanrequired
  Example
  true
  Description
  Indicates whether the workflow is active
- is_flexiblebooleanrequired
  Example
  true
  Description
  Indicates whether the workflow is flexible
- is_smart_duration_enabledbooleanrequired
  Example
  true
  Description
  Indicates whether the smart duration of a workflow is enabled
- is_asset_approval_enabledbooleanrequired
  Example
  true
  Description
  Indicates whether the asset approval of a workflow is enabled
- is_resource_management_enabledbooleanrequired
  Example
  true
  Description
  Indicates whether the resource management of a workflow is enabled
- stepsobject[]required
  Description
  List of steps
  - idstringrequired
    Example
    6e7f910551b00a722e04181
    Description
    Identifier of the step
  - namestringrequired
    Example
    Step 1
    Description
    Name of the step
  - sub_stepsobject[]required
    Description
    List of sub-steps
    - idstringrequired
      Example
      6e7f910551b00a722e04182
      Description
      Identifier of the sub-step
    - namestringrequired
      Example
      Step 1 Substep 1
      Description
      Name of the sub-step
    - actionsobject[]required
      Example
      [ { "name": "Approve" }, { "name": "Find Content" }, { "name": "Write/Edit Content" }, { "name": "Publish" }, { "name": "Set Publish Destination" }, { "name": "Edit Fields" }, { "name": "Set Publish Date" }, { "name": "Write/Edit Share" }, { "name": "Select Image" } ]
      Description
      List of actions of a sub-step
      - namestringrequired
        Example
        Approve
        Description
        Name of the action
    - typestring<default | external>required
      Example
      default
      Description
      Type of the sub-step
      Allowed
      defaultexternal
    - assigneesobject[]required
      Description
      List of assignees of a sub-step
      - idstringrequired
        Example
        6e7f910551b00a722e04182
        Description
        Identifier of the sub-step assignee
      - namestringrequired
        Example
        Ned Stark
        Description
        Name of the assignee
      - typestring<user | team>required
        Example
        user
        Description
        Type of the assignee
        Allowed
        userteam
      - linksobjectrequired
        Description
        Meta links
        selfstringrequired
        Example
        https://api.cmp.optimizely.com/v3/users/6e7f910551b00a722e04182
        Description
        URL of the assignee
- fieldsObjectFieldCreateResponse[]required
  Description
  List of fields
  - FieldTypeCommon
    - idstringrequired
      Example
      64be245ec0d79e79fdf1ad84
      Description
      Identifier of the field
    - namestringrequired
      Example
      Dropdown 101
      Description
      Name of the field
    - valuesundefined[]required
      Description
      List of selected values or from user input
    - typestringrequired
      Example
      text
      Description
      Type of the field
  - FieldTypeLabel
    - idstringrequired
      Example
      64be245ec0d79e79fdf1ad84
      Description
      Identifier of the field
    - namestringrequired
      Example
      Dropdown 101
      Description
      Name of the field
    - valuesundefined[]required
      Description
      List of selected values or from user input
    - typestringrequired
      Example
      text
      Description
      Type of the field
    - is_multi_selectbooleanrequired
      Description
      Select multiple values from the label
    - choicesundefined[]required
      Description
      Choices of the label
  - FieldTypeDropdown
    - idstringrequired
      Example
      64be245ec0d79e79fdf1ad84
      Description
      Identifier of the field
    - namestringrequired
      Example
      Dropdown 101
      Description
      Name of the field
    - valuesundefined[]required
      Description
      List of selected values or from user input
    - typestringrequired
      Example
      text
      Description
      Type of the field
    - is_multi_selectbooleanrequired
      Description
      Select multiple values from the dropdown
    - choicesundefined[]required
      Description
      Choices of the dropdown
  - FieldTypeRadio
    - idstringrequired
      Example
      64be245ec0d79e79fdf1ad84
      Description
      Identifier of the field
    - namestringrequired
      Example
      Dropdown 101
      Description
      Name of the field
    - valuesundefined[]required
      Description
      List of selected values or from user input
    - typestringrequired
      Example
      text
      Description
      Type of the field
    - choicesundefined[]required
      Description
      Choices of the radio button
  - FieldTypeCheckbox
    - Max depth limit reached
  - FieldTypeSimpleNumber
    - Max depth limit reached
  - FieldTypePercentageNumber
    - Max depth limit reached
  - FieldTypeCurrencyNumber
    - Max depth limit reached

401Authorization error

Error
Example
```
{
  "message": "Unauthorized"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

403Permission error

Error
Example
```
{
  "message": "You do not have the permission to perform this operation"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

404Not found error

Error
Example
```
{
  "message": "Resource not found"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

curl

curl --request GET \
     --url https://api.cmp.optimizely.com/v3/workflows/{workflow_id} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.cmp.optimizely.com/v3/workflows/{workflow_id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.cmp.optimizely.com/v3/workflows/{workflow_id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = https.request(request)
puts response.read_body

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/workflows/{workflow_id}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Fetched workflow
{
  "id": "6e7f910551b00a722e04188",
  "name": "The awesome workflow",
  "description": "Nice description",
  "is_active": true,
  "is_flexible": true,
  "is_smart_duration_enabled": true,
  "is_asset_approval_enabled": true,
  "is_resource_management_enabled": true,
  "steps": [
    {
      "id": "6e7f910551b00a722e04181",
      "name": "Step 1",
      "sub_steps": [
        {
          "id": "6e7f910551b00a722e04182",
          "name": "Step 1 Substep 1",
          "actions": [
            {
              "name": "Approve"
            }
          ],
          "type": "default",
          "assignees": [
            {
              "id": "6e7f910551b00a722e04182",
              "name": "Ned Stark",
              "type": "user",
              "links": {
                "self": "https://api.cmp.optimizely.com/v3/users/6e7f910551b00a722e04182"
              }
            }
          ]
        }
      ]
    }
  ],
  "fields": {}
}

401

// Authorization error
{
  "message": "Not found",
  "errors": ""
}

403

// Permission error
{
  "message": "Not found",
  "errors": ""
}

404

// Not found error
{
  "message": "Not found",
  "errors": ""
}