Newscred Tasks API
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.
Newscred Tasks API is one of 19 APIs that Newscred publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Task. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes
44 operations
across 28 paths,
and defines 158 schemas.
It is described by OpenAPI 3.2.0, at version V3.
Requests are made against 2 base URLs: https://api.cmp.optimizely.com/v3, https://api.welcomesoftware.com/v3.
The identity and technical contract details declared by the specification.
NumberTypeObjectFieldUpdatePayload
MultiChoiceTypeObjectField
TaskUrlResponse
object
2 properties
2 required
LocalizedFieldValuesWithEmbeddedContent
object
2 properties
2 required
RichTextFieldDefinition
object
4 properties
2 required
NumberFieldValueModel
object
2 properties
1 required
LocationFieldValueModel
object
3 properties
2 required
RichTextFieldValueModel
object
2 properties
1 required
TaskSubStep
object
9 properties
9 required
CommentCreateRequest
object
2 properties
1 required
VersionedContentTypeModel
object
15 properties
9 required
TaskAssetDraftResponse
object
8 properties
8 required
CoreFieldDef
object
13 properties
5 required
TaskAssetRequestForLibrary
object
3 properties
3 required
TaskSubStepCommentUpdateRequest
object
1 property
1 required
ObjectFieldCreateRequest
object
AssetContent
object
Content of the asset
2 properties
2 required
TaskBriefResponse
object
5 properties
4 required
AttachmentRequest
object
2 properties
2 required
StructuredContentBody
object
The fields of structured content
1 property
TaskCustomField
object
5 properties
5 required
Error
object
Error payload
2 properties
1 required
TaskImage
object
11 properties
10 required
TaskAssetCommentResponse
object
7 properties
7 required
JSONFieldValueModel
object
2 properties
1 required
TaskRawFile
object
10 properties
9 required
ContentTypeFieldEmbedMixConfig
integer
Ref Type: 1 Refer only 2 Refer and create embed 3 Create only
ContentFieldsVersionValidation
object
1 property
DateTypeObjectFieldUpdatePayload
NumberFieldDefinition
object
4 properties
1 required
RadioButtonTypeObjectFieldUpdatePayload
TaskAssetRequestForDirectUpload
object
3 properties
2 required
ContentFieldValueExpandedModel
object
5 properties
3 required
TaskExternalWorkRequest
object
4 properties
DropdownTypeObjectFieldUpdatePayload
CommentWithReplyCreateRequest
object
3 properties
1 required
TaskCreateRequest
object
6 properties
1 required
AttachmentResponse
object
3 properties
3 required
TaskCustomFieldChoiceListResponseItem
object
2 properties
2 required
TaskExternalWorkResponse
object
6 properties
6 required
TaskListResponseItem
object
13 properties
13 required
LibraryAssetType
string
An enumeration.
LibraryAssetFieldDefinition
object
3 properties
2 required
TaskPublishingIntentCreateRequest
object
1 property
1 required
AddUrlToTaskRequest
object
2 properties
1 required
TaskAssetResponse
object
9 properties
9 required
DatetimeFieldValueModel
object
2 properties
1 required
DeleteLocaleFieldValueModel
object
2 properties
2 required
FieldTypePercentageNumber
TaskSubStepRequest
object
5 properties
BaseFieldDefinition
object
3 properties
2 required
ContentFieldWithEmbeddedPatchValueModel
object
2 properties
2 required
RecursivePatchStructuredContentFields
object
8 properties
TaskUpdateRequest
object
7 properties
ContentFieldValueWithEmbeddedModel
object
1 property
1 required
AssetFieldTypeCurrencyNumber
TextFieldValueModel
object
2 properties
1 required
AssetFieldTypeSimpleNumber
BaseFieldDefinitionType
string
An enumeration.
LocalizedFieldValues
object
2 properties
2 required
BooleanFieldValueModel
object
2 properties
1 required
FieldType
string
An enumeration.
RecursiveStructuredContent
object
8 properties
2 required
MultiChoiceTypeObjectFieldUpdatePayload
TaskStructuredContentCreateRequest
object
11 properties
1 required
TaskBriefTemplateValue
object
Template info of the brief if the brief is of template type
2 properties
2 required
AssetTypeObjectFieldUpdatePayload
TaskStep
object
6 properties
6 required
AllowedContentTypeItem
object
2 properties
2 required
TextFieldDefinition
object
5 properties
3 required
error_reason
string
An enumeration.
AssetFieldListResponseItem
ObjectFieldCreateResponse
object
BaseContentTypeVersionModel
object
6 properties
6 required
LibraryAssetDefaultValue
object
2 properties
2 required
ContentTypeFieldDefinition
object
6 properties
3 required
DatetimeFieldDefinition
object
4 properties
3 required
TaskStructuredContentUpdateRequest
object
8 properties
LocationDefaultValue
object
2 properties
2 required
LibraryAssetFieldValueModel
object
4 properties
2 required
TaskVideo
object
10 properties
9 required
TaskAssetFieldsUpdateRequest
array
URLFieldValueModel
object
2 properties
1 required
ChoiceFieldDefinition
object
4 properties
2 required
StructuredContentFields
object
The fields of structured content
PatchLocalizedFieldValuesWithEmbeddedContent
object
2 properties
2 required
TaskCustomFieldUpdateRequest
object
1 property
1 required
ChoiceFieldValueModel
object
2 properties
1 required
StringTypeObjectFieldUpdatePayload
BaseObjectFieldUpdatePayload
object
2 properties
2 required
AssetFieldTypePercentageNumber
ResourceLabelResponse
object
Label associated to a fetched resource
2 properties
2 required
TaskResponse
object
15 properties
14 required
DeleteFieldValueModel
object
2 properties
1 required
ContentDetailsModel
object
19 properties
11 required
ResourceLabelRequest
object
Payload to associate labels to a resource
2 properties
2 required
ContentFieldsVersionDetails
object
8 properties
5 required
ChoiceDisplayOption
string
An enumeration.
Pagination
object
Pagination related information
2 properties
2 required
TaskCommentResponse
object
9 properties
9 required
TaskFieldUpdateRequest
object
FieldBaseType
object
4 properties
4 required
BaseAssetField
object
4 properties
4 required
RadioButtonTypeObjectField
TaskSubStepCommentResponse
object
7 properties
6 required
TaskPublishingIntentResponse
object
1 property
1 required
TaskArticle
object
9 properties
8 required
ContentFieldValueModel
object
4 properties
2 required
TaskStructuredContentDraftRequest
object
1 property
1 required
TaskAssetDraftListResponseItem
object
8 properties
8 required
AssetRequest
object
2 properties
2 required
ResourceCustomFieldChoiceResponse
object
2 properties
2 required
TaskResponse_2
object
10 properties
10 required
TaskExternalWorkRequest_2
object
4 properties
TaskPatchRequest
object
1 property
TaskSubStep_2
object
7 properties
7 required
ResourceCustomFieldRequest
object
1 property
1 required
TaskAssetDraftResponse_2
object
8 properties
8 required
AttachmentResponse_2
object
3 properties
3 required
TaskStep_2
object
6 properties
6 required
TaskExternalWorkResponse_2
object
6 properties
6 required
Pagination_2
object
Pagination related information
2 properties
2 required
CommentPostRequest
object
2 properties
1 required
AssetContent_2
object
Content of the asset
2 properties
2 required
TaskAssetResponse_2
object
9 properties
9 required
TaskBriefResponse_2
object
5 properties
4 required
AttachmentRequest_2
object
2 properties
2 required
TaskSubStepCommentResponse_2
object
7 properties
6 required
TaskVideo_2
object
9 properties
9 required
TaskImage_2
object
10 properties
10 required
TaskArticle_2
object
8 properties
8 required
TaskAssetCommentResponse_2
object
7 properties
7 required
TaskSubStepRequest_2
object
2 properties
TaskRawFile_2
object
9 properties
9 required
TaskSubStepCommentPatchRequest
object
1 property
1 required
ResourceCustomFieldResponse
object
5 properties
5 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Newscred publishes across the network.
