POST /work-requests/{id}/tasks

1 min

POST

https://api.cmp.optimizely.com/v3/work-requests/{id}/tasks

Experimental Create a new task from a work request.

Path Parameters

idstringrequired
Example
da80cfd7bbf84959a8a981acbad996b3
Description
Unique identifier of the work request

Body Parameters

bodyWorkRequestTaskRequestrequired
Description
Payload to create a task
- titlestring
  Example
  The awesome task
  Description
  Title of the task. If not provided. it will be populated by the work request title.
- start_atstring<date-time>
  Example
  2022-12-01T06:00:00Z
  Description
  Start date and time of the task, in ISO 8601 UTC format (2020-02-10T10:40
  ). If workflow_id is present and the workflow has step duration, then either start_at or due_at is required. If both start_at and due_at is provided with a workflow_id that has step duration, then the start_at field will be ignored.
  Format
  date-time
- due_atstring<date-time>
  Example
  2022-12-31T06:00:00Z
  Description
  Due date and time of the task, in ISO 8601 UTC format (2020-02-10T10:40
  ). The due_at field is required if workflow_id is present and the workflow does not have step duration. If workflow_id is present and the workflow has step duration, then either start_at or due_at is required.
  Format
  date-time
- campaign_idstring
  Example
  8q7f910551b00a722e0418830cee6612
  Description
  Unique identifier of parent campaign
- workflow_idstring
  Example
  8q7f910551b00a722e0418830cee6612
  Description
  Unique identifier of workflow
- owner_idstring
  Example
  8q7f910551b00a722e0418830cee6612
  Description
  Unique identifier of the task owner. If passed as null, then the owner will be the token user.
- asset_ids_without_field_inheritancestring[]
  Example
```
[
  "74f12a064b1611eda2fe02420ac8001d"
]
```
  Description
  List of asset ids which will not inherit any fields.
- inherit_fields_fromstring
  Example
  work_request
  Description
  Specifies the source from which to inherit fields.
  
  Supported values:
  
  work_request (default) : Fields are created from the work request
  
  workflow : Fields are inherited from the workflow specified by workflow_id
  Default
  work_request
- exclude_empty_fieldsboolean
  Example
  true
  Description
  If true, work request custom fields and labels that have no value (for example, fields hidden by form logic) are not copied to the task. When inherit_fields_from is workflow, an empty work request value falls back to the workflow field's default value instead. Set to false to copy every work request field, including empty ones.
  Default
  true

Responses

201Created a task from a work request

WorkRequestTaskResponse
- idstringrequired
  Example
  8q7f910551b00a722e0418830cee6612
  Description
  Unique identifier of the task
- titlestringrequired
  Example
  The awesome task
  Description
  Title of the task
- reference_idstring
  Example
  TSK-1111
  Description
  Reference Id of the task
- start_atstring<date-time>required
  Example
  2022-12-01T06:00:00Z
  Description
  Start date of the task, in ISO 8601 UTC format (2022-12-01T06:00
  )
  Format
  date-time
- due_atstring<date-time>required
  Example
  2022-12-31T06:00:00Z
  Description
  Due date of the task, in ISO 8601 UTC format (2022-12-31T06:00
  )
  Format
  date-time
- owner_idstringrequired
  Example
  8q7f910551b00a722e0418830cee6612
  Description
  Unique identifier of the owner
- linksobjectrequired
  Description
  Meta links
  - selfstringrequired
    Example
    https://api.cmp.optimizely.com/v3/tasks/8q7f910551b00a722e0418830cee6612
    Description
    URL of the task
  - ownerstring
    Example
    https://api.cmp.optimizely.com/v3/users/8q7f910551b00a722e0418830cee6612
    Description
    URL of the task owner

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 POST \
     --url https://api.cmp.optimizely.com/v3/work-requests/{id}/tasks \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "inherit_fields_from": "work_request",
     "exclude_empty_fields": true
     }'

javascript

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

var raw = JSON.stringify({
   "inherit_fields_from": "work_request",
   "exclude_empty_fields": true
});

var requestOptions = {
   method: 'POST',
   headers: myHeaders,
   body: raw,
   redirect: 'follow'
};

fetch("https://api.cmp.optimizely.com/v3/work-requests/{id}/tasks", 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/work-requests/{id}/tasks")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "inherit_fields_from": "work_request",
   "exclude_empty_fields": true
})

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

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/work-requests/{id}/tasks"

payload = json.dumps({
   "inherit_fields_from": "work_request",
   "exclude_empty_fields": True
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

201

// Created a task from a work request
{
  "id": "8q7f910551b00a722e0418830cee6612",
  "title": "The awesome task",
  "reference_id": "TSK-1111",
  "start_at": "2022-12-01T06:00:00Z",
  "due_at": "2022-12-31T06:00:00Z",
  "owner_id": "8q7f910551b00a722e0418830cee6612",
  "links": {
    "self": "https://api.cmp.optimizely.com/v3/tasks/8q7f910551b00a722e0418830cee6612",
    "owner": "https://api.cmp.optimizely.com/v3/users/8q7f910551b00a722e0418830cee6612"
  }
}

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": ""
}