openapi: 3.2.0
info:
title: Newscred Tasks API
version: V3
description: 'Operations tagged Tasks across 2 of this provider''s published API definitions: newscred-cmp-open-api-openapi.json, newscred-welcome-open-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
- url: https://api.welcomesoftware.com/v3
description: v3 version of _Welcome_ Open API
tags:
- description: 'Facilitates the integration of external systems with Optimizely CMP through the following use cases:
1. **External Work Management** – Use the endpoints to link Optimizely CMP with an external system (such as Jira or Aha). The external system can send status updates back to Optimizely CMP so that the Optimizely CMP user receives in-app updates for the status of the ''ticket'' in the external system.
2. **External Document Approval** – (a.k.a. Marketing Legal Review) Use the endpoints to link Optimizely CMP with an external system (such as Veeva PromoMats) to review, annotate, update, and approve marketing assets through the external system. The approval status can be sent back to Optimizely CMP so that the Optimizely CMP user receives in-app updates for the final approval status of the documents from the external system.
For information on these use cases, contact Optimizely CMP Support.
'
name: Tasks
paths:
/tasks:
get:
description: Experimental Get a list of tasks.
operationId: listTasks
parameters:
- example: task 1
in: query
name: search_key
schema:
description: Search for task title
type: string
- example: 8n7f910o51b00b722o0418n30cie8211
in: query
name: campaign
schema:
description: Campaign id of the tasks
type: string
- example: 8n7f910o51b00b722o0418n30cie8211
in: query
name: workflow
schema:
description: Workflow id of the tasks
type: string
- example: 8n7f910o51b00b722o0418n30cie8211
in: query
name: milestone
schema:
description: Milestone id of the tasks
type: string
- example: '2022-08-24T00:00:00.000Z'
in: query
name: start_date
schema:
description: Start date of the tasks, in ISO 8601 UTC format
type: string
- example: '2022-08-24T00:00:00.000Z'
in: query
name: due_date
schema:
description: Due date of the tasks, in ISO 8601 UTC format
type: string
- example:
- In Progress
- Not Started
in: query
name: status
schema:
description: Filter tasks by status. Provide multiple statuses to filter tasks across multiple statuses.
items:
enum:
- Archived
- Completed
- Overdue
- Not Started
- In Progress
- On Hold
type: string
type: array
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/page_size'
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
data:
description: List of tasks
items:
$ref: '#/components/schemas/TaskListResponseItem'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/Pagination'
- properties:
next:
example: https://api.cmp.optimizely.com/v3/tasks?offset=10&page_size=10
type:
- string
- 'null'
type: object
required:
- data
- pagination
type: object
description: List of fetched tasks
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
summary: GET /tasks
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
post:
description: Experimental Create a task
operationId: createTask
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskCreateRequest'
description: Payload to create a task
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskResponse'
description: Created task
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: POST /tasks
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{id}:
get:
description: Get a task
operationId: getTask
parameters:
- example: 7d7f910551b00a722e0418830cee6612
in: path
name: id
required: true
schema:
description: Unique identifier of the task
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskResponse'
description: Fetched task
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{id}
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
patch:
description: Update a task
operationId: updateTask
parameters:
- example: 7d7f910551b00a722e0418830cee6612
in: path
name: id
required: true
schema:
description: Unique identifier of the task
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskUpdateRequest'
description: Payload to update the task
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskResponse'
description: Updated task
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: PATCH /tasks/{id}
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{id}/assets:
get:
description: Get the list of the assets or contents of a task
operationId: listTaskAssets
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: id
required: true
schema:
description: Unique identifier of the task
type: string
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/page_size'
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
data:
description: List of assets
items:
allOf:
- $ref: '#/components/schemas/TaskAssetResponse'
- properties:
library_asset_id:
description: Unique identifier of the corresponding library asset — the library asset this task asset was forked from, or the one it was released to.
example: 6a8b2c3d4e5f6071829a3b4c
type:
- string
- 'null'
type: object
type: array
pagination:
allOf:
- $ref: '#/components/schemas/Pagination'
- properties:
next:
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/assets?offset=10&page_size=10
type:
- string
- 'null'
type: object
required:
- data
- pagination
type: object
description: List of fetched assets
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{id}/assets
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
post:
description: This API allows you to add an asset to a task. There currently two mechanisms to add an asset - either by uploading an asset first and then calling this API (for only `images`, `videos`, and `raw files`), or by adding an asset from the library. The 'type' parameter in the request body will determine the mechanism used to add the asset. See [Upload assets](https://docs.developers.optimizely.com/content-marketing-platform/docs/upload-assets) to upload an asset.
operationId: addAssetToTask
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: id
required: true
schema:
description: Unique identifier of the task
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskAssetRequest'
description: 'Payload to add an asset. There are two mechanisms for adding assets to a task:
- `direct_upload` - An asset that has been uploaded using the [Upload assets](https://docs.developers.optimizely.com/content-marketing-platform/docs/upload-assets) endpoint.
- `fork_from_library` - This will fork an existing asset from the library to the task.
The `type` field is optional, and will default to `direct_upload` if not provided.
Note: Renditions is currently not supported for library assets.
'
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskAssetResponse'
description: Created asset
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
summary: POST /tasks/{id}/assets
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{id}/attachments:
get:
description: Get the list of the attachments of a task
operationId: listTaskAttachments
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: id
required: true
schema:
description: Unique identifier of the task
type: string
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/page_size'
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
data:
description: List of attachments
items:
$ref: '#/components/schemas/AttachmentResponse'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/Pagination'
- properties:
next:
example: https://api.cmp.optimizely.com/v3/tasks/attachments?offset=10&page_size=10
type:
- string
- 'null'
type: object
required:
- data
- pagination
type: object
description: List of fetched attachments
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{id}/attachments
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{id}/brief:
get:
description: Get brief of the task
operationId: getTaskBrief
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: id
required: true
schema:
description: Unique identifier of the task
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskBriefResponse'
description: Fetched brief of the task
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{id}/brief
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{id}/custom-fields:
get:
description: Get the list of custom fields added to a task.
operationId: listTaskCustomFields
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: id
required: true
schema:
description: Unique identifier of the task
type: string
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/page_size'
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
data:
description: List of custom fields
items:
$ref: '#/components/schemas/TaskCustomField'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/Pagination'
- properties:
next:
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/custom-fields?offset=10&page_size=10
type:
- string
- 'null'
type: object
required:
- data
- pagination
type: object
description: List of fetched custom fields
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET tasks/{id}/custom-fields
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/articles/{article_id}:
get:
description: Get an article associated with the task identified by `task_id`.
operationId: getTaskArticle
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 5d7f910551b00a722e0418830cee6631
in: path
name: article_id
required: true
schema:
description: Unique identifier of the article associated with the task
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskArticle'
description: Fetched article
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{task_id}/articles/{article_id}
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/assets/{asset_id}/comments:
get:
description: List all the comments for the latest version of a task asset.
operationId: listTaskAssetComments
parameters:
- example: 7d7f910551b00a722e0418830cee6612
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 897f910551b00a722e0418830cee6612
in: path
name: asset_id
required: true
schema:
description: Unique identifier of the asset
type: string
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
data:
description: List of comments
items:
$ref: '#/components/schemas/TaskAssetCommentResponse'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/Pagination'
- properties:
next:
example: https://api.cmp.optimizely.com/v3/tasks/7d7f910551b00a722e0418830cee6612/assets/897f910551b00a722e0418830cee6612/comments?offset=10&page_size=10
type:
- string
- 'null'
type: object
type: object
description: List of comments for the asset
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{task_id}/assets/{asset_id}/comments
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
post:
description: Add a comment to the latest version of a task asset. Supports adding comments to only **images**, **videos** and **raw files** type assets.
operationId: addCommentToTaskAsset
parameters:
- example: 7d7f910551b00a722e0418830cee6612
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 897f910551b00a722e0418830cee6612
in: path
name: asset_id
required: true
schema:
description: Unique identifier of the asset
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CommentCreateRequest'
description: Payload to add comment
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskAssetCommentResponse'
description: Added comment
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
summary: POST /tasks/{task_id}/assets/{asset_id}/comments
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/assets/{asset_id}/drafts:
get:
description: Experimental Get the list of drafts on an asset of a task.
operationId: listTaskAssetDrafts
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 5d7f910551b00a722e0418830cee6631
in: path
name: asset_id
required: true
schema:
description: Unique identifier of the asset
type: string
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
data:
description: List of drafts
items:
$ref: '#/components/schemas/TaskAssetDraftListResponseItem'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/Pagination'
- properties:
next:
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/assets/5d7f910551b00a722e0418830cee6631/drafts?offset=10&page_size=10
type:
- string
- 'null'
type: object
required:
- data
- pagination
type: object
description: List of fetched drafts
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{task_id}/assets/{asset_id}/drafts
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
post:
description: Add a new draft to a task asset. You can add a draft to only `images`, `videos`, and `raw files` type task assets. See [Upload assets](https://docs.developers.optimizely.com/content-marketing-platform/docs/upload-assets) to upload an asset draft.
operationId: addDraftToTaskAsset
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 5d7f910551b00a722e0418830cee6631
in: path
name: asset_id
required: true
schema:
description: Unique identifier of the asset
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskAssetRequest'
description: Payload to add a draft to an asset
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskAssetDraftResponse'
description: Created draft
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
summary: POST /tasks/{task_id}/assets/{asset_id}/drafts
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/assets/{asset_id}/fields:
get:
description: Experimental List all the fields of a task asset.
operationId: listTaskAssetFields
parameters:
- example: 7d7f910551b00a722e0418830cee6612
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 897f910551b00a722e0418830cee6612
in: path
name: asset_id
required: true
schema:
description: Unique identifier of the asset
type: string
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
data:
description: List of fields
items:
$ref: '#/components/schemas/AssetFieldListResponseItem'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/Pagination'
- properties:
next:
example: https://api.cmp.optimizely.com/v3/tasks/7d7f910551b00a722e0418830cee6612/assets/897f910551b00a722e0418830cee6612/fields?offset=10&page_size=10
type:
- string
- 'null'
type: object
type: object
description: List of fields for the asset
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{task_id}/assets/{asset_id}/fields
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
put:
description: Experimental Replace fields of an asset in a task.
operationId: updateTaskAssetFields
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 5f857f30e1c4a2038d6179e9
in: path
name: asset_id
required: true
schema:
description: Unique identifier of the task asset
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskAssetFieldsUpdateRequest'
description: Payload to replace the fields
required: true
responses:
'204':
description: Fields successfulled updated.
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: PUT tasks/{task_id}/assets/{asset_id}/fields
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/comments:
post:
description: 'Experimental Post a comment on a task. '
operationId: addCommentToTask
parameters:
- example: da80cfd7bbf84959a8a981acbad996b3
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CommentCreateRequest'
description: Payload to add a comment
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskCommentResponse'
description: Created a comment for the task
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: POST /tasks/{task_id}/comments
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/custom-fields/{custom_field_id}:
get:
description: Get a custom field of a task
operationId: getTaskCustomField
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 9nu8ue9wf8u9nusd9q
in: path
name: custom_field_id
required: true
schema:
description: Unique identifier of the custom field
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskCustomField'
description: Fetched custom field
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{task_id}/custom-fields/{custom_field_id}
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
patch:
description: 'Update a custom field of a task.
You can update the following types: `text_field`, `multi_line_text_field`, `checkboxes`, `dropdown`, `multi_select_dropdown`, `multiple_choice`, `date_field`, `rich_text_field`
'
operationId: updateTaskCustomField
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 9nu8ue9wf8u9nusd9q
in: path
name: custom_field_id
required: true
schema:
description: Unique identifier of the custom field
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskCustomFieldUpdateRequest'
description: 'Payload to update the custom field.
'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskCustomField'
description: Updated custom field
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
summary: PATCH /tasks/{task_id}/custom-fields/{custom_field_id}
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/custom-fields/{custom_field_id}/choices:
get:
description: Get the list of the choices of a custom field in a task.
operationId: listTaskCustomFieldChoices
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 9nu8ue9wf8u9nusd9q
in: path
name: custom_field_id
required: true
schema:
description: Unique identifier of the custom field
type: string
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/page_size'
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
data:
description: List of custom field choices
items:
$ref: '#/components/schemas/TaskCustomFieldChoiceListResponseItem'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/Pagination'
- properties:
next:
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/custom-fields/j90uv0sd9i0si09sdip/choices?offset=10&page_size=10
type:
- string
- 'null'
type: object
required:
- data
- pagination
type: object
description: List of fetched custom field choices
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{task_id}/custom-fields/{custom_field_id}/choices
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/fields:
get:
description: 'Experimental Get the list of fields of a task. '
operationId: listTaskFields
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/page_size'
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
data:
description: List of fields
items:
$ref: '#/components/schemas/FieldListResponseItem'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/Pagination'
- properties:
next:
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/fields?offset=10&page_size=10
type:
- string
- 'null'
type: object
required:
- data
- pagination
type: object
description: List of fetched fields
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET tasks/{task_id}/fields
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
post:
description: Experimental Add a field to a task.
operationId: addFieldToTask
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectFieldCreateRequest'
description: Payload to add a field to a task
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ObjectFieldCreateResponse'
description: Added field to a task.
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
summary: POST tasks/{task_id}/fields
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/fields/{field_id}:
delete:
description: 'Experimental Remove a field of a task. '
operationId: removeTaskField
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: fa63cece6aa811efb70202420ac80016
in: path
name: field_id
required: true
schema:
description: Unique identifier of the field
type: string
responses:
'204':
description: The field is removed from the task
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: DELETE tasks/{task_id}/fields/{field_id}
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
put:
description: Experimental Update a field of a task.
operationId: updateTaskField
parameters:
- example: 124p857f3i220y38ad6179e9
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 124p857f3i220y38ad6179e9
in: path
name: field_id
required: true
schema:
description: Unique identifier of the field of the task
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskFieldUpdateRequest'
description: Payload to update a field of a task
required: true
responses:
'204':
description: The field of the task was updated.
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
summary: PUT tasks/{taks_id}/fields/{field_id}
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/images/{image_id}:
get:
description: Get an image associated with the task identified by `task_id`.
operationId: getTaskImage
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 5d7f910551b00a722e0418830cee6632
in: path
name: image_id
required: true
schema:
description: Unique identifier of the image associated with the task
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskImage'
description: Fetched image
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{task_id}/images/{image_id}
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/publishing-intents:
post:
description: Experimental Create a publishing intent for a task on the specified publishing channel.
operationId: createTaskPublishingIntent
parameters:
- example: 6a311afa4234a8b03875306c
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskPublishingIntentCreateRequest'
description: Payload to create a publishing intent
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskPublishingIntentResponse'
description: Created publishing intent for the task
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: POST /tasks/{task_id}/publishing-intents
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/raw-files/{raw_file_id}:
get:
description: Get a raw file associated with the task identified by `task_id`.
operationId: getTaskRawFile
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 5d7f910551b00a722e0418830cee6634
in: path
name: raw_file_id
required: true
schema:
description: Unique identifier of the raw file associated with the task
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskRawFile'
description: Fetched raw file
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{task_id}/raw-files/{raw_file_id}
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}:
get:
description: Get the substep of a task
operationId: getTaskSubStep
parameters:
- example: 7d7f910551b00a722e0418830cee6612
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 897f910551b00a722e0418830cee6612
in: path
name: step_id
required: true
schema:
description: Unique identifier of the step
type: string
- example: 700f910551b00a722e0418830cee6612
in: path
name: sub_step_id
required: true
schema:
description: Unique identifier of the substep
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskSubStep'
description: Fetched task substep information
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
patch:
description: Update a substep of a step in a task
operationId: updateTaskSubStep
parameters:
- example: 7d7f910551b00a722e0418830cee6612
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 897f910551b00a722e0418830cee6612
in: path
name: step_id
required: true
schema:
description: Unique identifier of the step
type: string
- example: 700f910551b00a722e0418830cee6612
in: path
name: sub_step_id
required: true
schema:
description: Unique identifier of the substep
type: string
requestBody:
content:
application/json:
examples:
assignee_id:
summary: Change the assignee of the substep
value:
assignee_id: 5fdf31d57f0d0e362e2b5908
is_completed:
summary: Mark the substep as completed
value:
is_completed: true
is_in_progress:
summary: Mark the substep as In Progress
value:
is_in_progress: true
schema:
$ref: '#/components/schemas/TaskSubStepRequest'
description: Payload to update the substep
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskSubStep'
description: Fetched task substep information
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
summary: PATCH /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments:
get:
description: Get the list of the comments of a task substep
operationId: listTaskSubStepComments
parameters:
- example: 7d7f910551b00a722e0418830cee6612
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 897f910551b00a722e0418830cee6612
in: path
name: step_id
required: true
schema:
description: Unique identifier of the step
type: string
- example: 700f910551b00a722e0418830cee6612
in: path
name: sub_step_id
required: true
schema:
description: Unique identifier of the substep
type: string
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
data:
description: List of substep comments
items:
$ref: '#/components/schemas/TaskSubStepCommentResponse'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/Pagination'
- properties:
next:
example: https://api.cmp.optimizely.com/v3/tasks/7d7f910551b00a722e0418830cee6612/steps/897f910551b00a722e0418830cee6612/sub-steps/700f910551b00a722e0418830cee6612/comments?offset=10&page_size=10
type:
- string
- 'null'
type: object
required:
- data
- pagination
type: object
description: List of fetched task substep comments
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
post:
description: Create a task substep comment
operationId: addCommentToTaskSubStep
parameters:
- example: 7d7f910551b00a722e0418830cee6612
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 897f910551b00a722e0418830cee6612
in: path
name: step_id
required: true
schema:
description: Unique identifier of the step
type: string
- example: 700f910551b00a722e0418830cee6612
in: path
name: sub_step_id
required: true
schema:
description: Unique identifier of the substep
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CommentWithReplyCreateRequest'
description: Payload to create substep comment
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskSubStepCommentResponse'
description: Created task substep comment
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
summary: POST /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments/{comment_id}:
delete:
description: Delete a task substep comment
operationId: deleteTaskSubStepComment
parameters:
- example: 7d7f910551b00a722e0418830cee6612
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 897f910551b00a722e0418830cee6612
in: path
name: step_id
required: true
schema:
description: Unique identifier of the step
type: string
- example: 700f910551b00a722e0418830cee6612
in: path
name: sub_step_id
required: true
schema:
description: Unique identifier of the substep
type: string
- example: 5fe3886c574b52a62a089237
in: path
name: comment_id
required: true
schema:
description: Unique identifier of the comment
type: string
responses:
'204':
description: Deleted task substep comment
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
summary: DELETE /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments/{comment_id}
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
get:
description: Get a task substep comment
operationId: getTaskSubStepComment
parameters:
- example: 7d7f910551b00a722e0418830cee6612
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 897f910551b00a722e0418830cee6612
in: path
name: step_id
required: true
schema:
description: Unique identifier of the step
type: string
- example: 700f910551b00a722e0418830cee6612
in: path
name: sub_step_id
required: true
schema:
description: Unique identifier of the substep
type: string
- example: 5fe3886c574b52a62a089237
in: path
name: comment_id
required: true
schema:
description: Unique identifier of the comment
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskSubStepCommentResponse'
description: Fetched task substep comment
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments/{comment_id}
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
patch:
description: Update a task substep comment
operationId: updateTaskSubStepComment
parameters:
- example: 7d7f910551b00a722e0418830cee6612
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 897f910551b00a722e0418830cee6612
in: path
name: step_id
required: true
schema:
description: Unique identifier of the step
type: string
- example: 700f910551b00a722e0418830cee6612
in: path
name: sub_step_id
required: true
schema:
description: Unique identifier of the substep
type: string
- example: 5fe3886c574b52a62a089237
in: path
name: comment_id
required: true
schema:
description: Unique identifier of the comment
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskSubStepCommentUpdateRequest'
description: Payload to update the substep comment
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskSubStepCommentResponse'
description: Updated task substep comment
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
summary: PATCH /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/comments/{comment_id}
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/external-work:
get:
description: Get the external work information of a task external substep
operationId: getTaskSubStepExternalWork
parameters:
- example: 7d7f910551b00a722e0418830cee6612
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 897f910551b00a722e0418830cee6612
in: path
name: step_id
required: true
schema:
description: Unique identifier of the step
type: string
- example: 700f910551b00a722e0418830cee6612
in: path
name: sub_step_id
required: true
schema:
description: Unique identifier of the substep
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskExternalWorkResponse'
description: Fetched external work information
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/external-work
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
patch:
description: Update the external work information of a task external substep
operationId: updateTaskSubStepExternalWork
parameters:
- example: 7d7f910551b00a722e0418830cee6612
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 897f910551b00a722e0418830cee6612
in: path
name: step_id
required: true
schema:
description: Unique identifier of the step
type: string
- example: 700f910551b00a722e0418830cee6612
in: path
name: sub_step_id
required: true
schema:
description: Unique identifier of the substep
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskExternalWorkRequest'
description: Payload to update the external work information
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskExternalWorkResponse'
description: Updated external work information
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
summary: PATCH /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/external-work
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/fields:
get:
description: 'Experimental Get the list of fields of a substep of a task. '
operationId: listTaskSubStepFields
parameters:
- example: 7d7f910551b00a722e0418830cee6612
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 897f910551b00a722e0418830cee6612
in: path
name: step_id
required: true
schema:
description: Unique identifier of the step
type: string
- example: 700f910551b00a722e0418830cee6612
in: path
name: sub_step_id
required: true
schema:
description: Unique identifier of the substep
type: string
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/page_size'
responses:
'200':
content:
application/json:
schema:
additionalProperties: false
properties:
data:
description: List of fields
items:
discriminator:
mapping:
checkbox: '#/components/schemas/FieldTypeCheckbox'
dropdown: '#/components/schemas/FieldTypeDropdown'
label: '#/components/schemas/FieldTypeLabel'
radio_button: '#/components/schemas/FieldTypeRadio'
propertyName: type
oneOf:
- $ref: '#/components/schemas/FieldTypeLabel'
- $ref: '#/components/schemas/FieldTypeDropdown'
- $ref: '#/components/schemas/FieldTypeRadio'
- $ref: '#/components/schemas/FieldTypeCheckbox'
type: array
pagination:
allOf:
- $ref: '#/components/schemas/Pagination'
- properties:
next:
example: https://api.cmp.optimizely.com/v3/tasks/7d7f910551b00a722e0418830cee6612/steps/897f910551b00a722e0418830cee6612/sub-steps/700f910551b00a722e0418830cee6612/fields?offset=10&page_size=10
type:
- string
- 'null'
type: object
required:
- data
- pagination
type: object
description: List of fetched fields
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{task_id}/steps/{step_id}/sub-steps/{sub_step_id}/fields
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/structured-contents:
post:
description: Experimental Add a new structured content to task
operationId: addStructuredContentToTask
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskStructuredContentCreateRequest'
description: Payload to add a structured content
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/ContentDetailsModel'
description: Created content
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
summary: POST /tasks/{task_id}/structured-contents
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/structured-contents/{content_id}:
delete:
description: Experimental Delete a structured content from task
operationId: deleteTaskStructuredContent
parameters:
- example: 5d7f910551b00a722e0418830cee6631
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: ff3f8e024f0611ed993202420ac8001b
in: path
name: content_id
required: true
schema:
description: Unique identifier of the content
type: string
responses:
'204':
description: Deleted the content
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
summary: DELETE /tasks/{task_id}/structured-contents/{content_id}
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
get:
description: Experimental Get a task structured content by its guid.
operationId: getTaskStructuredContent
parameters:
- example: 645cb61c966d0c591320f636
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 5fe38c39574b52a62a089239
in: path
name: content_id
required: true
schema:
description: Unique identifier of the structured content
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ContentDetailsModel'
description: Structured content by Id for the task
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{task_id}/structured-contents/{content_id}
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
patch:
description: Experimental Update structured content using a task.
operationId: updateTaskStructuredContent
parameters:
- example: da80cfd7bbf84959a8a981acbad996b3
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: da80cfd7bbf84959a8a981acbad996b3
in: path
name: content_id
required: true
schema:
description: Unique identifier of the structured content
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskStructuredContentUpdateRequest'
description: Payload to update structured content
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ContentDetailsModel'
description: Updated structured content as response
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
summary: PATCH /tasks/{task_id}/structured-contents/{content_id}
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/structured-contents/{content_id}/drafts:
post:
description: Experimental Create structured content draft using a task.
operationId: createTaskStructuredContentDraft
parameters:
- example: da80cfd7bbf84959a8a981acbad996b3
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: da80cfd7bbf84959a8a981acbad996b3
in: path
name: content_id
required: true
schema:
description: Unique identifier of the structured content
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TaskStructuredContentDraftRequest'
description: Payload to create structured content drafts
required: true
responses:
'201':
content:
application/json:
example: null
schema:
type: object
description: Created structured content draft as response
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
summary: POST /tasks/{task_id}/structured-contents/{content_id}/drafts
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/urls:
post:
description: Experimental Adds a URL to a task.
operationId: addUrlToTask
parameters:
- example: 68fdf93d09caf1463f145dc6
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddUrlToTaskRequest'
description: Payload to add a URL to a task
required: true
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskUrlResponse'
description: Created task URL
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/UnprocessableEntity'
summary: POST /tasks/{task_id}/urls
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
/tasks/{task_id}/videos/{video_id}:
get:
description: Get a video associated with the task identified by task_id
operationId: getTaskVideo
parameters:
- example: 5f857f30e1c4a2038d6179e9
in: path
name: task_id
required: true
schema:
description: Unique identifier of the task
type: string
- example: 5d7f910551b00a722e0418830cee6633
in: path
name: video_id
required: true
schema:
description: Unique identifier of the video associated with the task
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TaskVideo'
description: Fetched video
'400':
$ref: '#/components/responses/ClientError'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'404':
$ref: '#/components/responses/NotFound'
summary: GET /tasks/{task_id}/videos/{video_id}
tags:
- Tasks
security:
- OAuth2:
- openid
- profile
- offline_access
servers:
- description: v3 version of Optimizely CMP Open API
url: https://api.cmp.optimizely.com/v3
components:
schemas:
NumberTypeObjectFieldUpdatePayload:
allOf:
- $ref: '#/components/schemas/BaseObjectFieldUpdatePayload'
- properties:
values:
description: Accepts a single numeric value
items:
example: 200
type: number
maxItems: 1
type: array
type: object
MultiChoiceTypeObjectField:
allOf:
- $ref: '#/components/schemas/BaseObjectField'
- $ref: '#/components/schemas/MultiChoiceTypeObjectFieldUpdatePayload'
TaskUrlResponse:
additionalProperties: false
properties:
created_at:
description: Timestamp when the URL was added to the task
example: '2024-06-01T06:00:00Z'
format: date-time
type: string
id:
description: Unique identifier of the URL added to the task
example: 692851fbbd8c9217e28f7ad1
type: string
required:
- id
- created_at
type: object
FieldListResponseItem:
discriminator:
mapping:
checkbox: '#/components/schemas/FieldTypeCheckbox'
currency_number: '#/components/schemas/FieldTypeCurrencyNumber'
date: '#/components/schemas/FieldTypeCommon'
dropdown: '#/components/schemas/FieldTypeDropdown'
image: '#/components/schemas/FieldTypeCommon'
label: '#/components/schemas/FieldTypeLabel'
percentage_number: '#/components/schemas/FieldTypePercentageNumber'
radio_button: '#/components/schemas/FieldTypeRadio'
rich_text: '#/components/schemas/FieldTypeCommon'
simple_number: '#/components/schemas/FieldTypeSimpleNumber'
text: '#/components/schemas/FieldTypeCommon'
text_area: '#/components/schemas/FieldTypeCommon'
video: '#/components/schemas/FieldTypeCommon'
propertyName: type
oneOf:
- $ref: '#/components/schemas/FieldTypeCommon'
- $ref: '#/components/schemas/FieldTypeLabel'
- $ref: '#/components/schemas/FieldTypeDropdown'
- $ref: '#/components/schemas/FieldTypeRadio'
- $ref: '#/components/schemas/FieldTypeCheckbox'
- $ref: '#/components/schemas/FieldTypeSimpleNumber'
- $ref: '#/components/schemas/FieldTypePercentageNumber'
- $ref: '#/components/schemas/FieldTypeCurrencyNumber'
LocalizedFieldValuesWithEmbeddedContent:
properties:
field_values:
items:
anyOf:
- $ref: '#/components/schemas/NumberFieldValueModel'
- $ref: '#/components/schemas/BooleanFieldValueModel'
- $ref: '#/components/schemas/DatetimeFieldValueModel'
- $ref: '#/components/schemas/TextFieldValueModel'
- $ref: '#/components/schemas/RichTextFieldValueModel'
- $ref: '#/components/schemas/LibraryAssetFieldValueModel'
- $ref: '#/components/schemas/ContentFieldValueWithEmbeddedModel'
- $ref: '#/components/schemas/ContentFieldValueModel'
- $ref: '#/components/schemas/URLFieldValueModel'
- $ref: '#/components/schemas/JSONFieldValueModel'
- $ref: '#/components/schemas/ChoiceFieldValueModel'
- $ref: '#/components/schemas/LocationFieldValueModel'
type: array
locale:
type: string
required:
- locale
- field_values
type: object
RichTextFieldDefinition:
properties:
core:
$ref: '#/components/schemas/CoreFieldDef'
default_values:
description: Default values of the field
items:
type: string
type: array
max_visual_text_length:
description: Maximum length of the field
type: integer
min_visual_text_length:
description: Minimum length of the field
type: integer
required:
- core
- min_visual_text_length
type: object
NumberFieldValueModel:
properties:
num_value:
description: Value of the field value
type: number
order_index:
description: Order index of the field value
type: integer
required:
- num_value
type: object
LocationFieldValueModel:
properties:
latitude:
description: Longitude of the field value
type: number
longitude:
description: Longitude of the field value
type: number
order_index:
description: Order index of the field value
type: integer
required:
- longitude
- latitude
type: object
RichTextFieldValueModel:
properties:
order_index:
description: Order index of the field value
type: integer
rich_text_value:
description: Value of the field value
type: string
required:
- rich_text_value
type: object
TaskSubStep:
additionalProperties: false
properties:
assignee_id:
description: ID of the assignee of the step containing the substep
example: 5fdf31d57f0d0e362e2b5908
type:
- string
- 'null'
assignee_type:
description: Type of the assignee of the step containing the substep.
enum:
- user
- team
example: user
type: string
id:
description: Unique identifier of the substep
example: 9c7f910551b00a722e0418830cee2564
type: string
is_completed:
description: Determines whether the substep is completed in Optimizely CMP
example: false
type: boolean
is_external:
description: Determines whether the substep is external in Optimizely CMP
example: true
type: boolean
is_in_progress:
description: Determines whether the substep is In Progress in Optimizely CMP
example: false
type: boolean
is_skipped:
description: Determines whether the substep is skipped in Optimizely CMP
example: false
type: boolean
links:
additionalProperties: false
description: Meta links
properties:
assignee:
description: Assignee of the step containing the substep
example: https://api.cmp.optimizely.com/v3/users/5fdf31d57f0d0e362e2b5908
type:
- string
- 'null'
external_work:
description: URL of the external work associated with substep if substep is external in _Optimizely CMP_
example: https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/steps/6d7f910551b00a722e0418830cee5564/sub-steps/9c7f910551b00a722e0418830cee2564/external-work
type:
- string
- 'null'
self:
description: URL of the substep
example: https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/steps/6d7f910551b00a722e0418830cee5564/sub-steps/9c7f910551b00a722e0418830cee2564
type: string
task:
description: URL of the task
example: https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534
type: string
required:
- self
- task
- external_work
type: object
title:
description: Title of the substep
example: Sample step
type: string
required:
- id
- title
- assignee_id
- assignee_type
- is_completed
- is_in_progress
- is_skipped
- is_external
- links
type: object
CommentCreateRequest:
additionalProperties: false
properties:
attachments:
description: List of comment attachments.
items:
$ref: '#/components/schemas/AttachmentRequest'
type: array
value:
description: Content of the comment. Markdown is supported. To mention a user belonging to the organization, use the `@[name](openapi-user-link)` format.
example: Comment mentioning @[Organization User](https://api.cmp.optimizely.com/v3/users/5fe38aeb574b52a62a089238)
minLength: 1
type: string
required:
- value
type: object
VersionedContentTypeModel:
properties:
component:
description: Indicates whether the content type is a component
type: boolean
content_type_guid:
description: Unique identifier of the content type
type: string
created_at:
description: Date and time on which the content type was created, in ISO 8601 UTC format
format: date-time
type: string
created_by:
description: Unique identifier of the user who created the content type
type: string
description:
description: Description of the content type
type: string
disabled:
description: Disabled status of the content type
type: boolean
links:
description: Meta links
properties:
self:
description: URL of the content type
example: https://api.cmp.optimizely.com/v3/structured-content/content-types/9fda53cf66a14fd487251480ca695c7b
type: string
versions:
description: URL of the content type versions
example: https://api.cmp.optimizely.com/v3/structured-content/content-types/9fda53cf66a14fd487251480ca695c7b/versions
type: string
type: object
name:
description: Name of the content type
type: string
source:
description: Source of the content type
type: string
source_id:
description: Source of the content type
type: string
source_metadata:
description: Source metadata of the content type
type: string
thumbnail_guid:
description: Thumbnail GUID of the content type
type: string
updated_at:
description: Date and time on which the content type was last updated, in ISO 8601 UTC format
format: date-time
type: string
updated_by:
description: Unique identifier of the user who last updated the content type
type: string
version:
$ref: '#/components/schemas/SCContentTypeVersion'
required:
- name
- component
- content_type_guid
- created_by
- updated_by
- created_at
- updated_at
- links
- version
type: object
TaskAssetDraftResponse:
additionalProperties: false
properties:
asset_id:
description: Unique identifier of the asset
example: 5d7f910551b00a722e0418830cee6631
type: string
content:
additionalProperties: false
description: Content of the draft
properties:
type:
description: Type of the content
enum:
- url
example: url
type: string
value:
description: Content of the draft; download URL for `image`, `raw file`, and `video`
example: http://images.cmp.optimizely.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==S
type: string
required:
- type
- value
type: object
created_at:
description: Date and time on which the draft was created, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2019-10-06T13:15:30Z'
format: date-time
type: string
draft_number:
description: The serial number of the draft
example: 2
type: integer
links:
additionalProperties: false
description: Meta links
properties:
asset:
description: URL of the asset that the draft is associated with
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/images/5d7f910551b00a722e0418830cee6631
type: string
task:
description: URL of the task that the asset is associated with
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9
type: string
required:
- asset
- task
type: object
mime_type:
description: MIME type of the draft
example: image/png
type: string
title:
description: Title of the draft
example: sample_image.png
type: string
type:
description: Type of the draft
enum:
- image
- video
- raw_file
example: image
type: string
required:
- draft_number
- asset_id
- title
- type
- mime_type
- created_at
- content
- links
type: object
FieldTypeCommon:
allOf:
- $ref: '#/components/schemas/FieldBaseType'
- type: object
CoreFieldDef:
properties:
editor_metadata:
anyOf:
- type: object
- items: {}
type: array
description: Editor metadata of the field
field_type:
$ref: '#/components/schemas/FieldType'
help_text:
description: Helptext of the field
type: string
is_list:
description: Indicates whether the field is a list
type: boolean
is_required:
description: Required status of the field
type: boolean
key:
description: Key of the field
type: string
max_list_length:
description: Maximum length of the list
type: integer
min_list_length:
description: Minimum length of the list
type: integer
name:
description: Name of the field
type: string
need_internationalization:
description: Indicates whether the field needs internationalization
type: boolean
order_index:
description: Order index of the field
type: integer
source_id:
description: Source ID of the field
type: string
source_metadata:
description: Source metadata of the field
type: string
required:
- key
- name
- is_list
- is_required
- need_internationalization
type: object
TaskAssetRequestForLibrary:
additionalProperties: false
properties:
content_id:
description: Unique identifier of the asset
example: d1efd3c4625111f0baa002420ac8001d
format: uuid
type: string
content_type:
description: The type of asset
enum:
- article
- image
- raw_file
- structured_content
- video
example: image
type: string
type:
description: The mechanism for adding the asset to the task
example: fork_from_library
type: string
required:
- type
- content_id
- content_type
type: object
TaskSubStepCommentUpdateRequest:
additionalProperties: false
properties:
value:
description: Updated comment value. Markdown is supported. To mention a user belonging to the organization, use `@[name](openapi-user-link)` format.
example: Updated comment mentioning @[Organization User](https://api.cmp.optimizely.com/v3/users/5fe38aeb574b52a62a089238)
minLength: 1
type: string
required:
- value
type: object
FieldTypeRadio:
allOf:
- $ref: '#/components/schemas/FieldBaseType'
- properties:
choices:
description: Choices of the radio button
items:
properties:
id:
description: Identifier of the choice
example: 6ceee2f4fa3411ecb37802420ac8001b
type: string
name:
description: Name of the choice
example: Radio 1 Choice 1
type: string
required:
- id
- name
- color
type: object
type: array
required:
- choices
type: object
ObjectFieldCreateRequest:
additionalProperties: false
discriminator:
mapping:
checkbox: '#/components/schemas/MultiChoiceTypeObjectField'
currency_number: '#/components/schemas/NumberTypeObjectField'
date: '#/components/schemas/DateTypeObjectField'
dropdown: '#/components/schemas/DropdownTypeObjectField'
image: '#/components/schemas/AssetTypeObjectField'
label: '#/components/schemas/MultiChoiceTypeObjectField'
percentage_number: '#/components/schemas/NumberTypeObjectField'
radio_button: '#/components/schemas/RadioButtonTypeObjectField'
rich_text: '#/components/schemas/StringTypeObjectField'
simple_number: '#/components/schemas/NumberTypeObjectField'
text: '#/components/schemas/StringTypeObjectField'
text_area: '#/components/schemas/StringTypeObjectField'
video: '#/components/schemas/AssetTypeObjectField'
propertyName: type
oneOf:
- $ref: '#/components/schemas/StringTypeObjectField'
- $ref: '#/components/schemas/MultiChoiceTypeObjectField'
- $ref: '#/components/schemas/DropdownTypeObjectField'
- $ref: '#/components/schemas/RadioButtonTypeObjectField'
- $ref: '#/components/schemas/NumberTypeObjectField'
- $ref: '#/components/schemas/DateTypeObjectField'
- $ref: '#/components/schemas/AssetTypeObjectField'
type: object
AssetContent:
additionalProperties: false
description: Content of the asset
properties:
type:
description: "Type of the content. \n - article – `html_body`\n - image, raw_file, video – `url`\n - structured_content – `api_url`"
enum:
- url
- api_url
- html_body
example: url
type: string
value:
description: Content of the asset. - article – the html body - image, raw_file, video – the download URL - structured_content – api url
example: http://images.cmp.optimizely.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==S
type: string
required:
- type
- value
type: object
DropdownTypeObjectField:
allOf:
- $ref: '#/components/schemas/BaseObjectField'
- $ref: '#/components/schemas/DropdownTypeObjectFieldUpdatePayload'
TaskBriefResponse:
additionalProperties: false
properties:
fields:
description: List of fields of the brief
items:
additionalProperties: false
properties:
name:
description: Name of the brief field
example: My Dropdown
type: string
settings_field_id:
description: Unique identifier of the settings field. If available, can be used to look up the field details using settings API.
example: 67c5684de8b943290648a693
type:
- string
- 'null'
value:
description: List of values set for the brief field
items:
description: Value set in the brief field
example: option 1
type: string
type: array
required:
- id
- name
- value
- is_id_settings_searchable
type: object
type: array
links:
additionalProperties: false
description: Meta links
properties:
self:
description: URL of the brief
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/brief
type: string
task:
description: URL of the task
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9
type: string
required:
- self
- task
type: object
template:
allOf:
- $ref: '#/components/schemas/TaskBriefTemplateValue'
type:
- object
- 'null'
title:
description: Title of the task brief
example: Awesome Task Brief
type: string
type:
description: Type of the task brief
enum:
- template
- attachment
- text
example: template
type: string
required:
- type
- title
- fields
- links
type: object
FieldTypeDropdown:
allOf:
- $ref: '#/components/schemas/FieldBaseType'
- properties:
choices:
description: Choices of the dropdown
items:
properties:
id:
description: Identifier of the choice
example: 6ceee2f4fa3411ecb37802420ac8001b
type: string
name:
description: Name of the choice
example: Dropdown 1 Choice 1
type: string
required:
- id
- name
type: object
type: array
is_multi_select:
description: Select multiple values from the dropdown
type: boolean
required:
- is_multi_select
- choices
type: object
FieldTypeCurrencyNumber:
allOf:
- $ref: '#/components/schemas/FieldBaseType'
- properties:
currency_code:
description: Currency code of the numerical field
example: USD
type: string
decimal_places:
description: Decimal place of the numerical field
example: 2
type:
- integer
- 'null'
has_thousand_separator:
description: Whether the numerical field has a thousand separator
example: true
type: boolean
required:
- has_thousand_separator
- decimal_places
- currency_code
type: object
AttachmentRequest:
additionalProperties: false
properties:
key:
description: Unique identifier of the file upload session. This is the `upload_meta_fields.key` field retrieved from the `/v3/upload-url` endpoint.
example: ce8995aea58b11ea8cd90242ac120005
maxLength: 100
minLength: 1
type: string
name:
description: Filename of the attachment
example: sample_image.png
minLength: 1
type: string
required:
- key
- name
type: object
StructuredContentBody:
additionalProperties:
items:
$ref: '#/components/schemas/LocalizedFieldValuesWithEmbeddedContent'
type: array
description: The fields of structured content
properties:
has_embedded:
description: Whether the structured content has embedded content reference field values
type:
- boolean
- 'null'
type: object
TaskCustomField:
additionalProperties: false
properties:
id:
description: Unique identifier for the custom field
example: 9nu8ue9wf8u9nusd9q
type: string
links:
additionalProperties: false
description: Meta links
properties:
choices:
description: URL of the available custom field choices
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/custom-fields/9nu8ue9wf8u9nusd9q/choices
type:
- string
- 'null'
self:
description: URL of the custom field
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/custom-fields/9nu8ue9wf8u9nusd9q
type: string
required:
- self
- choices
type: object
name:
description: Name of the custom field
example: My Dropdown
type: string
type:
description: Type of the custom field
enum:
- text_field
- multi_line_text_field
- checkboxes
- dropdown
- multi_select_dropdown
- multiple_choice
- date_field
- image
- video
- rich_text_field
example: dropdown
type: string
values:
description: List of values of the custom field
items:
additionalProperties: false
properties:
id:
description: Identifier of the custom field value
example: 1nu8ue9wf8u9nusd9u
type:
- string
- 'null'
name:
description: Name of the custom field value
example: Some text
type: string
required:
- id
- name
type: object
type: array
required:
- id
- name
- type
- values
- links
type: object
Error:
additionalProperties: true
description: Error payload
properties:
errors:
additionalProperties: true
description: Additional information
properties: {}
type: object
message:
description: Message describing the error
example: Not found
type: string
required:
- message
type: object
AssetFieldTypeDropdown:
allOf:
- $ref: '#/components/schemas/BaseAssetField'
- properties:
choices:
description: Choices of the dropdown
items:
properties:
id:
description: Identifier of the choice
example: 6ceee2f4fa3411ecb37802420ac8001b
type: string
name:
description: Name of the choice
example: Dropdown 1 Choice 1
type: string
required:
- id
- name
type: object
type: array
is_multi_select:
description: Allow users to select multiple values from the dropdown
type: boolean
required:
- is_multi_select
- choices
type: object
TaskImage:
additionalProperties: false
properties:
created_at:
description: Date and time on which the image was created, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2019-10-06T13:15:30Z'
format: date-time
type: string
file_size:
description: Size of the image in bytes
example: 11244
type: integer
id:
description: Unique identifier of the image
example: 5d7f910551b00a722e0418830cee6632
type: string
image_resolution:
additionalProperties: false
description: Width and height of the image in pixels
properties:
height:
description: Height of the image in pixels
example: 800
type: integer
width:
description: Width of the image in pixels
example: 700
type: integer
required:
- height
- width
type: object
labels:
description: Labels associated with the image
items:
$ref: '#/components/schemas/ResourceLabelResponse'
type: array
library_asset_id:
description: Unique identifier of the corresponding library asset — the library asset this task asset was forked from, or the one it was released to.
example: 6a8b2c3d4e5f6071829a3b4c
type:
- string
- 'null'
links:
additionalProperties: false
description: Meta links
properties:
drafts:
description: URL to POST draft to the image
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/assets/5d7f910551b00a722e0418830cee6632/drafts
type: string
self:
description: URL of the image
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/images/5d7f910551b00a722e0418830cee6632
type: string
task:
description: URL of the task that the image is associated with
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9
type: string
web_urls:
additionalProperties: false
description: Web URLs
properties:
drafts:
description: Web URL of the drafts of the image
example: https://cmp.optimizely.com/cloud/task/5f857f30e1c4a2038d6179e9/image/5d7f910551b00a722e0418830cee6632
type: string
self:
description: Web URL of the image
example: https://cmp.optimizely.com/cloud/taskv3/5f857f30e1c4a2038d6179e9?contentTabGuid=5d7f910551b00a722e0418830cee6632
type: string
task:
description: Web URL of the task that the image is associated with
example: https://cmp.optimizely.com/cloud/taskv3/5f857f30e1c4a2038d6179e9
type: string
required:
- self
- task
- drafts
type: object
required:
- self
- task
- drafts
- web_urls
type: object
mime_type:
description: MIME type of the image
example: image/jpeg
type: string
modified_at:
description: Date and time of the most recent modification of the image, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2019-10-07T13:15:30Z'
format: date-time
type: string
title:
description: Title of the image
example: cat.jpeg
type: string
url:
description: Download the URL of the image
example: http://images.cmp.optimizely.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==
type: string
required:
- id
- title
- mime_type
- created_at
- modified_at
- file_size
- image_resolution
- url
- labels
- links
type: object
TaskAssetCommentResponse:
additionalProperties: false
properties:
attachments:
description: List of attachments of the comment
example:
- id: a113667245d111eb8945000c
name: sample.png
url: https://files.cmp.optimizely.com/download/96c314a645d111eb8945000c291b51d4?token=
items:
$ref: '#/components/schemas/AttachmentResponse'
type: array
created_at:
description: Creation date and time of the comment, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2020-10-06T13:15:30Z'
format: date-time
type: string
id:
description: Unique identifier of the comment
example: 5fe38c39574b52a62a089239
type: string
is_resolved:
description: Determines if the comment is resolved in Optimizely CMP
example: false
type: boolean
links:
additionalProperties: false
description: Meta links
properties:
asset:
description: URL of the asset
example: https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/images/6d7f910551b00a722e0418830cee5564
type: string
task:
description: URL of the task
example: https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534
type: string
required:
- task
- asset
type: object
modified_at:
description: Last modification date and time of the comment, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2020-10-06T14:15:30Z'
format: date-time
type: string
value:
description: Content of the comment
example: Well done!
type: string
required:
- id
- value
- is_resolved
- created_at
- modified_at
- attachments
- links
type: object
JSONFieldValueModel:
properties:
json_value:
anyOf:
- type: object
- items: {}
type: array
description: Value of the field value
order_index:
description: Order index of the field value
type: integer
required:
- json_value
type: object
TaskRawFile:
additionalProperties: false
properties:
created_at:
description: Date and time on which the raw file was created, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2019-10-06T13:15:30Z'
format: date-time
type: string
file_size:
description: Size of the raw file in bytes
example: 11244
type: integer
id:
description: Unique identifier of the raw file
example: 5d7f910551b00a722e0418830cee6634
type: string
labels:
description: Labels associated to the raw file
items:
$ref: '#/components/schemas/ResourceLabelResponse'
type: array
library_asset_id:
description: Unique identifier of the corresponding library asset — the library asset this task asset was forked from, or the one it was released to.
example: 6a8b2c3d4e5f6071829a3b4c
type:
- string
- 'null'
links:
additionalProperties: false
description: Meta links
properties:
drafts:
description: URL to POST draft to the raw file
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/assets/5d7f910551b00a722e0418830cee6634/drafts
type: string
self:
description: URL of the raw file
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/raw-files/5d7f910551b00a722e0418830cee6634
type: string
task:
description: URL of the task that the raw file is associated with
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9
type: string
web_urls:
additionalProperties: false
description: Web URLs
properties:
drafts:
description: Web URL of the drafts of the raw file
example: https://cmp.optimizely.com/cloud/task/5f857f30e1c4a2038d6179e9/raw_file/5d7f910551b00a722e0418830cee6634
type: string
self:
description: Web URL of the raw file
example: https://cmp.optimizely.com/cloud/taskv3/5f857f30e1c4a2038d6179e9?contentTabGuid=5d7f910551b00a722e0418830cee6634
type: string
task:
description: Web URL of the task that the raw file is associated with
example: https://cmp.optimizely.com/cloud/taskv3/5f857f30e1c4a2038d6179e9
type: string
required:
- self
- task
- drafts
type: object
required:
- self
- task
- drafts
- web_urls
type: object
mime_type:
description: MIME type of the raw file
example: application/zip
type: string
modified_at:
description: Date and time of the most recent modification of the raw file, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2019-10-07T13:15:30Z'
format: date-time
type: string
title:
description: Title of the raw file
example: documents.zip
type: string
url:
description: Download the URL of the raw file
example: https://files.cmp.optimizely.com/171451644651701b96f1122009f026bc
type: string
required:
- id
- title
- mime_type
- created_at
- modified_at
- file_size
- url
- labels
- links
type: object
ContentTypeFieldEmbedMixConfig:
description: "Ref Type:\n * `1` Refer only\n * `2` Refer and create embed\n * `3` Create only\n"
enum:
- 1
- 2
- 3
type: integer
StringTypeObjectField:
allOf:
- $ref: '#/components/schemas/BaseObjectField'
- $ref: '#/components/schemas/StringTypeObjectFieldUpdatePayload'
ContentFieldsVersionValidation:
properties:
fields:
additionalProperties:
additionalProperties:
$ref: '#/components/schemas/error_reason'
type: object
description: Validation for the fields
type: object
type: object
SCContentTypeVersion:
allOf:
- $ref: '#/components/schemas/BaseContentTypeVersionModel'
- properties:
field_definitions:
items:
anyOf:
- $ref: '#/components/schemas/ContentTypeFieldDefinition'
- $ref: '#/components/schemas/LibraryAssetFieldDefinition'
- $ref: '#/components/schemas/TextFieldDefinition'
- $ref: '#/components/schemas/BaseFieldDefinition'
- $ref: '#/components/schemas/DatetimeFieldDefinition'
- $ref: '#/components/schemas/RichTextFieldDefinition'
- $ref: '#/components/schemas/ChoiceFieldDefinition'
- $ref: '#/components/schemas/NumberFieldDefinition'
type: array
required:
- field_definitions
type: object
DateTypeObjectFieldUpdatePayload:
allOf:
- $ref: '#/components/schemas/BaseObjectFieldUpdatePayload'
- properties:
values:
description: Array of date-time values, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
items:
description: Date and time, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2020-02-10T10:40:45Z'
format: date-time
type: string
maxItems: 1
type: array
type: object
BaseObjectField:
allOf:
- $ref: '#/components/schemas/BaseObjectFieldUpdatePayload'
- properties:
id:
description: Unique identifier of the field
example: 41aac313bda1e40b6cde7116fc24a
type: string
required:
- id
type: object
NumberFieldDefinition:
properties:
core:
$ref: '#/components/schemas/CoreFieldDef'
default_values:
description: Default values of the field
items:
type: number
type: array
max_value:
description: Maximum value of the field
type: number
min_value:
description: Minimum value of the field
type: number
required:
- core
type: object
RadioButtonTypeObjectFieldUpdatePayload:
allOf:
- $ref: '#/components/schemas/BaseObjectFieldUpdatePayload'
- properties:
values:
description: Accepts a single choice Id.
items:
example: 9119a313057e401189407116fcd3
type: string
maxItems: 1
type: array
type: object
TaskAssetRequestForDirectUpload:
additionalProperties: false
properties:
key:
description: Unique identifier of the file upload session. This is the `upload_meta_fields.key` field retrieved from the `/v3/upload-url` endpoint.
maxLength: 100
type: string
title:
description: Title of the asset
example: sample_image.png
maxLength: 100
minLength: 1
type: string
type:
description: The mechanism for adding the asset to the task
example: direct_upload
type: string
required:
- key
- title
type: object
FieldTypeSimpleNumber:
allOf:
- $ref: '#/components/schemas/FieldBaseType'
- properties:
decimal_places:
description: Decimal place of the numerical field
example: 2
type:
- integer
- 'null'
has_thousand_separator:
description: Whether the numerical field has a thousand separator
example: true
type: boolean
required:
- has_thousand_separator
- decimal_places
type: object
ContentFieldValueExpandedModel:
properties:
content_details:
$ref: '#/components/schemas/ContentDetailsModel'
content_guid:
description: Content GUID of the field value
type: string
content_url:
description: Content URL of the field value
type: string
embedded:
description: Indicates whether the field value is embedded
type: boolean
order_index:
description: Order index of the field value
type: integer
required:
- content_guid
- embedded
- content_details
type: object
DateTypeObjectField:
allOf:
- $ref: '#/components/schemas/BaseObjectField'
- $ref: '#/components/schemas/DateTypeObjectFieldUpdatePayload'
TaskExternalWorkRequest:
additionalProperties: false
properties:
identifier:
description: Identifier of the external work
example: MY-PROJ-123
maxLength: 50
minLength: 1
type:
- string
- 'null'
status:
description: Status of the external work
example: In Progress
maxLength: 128
minLength: 1
type:
- string
- 'null'
title:
description: Title of the external work
example: A very important ticket
maxLength: 128
minLength: 1
type:
- string
- 'null'
url:
description: Link to the external work (must be a valid URL with HTTPS scheme)
example: https://example.com/some-project/MY-PROJ-123
maxLength: 500
type:
- string
- 'null'
type: object
DropdownTypeObjectFieldUpdatePayload:
allOf:
- $ref: '#/components/schemas/BaseObjectFieldUpdatePayload'
- properties:
values:
description: Array of choice ID. Multiple choice values are not acceptable for `is_multi_select=false`.
items:
example: 9119a313057e401189407116fcd3
type: string
type: array
type: object
CommentWithReplyCreateRequest:
additionalProperties: false
properties:
attachments:
description: List of comment attachments.
items:
$ref: '#/components/schemas/AttachmentRequest'
type: array
parent_comment_id:
description: Parent comment id to reply.
example: da80cfd7bbf84959a8a981acbad996b3
type: string
value:
description: Content of the comment. Markdown is supported. To mention a user belonging to the organization, use the `@[name](openapi-user-link)` format.
example: Comment mentioning @[Organization User](https://api.cmp.optimizely.com/v3/users/5fe38aeb574b52a62a089238)
minLength: 1
type: string
required:
- value
type: object
TaskCreateRequest:
additionalProperties: false
properties:
campaign_id:
description: Id of the campaign to be associated with the task
example: 6684f31be89a526d030cfc0f
type: string
due_at:
description: Due date and time of the task, in ISO 8601 UTC format (2020-02-10T10:40:45Z). 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.
example: '2020-10-06T13:15:30Z'
format: date-time
type: string
owner_id:
description: Id of the owner of the task
example: 665d5717c8ba0201647a0991
type: string
start_at:
description: Start date and time of the task, in ISO 8601 UTC format (2020-02-10T10:40:45Z). 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.
example: '2020-10-01T06:00:00Z'
format: date-time
type: string
title:
description: Title of the task
example: Awesome Task
type: string
workflow_id:
description: Id of the workflow to be used in the task
example: 665d56034854d100ad7cb8fb
type: string
required:
- title
type: object
AttachmentResponse:
additionalProperties: false
properties:
id:
description: Unique identifier for the attachment
example: 5a7f910511b0a72230ce6631
type: string
name:
description: Filename of the attachment
example: sample_image.png
type: string
url:
description: Download URL of the attachment
example: https://files.cmp.optimizely.com/download/2115bfe4450c11ebaae8000c291b51d4
type: string
required:
- id
- name
- url
type: object
AssetFieldTypeCommon:
allOf:
- $ref: '#/components/schemas/BaseAssetField'
- type: object
TaskCustomFieldChoiceListResponseItem:
additionalProperties: false
properties:
id:
description: Unique identifier of the custom field choice
example: j90uv0sd9i0si09sdip
type: string
name:
description: Name of the custom field choice
example: Some option
type: string
required:
- id
- name
type: object
TaskExternalWorkResponse:
additionalProperties: false
properties:
external_system:
description: Name of the external system
example: jira
type: string
identifier:
description: Identifier of the external work
example: MY-PROJ-123
type:
- string
- 'null'
links:
additionalProperties: false
description: Meta links
properties:
self:
description: URL to get or update the external work information
example: https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee6631/steps/32982hf94j98cnr48034nv035/sub-steps/9n390809r384nv503459075034nv5/external-work
type: string
required:
- self
type: object
status:
description: Status of the external work
example: In Progress
type:
- string
- 'null'
title:
description: Title of the external work
example: A very important ticket
type:
- string
- 'null'
url:
description: Link to the external work
example: https://example.com/some-project/MY-PROJ-123
type:
- string
- 'null'
required:
- identifier
- title
- status
- url
- external_system
- links
type: object
TaskListResponseItem:
additionalProperties: false
properties:
campaign_id:
description: Unique identifier of the campaign
example: 8n7f910o51b00b722o0418n30cie8211
type:
- string
- 'null'
due_at:
description: Due date of the task in ISO 8601 UTC format
example: '2024-06-01T06:00:00Z'
type:
- string
- 'null'
id:
description: Unique identifier of the task
example: 837f910551b00a722e0418830cee6612
type: string
is_archived:
description: Whether the task is archived or not
example: false
type: boolean
is_completed:
description: Whether the task is completed or not
example: false
type: boolean
links:
additionalProperties: false
description: Meta links
properties:
campaign:
description: URL of the campaign that the task is associated with
example: https://api.cmp.optimizely.com/v3/campaigns/2e7f9107351b00a722e0412230cee5534
type:
- string
- 'null'
milestone:
description: URL of the milestone that the task is associated with
example: https://api.cmp.optimizely.com/v3/milestones/63f1c2b675be4132854d2741
type:
- string
- 'null'
self:
description: URL of the task
example: https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534
type: string
web_urls:
additionalProperties: false
description: Web URLs
properties:
self:
description: Web URL of the task
example: https://cmp.optimizely.com/cloud/taskv3/5c52cc153db27d0e5141146f
type: string
required:
- self
type: object
workflow:
description: URL of the workflow the task
example: https://api.cmp.optimizely.com/v3/workflows/63f1c2b675be4132854d2741
type:
- string
- 'null'
required:
- self
- campaign
- workflow
- milestone
- web_urls
type: object
milestone_id:
description: Unique identifier of the milestone
example: 8n7f910o51b00b722o0418n30cie8211
type:
- string
- 'null'
modified_at:
description: Modified date of the task in ISO 8601 UTC format
example: '2024-06-01T06:00:00Z'
type:
- string
- 'null'
reference_id:
description: Reference identifier of the task
example: TSK-1589
type: string
start_at:
description: Start date of the task in ISO 8601 UTC format
example: '2024-06-01T06:00:00Z'
type:
- string
- 'null'
status:
description: Current status of the task
enum:
- Archived
- Completed
- Overdue
- Not Started
- In Progress
- On Hold
example: Not Started
type: string
title:
description: Title of the task
example: The awesome task
type: string
workflow_id:
description: Unique identifier of the workflow
example: 8n7f910o51b00b722o0418n30cie8211
type:
- string
- 'null'
required:
- id
- title
- start_at
- due_at
- modified_at
- reference_id
- campaign_id
- workflow_id
- milestone_id
- is_completed
- is_archived
- status
- links
type: object
LibraryAssetType:
description: An enumeration.
enum:
- article
- image
- video
- raw_file
- structured_content
type: string
LibraryAssetFieldDefinition:
properties:
allowed_types:
items:
$ref: '#/components/schemas/LibraryAssetType'
type: array
core:
$ref: '#/components/schemas/CoreFieldDef'
default_values:
description: Default values for the field
items:
$ref: '#/components/schemas/LibraryAssetDefaultValue'
type: array
required:
- core
- allowed_types
type: object
TaskPublishingIntentCreateRequest:
additionalProperties: false
properties:
channel_id:
description: Unique identifier of the target publishing channel
example: 6a2fd16faec3bed9c72f7d4f
type: string
required:
- channel_id
type: object
AddUrlToTaskRequest:
additionalProperties: false
properties:
title:
description: Title of the URL.
example: Google
type: string
url:
description: The URL to be added to the task.
example: https://www.google.com
type: string
required:
- url
type: object
FieldTypeLabel:
allOf:
- $ref: '#/components/schemas/FieldBaseType'
- properties:
choices:
description: Choices of the label
items:
properties:
id:
description: Identifier of the choice
example: 6ceee2f4fa3411ecb37802420ac8001b
type: string
name:
description: Name of the choice
example: Label 1 Choice 1
type: string
required:
- id
- name
- color
type: object
type: array
is_multi_select:
description: Select multiple values from the label
type: boolean
required:
- is_multi_select
- choices
type: object
TaskAssetResponse:
additionalProperties: false
properties:
content:
$ref: '#/components/schemas/AssetContent'
created_at:
description: Date and time on which the asset was created, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2019-10-06T13:15:30Z'
format: date-time
type: string
id:
description: Unique identifier for the asset
example: 5d7f910551b00a722e0418830cee6631
type: string
labels:
description: Labels associated with the asset
items:
$ref: '#/components/schemas/ResourceLabelResponse'
type: array
links:
additionalProperties: false
description: Meta links
properties:
drafts:
description: URL to POST draft to the asset - null for `article` - non-null for `image`, `video`, and `raw file`.
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/assets/5d7f910551b00a722e0418830cee6631/drafts
type:
- string
- 'null'
self:
description: URL of the asset
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/image/5d7f910551b00a722e0418830cee6631
type: string
task:
description: URL of the task that the asset is associated with
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9
type: string
web_urls:
additionalProperties: false
description: Web URLs
properties:
drafts:
description: Web URL of the drafts of the asset - null for `article` - non-null for `image`, `video`, and `raw file`.
example: https://cmp.optimizely.com/cloud/task/5f857f30e1c4a2038d6179e9/image/5d7f910551b00a722e0418830cee6631
type:
- string
- 'null'
self:
description: Web URL of the asset
example: https://cmp.optimizely.com/cloud/taskv3/5f857f30e1c4a2038d6179e9?contentTabGuid=5d7f910551b00a722e0418830cee6631
type: string
task:
description: Web URL of the task that the asset is associated with
example: https://cmp.optimizely.com/cloud/taskv3/5f857f30e1c4a2038d6179e9
type: string
required:
- self
- task
- drafts
type: object
required:
- self
- task
- drafts
- web_urls
type: object
mime_type:
description: MIME type of the asset
example: image/png
type: string
modified_at:
description: Date and time of the most recent modification of the asset, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2019-10-07T13:15:30Z'
format: date-time
type: string
title:
description: Title of the asset
example: sample_image.png
type: string
type:
description: Type of the asset
enum:
- article
- image
- video
- raw_file
- structured_content
example: image
type: string
required:
- id
- title
- type
- mime_type
- created_at
- modified_at
- content
- labels
- links
type: object
DatetimeFieldValueModel:
properties:
datetime_value:
description: Value of the field value
format: date-time
type: string
order_index:
description: Order index of the field value
type: integer
required:
- datetime_value
type: object
DeleteLocaleFieldValueModel:
properties:
delete:
description: Should be true if the field value with locale needs to be deleted
type: boolean
locale:
type: string
required:
- locale
- delete
type: object
FieldTypePercentageNumber:
allOf:
- $ref: '#/components/schemas/FieldBaseType'
- properties:
decimal_places:
description: Decimal place of the numerical field
example: 2
type:
- integer
- 'null'
required:
- decimal_places
type: object
TaskSubStepRequest:
additionalProperties: false
properties:
assignee_id:
description: ID of the assignee for the substep; cannot be passed together with `is_completed`, `is_in_progress` or `is_skipped`
example: 5fdf31d57f0d0e362e2b5908
type:
- string
- 'null'
assignee_type:
description: Type of the assignee for the substep. If not provided with `assignee_id`, defaults to `user`.
enum:
- user
- team
example: user
type: string
is_completed:
description: Whether the substep should be completed; cannot be passed together with `is_in_progress`, `is_skipped` or `assignee_id`
enum:
- true
example: true
type: boolean
is_in_progress:
description: Whether the substep should be progressed; cannot be passed together with `is_completed`, `is_skipped` or `assignee_id`
enum:
- true
example: true
type: boolean
is_skipped:
description: Whether the substep should be skipped; cannot be passed together with `is_in_progress`, `is_completed` or `assignee_id`
enum:
- true
type: boolean
type: object
BaseFieldDefinition:
properties:
base_type:
$ref: '#/components/schemas/BaseFieldDefinitionType'
core:
$ref: '#/components/schemas/CoreFieldDef'
default_values:
items:
anyOf:
- $ref: '#/components/schemas/LocationDefaultValue'
- type: boolean
- format: uri
maxLength: 65536
minLength: 1
type: string
- type: object
- items: {}
type: array
type: array
required:
- core
- base_type
type: object
ContentFieldWithEmbeddedPatchValueModel:
properties:
content_id:
type: string
patch_details:
$ref: '#/components/schemas/RecursivePatchStructuredContentFields'
required:
- content_id
- patch_details
type: object
RecursivePatchStructuredContentFields:
additionalProperties: false
properties:
content_body:
$ref: '#/components/schemas/StructuredContentFields'
title: Contentbody
type: object
expired:
description: Expired status of the content
title: Expired
type: boolean
expiry_datetime:
description: Date and time on which the content will expire, in ISO 8601 UTC format
format: date-time
title: Expirydatetime
type:
- string
- 'null'
root_content:
description: This is true when the content is not embedded in another content through a content type reference field
title: Rootcontent
type: boolean
source:
description: Source of the content
title: Source
type:
- string
- 'null'
source_id:
description: Source id of the content
title: Sourceid
type:
- string
- 'null'
source_metadata:
title: Sourcemetadata
type: string
title:
description: Title of the structured content
example: Some webpage
type: string
type: object
TaskUpdateRequest:
additionalProperties: false
properties:
campaign_id:
description: ID of the campaign to be associated with the task
example: 6684f31be89a526d030cfc0f
type: string
due_at:
description: Due date and time of the task
example: '2025-10-06T13:00:00Z'
format: date-time
type: string
labels:
description: Labels to associate
items:
$ref: '#/components/schemas/ResourceLabelRequest'
type: array
owner_id:
description: ID of the owner for the task
example: 6853b3e37ed5e42cff067434
type: string
start_at:
description: Start date of the task
example: '2025-10-06T13:00:00Z'
format: date-time
type: string
title:
description: Title of the task
type: string
workflow_id:
description: ID of the workflow to be used in the task
example: 665d56034854d100ad7cb8fb
type: string
type: object
ContentFieldValueWithEmbeddedModel:
properties:
content_details:
$ref: '#/components/schemas/RecursiveStructuredContent'
description: The embedded content object
title: Contentdetails
required:
- content_details
type: object
AssetFieldTypeCurrencyNumber:
allOf:
- $ref: '#/components/schemas/BaseAssetField'
- properties:
currency_code:
description: Currency code of the numerical field
example: USD
type: string
decimal_places:
description: Decimal place of the numerical field
example: 2
type:
- integer
- 'null'
has_thousand_separator:
description: Whether the numerical field has a thousand separator
example: true
type: boolean
required:
- has_thousand_separator
- decimal_places
- currency_code
type: object
TextFieldValueModel:
properties:
order_index:
description: Order index of the field value
type: integer
text_value:
description: Value of the field value
type: string
required:
- text_value
type: object
AssetFieldTypeSimpleNumber:
allOf:
- $ref: '#/components/schemas/BaseAssetField'
- properties:
decimal_places:
description: Decimal place of the numerical field
example: 2
type:
- integer
- 'null'
has_thousand_separator:
description: Whether the numerical field has a thousand separator
example: true
type: boolean
required:
- has_thousand_separator
- decimal_places
type: object
BaseFieldDefinitionType:
description: An enumeration.
enum:
- boolean
- json
- url
- location
type: string
LocalizedFieldValues:
properties:
field_values:
items:
anyOf:
- $ref: '#/components/schemas/NumberFieldValueModel'
- $ref: '#/components/schemas/BooleanFieldValueModel'
- $ref: '#/components/schemas/DatetimeFieldValueModel'
- $ref: '#/components/schemas/TextFieldValueModel'
- $ref: '#/components/schemas/RichTextFieldValueModel'
- $ref: '#/components/schemas/LibraryAssetFieldValueModel'
- $ref: '#/components/schemas/ContentFieldValueExpandedModel'
- $ref: '#/components/schemas/ContentFieldValueModel'
- $ref: '#/components/schemas/URLFieldValueModel'
- $ref: '#/components/schemas/JSONFieldValueModel'
- $ref: '#/components/schemas/ChoiceFieldValueModel'
- $ref: '#/components/schemas/LocationFieldValueModel'
type: array
locale:
type: string
required:
- locale
- field_values
type: object
BooleanFieldValueModel:
properties:
bool_value:
description: Value of the field value
type: boolean
order_index:
description: Order index of the field value
type: integer
required:
- bool_value
type: object
FieldType:
description: An enumeration.
enum:
- boolean
- number
- text-field
- rich-text
- datetime
- library-asset
- content-type
- json
- url
- choice
- location
type: string
RecursiveStructuredContent:
additionalProperties:
items:
$ref: '#/components/schemas/LocalizedFieldValuesWithEmbeddedContent'
type: array
properties:
content_type_guid:
description: The guid of the content's content type
title: Contenttypeguid
type: string
expired:
description: Expired status of the content
title: Expired
type: boolean
expiry_datetime:
description: Date and time on which the content will expire, in ISO 8601 UTC format
format: date-time
title: Expirydatetime
type:
- string
- 'null'
root_content:
description: This is true when the content is not embedded in another content through a content type reference field
title: Rootcontent
type: boolean
source:
description: Source of the content
title: Source
type:
- string
- 'null'
source_id:
description: Source id of the content
title: Sourceid
type:
- string
- 'null'
source_metadata:
description: Source metadata of the content
title: Sourcemetadata
type:
- string
- 'null'
title:
description: Title of the structured content
example: Some webpage
type: string
required:
- content_type_guid
- root_content
type: object
MultiChoiceTypeObjectFieldUpdatePayload:
allOf:
- $ref: '#/components/schemas/BaseObjectFieldUpdatePayload'
- properties:
values:
description: Array of choice IDs
items:
example: 9119a313057e401189407116fcd3
type: string
type: array
type: object
TaskStructuredContentCreateRequest:
additionalProperties: false
properties:
content_type_guid:
description: Unique identifier of the content type
example: 5d7f910551b00a722e0418830cee6633
type: string
expired:
description: Expired status of the content
title: Expired
type: boolean
expiry_datetime:
description: Date and time on which the content will expire, in ISO 8601 UTC format
example: '2019-10-07T13:15:30Z'
format: date-time
title: Expirydatetime
type:
- string
- 'null'
fields:
$ref: '#/components/schemas/StructuredContentBody'
title: fields
type:
- object
- 'null'
primary_locale:
description: The primary locale of the content
example: en_US
type: string
root_content:
description: This is true when the content is not embedded in another content through a content type reference field
title: Rootcontent
type: boolean
source:
description: Source of the content
title: Source
type:
- string
- 'null'
source_id:
description: Source id of the content
title: Sourceid
type:
- string
- 'null'
source_metadata:
description: Source metadata of the content
title: Sourcemetadata
type:
- string
- 'null'
template_guid:
description: Unique identifier of the template
example: 5d7f910551b00a722e0418830cee6633
type: string
title:
description: Title of the structured content
example: Some webpage
type: string
required:
- content_type_guid
type: object
TaskBriefTemplateValue:
additionalProperties: false
description: Template info of the brief if the brief is of template type
properties:
id:
description: Unique identifier of the template
example: 9nu8ue9wf8u9nusd9f
type: string
name:
description: Name of the template
example: My Template
type: string
required:
- id
- name
type: object
AssetTypeObjectFieldUpdatePayload:
allOf:
- $ref: '#/components/schemas/BaseObjectFieldUpdatePayload'
- properties:
values:
description: Payload for fields with attachments
items:
properties:
key:
description: Unique identifier of the file upload session. This is the `upload_meta_fields.key` field retrieved from the `/v3/upload-url` endpoint.
example: ce8995aea58b11ea8cd90242ac120005
type: string
title:
description: Title of the image or video
example: Sample.jpeg
minLength: 1
type: string
required:
- title
- key
maxItems: 1
type: array
type: object
TaskStep:
additionalProperties: false
properties:
description:
description: Description of the step
example: Description of the step
type:
- string
- 'null'
due_at:
description: Due date and time of the step containing the substep, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2020-10-06T13:15:30Z'
format: date-time
type:
- string
- 'null'
id:
description: Unique identifier of the step
example: 6d7f910551b00a722e0418830cee5564
type: string
is_completed:
description: Determines whether the step is completed in Optimizely CMP
example: false
type: boolean
sub_steps:
description: Substeps of the step
items:
$ref: '#/components/schemas/TaskSubStep'
type: array
title:
description: Title of the step
example: Sample step
type: string
required:
- id
- title
- is_completed
- description
- due_at
- sub_steps
type: object
AllowedContentTypeItem:
properties:
name:
description: Name of the item
type: string
url:
description: URL of the item
type: string
required:
- name
- url
type: object
TextFieldDefinition:
properties:
core:
$ref: '#/components/schemas/CoreFieldDef'
default_values:
description: Default values of the field
items:
type: string
type: array
max_length:
description: Maximum length of the field
type: integer
min_length:
description: Minimum length of the field
type: integer
validation_pattern:
description: Validation pattern of the field
type: string
required:
- core
- validation_pattern
- min_length
type: object
NumberTypeObjectField:
allOf:
- $ref: '#/components/schemas/BaseObjectField'
- $ref: '#/components/schemas/NumberTypeObjectFieldUpdatePayload'
error_reason:
description: An enumeration.
enum:
- REQUIRED_FIELD_ABSENT
- LIST_EMPTY
- INVALID_STATE
- INVALID_SELF_REF
- MIN_NOT_MET
- MAX_NOT_MET
- PATTERN_ERROR
title: error_reason
type: string
AssetFieldListResponseItem:
discriminator:
mapping:
checkbox: '#/components/schemas/AssetFieldTypeCheckbox'
currency_number: '#/components/schemas/AssetFieldTypeCurrencyNumber'
date: '#/components/schemas/AssetFieldTypeCommon'
dropdown: '#/components/schemas/AssetFieldTypeDropdown'
image: '#/components/schemas/AssetFieldTypeCommon'
label: '#/components/schemas/AssetFieldTypeLabel'
percentage_number: '#/components/schemas/AssetFieldTypePercentageNumber'
radio_button: '#/components/schemas/AssetFieldTypeRadio'
rich_text: '#/components/schemas/AssetFieldTypeCommon'
simple_number: '#/components/schemas/AssetFieldTypeSimpleNumber'
text: '#/components/schemas/AssetFieldTypeCommon'
text_area: '#/components/schemas/AssetFieldTypeCommon'
video: '#/components/schemas/AssetFieldTypeCommon'
propertyName: type
oneOf:
- $ref: '#/components/schemas/AssetFieldTypeCommon'
- $ref: '#/components/schemas/AssetFieldTypeLabel'
- $ref: '#/components/schemas/AssetFieldTypeDropdown'
- $ref: '#/components/schemas/AssetFieldTypeRadio'
- $ref: '#/components/schemas/AssetFieldTypeCheckbox'
- $ref: '#/components/schemas/AssetFieldTypeSimpleNumber'
- $ref: '#/components/schemas/AssetFieldTypePercentageNumber'
- $ref: '#/components/schemas/AssetFieldTypeCurrencyNumber'
ObjectFieldCreateResponse:
additionalProperties: false
discriminator:
mapping:
checkbox: '#/components/schemas/FieldTypeCheckbox'
currency_number: '#/components/schemas/FieldTypeCurrencyNumber'
date: '#/components/schemas/FieldTypeCommon'
dropdown: '#/components/schemas/FieldTypeDropdown'
image: '#/components/schemas/FieldTypeCommon'
label: '#/components/schemas/FieldTypeLabel'
percentage_number: '#/components/schemas/FieldTypePercentageNumber'
radio_button: '#/components/schemas/FieldTypeRadio'
rich_text: '#/components/schemas/FieldTypeCommon'
simple_number: '#/components/schemas/FieldTypeSimpleNumber'
text: '#/components/schemas/FieldTypeCommon'
text_area: '#/components/schemas/FieldTypeCommon'
video: '#/components/schemas/FieldTypeCommon'
propertyName: type
oneOf:
- $ref: '#/components/schemas/FieldTypeCommon'
- $ref: '#/components/schemas/FieldTypeLabel'
- $ref: '#/components/schemas/FieldTypeDropdown'
- $ref: '#/components/schemas/FieldTypeRadio'
- $ref: '#/components/schemas/FieldTypeCheckbox'
- $ref: '#/components/schemas/FieldTypeSimpleNumber'
- $ref: '#/components/schemas/FieldTypePercentageNumber'
- $ref: '#/components/schemas/FieldTypeCurrencyNumber'
type: object
BaseContentTypeVersionModel:
properties:
created_at:
description: Date and time on which the version was created, in ISO 8601 UTC format
format: date-time
type: string
created_by:
description: Unique identifier of the user who created the version
type: string
expected_locales:
description: Expected locales of the version
items:
type: string
type: array
latest:
description: Indicates whether the version is the latest
type: boolean
links:
description: Meta links
properties:
content_type:
description: URL of the content type
example: https://api.cmp.optimizely.com/v3/structured-content/content-types/555876bf63e94ea4b3ec4da318736414
type: string
self:
description: URL of the content type version
example: https://api.cmp.optimizely.com/v3/structured-content/content-types/555876bf63e94ea4b3ec4da318736414/versions/31a6d15b09c54a04935203eb958ae058
type: string
type: object
version_guid:
description: Unique identifier of the version
type: string
required:
- version_guid
- created_by
- created_at
- latest
- expected_locales
- links
type: object
AssetFieldTypeLabel:
allOf:
- $ref: '#/components/schemas/BaseAssetField'
- properties:
choices:
description: Choices of the label
items:
properties:
id:
description: Identifier of the choice
example: 6ceee2f4fa3411ecb37802420ac8001b
type: string
name:
description: Name of the choice
example: Label 1 Choice 1
type: string
required:
- id
- name
type: object
type: array
is_multi_select:
description: Select multiple values from the label
type: boolean
required:
- is_multi_select
- choices
type: object
LibraryAssetDefaultValue:
properties:
asset_guid:
description: Unique identifier of the asset
type: string
asset_type:
$ref: '#/components/schemas/LibraryAssetType'
required:
- asset_type
- asset_guid
type: object
ContentTypeFieldDefinition:
properties:
allow_ref_edit:
description: Whether to allow ref editing
type: boolean
allowed_content_types:
description: List of allowed content types
items:
type: string
type: array
content_type_links:
additionalProperties:
$ref: '#/components/schemas/AllowedContentTypeItem'
description: Links related to the content type
type: object
core:
$ref: '#/components/schemas/CoreFieldDef'
default_value:
description: Default value for the field
type: string
ref_type:
$ref: '#/components/schemas/ContentTypeFieldEmbedMixConfig'
required:
- core
- allowed_content_types
- ref_type
type: object
DatetimeFieldDefinition:
properties:
core:
$ref: '#/components/schemas/CoreFieldDef'
default_values:
description: Default values of the field
items:
format: date-time
type: string
type: array
max_date:
description: Maximum date of the field
format: date-time
type: string
min_date:
description: Minimum date of the field
format: date-time
type: string
required:
- core
- min_date
- max_date
type: object
TaskStructuredContentUpdateRequest:
additionalProperties: false
properties:
expired:
description: Expired status of the content
title: Expired
type: boolean
expiry_datetime:
description: Date and time on which the content will expire, in ISO 8601 UTC format
example: '2019-10-07T13:15:30Z'
format: date-time
title: Expirydatetime
type:
- string
- 'null'
fields:
$ref: '#/components/schemas/StructuredContentFields'
description: The fields of structured content
title: fields
type: object
primary_locale:
description: The primary locale of the content
example: en_US
type: string
source:
description: Source of the content
title: Source
type:
- string
- 'null'
source_id:
description: Source id of the content
title: Sourceid
type:
- string
- 'null'
source_metadata:
description: Source metadata of the content
title: Sourcemetadata
type:
- string
- 'null'
title:
description: Title of the structured content
example: Some webpage
type: string
type: object
LocationDefaultValue:
properties:
latitude:
description: Latitude of the location
type: number
longitude:
description: Longitude of the location
type: number
required:
- longitude
- latitude
type: object
LibraryAssetFieldValueModel:
properties:
asset_guid:
description: Asset GUID of the field value
type: string
asset_type:
$ref: '#/components/schemas/LibraryAssetType'
links:
additionalProperties:
type: string
description: Meta links
type: object
order_index:
description: Order index of the field value
type: integer
required:
- asset_guid
- asset_type
type: object
TaskVideo:
additionalProperties: false
properties:
created_at:
description: Date and time when the video was created, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2019-10-06T13:15:30Z'
format: date-time
type: string
file_size:
description: Size of the video in bytes
example: 11244
type: integer
id:
description: Unique identifier for the video
example: 5d7f910551b00a722e0418830cee6633
type: string
labels:
description: Labels associated with the video
items:
$ref: '#/components/schemas/ResourceLabelResponse'
type: array
library_asset_id:
description: Unique identifier of the corresponding library asset — the library asset this task asset was forked from, or the one it was released to.
example: 6a8b2c3d4e5f6071829a3b4c
type:
- string
- 'null'
links:
additionalProperties: false
description: Meta links
properties:
drafts:
description: URL to POST draft to the video
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/assets/5d7f910551b00a722e0418830cee6633/drafts
type: string
self:
description: URL of the video
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/videos/5d7f910551b00a722e0418830cee6633
type: string
task:
description: URL of the task that the video is associated with
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9
type: string
web_urls:
additionalProperties: false
description: Web URLs
properties:
drafts:
description: Web URL of the drafts of the video
example: https://cmp.optimizely.com/cloud/task/5f857f30e1c4a2038d6179e9/video/5d7f910551b00a722e0418830cee6633
type: string
self:
description: Web URL of the video
example: https://cmp.optimizely.com/cloud/taskv3/5f857f30e1c4a2038d6179e9?contentTabGuid=5d7f910551b00a722e0418830cee6633
type: string
task:
description: Web URL of the task that the video is associated with
example: https://cmp.optimizely.com/cloud/taskv3/5f857f30e1c4a2038d6179e9
type: string
required:
- self
- task
- drafts
type: object
required:
- self
- task
- drafts
- web_urls
type: object
mime_type:
description: MIME type of the video
example: video/mp4
type: string
modified_at:
description: Date and time of the most recent modification of the video, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2019-10-07T13:15:30Z'
format: date-time
type: string
title:
description: Title of the video
example: product.mp4
type: string
url:
description: Download URL of the video
example: https://videos.cmp.optimizely.com/03a747babe81ceb55763fa085bqa20dc
type: string
required:
- id
- title
- mime_type
- created_at
- modified_at
- file_size
- url
- labels
- links
type: object
TaskAssetFieldsUpdateRequest:
items:
additionalProperties: false
discriminator:
mapping:
checkbox: '#/components/schemas/MultiChoiceTypeObjectField'
currency_number: '#/components/schemas/NumberTypeObjectField'
date: '#/components/schemas/DateTypeObjectField'
dropdown: '#/components/schemas/DropdownTypeObjectField'
image: '#/components/schemas/AssetTypeObjectField'
label: '#/components/schemas/MultiChoiceTypeObjectField'
percentage_number: '#/components/schemas/NumberTypeObjectField'
radio_button: '#/components/schemas/RadioButtonTypeObjectField'
rich_text: '#/components/schemas/StringTypeObjectField'
simple_number: '#/components/schemas/NumberTypeObjectField'
text: '#/components/schemas/StringTypeObjectField'
text_area: '#/components/schemas/StringTypeObjectField'
video: '#/components/schemas/AssetTypeObjectField'
propertyName: type
oneOf:
- $ref: '#/components/schemas/StringTypeObjectField'
- $ref: '#/components/schemas/MultiChoiceTypeObjectField'
- $ref: '#/components/schemas/DropdownTypeObjectField'
- $ref: '#/components/schemas/RadioButtonTypeObjectField'
- $ref: '#/components/schemas/NumberTypeObjectField'
- $ref: '#/components/schemas/DateTypeObjectField'
- $ref: '#/components/schemas/AssetTypeObjectField'
type: object
type: array
AssetFieldTypeCheckbox:
allOf:
- $ref: '#/components/schemas/BaseAssetField'
- properties:
choices:
description: Choices of the checkbox
items:
properties:
id:
description: Identifier of the choice
example: 6ceee2f4fa3411ecb37802420ac8001b
type: string
name:
description: Name of the choice
example: Checkbox 1 Choice 1
type: string
required:
- id
- name
type: object
type: array
required:
- choices
type: object
URLFieldValueModel:
properties:
order_index:
description: Order index of the field value
type: integer
url:
description: URL of the field value
format: uri
maxLength: 65536
minLength: 1
type: string
required:
- url
type: object
ChoiceFieldDefinition:
properties:
choices:
additionalProperties:
type: string
description: Choices of the field
type: object
core:
$ref: '#/components/schemas/CoreFieldDef'
default_values:
description: Default values of the field
items:
type: string
type: array
display_option:
$ref: '#/components/schemas/ChoiceDisplayOption'
required:
- core
- choices
type: object
StructuredContentFields:
additionalProperties:
items:
anyOf:
- $ref: '#/components/schemas/PatchLocalizedFieldValuesWithEmbeddedContent'
- $ref: '#/components/schemas/DeleteLocaleFieldValueModel'
type: array
description: The fields of structured content
type: object
PatchLocalizedFieldValuesWithEmbeddedContent:
properties:
field_values:
items:
anyOf:
- $ref: '#/components/schemas/NumberFieldValueModel'
- $ref: '#/components/schemas/BooleanFieldValueModel'
- $ref: '#/components/schemas/DatetimeFieldValueModel'
- $ref: '#/components/schemas/TextFieldValueModel'
- $ref: '#/components/schemas/RichTextFieldValueModel'
- $ref: '#/components/schemas/LibraryAssetFieldValueModel'
- $ref: '#/components/schemas/ContentFieldValueWithEmbeddedModel'
- $ref: '#/components/schemas/ContentFieldValueModel'
- $ref: '#/components/schemas/URLFieldValueModel'
- $ref: '#/components/schemas/JSONFieldValueModel'
- $ref: '#/components/schemas/ChoiceFieldValueModel'
- $ref: '#/components/schemas/LocationFieldValueModel'
- $ref: '#/components/schemas/DeleteFieldValueModel'
- $ref: '#/components/schemas/ContentFieldWithEmbeddedPatchValueModel'
type: array
locale:
description: The default value should be en_US
type: string
required:
- locale
- field_values
type: object
TaskCustomFieldUpdateRequest:
additionalProperties: false
properties:
values:
description: 'An array of choice IDs, if the custom field has choices. Otherwise, text values to update the custom field values with. Must contain at least one id/value in the array. For custom fields of type `checkboxes`, you can provide an array of multiple-choice IDs as values.
Value for the custom field of type `date_field` must follow this format: `YYYY-MM-DD`.
'
items:
example: 1nu8ue9wf8u9nusd9u
type: string
minItems: 1
type: array
required:
- values
type: object
ChoiceFieldValueModel:
properties:
choice_key:
description: Choice key of the field value
type: string
order_index:
description: Order index of the field value
type: integer
required:
- choice_key
type: object
StringTypeObjectFieldUpdatePayload:
allOf:
- $ref: '#/components/schemas/BaseObjectFieldUpdatePayload'
- properties:
values:
description: Any single string
items:
example: This is a test string
type: string
type: array
type: object
BaseObjectFieldUpdatePayload:
properties:
type:
description: Type of the field
example: checkbox
type: string
values:
description: Values for the campaign field
type: array
required:
- type
- values
type: object
AssetFieldTypePercentageNumber:
allOf:
- $ref: '#/components/schemas/BaseAssetField'
- properties:
decimal_places:
description: Decimal place of the numerical field
example: 2
type:
- integer
- 'null'
required:
- decimal_places
type: object
AssetFieldTypeRadio:
allOf:
- $ref: '#/components/schemas/BaseAssetField'
- properties:
choices:
description: Choices of the radio button
items:
properties:
id:
description: Identifier of the choice
example: 6ceee2f4fa3411ecb37802420ac8001b
type: string
name:
description: Name of the choice
example: Radio 1 Choice 1
type: string
required:
- id
- name
type: object
type: array
required:
- choices
type: object
ResourceLabelResponse:
additionalProperties: false
description: Label associated to a fetched resource
properties:
group:
additionalProperties: false
description: Label group
properties:
id:
description: Identifier of the label group
example: 2467e583a60e23fda2b89db81a453cd2
type: string
name:
description: Name of the label group
example: Content Format
type: string
required:
- id
- name
type: object
values:
description: List of values of the label
items:
additionalProperties: false
properties:
id:
description: Identifier of the label value
example: 71c378f3fee3d822759d1bdc2aab628c
type: string
name:
description: Name of the label value
example: Photos
type: string
required:
- id
- name
type: object
type: array
required:
- group
- values
type: object
TaskResponse:
additionalProperties: false
properties:
campaign_id:
description: Unique identifier of the campaign
example: 8n7f910o51b00b722o0418n30cie8211
type:
- string
- 'null'
due_at:
description: Due date and time of the task, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2020-10-06T13:15:30Z'
format: date-time
type:
- string
- 'null'
id:
description: Unique identifier of the task
example: 5d7f910551b00a722e0418830cee5534
type: string
is_archived:
description: Determines whether the task is archived
example: false
type: boolean
is_completed:
description: Determines whether the task is completed
example: false
type: boolean
labels:
description: Labels associated with the task
items:
$ref: '#/components/schemas/ResourceLabelResponse'
type: array
links:
additionalProperties: false
description: Meta links
properties:
assets:
description: URL for getting the list of the task assets or adding a new asset to the task
example: https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/assets
type: string
attachments:
description: URL for getting the list of the task attachments
example: https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/attachments
type: string
brief:
description: URL of the task brief
example: https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/brief
type:
- string
- 'null'
campaign:
description: URL of the campaign that the task is associated with
example: https://api.cmp.optimizely.com/v3/campaigns/2e7f9107351b00a722e0412230cee5534
type: string
custom_fields:
description: URL of the list of custom fields added to the task
example: https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/custom-fields
type:
- string
- 'null'
milestone:
description: URL of the milestone that the task is associated with
example: https://api.cmp.optimizely.com/v3/milestones/63f1c2b675be4132854d2741
type:
- string
- 'null'
self:
description: URL of the task
example: https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534
type: string
web_urls:
additionalProperties: false
description: Web URLs
properties:
brief:
description: Web URL of the task brief
example: https://cmp.optimizely.com/cloud/taskv3/5c52cc153db27d0e5141146f?activeTab=brief
type: string
self:
description: Web URL of the task
example: https://cmp.optimizely.com/cloud/taskv3/5c52cc153db27d0e5141146f
type: string
required:
- self
- brief
type: object
required:
- self
- assets
- attachments
- brief
- campaign
- custom_fields
- milestone
- web_urls
type: object
milestone_id:
description: Unique identifier of the milestone
example: 8n7f910o51b00b722o0418n30cie8211
type:
- string
- 'null'
modified_at:
description: Modified date of the task in ISO 8601 UTC format
example: '2024-06-01T06:00:00Z'
type:
- string
- 'null'
reference_id:
description: Reference ID of the task
example: TSK-123
type: string
start_at:
description: Start date and time of the task, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2019-10-06T13:15:30Z'
format: date-time
type:
- string
- 'null'
status:
description: Current status of the task
enum:
- Archived
- Completed
- Overdue
- Not Started
- In Progress
- On Hold
example: Not Started
type: string
steps:
description: Steps of the task
items:
$ref: '#/components/schemas/TaskStep'
type: array
title:
description: Title of the task
example: Awesome Task
type: string
workflow_id:
description: Unique identifier of workflow
example: 8q7f910551b00a722e0418830cee6612
type:
- string
- 'null'
required:
- id
- title
- start_at
- due_at
- is_completed
- is_archived
- reference_id
- status
- campaign_id
- milestone_id
- modified_at
- labels
- steps
- links
type: object
FieldTypeCheckbox:
allOf:
- $ref: '#/components/schemas/FieldBaseType'
- properties:
choices:
description: Choices of the checkbox
items:
properties:
id:
description: Identifier of the choice
example: 6ceee2f4fa3411ecb37802420ac8001b
type: string
name:
description: Name of the choice
example: Checkbox 1 Choice 1
type: string
required:
- id
- name
- color
type: object
type: array
required:
- choices
type: object
DeleteFieldValueModel:
properties:
delete:
description: Should be true if the field value needs to be deleted
type: boolean
order_index:
description: Order index of the field value
type: integer
required:
- delete
type: object
ContentDetailsModel:
properties:
content_guid:
description: Unique identifier of the content
type: string
content_type:
$ref: '#/components/schemas/VersionedContentTypeModel'
content_type_guid:
description: Unique identifier of the content type
type: string
content_type_name:
description: Name of the content type
type: string
created_at:
description: Date and time on which the content was created, in ISO 8601 UTC format
format: date-time
type: string
created_by:
description: Unique identifier of the user who created the content
type: string
expired:
description: Expired status of the content
type: boolean
expiry_datetime:
description: Date and time on which the content will expire, in ISO 8601 UTC format
format: date-time
type: string
latest_fields_version:
$ref: '#/components/schemas/ContentFieldsVersionDetails'
links:
description: Meta links
properties:
definition:
description: URL of the content definition
example: https://api.cmp.optimizely.com/v3/structured-content/content-types/5291e00b990a49f1857adc024fd26620/versions/a8b48d529701452aa56a4e752e1b0ffc
type: string
self:
description: URL of the content
example: https://api.cmp.optimizely.com/v3/structured-content/contents/a24b834428a043ab8caed1ded4606f7d
type: string
type: object
primary_locale:
description: The primary locale of the content
example: en_US
type: string
root_content:
description: This is true when the content is not embedded in another content through a content type reference field
type: boolean
source:
description: Source of the content
type: string
source_id:
description: Source ID of the content
type: string
source_metadata:
description: Source metadata of the content
type: string
template_guid:
description: Template GUID of the content
type: string
title:
description: Title of the content
type: string
updated_at:
description: Date and time on which the content was last updated, in ISO 8601 UTC format
format: date-time
type: string
updated_by:
description: Unique identifier of the user who last updated the content
type: string
required:
- root_content
- title
- latest_fields_version
- content_guid
- created_by
- updated_by
- created_at
- updated_at
- content_type_guid
- content_type_name
- links
type: object
ResourceLabelRequest:
additionalProperties: false
description: Payload to associate labels to a resource
properties:
group:
description: Label group
example: 2467e583a60e23fda2b89db81a453cd2
maxLength: 32
minLength: 32
type: string
values:
description: List of values of the label
items:
example: 71c378f3fee3d822759d1bdc2aab628c
maxLength: 32
minLength: 32
type: string
type: array
required:
- group
- values
type: object
ContentFieldsVersionDetails:
properties:
content_hash:
description: Content hash of the version
type: string
created_at:
description: Date and time on which the version was created, in ISO 8601 UTC format
format: date-time
type: string
created_by:
description: Unique identifier of the user who created the version
type: string
fields:
additionalProperties:
items:
$ref: '#/components/schemas/LocalizedFieldValues'
type: array
description: List of fields
type: object
source_id:
description: Source ID of the version
type: string
source_metadata:
description: Source metadata of the version
type: string
validation:
$ref: '#/components/schemas/ContentFieldsVersionValidation'
version_guid:
description: Unique identifier of the version
type: string
required:
- fields
- created_by
- created_at
- version_guid
- content_hash
type: object
ChoiceDisplayOption:
description: An enumeration.
enum:
- radio
- dropdown
- tag
- checkbox
type: string
Pagination:
additionalProperties: false
description: Pagination related information
properties:
next:
description: URL to the next page
example: https://api.cmp.optimizely.com/?offset=10&page_size=10
type:
- string
- 'null'
previous:
description: URL to the previous page
example: null
type:
- string
- 'null'
required:
- next
- previous
type: object
TaskCommentResponse:
additionalProperties: false
properties:
attachments:
description: List of attachments of the comment
example:
- id: a113667245d111eb8945000c
name: sample.png
url: https://files.cmp.optimizely.com/download/96c314a645d111eb8945000c291b51d4?token=
items:
$ref: '#/components/schemas/AttachmentResponse'
type: array
comment_by:
description: Unique identifier of the user who posted the comment
example: 62a8455e29fed3045d9c7a8b
type: string
created_at:
description: Creation date and time of the task comment, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2020-10-06T13:15:30Z'
format: date-time
type: string
id:
description: Unique identifier of the task comment
example: 5fe38c39574b52a62a089239
type: string
is_resolved:
description: Determines if the comment is resolved in Optimizely CMP
example: false
type: boolean
links:
additionalProperties: false
description: Meta links
properties:
comment_by:
description: URL of the user who posted the comment
example: https://api.cmp.optimizely.com/v3/users/62a8455e29fed3045d9c7a8b
type: string
task:
description: URL of the task
example: https://api.cmp.optimizely.com/v3/tasks/5fe38c39574b52a62a089239
type: string
required:
- task
- comment_by
type: object
modified_at:
description: Last modification date and time of the task comment, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2020-10-06T14:15:30Z'
format: date-time
type: string
parent_comment_id:
description: Unique identifier of the parent comment
example: 5fe38c39574b52a62a089238
type:
- string
- 'null'
value:
description: Content of the comment
example: Well done!
type: string
required:
- id
- value
- is_resolved
- parent_comment_id
- comment_by
- created_at
- modified_at
- attachments
- links
type: object
TaskFieldUpdateRequest:
additionalProperties: false
discriminator:
mapping:
checkbox: '#/components/schemas/MultiChoiceTypeObjectFieldUpdatePayload'
currency_number: '#/components/schemas/NumberTypeObjectFieldUpdatePayload'
date: '#/components/schemas/DateTypeObjectFieldUpdatePayload'
dropdown: '#/components/schemas/DropdownTypeObjectFieldUpdatePayload'
image: '#/components/schemas/AssetTypeObjectFieldUpdatePayload'
label: '#/components/schemas/MultiChoiceTypeObjectFieldUpdatePayload'
percentage_number: '#/components/schemas/NumberTypeObjectFieldUpdatePayload'
radio_button: '#/components/schemas/RadioButtonTypeObjectFieldUpdatePayload'
rich_text: '#/components/schemas/StringTypeObjectFieldUpdatePayload'
simple_number: '#/components/schemas/NumberTypeObjectFieldUpdatePayload'
text: '#/components/schemas/StringTypeObjectFieldUpdatePayload'
text_area: '#/components/schemas/StringTypeObjectFieldUpdatePayload'
video: '#/components/schemas/AssetTypeObjectFieldUpdatePayload'
propertyName: type
oneOf:
- $ref: '#/components/schemas/StringTypeObjectFieldUpdatePayload'
- $ref: '#/components/schemas/MultiChoiceTypeObjectFieldUpdatePayload'
- $ref: '#/components/schemas/DropdownTypeObjectFieldUpdatePayload'
- $ref: '#/components/schemas/RadioButtonTypeObjectFieldUpdatePayload'
- $ref: '#/components/schemas/NumberTypeObjectFieldUpdatePayload'
- $ref: '#/components/schemas/DateTypeObjectFieldUpdatePayload'
- $ref: '#/components/schemas/AssetTypeObjectFieldUpdatePayload'
type: object
TaskAssetRequest:
additionalProperties: false
discriminator:
mapping:
direct_upload: '#/components/schemas/TaskAssetRequestForDirectUpload'
fork_from_library: '#/components/schemas/TaskAssetRequestForLibrary'
propertyName: type
oneOf:
- $ref: '#/components/schemas/TaskAssetRequestForDirectUpload'
- $ref: '#/components/schemas/TaskAssetRequestForLibrary'
type: object
FieldBaseType:
additionalProperties: false
properties:
id:
description: Identifier of the field
example: 64be245ec0d79e79fdf1ad84
type: string
name:
description: Name of the field
example: Dropdown 101
type: string
type:
description: Type of the field
example: text
type: string
values:
description: List of selected values or from user input
items:
type: string
type: array
required:
- id
- name
- type
- values
type: object
BaseAssetField:
additionalProperties: false
properties:
id:
description: Identifier of the field
example: 64be245ec0d79e79fdf1ad84
type: string
name:
description: Name of the field
example: Simple Text
type: string
type:
description: Type of the field
example: text
type: string
values:
description: List of selected values or from user input
items:
type: string
type: array
required:
- id
- name
- type
- values
type: object
RadioButtonTypeObjectField:
allOf:
- $ref: '#/components/schemas/BaseObjectField'
- $ref: '#/components/schemas/RadioButtonTypeObjectFieldUpdatePayload'
TaskSubStepCommentResponse:
additionalProperties: false
properties:
attachments:
description: List of attachments of the comment
example:
- id: a113667245d111eb8945000c
name: sample.png
url: https://files.cmp.optimizely.com/download/96c314a645d111eb8945000c291b51d4?token=
items:
$ref: '#/components/schemas/AttachmentResponse'
type: array
created_at:
description: Creation date and time of the task substep comment, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2020-10-06T13:15:30Z'
format: date-time
type: string
id:
description: Unique identifier of the substep comment
example: 5fe38c39574b52a62a089239
type: string
is_resolved:
description: Determines if the comment is resolved in Optimizely CMP
example: false
type: boolean
links:
additionalProperties: false
description: Meta links
properties:
comment_by:
description: Creator of the substep comment
example: https://api.cmp.optimizely.com/v3/users/5fe38eea574b52a62a08923a
type: string
self:
description: URL of the substep comment
example: https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/steps/6d7f910551b00a722e0418830cee5564/sub-steps/9c7f910551b00a722e0418830cee2564
type: string
sub_step:
description: URL of the substep
example: https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534/steps/6d7f910551b00a722e0418830cee5564/sub-steps/9c7f910551b00a722e0418830cee2564
type: string
task:
description: URL of the task
example: https://api.cmp.optimizely.com/v3/tasks/5d7f910551b00a722e0418830cee5534
type: string
required:
- self
- comment_by
- task
- sub_step
type: object
modified_at:
description: Last modification date and time of the task substep comment, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2020-10-06T14:15:30Z'
format: date-time
type: string
value:
description: Content of the comment
example: Well done!
type: string
required:
- id
- value
- is_resolved
- created_at
- modified_at
- attachments
type: object
TaskPublishingIntentResponse:
additionalProperties: false
properties:
id:
description: Unique identifier of the publishing intent
example: 6a3a61f8c201c660b84bbfff
type: string
required:
- id
type: object
TaskArticle:
additionalProperties: false
properties:
created_at:
description: Date and time on which the article was created, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2019-10-06T13:15:30Z'
format: date-time
type: string
html_body:
description: Content of the article
example: Article text
type: string
id:
description: Unique identifier of the article
example: 5d7f910551b00a722e0418830cee6631
type: string
labels:
description: Labels associated with the article
items:
$ref: '#/components/schemas/ResourceLabelResponse'
type: array
library_asset_id:
description: Unique identifier of the corresponding library asset — the library asset this task asset was forked from, or the one it was released to.
example: 6a8b2c3d4e5f6071829a3b4c
type:
- string
- 'null'
links:
additionalProperties: false
description: Meta links
properties:
drafts:
description: URL to POST draft to a task asset – not supported for `article` so the value will be `null`
example: null
type:
- string
- 'null'
self:
description: URL of the article
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/articles/5d7f910551b00a722e0418830cee6631
type: string
task:
description: URL of the task that the article is associated with
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9
type: string
web_urls:
additionalProperties: false
description: Web URLs
properties:
drafts:
description: Web URL of the drafts of the article – not supported for `article` so the value will be `null`
example: null
type:
- string
- 'null'
self:
description: Web URL of the article
example: https://cmp.optimizely.com/cloud/taskv3/5f857f30e1c4a2038d6179e9?contentTabGuid=5d7f910551b00a722e0418830cee6631
type: string
task:
description: Web URL of the task that the article is associated with
example: https://cmp.optimizely.com/cloud/taskv3/5f857f30e1c4a2038d6179e9
type: string
required:
- self
- task
- drafts
type: object
required:
- self
- task
- drafts
- web_urls
type: object
modified_at:
description: Date and time of the most recent modification of the article, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2019-10-07T13:15:30Z'
format: date-time
type: string
title:
description: Title of the article
example: 3 Ways Influencer Marketing Will Further Mature in 2020
type: string
url:
description: Public URL of the article
example: https://cmp.optimizely.com/new-article-published.html
type:
- string
- 'null'
required:
- id
- title
- created_at
- modified_at
- html_body
- url
- labels
- links
type: object
ContentFieldValueModel:
properties:
content_guid:
description: Content GUID of the field value
type: string
content_url:
description: Content URL of the field value
type: string
embedded:
description: Indicates whether the field value is embedded
type: boolean
order_index:
description: Order index of the field value
type: integer
required:
- content_guid
- embedded
type: object
TaskStructuredContentDraftRequest:
additionalProperties: false
properties:
content_body:
$ref: '#/components/schemas/LocalizedFieldValues'
description: The fields of structured content
title: contentbody
type: object
required:
- content_body
type: object
TaskAssetDraftListResponseItem:
additionalProperties: false
properties:
content:
additionalProperties: false
description: Content of the draft
properties:
type:
description: Type of the content
enum:
- url
example: url
type: string
value:
description: Content of the draft; download URL for `image`, `raw file`, and `video`
example: http://images.cmp.optimizely.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==S
type: string
required:
- type
- value
type: object
created_at:
description: Date and time on which the draft was created, in ISO 8601 UTC format (2020-02-10T10:40:45Z)
example: '2019-10-06T13:15:30Z'
format: date-time
type: string
draft_number:
description: The serial number of the draft
example: 2
type: integer
id:
description: Unique identifier of the draft
example: 5d7f910551b00a722e0418830cee6631
type: string
links:
additionalProperties: false
description: Meta links
properties:
asset:
description: URL of the asset that the draft is associated with
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9/images/5d7f910551b00a722e0418830cee6631
type: string
task:
description: URL of the task that the asset is associated with
example: https://api.cmp.optimizely.com/v3/tasks/5f857f30e1c4a2038d6179e9
type: string
required:
- asset
- task
type: object
mime_type:
description: MIME type of the draft
example: image/png
type: string
title:
description: Title of the draft
example: sample_image.png
type: string
type:
description: Type of the draft
enum:
- image
- video
- raw_file
example: image
type: string
required:
- id
- draft_number
- title
- type
- mime_type
- created_at
- content
- links
type: object
AssetTypeObjectField:
allOf:
- $ref: '#/components/schemas/BaseObjectField'
- $ref: '#/components/schemas/AssetTypeObjectFieldUpdatePayload'
AssetRequest:
type: object
additionalProperties: false
properties:
key:
type: string
maxLength: 100
description: Unique identifier of the file upload session. This is the `upload_meta_fields.key` field which was retrieved from the `/v3/upload-url` endpoint
title:
type: string
minLength: 1
maxLength: 100
description: Title of the asset
example: sample_image.png
required:
- key
- title
ResourceCustomFieldChoiceResponse:
type: object
additionalProperties: false
properties:
id:
type: string
description: Unique identifier of the custom field choice
example: j90uv0sd9i0si09sdip
name:
type: string
description: Name of the custom field choice
example: Some option
required:
- id
- name
TaskResponse_2:
type: object
additionalProperties: false
properties:
id:
type: string
description: Unique identifier of the task
example: 5d7f910551b00a722e0418830cee5534
title:
type: string
description: Title of the task
example: Awesome Task
start_at:
type:
- string
- 'null'
format: date-time
description: Start date and time of the task in ISO 8601 UTC format (eg. 2020-02-10T10:40:45Z)
example: '2019-10-06T13:15:30Z'
due_at:
type:
- string
- 'null'
format: date-time
description: Due date and time of the task in ISO 8601 UTC format (eg. 2020-02-10T10:40:45Z)
example: '2020-10-06T13:15:30Z'
is_completed:
type: boolean
description: Determines if the task is completed or not
example: false
is_archived:
type: boolean
description: Determines if the task is archived or not
example: false
reference_id:
type: string
description: Reference ID of the task
example: TSK-123
labels:
type: array
description: Labels associated to the task
items:
$ref: '#/components/schemas/ResourceLabelResponse'
steps:
type: array
description: Steps of the task
items:
$ref: '#/components/schemas/TaskStep_2'
links:
type: object
additionalProperties: false
description: Meta links
properties:
self:
type: string
description: URL of the task
example: https://api.welcomesoftware.com/v3/tasks/5d7f910551b00a722e0418830cee5534
assets:
type: string
description: URL for getting the list of the task assets or adding a new asset to the task
example: https://api.welcomesoftware.com/v3/tasks/5d7f910551b00a722e0418830cee5534/assets
attachments:
type: string
description: URL for getting the list of the task attachments
example: https://api.welcomesoftware.com/v3/tasks/5d7f910551b00a722e0418830cee5534/attachments
brief:
type:
- string
- 'null'
description: URL of the task brief
example: https://api.welcomesoftware.com/v3/tasks/5d7f910551b00a722e0418830cee5534/brief
campaign:
type: string
description: URL of the campaign that the task is associated with
example: https://api.welcomesoftware.com/v3/campaigns/2e7f9107351b00a722e0412230cee5534
custom_fields:
type:
- string
- 'null'
description: URL of the list of custom fields added to the task
example: https://api.welcomesoftware.com/v3/tasks/5d7f910551b00a722e0418830cee5534/custom-fields
web_urls:
type: object
additionalProperties: false
description: web urls
properties:
self:
type: string
description: Web URL of the task
example: https://app.welcomesoftware.com/cloud/taskv3/5c52cc153db27d0e5141146f
brief:
type: string
description: Web URL of the task brief
example: https://app.welcomesoftware.com/cloud/taskv3/5c52cc153db27d0e5141146f?activeTab=brief
required:
- self
- brief
required:
- self
- assets
- attachments
- brief
- campaign
- custom_fields
- web_urls
required:
- id
- title
- start_at
- due_at
- is_completed
- is_archived
- reference_id
- labels
- steps
- links
TaskExternalWorkRequest_2:
type: object
additionalProperties: false
properties:
identifier:
type:
- string
- 'null'
minLength: 1
maxLength: 50
description: Identifier of the external work
example: MY-PROJ-123
title:
type:
- string
- 'null'
minLength: 1
maxLength: 128
description: Title of the external work
example: A very important ticket
status:
type:
- string
- 'null'
minLength: 1
maxLength: 50
description: Status of the external work
example: In Progress
url:
type:
- string
- 'null'
maxLength: 500
description: Link to the external work (must be a valid URL with HTTPS scheme)
example: https://example.com/some-project/MY-PROJ-123
TaskPatchRequest:
type: object
additionalProperties: false
properties:
labels:
type: array
description: Labels to associate
items:
$ref: '#/components/schemas/ResourceLabelRequest'
TaskSubStep_2:
type: object
additionalProperties: false
properties:
id:
type: string
description: Unique identifier of the sub step
example: 9c7f910551b00a722e0418830cee2564
title:
type: string
description: Title of the sub step
example: Sample step
assignee_id:
type:
- string
- 'null'
description: ID of the assignee of the step containing the sub step
example: 5fdf31d57f0d0e362e2b5908
is_completed:
type: boolean
description: Determines if the sub step is completed in _Welcome_
example: false
is_skipped:
type: boolean
description: Determines if the sub step is skipped in _Welcome_
example: false
is_external:
type: boolean
description: Determines if the sub step is external in _Welcome_
example: true
links:
type: object
additionalProperties: false
description: Meta links
properties:
self:
type: string
description: URL of the sub step
example: https://api.welcomesoftware.com/v3/tasks/5d7f910551b00a722e0418830cee5534/steps/6d7f910551b00a722e0418830cee5564/sub-steps/9c7f910551b00a722e0418830cee2564
task:
type: string
description: URL of the task
example: https://api.welcomesoftware.com/v3/tasks/5d7f910551b00a722e0418830cee5534
external_work:
type:
- string
- 'null'
description: URL of the external work associated with sub step if sub step is external in _Welcome_
example: https://api.welcomesoftware.com/v3/tasks/5d7f910551b00a722e0418830cee5534/steps/6d7f910551b00a722e0418830cee5564/sub-steps/9c7f910551b00a722e0418830cee2564/external-work
assignee:
type:
- string
- 'null'
description: Assignee of the step containing the sub step
example: https://api.welcomesoftware.com/v3/users/5fdf31d57f0d0e362e2b5908
required:
- self
- task
- external_work
required:
- id
- title
- assignee_id
- is_completed
- is_skipped
- is_external
- links
ResourceCustomFieldRequest:
type: object
additionalProperties: false
properties:
values:
type: array
minLength: 1
description: 'Array of choice ids if custom field has choices, otherwise text values to update the custom field values with. Must contain at least 1 id / value in the array. For custom field of type `checkboxes`, array of multiple choice ids can be provided as values.
Value for custom field of type `date_field` must follow this format: `YYYY-MM-DD`.
'
items:
type: string
example: 1nu8ue9wf8u9nusd9u
required:
- values
TaskAssetDraftResponse_2:
type: object
additionalProperties: false
properties:
draft_number:
type: integer
description: The serial number of the draft
example: 2
asset_id:
type: string
description: Unique identifier of the asset
example: 5d7f910551b00a722e0418830cee6631
title:
type: string
description: Title of the draft
example: sample_image.png
type:
type: string
enum:
- image
- video
- raw_file
description: Type of the draft
example: image
mime_type:
type: string
description: MIME type of the draft
example: image/png
created_at:
type: string
format: date-time
description: Date and time, in ISO 8601 UTC format, on which the draft has been created (eg. 2020-02-10T10:40:45Z)
example: '2019-10-06T13:15:30Z'
content:
description: Content of the draft
type: object
additionalProperties: false
properties:
type:
type: string
description: Type of the content
enum:
- url
example: url
value:
type: string
description: Content of the draft. For image, raw file and video it is the download URL
example: http://images.welcomesoftware.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==S
required:
- type
- value
links:
type: object
additionalProperties: false
description: Meta links
properties:
asset:
type: string
description: URL of the asset that the draft is associated with
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9/images/5d7f910551b00a722e0418830cee6631
task:
type: string
description: URL of the task that the asset is associated with
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9
required:
- asset
- task
required:
- draft_number
- asset_id
- title
- type
- mime_type
- created_at
- content
- links
AttachmentResponse_2:
type: object
additionalProperties: false
properties:
id:
type: string
description: Unique identifier for the attachment
example: 5a7f910511b0a72230ce6631
name:
type: string
description: Filename of the attachment
example: sample_image.png
url:
type: string
description: Download URL of the attachment
example: https://files.welcomesoftware.com/download/2115bfe4450c11ebaae8000c291b51d4
required:
- id
- name
- url
TaskStep_2:
type: object
additionalProperties: false
properties:
id:
type: string
description: Unique identifier of the step
example: 6d7f910551b00a722e0418830cee5564
title:
type: string
description: Title of the step
example: Sample step
is_completed:
type: boolean
description: Determines if the step is completed in _Welcome_
example: false
description:
type:
- string
- 'null'
description: Description of the step
example: Description of the step
due_at:
type:
- string
- 'null'
format: date-time
description: Due date and time of the step containing the sub step in ISO 8601 UTC format (eg. 2020-02-10T10:40:45Z)
example: '2020-10-06T13:15:30Z'
sub_steps:
type: array
description: Sub steps of the step
items:
$ref: '#/components/schemas/TaskSubStep_2'
required:
- id
- title
- is_completed
- description
- due_at
- sub_steps
TaskExternalWorkResponse_2:
type: object
additionalProperties: false
properties:
identifier:
type:
- string
- 'null'
description: Identifier of the external work
example: MY-PROJ-123
title:
type:
- string
- 'null'
description: Title of the external work
example: A very important ticket
status:
type:
- string
- 'null'
description: Status of the external work
example: In Progress
url:
type:
- string
- 'null'
description: Link to the external work
example: https://example.com/some-project/MY-PROJ-123
external_system:
type: string
description: Name of the external system
example: jira
links:
type: object
additionalProperties: false
description: Meta links
properties:
self:
type: string
description: URL to get or update the external work information
example: https://api.welcomesoftware.com/v3/tasks/5d7f910551b00a722e0418830cee6631/steps/32982hf94j98cnr48034nv035/sub-steps/9n390809r384nv503459075034nv5/external-work
required:
- self
required:
- identifier
- title
- status
- url
- external_system
- links
Pagination_2:
type: object
additionalProperties: false
description: Pagination related information
properties:
next:
type:
- string
- 'null'
description: URL to the next page
example: https://api.welcomesoftware.com/?offset=10&page_size=10
previous:
type:
- string
- 'null'
description: URL to the previous page
example: null
required:
- next
- previous
CommentPostRequest:
type: object
additionalProperties: false
properties:
value:
type: string
minLength: 1
description: Content of the comment. To mention a user belonging to the organization, use the `@[name](openapi-user-link)` format.
example: Comment mentioning @[Organization User](https://api.welcomesoftware.com/v3/users/5fe38aeb574b52a62a089238)
attachments:
description: List of comment attachments.
type: array
items:
$ref: '#/components/schemas/AttachmentRequest_2'
required:
- value
AssetContent_2:
description: Content of the asset
type: object
additionalProperties: false
properties:
type:
type: string
description: Type of the content. For article it is `html_body` and for image, raw file and video it is `url`
enum:
- url
- html_body
example: url
value:
type: string
description: Content of the asset. For article it is the html body and for image, raw file and video it is the download URL
example: http://images.welcomesoftware.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==S
required:
- type
- value
TaskAssetResponse_2:
type: object
additionalProperties: false
properties:
id:
type: string
description: Unique identifier for the asset
example: 5d7f910551b00a722e0418830cee6631
title:
type: string
description: Title of the asset
example: sample_image.png
type:
type: string
enum:
- article
- image
- video
- raw_file
description: Type of the asset
example: image
mime_type:
type: string
description: MIME type of the asset
example: image/png
created_at:
type: string
format: date-time
description: Date and time, in ISO 8601 UTC format, on which the asset has been created (eg. 2020-02-10T10:40:45Z)
example: '2019-10-06T13:15:30Z'
modified_at:
type: string
format: date-time
description: Date and time, in ISO 8601 UTC format, of the most recent modification of the asset (eg. 2020-02-10T10:40:45Z)
example: '2019-10-07T13:15:30Z'
content:
$ref: '#/components/schemas/AssetContent_2'
labels:
type: array
description: Labels associated to the asset
items:
$ref: '#/components/schemas/ResourceLabelResponse'
links:
type: object
additionalProperties: false
description: Meta links
properties:
self:
type: string
description: URL of the asset
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9/image/5d7f910551b00a722e0418830cee6631
task:
type: string
description: URL of the task that the asset is associated with
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9
drafts:
type:
- string
- 'null'
description: URL to POST draft to the asset, always null for **article**, non null for **image**, **video** and **raw file**.
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9/assets/5d7f910551b00a722e0418830cee6631/drafts
web_urls:
type: object
additionalProperties: false
description: Web URLs
properties:
self:
type: string
description: Web URL of the asset
example: https://app.welcomesoftware.com/cloud/taskv3/5f857f30e1c4a2038d6179e9?contentTabGuid=5d7f910551b00a722e0418830cee6631
task:
type: string
description: Web URL of the task that the asset is associated with
example: https://app.welcomesoftware.com/cloud/taskv3/5f857f30e1c4a2038d6179e9
drafts:
type:
- string
- 'null'
description: Web URL of the drafts of the asset, always null for **article**, non null for **image**, **video** and **raw file**.
example: https://app.welcomesoftware.com/cloud/task/5f857f30e1c4a2038d6179e9/image/5d7f910551b00a722e0418830cee6631
required:
- self
- task
- drafts
required:
- self
- task
- drafts
- web_urls
required:
- id
- title
- type
- mime_type
- created_at
- modified_at
- content
- labels
- links
TaskBriefResponse_2:
type: object
additionalProperties: false
properties:
type:
type: string
description: Type of the task brief
example: template
enum:
- template
- attachment
- text
title:
type: string
description: Title of the task brief
example: Awesome Task Brief
template:
oneOf:
- $ref: '#/components/schemas/TaskBriefTemplateValue'
- $ref: '#/components/schemas/NullValue'
fields:
description: List of fields of the brief
type: array
items:
type: object
additionalProperties: false
properties:
name:
type: string
description: Name of the brief field
example: My Dropdown
value:
type: array
description: List of values set for the brief field
items:
type: string
description: value set in the brief field
example: option 1
required:
- name
- value
links:
type: object
additionalProperties: false
description: Meta links
properties:
self:
type: string
description: URL of the brief
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9/brief
task:
type: string
description: URL of the task
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9
required:
- self
- task
required:
- type
- title
- fields
- links
AttachmentRequest_2:
type: object
additionalProperties: false
properties:
key:
type: string
minLength: 1
maxLength: 100
description: Unique identifier of the file upload session. This is the `upload_meta_fields.key` field which was retrieved from the `/v3/upload-url` endpoint
example: ce8995aea58b11ea8cd90242ac120005
name:
type: string
minLength: 1
description: Filename of the attachment
example: sample_image.png
required:
- key
- name
TaskSubStepCommentResponse_2:
type: object
additionalProperties: false
properties:
id:
type: string
description: Unique identifier of the sub step comment
example: 5fe38c39574b52a62a089239
value:
type: string
description: Content of the comment
example: Well done!
is_resolved:
type: boolean
description: Determines if the comment is resolved in _Welcome_
example: false
created_at:
type: string
format: date-time
description: Creation date and time of the task sub step comment in ISO 8601 UTC format (eg. 2020-02-10T10:40:45Z)
example: '2020-10-06T13:15:30Z'
modified_at:
type: string
format: date-time
description: Last modification date and time of the task sub step comment in ISO 8601 UTC format (eg. 2020-02-10T10:40:45Z)
example: '2020-10-06T14:15:30Z'
attachments:
description: List of attachments of the comment
type: array
items:
$ref: '#/components/schemas/AttachmentResponse_2'
example:
- id: a113667245d111eb8945000c
name: sample.png
url: https://files.welcomesoftware.com/download/96c314a645d111eb8945000c291b51d4?token=
links:
type: object
additionalProperties: false
description: Meta links
properties:
self:
type: string
description: URL of the sub step comment
example: https://api.welcomesoftware.com/v3/tasks/5d7f910551b00a722e0418830cee5534/steps/6d7f910551b00a722e0418830cee5564/sub-steps/9c7f910551b00a722e0418830cee2564
comment_by:
type: string
description: Creator of the sub step comment
example: https://api.welcomesoftware.com/v3/users/5fe38eea574b52a62a08923a
task:
type: string
description: URL of the task
example: https://api.welcomesoftware.com/v3/tasks/5d7f910551b00a722e0418830cee5534
sub_step:
type: string
description: URL of the sub step
example: https://api.welcomesoftware.com/v3/tasks/5d7f910551b00a722e0418830cee5534/steps/6d7f910551b00a722e0418830cee5564/sub-steps/9c7f910551b00a722e0418830cee2564
required:
- self
- comment_by
- task
- sub_step
required:
- id
- value
- is_resolved
- created_at
- modified_at
- attachments
NullValue:
not:
anyOf:
- type: string
- type: number
- type: boolean
- type: object
- type: array
items: {}
TaskVideo_2:
type: object
additionalProperties: false
properties:
id:
type: string
description: Unique identifier for the video
example: 5d7f910551b00a722e0418830cee6633
title:
type: string
description: Title of the video
example: product.mp4
mime_type:
type: string
description: MIME type of the video
example: video/mp4
created_at:
type: string
format: date-time
description: Date and time, in ISO 8601 UTC format, on which the video has been created (eg. 2020-02-10T10:40:45Z)
example: '2019-10-06T13:15:30Z'
modified_at:
type: string
format: date-time
description: Date and time, in ISO 8601 UTC format, of the most recent modification of the video (eg. 2020-02-10T10:40:45Z)
example: '2019-10-07T13:15:30Z'
file_size:
type: integer
description: Size of the video in bytes
example: 11244
url:
type: string
description: Download url of the video
example: https://s3.amazonaws.com/videos.welcomesoftware.com/03a747babe81ceb55763fa085bqa20dc
labels:
type: array
description: Labels associated to the video
items:
$ref: '#/components/schemas/ResourceLabelResponse'
links:
type: object
additionalProperties: false
description: Meta links
properties:
self:
type: string
description: URL of the video
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9/videos/5d7f910551b00a722e0418830cee6633
task:
type: string
description: URL of the task that the video is associated with
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9
drafts:
type: string
description: URL to POST draft to the video
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9/assets/5d7f910551b00a722e0418830cee6633/drafts
web_urls:
type: object
additionalProperties: false
description: Web URLs
properties:
self:
type: string
description: Web URL of the video
example: https://app.welcomesoftware.com/cloud/taskv3/5f857f30e1c4a2038d6179e9?contentTabGuid=5d7f910551b00a722e0418830cee6633
task:
type: string
description: Web URL of the task that the video is associated with
example: https://app.welcomesoftware.com/cloud/taskv3/5f857f30e1c4a2038d6179e9
drafts:
type: string
description: Web URL of the drafts of the video
example: https://app.welcomesoftware.com/cloud/task/5f857f30e1c4a2038d6179e9/video/5d7f910551b00a722e0418830cee6633
required:
- self
- task
- drafts
required:
- self
- task
- drafts
- web_urls
required:
- id
- title
- mime_type
- created_at
- modified_at
- file_size
- url
- labels
- links
TaskImage_2:
type: object
additionalProperties: false
properties:
id:
type: string
description: Unique identifier of the image
example: 5d7f910551b00a722e0418830cee6632
title:
type: string
description: Title of the image
example: cat.jpeg
mime_type:
type: string
description: MIME type of the image
example: image/jpeg
created_at:
type: string
format: date-time
description: Date and time, in ISO 8601 UTC format, on which the image has been created (eg. 2020-02-10T10:40:45Z)
example: '2019-10-06T13:15:30Z'
modified_at:
type: string
format: date-time
description: Date and time, in ISO 8601 UTC format, of the most recent modification of the image (eg. 2020-02-10T10:40:45Z)
example: '2019-10-07T13:15:30Z'
file_size:
type: integer
description: Size of the image in bytes
example: 11244
image_resolution:
type: object
additionalProperties: false
description: Width and height of the image in pixels
properties:
height:
type: integer
description: Height of the image in pixels
example: 800
width:
type: integer
description: Width of the image in pixels
example: 700
required:
- height
- width
url:
type: string
description: Download URL of the image
example: http://images.welcomesoftware.com/Zz0xODQ3NDU3Y2Y2YmYzOTlmNjkyOTgyZDY3Y2I3YWM2OA==
labels:
type: array
description: Labels associated to the image
items:
$ref: '#/components/schemas/ResourceLabelResponse'
links:
type: object
additionalProperties: false
description: Meta links
properties:
self:
type: string
description: URL of the image
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9/images/5d7f910551b00a722e0418830cee6632
task:
type: string
description: URL of the task that the image is associated with
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9
drafts:
type: string
description: URL to POST draft to the image
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9/assets/5d7f910551b00a722e0418830cee6632/drafts
web_urls:
type: object
additionalProperties: false
description: Web URLs
properties:
self:
type: string
description: Web URL of the image
example: https://app.welcomesoftware.com/cloud/taskv3/5f857f30e1c4a2038d6179e9?contentTabGuid=5d7f910551b00a722e0418830cee6632
task:
type: string
description: Web URL of the task that the image is associated with
example: https://app.welcomesoftware.com/cloud/taskv3/5f857f30e1c4a2038d6179e9
drafts:
type: string
description: Web URL of the drafts of the image
example: https://app.welcomesoftware.com/cloud/task/5f857f30e1c4a2038d6179e9/image/5d7f910551b00a722e0418830cee6632
required:
- self
- task
- drafts
required:
- self
- task
- drafts
- web_urls
required:
- id
- title
- mime_type
- created_at
- modified_at
- file_size
- image_resolution
- url
- labels
- links
TaskArticle_2:
type: object
additionalProperties: false
properties:
id:
type: string
description: Unique identifier of the article
example: 5d7f910551b00a722e0418830cee6631
title:
type: string
description: Title of the article
example: 3 Ways Influencer Marketing Will Further Mature in 2020
created_at:
type: string
format: date-time
description: Date and time, in ISO 8601 UTC format, on which the article has been created (eg. 2020-02-10T10:40:45Z)
example: '2019-10-06T13:15:30Z'
modified_at:
type: string
format: date-time
description: Date and time, in ISO 8601 UTC format, of the most recent modification of the article (eg. 2020-02-10T10:40:45Z)
example: '2019-10-07T13:15:30Z'
html_body:
type: string
description: Content of the article
example: Article text
url:
type:
- string
- 'null'
description: Public URL of the article
example: https://welcomesoftware.com/new-article-published.html
labels:
type: array
description: Labels associated to the article
items:
$ref: '#/components/schemas/ResourceLabelResponse'
links:
type: object
additionalProperties: false
description: Meta links
properties:
self:
type: string
description: URL of the article
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9/articles/5d7f910551b00a722e0418830cee6631
task:
type: string
description: URL of the task that the article is associated with
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9
drafts:
type:
- string
- 'null'
description: URL to POST draft to a task asset, currently not supported for **article**, hence the value will always be `null`
example: null
web_urls:
type: object
additionalProperties: false
description: Web URLs
properties:
self:
type: string
description: Web URL of the article
example: https://app.welcomesoftware.com/cloud/taskv3/5f857f30e1c4a2038d6179e9?contentTabGuid=5d7f910551b00a722e0418830cee6631
task:
type: string
description: Web URL of the task that the article is associated with
example: https://app.welcomesoftware.com/cloud/taskv3/5f857f30e1c4a2038d6179e9
drafts:
type:
- string
- 'null'
description: Web URL of the drafts of the article, currently not supported for **article**, hence the value will always be `null`
example: null
required:
- self
- task
- drafts
required:
- self
- task
- drafts
- web_urls
required:
- id
- title
- created_at
- modified_at
- html_body
- url
- labels
- links
TaskAssetCommentResponse_2:
type: object
additionalProperties: false
properties:
id:
type: string
description: Unique identifier of the comment
example: 5fe38c39574b52a62a089239
value:
type: string
description: Content of the comment
example: Well done!
is_resolved:
type: boolean
description: Determines if the comment is resolved in _Welcome_
example: false
created_at:
type: string
format: date-time
description: Creation date and time of the comment in ISO 8601 UTC format (eg. 2020-02-10T10:40:45Z)
example: '2020-10-06T13:15:30Z'
modified_at:
type: string
format: date-time
description: Last modification date and time of the comment in ISO 8601 UTC format (eg. 2020-02-10T10:40:45Z)
example: '2020-10-06T14:15:30Z'
attachments:
description: List of attachments of the comment
type: array
items:
$ref: '#/components/schemas/AttachmentResponse_2'
example:
- id: a113667245d111eb8945000c
name: sample.png
url: https://files.welcomesoftware.com/download/96c314a645d111eb8945000c291b51d4?token=
links:
type: object
additionalProperties: false
description: Meta links
properties:
task:
type: string
description: URL of the task
example: https://api.welcomesoftware.com/v3/tasks/5d7f910551b00a722e0418830cee5534
asset:
type: string
description: Url of the asset
example: https://api.welcomesoftware.com/v3/tasks/5d7f910551b00a722e0418830cee5534/images/6d7f910551b00a722e0418830cee5564
required:
- task
- asset
required:
- id
- value
- is_resolved
- created_at
- modified_at
- attachments
- links
TaskSubStepRequest_2:
type: object
additionalProperties: false
properties:
is_completed:
type: boolean
enum:
- true
description: If the sub step should be completed, cannot be passed together with `assignee_id`
example: true
assignee_id:
type:
- string
- 'null'
description: ID of the assignee for the sub step, cannot be passed together with `is_completed`
example: 5fdf31d57f0d0e362e2b5908
TaskRawFile_2:
type: object
additionalProperties: false
properties:
id:
type: string
description: Unique identifier of the raw file
example: 5d7f910551b00a722e0418830cee6634
title:
type: string
description: Title of the raw file
example: documents.zip
mime_type:
type: string
description: MIME type of the raw file
example: application/zip
created_at:
type: string
format: date-time
description: Date and time, in ISO 8601 UTC format, on which the raw file has been created (eg. 2020-02-10T10:40:45Z)
example: '2019-10-06T13:15:30Z'
modified_at:
type: string
format: date-time
description: Date and time, in ISO 8601 UTC format, of the most recent modification of the raw file (eg. 2020-02-10T10:40:45Z)
example: '2019-10-07T13:15:30Z'
file_size:
type: integer
description: Size of the raw file in bytes
example: 11244
url:
type: string
description: Download url of the raw file
example: https://s3.amazonaws.com/files.welcomesoftware.com/171451644651701b96f1122009f026bc
labels:
type: array
description: Labels associated to the raw file
items:
$ref: '#/components/schemas/ResourceLabelResponse'
links:
type: object
additionalProperties: false
description: Meta links
properties:
self:
type: string
description: URL of the raw file
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9/raw-files/5d7f910551b00a722e0418830cee6634
task:
type: string
description: URL of the task that the raw file is associated with
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9
drafts:
type: string
description: URL to POST draft to the raw file
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9/assets/5d7f910551b00a722e0418830cee6634/drafts
web_urls:
type: object
additionalProperties: false
description: Web URLs
properties:
self:
type: string
description: Web URL of the raw file
example: https://app.welcomesoftware.com/cloud/taskv3/5f857f30e1c4a2038d6179e9?contentTabGuid=5d7f910551b00a722e0418830cee6634
task:
type: string
description: Web URL of the task that the raw file is associated with
example: https://app.welcomesoftware.com/cloud/taskv3/5f857f30e1c4a2038d6179e9
drafts:
type: string
description: Web URL of the drafts of the raw file
example: https://app.welcomesoftware.com/cloud/task/5f857f30e1c4a2038d6179e9/raw_file/5d7f910551b00a722e0418830cee6634
required:
- self
- task
- drafts
required:
- self
- task
- drafts
- web_urls
required:
- id
- title
- mime_type
- created_at
- modified_at
- file_size
- url
- labels
- links
TaskSubStepCommentPatchRequest:
type: object
additionalProperties: false
properties:
value:
type: string
minLength: 1
description: Updated comment value. To mention a user belonging to the organization, use `@[name](openapi-user-link)` format.
example: Updated comment mentioning @[Organization User](https://api.welcomesoftware.com/v3/users/5fe38aeb574b52a62a089238)
required:
- value
ResourceCustomFieldResponse:
type: object
additionalProperties: false
properties:
id:
type: string
description: Unique identifier for the custom field
example: 9nu8ue9wf8u9nusd9q
name:
type: string
description: Name of the custom field
example: My Dropdown
type:
type: string
description: Type of the custom field
example: dropdown
enum:
- text_field
- multi_line_text_field
- checkboxes
- dropdown
- multiple_choice
- date_field
- image
- video
- rich_text_field
values:
type: array
description: List of values of the custom field
items:
type: object
additionalProperties: false
properties:
id:
type:
- string
- 'null'
description: Identifier of the custom field value
example: 1nu8ue9wf8u9nusd9u
name:
type: string
description: Name of the custom field value
example: Some text
required:
- id
- name
links:
type: object
additionalProperties: false
description: Meta links
properties:
self:
type: string
description: URL of the custom field
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9/custom-fields/9nu8ue9wf8u9nusd9q
choices:
type:
- string
- 'null'
description: URL of the available custom field choices
example: https://api.welcomesoftware.com/v3/tasks/5f857f30e1c4a2038d6179e9/custom-fields/9nu8ue9wf8u9nusd9q/choices
required:
- self
- choices
required:
- id
- name
- type
- values
- links
parameters:
page_size:
description: Number of results to return per page
example: 15
in: query
name: page_size
schema:
default: 10
maximum: 100
minimum: 1
type: integer
offset:
description: Starting index of results (zero indexed)
example: 5
in: query
name: offset
schema:
default: 0
minimum: 0
type: integer
responses:
UnprocessableEntity:
content:
application/json:
example:
message: Resource cannot be processed
schema:
$ref: '#/components/schemas/Error'
description: Unprocessable entity error
Unauthorized:
content:
application/json:
example:
message: Unauthorized
schema:
$ref: '#/components/schemas/Error'
description: Authorization error
NotFound:
content:
application/json:
example:
message: Resource not found
schema:
$ref: '#/components/schemas/Error'
description: Not found error
Forbidden:
content:
application/json:
example:
message: You do not have the permission to perform this operation
schema:
$ref: '#/components/schemas/Error'
description: Permission error
ClientError:
content:
application/json:
example:
message: 'Unsupported arguments: a,b,c'
schema:
$ref: '#/components/schemas/Error'
description: Client error
Forbidden_2:
description: Permission error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
message: User does not have the permission to perform this operation
UnprocessableEntity_2:
description: Unprocessable entity error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
message: Resource is unprocessable
securitySchemes:
OAuth2:
flows:
authorizationCode:
authorizationUrl: https://accounts.cmp.optimizely.com/o/oauth2/v1/auth
scopes:
offline_access: Grants the ability to refresh access_token using the refresh token even when user is not present (not logged in).
openid: Grants the ability to receive a unique identifier for the user.
profile: Grants access to user profile information.
tokenUrl: https://accounts.cmp.optimizely.com/o/oauth2/v1/token
clientCredentials:
scopes: {}
tokenUrl: https://accounts.cmp.optimizely.com/o/oauth2/v1/token
type: oauth2
x-refined-from:
- newscred-cmp-open-api-openapi.json
- newscred-welcome-open-api-openapi.yml
x-tagGroups:
- name: API
tags:
- Uploader
- Library
- Labels
- Brand Compliance
- Tasks
- Task Step
- Campaigns
- Publishing
- Templates
- Users
- Work Requests
- Structured Contents
- Assets
- Milestones
- Teams
- Settings
- Workflows
- Fields
- Events