PATCH /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}

1 min

PATCH

https://api.cmp.optimizely.com/v3/tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}

Update a substep of a step in a task

Path Parameters

task_idstringrequired
Example
7d7f910551b00a722e0418830cee6612
Description
Unique identifier of the task
step_idstringrequired
Example
897f910551b00a722e0418830cee6612
Description
Unique identifier of the step
sub_step_idstringrequired
Example
700f910551b00a722e0418830cee6612
Description
Unique identifier of the substep

Body Parameters

bodyTaskSubStepRequestrequired
Examples
Mark the substep as In Progress:
{ "is_in_progress": true }
Mark the substep as completed:
{ "is_completed": true }
Change the assignee of the substep:
{ "assignee_id": "5fdf31d57f0d0e362e2b5908" }
Description
Payload to update the substep
- is_completedboolean
  Example
  true
  Description
  Whether the substep should be completed; cannot be passed together with is_in_progress, is_skipped or assignee_id
  Allowed
  true
- is_in_progressboolean
  Example
  true
  Description
  Whether the substep should be progressed; cannot be passed together with is_completed, is_skipped or assignee_id
  Allowed
  true
- is_skippedboolean
  Description
  Whether the substep should be skipped; cannot be passed together with is_in_progress, is_completed or assignee_id
  Allowed
  true
- assignee_idstring
  Example
  5fdf31d57f0d0e362e2b5908
  Description
  ID of the assignee for the substep; cannot be passed together with is_completed, is_in_progress or is_skipped
- assignee_typestring<user | team>
  Example
  user
  Description
  Type of the assignee for the substep. If not provided with assignee_id, defaults to user.
  Allowed
  userteam

Responses

200Fetched task substep information

TaskSubStep
- idstringrequired
  Example
  9c7f910551b00a722e0418830cee2564
  Description
  Unique identifier of the substep
- titlestringrequired
  Example
  Sample step
  Description
  Title of the substep
- assignee_idstringrequired
  Example
  5fdf31d57f0d0e362e2b5908
  Description
  ID of the assignee of the step containing the substep
- assignee_typestring<user | team>required
  Example
  user
  Description
  Type of the assignee of the step containing the substep.
  Allowed
  userteam
- is_completedbooleanrequired
  Description
  Determines whether the substep is completed in Optimizely CMP
- is_in_progressbooleanrequired
  Description
  Determines whether the substep is In Progress in Optimizely CMP
- is_skippedbooleanrequired
  Description
  Determines whether the substep is skipped in Optimizely CMP
- is_externalbooleanrequired
  Example
  true
  Description
  Determines whether the substep is external in Optimizely CMP
- linksobjectrequired
  Description
  Meta links
  - selfstringrequired
    Example
    https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/steps/6d7f910551b00a722e0418830cee5564/sub-steps/9c7f910551b00a722e0418830cee2564
    Description
    URL of the substep
  - taskstringrequired
    Example
    https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534
    Description
    URL of the task
  - external_workstringrequired
    Example
    https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/steps/6d7f910551b00a722e0418830cee5564/sub-steps/9c7f910551b00a722e0418830cee2564/external-work
    Description
    URL of the external work associated with substep if substep is external in Optimizely CMP
  - assigneestring
    Example
    https://api.cmp.optimizely.com/v3/users/5fdf31d57f0d0e362e2b5908
    Description
    Assignee of the step containing the substep

400Client error

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

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

422Unprocessable entity error

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

curl

curl --request PATCH \
     --url https://api.cmp.optimizely.com/v3/tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id} \
     --header 'accept: application/json'

javascript

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

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

fetch("https://api.cmp.optimizely.com/v3/tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_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/tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}")

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

request = Net::HTTP::Patch.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/tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}"

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

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

print(response.text)

200

// Fetched task substep information
{
  "id": "9c7f910551b00a722e0418830cee2564",
  "title": "Sample step",
  "assignee_id": "5fdf31d57f0d0e362e2b5908",
  "assignee_type": "user",
  "is_completed": false,
  "is_in_progress": false,
  "is_skipped": false,
  "is_external": true,
  "links": {
    "self": "https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/steps/6d7f910551b00a722e0418830cee5564/sub-steps/9c7f910551b00a722e0418830cee2564",
    "task": "https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534",
    "external_work": "https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/steps/6d7f910551b00a722e0418830cee5564/sub-steps/9c7f910551b00a722e0418830cee2564/external-work",
    "assignee": "https://api.cmp.optimizely.com/v3/users/5fdf31d57f0d0e362e2b5908"
  }
}

400

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

401

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

403

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

404

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

422

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