CoreMedia Ingest Service API Reference

Last updated a month ago

Learn the features of the Ingest Service API

What you'll learn

Get an overview of the Ingest Service API features before you have a login

Prerequisites

Knowledge of CoreMedia Content Cloud

Time matters

Reading time: 10 to 15 minutes

Should I read this?

This guide is for Developers, Administrators.

The CoreMedia Ingest Service is a cloud-only service which enables you to develop your own importer-like applications for the CoreMedia Content Cloud.

It offers an API with basic methods to create and modify content items. In addition, the content lifecycle is supported with bulk publish, withdraw and delete methods.

Authentication

All API calls need to be authenticated using a JSON Web Token (JWT), see https://jwt.io/introduction/. When the Ingest Service is enabled for your cloud environment, you can request access tokens from the CoreMedia Support.

Endpoints

Blob

The BLOB API provides methods for creating server side Binary Large Objects (BLOB). This API is the preferred way of uploading binary data when creating or modifying CoreMedia documents with BLOB properties.

createTempBlob

POST /blobs

Create a temporary server side BLOB

Description

Create a temporary server side BLOB by streaming the binary data to the service endpoint. This is the preferred method when creating CoreMedia documents containing BLOB properties.

The property model returned in the response can be passed directly in a following service call to create or update a document. By default, the temporary BLOB can be accessed up to 10 minutes after creation. After that period, it will be discarded.

This call streams the binary data directly, so it is not possible to use the 'Try it out' function of the Swagger UI.

Parameters

Header Parameters

Name

Description

Required

Default

Pattern

Content-Type

The content type of the binary data. It must be assignable to the BLOB property’s MIME-Type.

null

Content-Length

The length of the binary data in bytes

null

Query Parameters

Name

Description

Required

Default

Pattern

contentTypeName

The name of the CoreMedia content type for which the BLOB is created

null

propertyName

The name of the property for which the BLOB is created

null

preferTikaDetection

Prefer Tika detected MIME type over supplied MIME type

null

cleanContentType

Remove parameters not specified by IANA registration from certain MIME types

null

Return Type

TempBlobPropertyResponse

Content Type

application/json

Responses

Table 1. HTTP Response Codes
Code	Message	Datatype
201	Result model containing the created temporary BLOB property model	TempBlobPropertyResponse
400	The request or its input data is invalid. Examples include invalid names, referring to nonexistent content or property types or invalid property values. Refer to the error items for detailed information.	ErrorResponse
401	The request is missing a valid authentication	ErrorResponse
403	The user is missing the necessary authorization to perform the operation on the requested content item	ErrorResponse
500	An error was encountered while processing the request. Refer to the error items for detailed information.	ErrorResponse

Content

The Content API provides all methods for reading, creating and updating content items.

getContents

GET /content

Get the content at the given repository path

Description

Looks up and returns the content found at the given repository path.
This method currently requires the path filter condition and always returns a collection with a single item.

Parameters

Query Parameters

Name

Description

Required

Default

Pattern

path

The content’s repository path

null

Return Type

ContentDataListReadResponse

Content Type

application/json

Responses

Table 2. HTTP Response Codes
Code	Message	Datatype
200	Response model with the singleton content item found at the given repository path	ContentDataListReadResponse
400	The request or its input data is invalid. Examples include invalid names, referring to nonexistent content or property types or invalid property values. Refer to the error items for detailed information.	ErrorResponse
401	The request is missing a valid authentication	ErrorResponse
403	The user is missing the necessary authorization to perform the operation on the requested content item	ErrorResponse
500	An error was encountered while processing the request. Refer to the error items for detailed information.	ErrorResponse

addContent

POST /content

Create a new content

Description

Creates a new content from the given model.
Since the CMS version 2210.1 the creation of a content with specified UUID is supported.
Missing folders in the target path are created automatically.

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

ContentDataInput

ContentDataInput

Return Type

ContentDataWriteResponse

Content Type

application/json

Responses

Table 3. HTTP Response Codes
Code	Message	Datatype
201	Response model with the created content	ContentDataWriteResponse
400	The request or its input data is invalid. Examples include invalid names, referring to nonexistent content or property types or invalid property values. Refer to the error items for detailed information.	ErrorResponse
401	The request is missing a valid authentication	ErrorResponse
403	The user is missing the necessary authorization to perform the operation on the requested content item	ErrorResponse
409	The requested operation conflicts with an existing resource. Refer to the error items for detailed information.	ErrorResponse
500	An error was encountered while processing the request. Refer to the error items for detailed information.	ErrorResponse

getContent

GET /content/{id}

Get the content with the given ID

Description

Looks up and returns the content with the given ID

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

The content’s numeric ID

null

Return Type

ContentDataReadResponse

Content Type

application/json

Responses

Table 4. HTTP Response Codes
Code	Message	Datatype
200	Response model with the found content	ContentDataReadResponse
401	The request is missing a valid authentication	ErrorResponse
403	The user is missing the necessary authorization to perform the operation on the requested content item	ErrorResponse
404	The requested resource was not found. Refer to the error items for detailed information.	ErrorResponse
500	An error was encountered while processing the request. Refer to the error items for detailed information.	ErrorResponse

getContent

GET /content/{uuid}

Get the content with the given UUID

Description

Looks up and returns the content with the given UUID

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

The content’s UUID

null

Return Type

ContentDataReadResponse

Content Type

application/json

Responses

Table 5. HTTP Response Codes
Code	Message	Datatype
200	Response model with the found content	ContentDataReadResponse
401	The request is missing a valid authentication	ErrorResponse
403	The user is missing the necessary authorization to perform the operation on the requested content item	ErrorResponse
404	The requested resource was not found. Refer to the error items for detailed information.	ErrorResponse
500	An error was encountered while processing the request. Refer to the error items for detailed information.	ErrorResponse

updateContent

PATCH /content/{id}

Update the content with the given ID

Description

Looks up the content with the given ID and updates its properties from the properties of the input model.
The passed in property set does not have to be complete, partial updates are possible. If the content is checked-out, it will be checked in first, before applying the updates.

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

The content’s numeric ID

null

Body Parameter

Name

Description

Required

Default

Pattern

ContentDataInput

ContentDataInput

Return Type

ContentDataWriteResponse

Content Type

application/json

Responses

Table 6. HTTP Response Codes
Code	Message	Datatype
200	Response model with the updated content	ContentDataWriteResponse
400	The request or its input data is invalid. Examples include invalid names, referring to nonexistent content or property types or invalid property values. Refer to the error items for detailed information.	ErrorResponse
401	The request is missing a valid authentication	ErrorResponse
403	The user is missing the necessary authorization to perform the operation on the requested content item	ErrorResponse
404	The requested resource was not found. Refer to the error items for detailed information.	ErrorResponse
500	An error was encountered while processing the request. Refer to the error items for detailed information.	ErrorResponse

getBlobData

GET /content/{id}/properties/{propertyName}/data

Get the raw BLOB data from the content with the given ID and property name

Description

Looks up the content with the given ID and returns the raw BLOB data from the property with the given name

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

The content’s numeric ID

null

propertyName

The name of content’s BLOB property

null

Return Type

[File]

Content Type

Responses

Table 7. HTTP Response Codes
Code	Message	Datatype
200	A raw binary stream of the BLOB’s data	[File]
400	The request or its input data is invalid. Examples include invalid names, referring to nonexistent content or property types or invalid property values. Refer to the error items for detailed information.	ErrorResponse
401	The request is missing a valid authentication	ErrorResponse
403	The user is missing the necessary authorization to perform the operation on the requested content item	ErrorResponse
404	The requested resource was not found. Refer to the error items for detailed information.	ErrorResponse
500	An error was encountered while processing the request. Refer to the error items for detailed information.	ErrorResponse

postBlobData

POST /content/{id}/properties/{propertyName}/data

Update a content’s BLOB property

Description

Looks up the content with the given ID and updates the BLOB property with the given name with the data streamed in the request body.
If the content is checked-out, it will be checked in first, before applying the update.

This call streams the binary data directly, so it is not possible to use the 'Try it out' function of the Swagger UI.

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

The content’s numeric ID

null

propertyName

The name of the content’s BLOB property

null

Header Parameters

Name

Description

Required

Default

Pattern

Content-Type

The content type of the binary data. It must be assignable to the property’s MIME-Type.

null

Content-Length

The length of the binary data in bytes

null

Query Parameters

Name

Description

Required

Default

Pattern

preferTikaDetection

Prefer Tika detected MIME type over supplied MIME type

null

cleanContentType

Remove parameters not specified by IANA registration from certain MIME types

null

Return Type

ServerBlobPropertyResponse

Content Type

application/json

Responses

Table 8. HTTP Response Codes
Code	Message	Datatype
200	Result model containing the updated server side BLOB property model	ServerBlobPropertyResponse
400	The request or its input data is invalid. Examples include invalid names, referring to nonexistent content or property types or invalid property values. Refer to the error items for detailed information.	ErrorResponse
401	The request is missing a valid authentication	ErrorResponse
403	The user is missing the necessary authorization to perform the operation on the requested content item	ErrorResponse
404	The requested resource was not found. Refer to the error items for detailed information.	ErrorResponse
500	An error was encountered while processing the request. Refer to the error items for detailed information.	ErrorResponse

Repository

The Repository API provides bulk operations to handle the content lifecycle of CoreMedia content. It supports synchronous and asynchronous operation.

publishAll

POST /repository/publish-all

Publish the given set of content items

Description

Publishes the given set of content items in one bulk operation.
The latest version and the place of each item is approved before publication. Additionally, the folders up to the root are place approved and published for each item if needed. If an item is a folder, the operation is applied recursively to all children.
The bulk operation is not executed in one transaction. If the operation fails, content items might be in an intermediate state, for example fully approved but not published yet. In this case, check the result’s error messages for detailed information.

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

ContentIdList

ContentIdList

Return Type

BulkResultResponse

Content Type

application/json

Responses

Table 9. HTTP Response Codes
Code	Message	Datatype
200	The bulk operation result. A result code of 200 does not imply a successfully executed operation. For this, check the successful flag of the result.	BulkResultResponse
400	The request or its input data is invalid. Examples include invalid names, referring to nonexistent content or property types or invalid property values. Refer to the error items for detailed information.	ErrorResponse
401	The request is missing a valid authentication	ErrorResponse
403	The user is missing the necessary authorization to perform the operation on the requested content item	ErrorResponse
429	The request cannot be processed due to capacity limits. This can happen if you request bulk updates and all internal workers are busy and job queues are full. In such a case, clients should wait for a short moment and retry the operation.	ErrorResponse
500	An error was encountered while processing the request. Refer to the error items for detailed information.	ErrorResponse

withdrawAll

POST /repository/withdraw-all

Withdraw (unpublish) the given set of content items

Description

Withdraws the given set of content items in one bulk operation.
On each item the withdrawal flag is set and its place is approved before unpublication. If an item is a folder, the operation is applied recursively to all children.
The bulk operation is not executed in one transaction. If the operation fails, content items might be in an intermediate state, for example having the withdrawal flag set but not unpublished yet. In this case, check the result’s error messages for detailed information.

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

ContentIdList

ContentIdList

Return Type

BulkResultResponse

Content Type

application/json

Responses

Table 10. HTTP Response Codes
Code	Message	Datatype
200	The bulk operation result. A result code of 200 does not imply a successfully executed operation. For this, check the successful flag of the result.	BulkResultResponse
400	The request or its input data is invalid. Examples include invalid names, referring to nonexistent content or property types or invalid property values. Refer to the error items for detailed information.	ErrorResponse
401	The request is missing a valid authentication	ErrorResponse
403	The user is missing the necessary authorization to perform the operation on the requested content item	ErrorResponse
429	The request cannot be processed due to capacity limits. This can happen if you request bulk updates and all internal workers are busy and job queues are full. In such a case, clients should wait for a short moment and retry the operation.	ErrorResponse
500	An error was encountered while processing the request. Refer to the error items for detailed information.	ErrorResponse

deleteAll

POST /repository/delete-all

Delete the given set of content items

Description

Unpublishes and moves the given set of content items to the recycle bin in one bulk operation.
On each item the withdrawal flag is set and its place is approved before unpublication. After unpublication, all items are moved to the recycle bin. If an item is a folder, the operation is applied recursively to all children.
The bulk operation is not executed in one transaction. If the operation fails, content items might be in an intermediate state, for example having the withdrawal flag set but not deleted yet. In this case, check the result’s error messages for detailed information.

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

ContentIdList

ContentIdList

Return Type

BulkResultResponse

Content Type

application/json

Responses

Table 11. HTTP Response Codes
Code	Message	Datatype
200	The bulk operation result. A result code of 200 does not imply a successfully executed operation. For this, check the successful flag of the result.	BulkResultResponse
400	The request or its input data is invalid. Examples include invalid names, referring to nonexistent content or property types or invalid property values. Refer to the error items for detailed information.	ErrorResponse
401	The request is missing a valid authentication	ErrorResponse
403	The user is missing the necessary authorization to perform the operation on the requested content item	ErrorResponse
429	The request cannot be processed due to capacity limits. This can happen if you request bulk updates and all internal workers are busy and job queues are full. In such a case clients should wait for a short moment and retry the operation.	ErrorResponse
500	An error was encountered while processing the request. Refer to the error items for detailed information.	ErrorResponse

publishAllAsync

POST /repository/publish-all-async

Publish the given set of content items asynchronously

Description

Publishes the given set of content items in one asynchronous bulk operation.
The latest version and the place of each item is approved before publication. Additionally, the folders up to the root are place approved and published for each item if needed. If an item is a folder, the operation is applied recursively to all children.
The bulk operation is not executed in one transaction. If the operation fails, content items might be in an intermediate state, for example fully approved but not published yet.
This call returns the initial state upon scheduling the operation. Updates can be fetched by using the returned ID from the initial state (see method /jobs/{id}).

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

ContentIdList

ContentIdList

Return Type

AsyncJobResultResponse

Content Type

application/json

Responses

Table 12. HTTP Response Codes
Code	Message	Datatype
202	The initial state of the asynchronous bulk operation	AsyncJobResultResponse
400	The request or its input data is invalid. Examples include invalid names, referring to nonexistent content or property types or invalid property values. Refer to the error items for detailed information.	ErrorResponse
401	The request is missing a valid authentication	ErrorResponse
403	The user is missing the necessary authorization to perform the operation on the requested content item	ErrorResponse
429	The request cannot be processed due to capacity limits. This can happen if you request bulk updates and all internal workers are busy and job queues are full. In such a case clients should wait for a short moment and retry the operation.	ErrorResponse
500	An error was encountered while processing the request. Refer to the error items for detailed information.	ErrorResponse

withdrawAllAsync

POST /repository/withdraw-all-async

Withdraw (unpublish) the given set of content items asynchronously

Description

Withdraws the given set of content items in one asynchronous bulk operation.
On each item the withdrawal flag is set and its place is approved before unpublication. If an item is a folder, the operation is applied recursively to all children.
The bulk operation is not executed in one transaction. If the operation fails, content items might be in an intermediate state, for example having the withdrawal flag set but not unpublished yet.
This call returns the initial state upon scheduling the operation. Updates can be fetched by using the returned ID from the initial state (see method /jobs/{id}).

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

ContentIdList

ContentIdList

Return Type

AsyncJobResultResponse

Content Type

application/json

Responses

Table 13. HTTP Response Codes
Code	Message	Datatype
202	The initial state of the asynchronous bulk operation	AsyncJobResultResponse
400	The request or its input data is invalid. Examples include invalid names, referring to nonexistent content or property types or invalid property values. Refer to the error items for detailed information.	ErrorResponse
401	The request is missing a valid authentication	ErrorResponse
403	The user is missing the necessary authorization to perform the operation on the requested content item	ErrorResponse
429	The request cannot be processed due to capacity limits. This can happen if you request bulk updates and all internal workers are busy and job queues are full. In such a case clients should wait for a short moment and retry the operation.	ErrorResponse
500	An error was encountered while processing the request. Refer to the error items for detailed information.	ErrorResponse

deleteAllAsync

POST /repository/delete-all-async

Delete the given set of content items asynchronously

Description

Unpublishes and moves the given set of content items to the recycle bin in one asynchronous bulk operation.
On each item the withdrawal flag is set and its place is approved before unpublication. After unpublication, all items are moved to the recycle bin. If an item is a folder, the operation is applied recursively to all children.
The bulk operation is not executed in one transaction. If the operation fails, content items might be in an intermediate state, for example having the withdrawal flag set but not deleted yet.
This call returns the initial state upon scheduling the operation. Updates can be fetched by using the returned ID from the initial state (see method /jobs/{id}).

Parameters

Body Parameter

Name

Description

Required

Default

Pattern

ContentIdList

ContentIdList

Return Type

AsyncJobResultResponse

Content Type

application/json

Responses

Table 14. HTTP Response Codes
Code	Message	Datatype
202	The initial state of the asynchronous bulk operation	AsyncJobResultResponse
400	The request or its input data is invalid. Examples include invalid names, referring to nonexistent content or property types or invalid property values. Refer to the error items for detailed information.	ErrorResponse
401	The request is missing a valid authentication	ErrorResponse
403	The user is missing the necessary authorization to perform the operation on the requested content item	ErrorResponse
429	The request cannot be processed due to capacity limits. This can happen if you request bulk updates and all internal workers are busy and job queues are full. In such a case clients should wait for a short moment and retry the operation.	ErrorResponse
500	An error was encountered while processing the request. Refer to the error items for detailed information.	ErrorResponse

getAsyncJob

GET /repository/jobs/{id}

Get the state of the asynchronous bulk operation with the given ID

Description

Returns the state of the bulk operation with the given ID.
The state can be fetched up to 10 minutes after - successful or failed - completion of the bulk operation. After that period, the state will be discarded.
Once completed without an unexpected error the state contains a result object which can be inspected in the same way as the result object from a synchronous call.

Parameters

Path Parameters

Name

Description

Required

Default

Pattern

The ID of the asynchronous job

null

Return Type

AsyncJobResultResponse

Content Type

application/json

Responses

Table 15. HTTP Response Codes
Code	Message	Datatype
200	The state of the requested asynchronous bulk operation	AsyncJobResultResponse
401	The request is missing a valid authentication	ErrorResponse
403	The user is missing the necessary authorization to perform the operation on the requested content item	ErrorResponse
410	The requested resource is not available anymore. Refer to the error items for detailed information.	ErrorResponse
500	An error was encountered while processing the request. Refer to the error items for detailed information.	ErrorResponse

Models

ActionResultItem

Result of an action on a single content item during an Ingest Service bulk operation

Field Name

Required

Type

Description

Format

type

String

Type discriminator

Enum: ActionResultItem,

stage

String

The current stage when the item result was created

Enum: CHECK_RIGHTS, MARK_WITHDRAW, APPROVE_LATEST_VERSION, APPROVE_PLACE, PUBLISH, DELETE,

params

List of String

code

String

The item’s result code

Enum: CONTENT_ERROR, UNEXPECTED_ERROR, INSUFFICIENT_RIGHTS, CONTENT_IS_DELETED, CONTENT_IS_CHECKED_OUT, NO_APPROVE_RIGHT, NO_APPROVE_RIGHT_IN_PATH, NO_DELETE_RIGHT, NO_DELETE_RIGHT_IN_PATH, NO_PUBLISH_RIGHT, PUBLICATION_FAILED_EXCEPTION, PUBLICATION_EXCEPTION, BULK_OPERATION_FAILED, BULK_OPERATION_CONTENT_ERROR,

AsyncJobResult

Execution state of an asynchronous bulk operation.
The initial state is returned when calling the asynchronous repository method. It can be refreshed up to 10 minutes after the execution of the bulk operation finished (successfully or unsuccessfully).

Field Name

Required

Type

Description

Format

UUID

The job’s unique ID

uuid

type

String

The bulk operation’s type

Enum: PUBLICATION, WITHDRAWAL, DELETION,

scheduledAt

String

The date and time the bulk operation was scheduled for execution.
Date format is ISO-8601 with an additional zone ID.

startedAt

String

The time and date the bulk operation’s execution started.
Date format is ISO-8601 with an additional zone ID.

finishedAt

String

The time and date the bulk operation’s execution finished (successfully or due to an error or cancellation).
Date format is ISO-8601 with an additional zone ID.

state

String

The bulk operation’s current state

Enum: SCHEDULED, RUNNING, FINISHED, FAILED, CANCELLED,

bulkResult

BulkResult

errors

List of ErrorItem

The encountered errors if the bulk operation terminated abnormally

AsyncJobResultResponse

Response model for the state of an asynchronous bulk operation

Field Name

Required

Type

Description

Format

data

AsyncJobResult

BulkActionResultItem

Result of an Unified API bulk operation on a single content item during an Ingest Service bulk operation

Field Name Required Type Description Format

type

String

Type discriminator

Enum: BulkActionResultItem,

stage

String

The current stage when the item result was created

Enum: CHECK_RIGHTS, MARK_WITHDRAW, APPROVE_LATEST_VERSION, APPROVE_PLACE, PUBLISH, DELETE,

params

List of String

code

String

The item’s result code.
The code is mapped from its Unified API counterpart: com.coremedia.cap.content. results.BulkOperationResultItem

Enum: UNKNOWN, OK, NOOP, NOT_PUBLISHED, ALREADY_PUBLISHED, CHECKED_OUT, DELETED, FAILED, NOT_AUTHORIZED, UNPROCESSED_CHILD, PARENT_DELETED, TO_BE_DELETED, DUPLICATE_NAME, INVALID_NAME, WIDE_LINK,

BulkResult

Result model for a bulk operation.

If the bulk operation executed Unified API bulk operations or publications, the model contains detailed information about the actions taken on each content item.

Field Name

Required

Type

Description

Format

successful

Boolean

Indicates weather the bulk operation as a whole was successful

scheduledAt

String

The date and time the bulk operation was scheduled for execution.
Date format is ISO-8601 with an additional zone ID.

startedAt

String

The time and date the bulk operation’s execution started.
Date format is ISO-8601 with an additional zone ID.

finishedAt

String

The time and date the bulk operation’s execution finished (successfully or due to an error or cancellation).
Date format is ISO-8601 with an additional zone ID.

stageInfos

List of StageInfo

errors

List of ResultItem

warnings

List of ResultItem

info

List of ResultItem

BulkResultResponse

Response model for the result of a synchronous bulk operation

Field Name

Required

Type

Description

Format

data

BulkResult

ContentData

Model object for a content

Field Name

Required

Type

Description

Format

String

The content’s unique identifier

uuid

UUID

The content’s UUID

uuid

path

String

The content’s repository path.
Ignored when updating content.

type

String

The content’s type name.
Ignored when updating content.

links

Map

Map of content’s links. Currently, there are children, references and referrers.
Ignored when updating content.

lifeCycleStatus

String

The content’s current state in the simplified editorial lifecycle for Studio users

Enum: DELETED, APPROVED, PUBLISHED, IN_PRODUCTION,

creationDate

String

The content’s creation date.
Date format is ISO-8601 with an additional zone ID.

modificationDate

String

The content’s last modification date.
Date format is ISO-8601 with an additional zone ID.

editionDate

String

The date the content’s properties were last saved.
Date format is ISO-8601 with an additional zone ID.

publicationDate

String

The date the content was published.
Date format is ISO-8601 with an additional zone ID.

children

List of ContentRefData

The content’s children.
Always empty except for folders.

properties

Map of Property

The content’s properties.
Always empty for folders.

inProduction

Boolean

A flag indicating if the content is neither deleted nor destroyed

published

Boolean

A flag indicating if the content is published (exists on the live side)

ContentDataInput

The input model for creating new content or updating content.
This is actually the same as ContentData and only required for the Swagger UI to add meaningful examples.

Field Name

Required

Type

Description

Format

uuid

UUID

The content’s UUID.
Supported since the CMS version 2210.1 when creating content.
Ignored when updating content or the version is older than CMS 2210.1.

uuid

path

String

The content’s repository path.
Ignored when updating content.

type

String

The content’s type name.
Ignored when updating content.

properties

Map of Property

The content’s properties.
Always empty for folders.

ContentDataListReadResponse

Response model for a list of content items

Field Name

Required

Type

Description

Format

data

List of ContentData

ContentDataReadResponse

Response model for a content

Field Name

Required

Type

Description

Format

data

ContentData

ContentDataWriteResponse

Response model for a content

Field Name

Required

Type

Description

Format

data

ContentData

warnings

List of WarningItem

ContentIdList

The IDs of the content items to delete

Field Name

Required

Type

Description

Format

ids

List of String

ContentRefData

Model object for a content reference

Field Name

Required

Type

Description

Format

String

The content’s unique identifier

uuid

UUID

The content’s UUID

uuid

path

String

The content’s repository path

type

String

The content’s type name

DateProperty

Property model holding a date value

Field Name

Required

Type

Description

Format

type

String

Type discriminator

Enum: Date,

value

String

The date value as string.
Date format is ISO-8601 with an additional zone ID.

ErrorItem

Error information

Field Name

Required

Type

Description

Format

code

String

The error code

message

String

The error message

ErrorResponse

Generic error response

Field Name

Required

Type

Description

Format

errors

List of ErrorItem

IntegerProperty

Property model holding an integer value

Field Name

Required

Type

Description

Format

type

String

Type discriminator

Enum: Integer,

value

Integer

The integer value

int32

LinklistProperty

Property model holding a list of content references

Field Name

Required

Type

Description

Format

type

String

Type discriminator

Enum: Linklist,

references

List of ContentRefData

MarkupProperty

Property model holding a markup string

Field Name

Required

Type

Description

Format

type

String

Type discriminator

Enum: Markup,

value

String

The markup value as string

failOnError

Boolean

If set to 'true', markup which is invalid against the property type’s grammar will cause an error when creating or updating content

skipOnUnresolvableGrammar

Boolean

If set to 'true', markup validation will be skipped if the property type’s grammar cannot be accessed by the ingest service (which currently is the case for all customer defined grammars)

Property

Abstract parent of property models.
The following types are the concrete subtypes:

DateProperty
IntegerProperty
LinklistProperty
MarkupProperty
ServerBlobProperty
StringProperty
StructProperty
TempBlobProperty
UrlBlobProperty

Field Name

Required

Type

Description

Format

type

String

Type discriminator for subtypes

Enum: Date, Integer, Linklist, Markup, ServerBlob, String, Struct, TempBlob, UrlBlob,

PublicationActionResultItem

Result of a Unified API publication action on a single content item during an Ingest Service bulk operation

Field Name Required Type Description Format

type

String

Type discriminator

Enum: PublicationActionResultItem,

stage

String

The current stage when the item result was created

Enum: CHECK_RIGHTS, MARK_WITHDRAW, APPROVE_LATEST_VERSION, APPROVE_PLACE, PUBLISH, DELETE,

params

List of String

code

String

The item’s result code.
The code is mapped from its Unified API counterpart: com.coremedia.cap.content.publication .results.PublicationResultItem

Enum: UNKNOWN, NOOP, VERSION_PUBLISHED, CREATED, MOVED, DELETED, WITHDRAWN, ALREADY_PUBLISHED, LATER_VERSION, DOES_NOT_EXIST, PLACE_NOT_APPROVED, VERSION_NOT_APPROVED, SELECT_VERSION, NO_APPROVED_VERSION, ALREADY_DELETED, LINK_FAILED, CREATE_PARENT_FAILED, TARGET_NAME_CONFLICT, NAME_CHANGED, NO_RIGHT_TO_PUBLISH, CANNOT_WITHDRAW_BECAUSE_OF_LINK, CANNOT_PUBLISH_DELETED, ORPHANED, MUST_DELETE_CHILD, NOT_BELOW_BASE_FOLDER,

ResultItem

Abstract parent of bulk operation result items.
The following types are the concrete subtypes:

ActionResultItem
BulkActionResultItem
PublicationActionResultItem

Field Name

Required

Type

Description

Format

type

String

Type discriminator for subtypes

Enum: ActionResultItem, BulkActionResultItem, PublicationActionResultItem,

stage

String

The current stage when the item result was created

Enum: CHECK_RIGHTS, MARK_WITHDRAW, APPROVE_LATEST_VERSION, APPROVE_PLACE, PUBLISH, DELETE,

params

List of String

ServerBlobProperty

Property model holding the attributes of a server side BLOB.
Only valid as a response - cannot be used for creating or updating content items.

Field Name

Required

Type

Description

Format

type

String

Type discriminator

Enum: ServerBlob,

url

String

The URL to retrieve the BLOB’s binary data.
This URL references the Ingest Service.

mimeType

String

The BLOB’s MIME-Type

size

Integer

The BLOB’s size

int32

etag

String

The BLOB’s unique hash

ServerBlobPropertyResponse

Response model for an updated BLOB

Field Name

Required

Type

Description

Format

data

ServerBlobProperty

warnings

List of WarningItem

StageInfo

Model for the different stages executed during a bulk operation.
For a publication these are:

CHECK_RIGHTS
APPROVE_LATEST_VERSION
APPROVE_PLACE
PUBLISH

For a withdrawal these are:

CHECK_RIGHTS
MARK_WITHDRAW
APPROVE_PLACE
PUBLISH

For a deletion these are:

CHECK_RIGHTS
MARK_WITHDRAW
APPROVE_PLACE
PUBLISH
DELETE

Field Name

Required

Type

Description

Format

stage

String

The name of the stage

Enum: CHECK_RIGHTS, MARK_WITHDRAW, APPROVE_LATEST_VERSION, APPROVE_PLACE, PUBLISH, DELETE,

startedAt

String

The date and time the stage was started.
Date format is ISO-8601 with an additional zone ID.

StringProperty

Property model holding a string value

Field Name

Required

Type

Description

Format

type

String

Type discriminator

Enum: String,

value

String

The string value

StructProperty

Property model holding a struct markup string

Field Name

Required

Type

Description

Format

type

String

Type discriminator

Enum: Struct,

value

String

The struct value as string

TempBlobProperty

Property model holding the attributes of a temporary server side BLOB

Field Name

Required

Type

Description

Format

type

String

Type discriminator

Enum: TempBlob,

String

The BLOB’s unique ID

mimeType

String

The BLOB’s MIME-Type

size

Integer

The BLOB’s size

int32

TempBlobPropertyResponse

Response model for a created temporary server side BLOB

Field Name

Required

Type

Description

Format

data

TempBlobProperty

warnings

List of WarningItem

UrlBlobProperty

Property model holding the attributes of an URL BLOB.
URL BLOB’s are used in two different cases:

Ingesting binary data via a URL reference.
Reading a persistent URL BLOB from the Content Server.

Field Name

Required

Type

Description

Format

type

String

Type discriminator

Enum: UrlBlob,

url

String

The BLOB’s URL.
If passed to the Ingest Service when creating or updating a content and the BLOB is not marked as persistent, the BLOB’s binary data will be read from the URL and written to the CoreMedia Content Server. For this to work, the URL must not be protected by any user authentication scheme.

mimeType

String

The BLOB’s MIME-Type.
If missing on create or update operations, the 'Content-Type' header of the URL stream will be used.

size

Integer

The BLOB’s size.
If missing on create or update operations, the 'Content-Size' header of the URL stream will be used.

int32

preferTikaDetection

Boolean

If set to 'true', the MIME type returned by Tika will override any value explicitly specified or extracted from the URL stream

cleanMimeType

Boolean

By default parameters are sanitized for a limited number of MIME types.
Setting this value to 'false' will disable this behaviour. Be aware that a BLOB with parameters not specified in the IANA registration my cause errors with services processing this BLOB, i.e. image transformation.

persistent

Boolean

Flag if the BLOB’s data URL is persistent.
If the URL is persistent, the CoreMedia Content Server does not store the binary data itself but only the URL. If required, the binary data is read from the stored URL on demand.
A URL used in this way must not be protected by any user authentication scheme.
In most environments the use of persistent URLs is restricted.

WarningItem

Warning information

Field Name

Required

Type

Description

Format

code

String

The warning code

message

String

The warning message

Is this page useful?