Model: PublishingEventMetadataBulkCreateResponse

1 min

Model Parameters

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