Tagging

Get the Tags applied to a Content Fragment Model

SecuritybearerAuth
Request
path Parameters
id
required
string (Base64URLId) non-empty

The ID of the Content Fragment Model.

Responses
200

A successful response that returns the list of tags.

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

get/cf/models/{id}/tags
Request samples
Response samples
application/json
{
  • "items": [
    ]
}

Add Tags to a Content Fragment Model

This operation adds new tags to an existing Content Fragment Model. The tags must be already available in the system when this request is made.

SecuritybearerAuth
Request
path Parameters
id
required
string (Base64URLId) non-empty

The ID of the Content Fragment Model.

Request Body schema: application/json
required
tags
required
Array of strings (TagId) non-empty

List of tag IDs to be added to the Content Fragment

Responses
200

A successful response that returns the list of tags.

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

415

Unsupported Media Type. Indicates that the origin server is refusing to service the request because the content is in a format not supported by this method on the target resource.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

post/cf/models/{id}/tags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Replace the Tags applied to a Content Fragment Model

This operation updates all tags of an existing Content Fragment Model by replacing the existing tags with tags based on the details from the payload. The tags must be already available in the system when this request is made.

SecuritybearerAuth
Request
path Parameters
id
required
string (Base64URLId) non-empty

The ID of the Content Fragment Model.

header Parameters
If-Match
required
string

The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.

For more details, please head over to RFC9110.

Request Body schema: application/json
required
tags
required
Array of strings (TagId) non-empty

List of tag IDs to be added to the Content Fragment

Responses
200

A successful response that returns the list of tags.

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

412

Precondition Failed. Indicates that one or more conditions given in the request header fields evaluated to false when tested on the server.

415

Unsupported Media Type. Indicates that the origin server is refusing to service the request because the content is in a format not supported by this method on the target resource.

428

Precondition Required. Indicates that the origin server requires the request to be conditional.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

put/cf/models/{id}/tags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Delete the Tags applied to a Content Fragment Model

SecuritybearerAuth
Request
path Parameters
id
required
string (Base64URLId) non-empty

The ID of the Content Fragment Model.

header Parameters
If-Match
required
string

The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.

For more details, please head over to RFC9110.

Responses
204

No Content

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

412

Precondition Failed. Indicates that one or more conditions given in the request header fields evaluated to false when tested on the server.

428

Precondition Required. Indicates that the origin server requires the request to be conditional.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

delete/cf/models/{id}/tags
Request samples
Response samples
application/problem+json
{}

Get the Tags applied to a Content Fragment

SecuritybearerAuth
Request
path Parameters
fragmentId
required
string <uuid> (UUID)

Content Fragment unique identifier

Example: 49af775d-0e7a-46c3-913d-00f762528373
Responses
200

A successful response that returns the list of tags.

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

get/cf/fragments/{fragmentId}/tags
Request samples
Response samples
application/json
{
  • "items": [
    ]
}

Add tags to a Content Fragment

This operation adds new tags to an existing Content Fragment. The tags must be already available in the system when this request is made.

SecuritybearerAuth
Request
path Parameters
fragmentId
required
string <uuid> (UUID)

Content Fragment unique identifier

Example: 49af775d-0e7a-46c3-913d-00f762528373
Request Body schema: application/json
required
tags
required
Array of strings (TagId) non-empty

List of tag IDs to be added to the Content Fragment

Responses
200

A successful response that returns the list of tags.

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

415

Unsupported Media Type. Indicates that the origin server is refusing to service the request because the content is in a format not supported by this method on the target resource.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

post/cf/fragments/{fragmentId}/tags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Replace the Tags applied to a Content Fragment

This operation updates all tags of an existing Content Fragment by replacing the existing tags with tags based on the details from the payload. The tags must be already available in the system when this request is made.

SecuritybearerAuth
Request
path Parameters
fragmentId
required
string <uuid> (UUID)

Content Fragment unique identifier

Example: 49af775d-0e7a-46c3-913d-00f762528373
header Parameters
If-Match
required
string

The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.

For more details, please head over to RFC9110.

Request Body schema: application/json
required
tags
required
Array of strings (TagId) non-empty

List of tag IDs to be added to the Content Fragment

Responses
200

A successful response that returns the list of tags.

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

412

Precondition Failed. Indicates that one or more conditions given in the request header fields evaluated to false when tested on the server.

415

Unsupported Media Type. Indicates that the origin server is refusing to service the request because the content is in a format not supported by this method on the target resource.

428

Precondition Required. Indicates that the origin server requires the request to be conditional.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

put/cf/fragments/{fragmentId}/tags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Delete the Tags applied to a Content Fragment

SecuritybearerAuth
Request
path Parameters
fragmentId
required
string <uuid> (UUID)

Content Fragment unique identifier

Example: 49af775d-0e7a-46c3-913d-00f762528373
header Parameters
If-Match
required
string

The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.

For more details, please head over to RFC9110.

Responses
204

No Content

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

412

Precondition Failed. Indicates that one or more conditions given in the request header fields evaluated to false when tested on the server.

428

Precondition Required. Indicates that the origin server requires the request to be conditional.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

delete/cf/fragments/{fragmentId}/tags
Request samples
Response samples
application/problem+json
{}

Get the Tags applied to a Content Fragment Variation

SecuritybearerAuth
Request
path Parameters
fragmentId
required
string <uuid> (UUID)

Content Fragment unique identifier

Example: 49af775d-0e7a-46c3-913d-00f762528373
name
required
string

The name of the variation for which the tags are retrieved.

Responses
200

A successful response that returns the list of tags.

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

get/cf/fragments/{fragmentId}/variations/{name}/tags
Request samples
Response samples
application/json
{
  • "items": [
    ]
}

Add Tags to a Content Fragment Variation

SecuritybearerAuth
Request
path Parameters
fragmentId
required
string <uuid> (UUID)

Content Fragment unique identifier

Example: 49af775d-0e7a-46c3-913d-00f762528373
name
required
string

The name of the variation for which the tags are retrieved.

Request Body schema: application/json
required
tags
required
Array of strings (TagId) non-empty

List of tag IDs to be added to the Content Fragment

Responses
200

A successful response that returns the list of tags.

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

415

Unsupported Media Type. Indicates that the origin server is refusing to service the request because the content is in a format not supported by this method on the target resource.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

post/cf/fragments/{fragmentId}/variations/{name}/tags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Replace the Tags applied to a Content Fragment Variation

This operation updates all tags of an existing Content Fragment Variation by replacing the existing tags with tags based on the details from the payload. The tags must be already available in the system when this request is made.

SecuritybearerAuth
Request
path Parameters
fragmentId
required
string <uuid> (UUID)

Content Fragment unique identifier

Example: 49af775d-0e7a-46c3-913d-00f762528373
name
required
string

The name of the variation for which the tags are retrieved.

header Parameters
If-Match
required
string

The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.

For more details, please head over to RFC9110.

Request Body schema: application/json
required
tags
required
Array of strings (TagId) non-empty

List of tag IDs to be added to the Content Fragment

Responses
200

A successful response that returns the list of tags.

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

406

Not Acceptable. Indicates that the target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request.

412

Precondition Failed. Indicates that one or more conditions given in the request header fields evaluated to false when tested on the server.

415

Unsupported Media Type. Indicates that the origin server is refusing to service the request because the content is in a format not supported by this method on the target resource.

428

Precondition Required. Indicates that the origin server requires the request to be conditional.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

put/cf/fragments/{fragmentId}/variations/{name}/tags
Request samples
application/json
{
  • "tags": [
    ]
}
Response samples
application/json
{
  • "items": [
    ]
}

Delete the Tags applied to a Content Fragment Variation

SecuritybearerAuth
Request
path Parameters
fragmentId
required
string <uuid> (UUID)

Content Fragment unique identifier

Example: 49af775d-0e7a-46c3-913d-00f762528373
name
required
string

The name of the variation for which the tags are retrieved.

header Parameters
If-Match
required
string

The If-Match header field makes the request method conditional on the recipient origin server either having at least one current representation of the target resource, when the field value is "*", or having a current representation of the target resource that has an entity tag matching a member of the list of entity tags provided in the field value.

For more details, please head over to RFC9110.

Responses
204

No Content

400

Bad Request. Indicates that the server cannot or will not process the request due to something that is perceived to be a client error. The Problem Details object will provide more information about the exact cause.

403

Forbidden. Indicates that the server understood the request but refuses to fulfil it.

404

Not Found. Indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists.

412

Precondition Failed. Indicates that one or more conditions given in the request header fields evaluated to false when tested on the server.

428

Precondition Required. Indicates that the origin server requires the request to be conditional.

500

Internal Server Error. Indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

delete/cf/fragments/{fragmentId}/variations/{name}/tags
Request samples
Response samples
application/problem+json
{}