GET /tasks/{id}/brief

1 min

GET

https://api.cmp.optimizely.com/v3/tasks/{id}/brief

Get brief of the task

Path Parameters

idstringrequired
Example
5f857f30e1c4a2038d6179e9
Description
Unique identifier of the task

Responses

200Fetched brief of the task

TaskBriefResponse
- typestring<template | attachment | text>required
  Example
  template
  Description
  Type of the task brief
  Allowed
  templateattachmenttext
- titlestringrequired
  Example
  Awesome Task Brief
  Description
  Title of the task brief
- templateobject
  - TaskBriefTemplateValue
    - idstringrequired
      Example
      9nu8ue9wf8u9nusd9f
      Description
      Unique identifier of the template
    - namestringrequired
      Example
      My Template
      Description
      Name of the template
- fieldsobject[]required
  Description
  List of fields of the brief
  - namestringrequired
    Example
    My Dropdown
    Description
    Name of the brief field
  - settings_field_idstring
    Example
    67c5684de8b943290648a693
    Description
    Unique identifier of the settings field. If available, can be used to look up the field details using settings API.
  - valuestring[]required
    Example
    [ "option 1" ]
    Description
    List of values set for the brief field
- linksobjectrequired
  Description
  Meta links
  - selfstringrequired
    Example
    https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/brief
    Description
    URL of the brief
  - taskstringrequired
    Example
    https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9
    Description
    URL of the task

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

curl

curl --request GET \
     --url https://api.cmp.optimizely.com/v3/tasks/{id}/brief \
     --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/tasks/{id}/brief", 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/{id}/brief")

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/tasks/{id}/brief"

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

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

print(response.text)

200

// Fetched brief of the task
{
  "type": "template",
  "title": "Awesome Task Brief",
  "template": {},
  "fields": [
    {
      "name": "My Dropdown",
      "settings_field_id": "67c5684de8b943290648a693",
      "value": [
        "option 1"
      ]
    }
  ],
  "links": {
    "self": "https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/brief",
    "task": "https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9"
  }
}

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