POST /v3/publishing-events/{publishing_event_id}/publishing-metadata

1 min

POST

https://api.cmp.optimizely.com/v3/publishing-events/{publishing_event_id}/publishing-metadata

Create asset metadata in bulk.

Path Parameters

publishing_event_idstringrequired
Example
1d9d8aeca10811ebbc640242ac12001b
Description
Unique identifier of the publishing event

Body Parameters

bodyPublishingEventMetadataBulkCreateRequestrequired
Description
Payload to create publishing metadata for all assets in a publishing event
- dataPublishingEventMetadataCreateRequest[]required
  Description
  List publishing metadata to be posted
  - asset_idstringrequired
    Example
    4567m474974987479856456457
    Description
    Unique identifier of the asset
  - statusstring<published | unpublished | synced | failed>required
    Example
    published
    Description
    Publishing status of the asset
    Allowed
    publishedunpublishedsyncedfailed
  - status_messagestring
    Example
    This asset is in review
    Description
    Any message patched by the integrator about the asset's status
  - localestring
    Example
    en
    Description
    The locale to which the asset is being published
  - public_urlstring
    Example
    https://example.com/test
    Description
    public url of asset
  - publishing_destination_updated_atstring<date-time>
    Example
    2019-10-06T13:15:30Z
    Description
    Timestamp of when the publishing destination of the asset was updated
    Format
    date-time

Responses

200Fetched all publishing metadata associated with the publishing event

PublishingEventMetadataBulkCreateResponse
- dataPublishingEventMetadataResponse[]required
  Description
  List of successfully posted publishing metadata
  - idstringrequired
    Example
    5ebcd5644967474414564
    Description
    Unique identifier of publishing metadata
  - asset_idstringrequired
    Example
    4567m74974987479856456456
    Description
    Unique identifier of asset
  - asset_typestring<article | image | video | raw_file | structured_content>required
    Example
    article
    Description
    Type of the asset
    Allowed
    articleimagevideoraw_filestructured_content
  - statusstring<published | unpublished | synced | failed | >required
    Example
    published
    Description
    Publishing status of the asset
    Allowed
    publishedunpublishedsyncedfailednull
  - status_messagestringrequired
    Example
    This asset is in review
    Description
    Any message patched by the integrator about the asset's status
  - localestringrequired
    Example
    en
    Description
    The locale to which the asset is being published.
  - public_urlstringrequired
    Example
    https://example.com/test
    Description
    Public URL of the asset
  - publishing_destination_updated_atstring<date-time>required
    Example
    2019-10-06T13:15:30Z
    Description
    Timestamp of when the publishing destination of the asset was updated
    Format
    date-time
  - linksobjectrequired
    Description
    Meta links
    - selfstringrequired
      Example
      https://api.cmp.optimizely.com/v3/publishing-events/1d9d8aeca10811ebbc640242ac12001b/assets/1d9d8aeca10811ebbc640242ac12003c/publishing-metadata/5ebcd5644967474414564
      Description
      URL of the publishing metadata
    - publishing_eventstringrequired
      Example
      https://api.cmp.optimizely.com/v3/publishing-events/1d9d8aeca10811ebbc640242ac12001b
      Description
      URL of the publishing event
    - assetstringrequired
      Example
      https://api.cmp.optimizely.com/v3/articles/4567m474974987479856456456
      Description
      URL of the asset
- errorsobject[]required
  Description
  List of errors of assets for which publishing metadata failed to post
  - error_codestring<canonical-link-error | unknown-asset | metadata-exists | duplicate-metadata | invalid-status | missing-public-url | public-url-not-allowed | domain-not-whitelisted | missing-publishing-destination-updated-at | publishing-destination-updated-at-not-allowed | missing-locale | locale-not-allowed>required
    Example
    canonical-link-error
    Description
    Custom error code
    Allowed
    canonical-link-errorunknown-assetmetadata-existsduplicate-metadatainvalid-statusmissing-public-urlpublic-url-not-alloweddomain-not-whitelistedmissing-publishing-destination-updated-atpublishing-destination-updated-at-not-allowedmissing-localelocale-not-allowed
  - asset_idstringrequired
    Example
    4567m474974987479856456457
    Description
    Unique identifier of the asset that failed to update its publishing metadata
  - localestringrequired
    Example
    en
    Description
    locale of the asset
  - messagestringrequired
    Example
    A canonical URL already exists for the task article '5e46456144645674564456'
    Description
    Description of the error

400Client error

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

401Authorization error

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

403Permission error

Error
Example
```
{
  "message": "You do not have the permission to perform this operation"
}
```
Description
Error payload
- messagestringrequired
  Example
  Not found
  Description
  Message describing the error
- errorsmap<string, string>
  Description
  Additional information

404Not found error

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

curl

curl --request POST \
     --url https://api.cmp.optimizely.com/v3/publishing-events/{publishing_event_id}/publishing-metadata \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "data": [
     {
     "asset_id": "4567m474974987479856456457",
     "status": "published"
     }
     ]
     }'

javascript

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

var raw = JSON.stringify({
   "data": [
      {
         "asset_id": "4567m474974987479856456457",
         "status": "published"
      }
   ]
});

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

fetch("https://api.cmp.optimizely.com/v3/publishing-events/{publishing_event_id}/publishing-metadata", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.cmp.optimizely.com/v3/publishing-events/{publishing_event_id}/publishing-metadata")

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

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request.body = JSON.dump({
   "data": [
      {
         "asset_id": "4567m474974987479856456457",
         "status": "published"
      }
   ]
})

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

python

import requests
import json

url = "https://api.cmp.optimizely.com/v3/publishing-events/{publishing_event_id}/publishing-metadata"

payload = json.dumps({
   "data": [
      {
         "asset_id": "4567m474974987479856456457",
         "status": "published"
      }
   ]
})
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

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

print(response.text)

200

// Fetched all publishing metadata associated with the publishing event
{
  "data": [
    {
      "id": "5ebcd5644967474414564",
      "asset_id": "4567m74974987479856456456",
      "asset_type": "article",
      "status": "published",
      "status_message": "This asset is in review",
      "locale": "en",
      "public_url": "https://example.com/test",
      "publishing_destination_updated_at": "2019-10-06T13:15:30Z",
      "links": {
        "self": "https://api.cmp.optimizely.com/v3/publishing-events/1d9d8aeca10811ebbc640242ac12001b/assets/1d9d8aeca10811ebbc640242ac12003c/publishing-metadata/5ebcd5644967474414564",
        "publishing_event": "https://api.cmp.optimizely.com/v3/publishing-events/1d9d8aeca10811ebbc640242ac12001b",
        "asset": "https://api.cmp.optimizely.com/v3/articles/4567m474974987479856456456"
      }
    }
  ],
  "errors": [
    {
      "error_code": "canonical-link-error",
      "asset_id": "4567m474974987479856456457",
      "locale": "en",
      "message": "A canonical URL already exists for the task article '5e46456144645674564456'"
    }
  ]
}

400

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

401

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

403

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

404

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