Skip to content

Catalog API ​

The Catalog API manages collection settings: the named document and media folders that structure a store's content. A collection is a document-collection or a media-collection resource, with its key as the JSON:API id. Mount a catalog with buildJsonApi from contentia/catalog-api. Like every Contentia API server, it requires an access policy.

Every response carries Cache-Control: no-store.

Collections​

Catalog collection settings.


List all collections​

GET/collections

Responses​

All configured collections.

application/vnd.api+json
JSON
{
  
"data": [
  
  
{
  
  
  
"type": "document-collection",
  
  
  
"id": "string",
  
  
  
"attributes": {
  
  
  
  
"name": "string",
  
  
  
  
"directory": "string",
  
  
  
  
"recursive": true,
  
  
  
  
"format": "string",
  
  
  
  
"documentTitleKey": "string",
  
  
  
  
"documentDescriptionKey": "string",
  
  
  
  
"documentStatusKey": "string",
  
  
  
  
"unpublishedStatuses": {
  
  
  
  
  
"additionalProperties": {
  
  
  
  
  
  
"directory": "string",
  
  
  
  
  
  
"name": "string"
  
  
  
  
  
}
  
  
  
  
},
  
  
  
  
"revisionDirectory": "string",
  
  
  
  
"draftDirectory": "string",
  
  
  
  
"archiveDirectory": "string",
  
  
  
  
"trashDirectory": "string"
  
  
  
}
  
  
}
  
]
}

Samples​


Create a collection​

POST/collections

Writes the collection under data.id, replacing any existing collection with that key.

Request Body​

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "document-collection",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"name": "string",
  
  
  
"directory": "string",
  
  
  
"recursive": true,
  
  
  
"format": "string",
  
  
  
"documentTitleKey": "string",
  
  
  
"documentDescriptionKey": "string",
  
  
  
"documentStatusKey": "string",
  
  
  
"unpublishedStatuses": {
  
  
  
  
"additionalProperties": {
  
  
  
  
  
"directory": "string",
  
  
  
  
  
"name": "string"
  
  
  
  
}
  
  
  
},
  
  
  
"revisionDirectory": "string",
  
  
  
"draftDirectory": "string",
  
  
  
"archiveDirectory": "string",
  
  
  
"trashDirectory": "string"
  
  
}
  
}
}

Responses​

The submitted collection as decoded, echoed back; it is not read back from the settings provider.

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "document-collection",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"name": "string",
  
  
  
"directory": "string",
  
  
  
"recursive": true,
  
  
  
"format": "string",
  
  
  
"documentTitleKey": "string",
  
  
  
"documentDescriptionKey": "string",
  
  
  
"documentStatusKey": "string",
  
  
  
"unpublishedStatuses": {
  
  
  
  
"additionalProperties": {
  
  
  
  
  
"directory": "string",
  
  
  
  
  
"name": "string"
  
  
  
  
}
  
  
  
},
  
  
  
"revisionDirectory": "string",
  
  
  
"draftDirectory": "string",
  
  
  
"archiveDirectory": "string",
  
  
  
"trashDirectory": "string"
  
  
}
  
}
}

Samples​


Read a single collection​

GET/collections/{key}

Responses​

The requested collection.

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "document-collection",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"name": "string",
  
  
  
"directory": "string",
  
  
  
"recursive": true,
  
  
  
"format": "string",
  
  
  
"documentTitleKey": "string",
  
  
  
"documentDescriptionKey": "string",
  
  
  
"documentStatusKey": "string",
  
  
  
"unpublishedStatuses": {
  
  
  
  
"additionalProperties": {
  
  
  
  
  
"directory": "string",
  
  
  
  
  
"name": "string"
  
  
  
  
}
  
  
  
},
  
  
  
"revisionDirectory": "string",
  
  
  
"draftDirectory": "string",
  
  
  
"archiveDirectory": "string",
  
  
  
"trashDirectory": "string"
  
  
}
  
}
}

Samples​


Delete a collection​

DELETE/collections/{key}

Responses​

Collection deleted. Empty body.

Samples​


Update a collection​

PATCH/collections/{key}

The submitted attributes replace the collection's settings; they are not merged with the stored ones.

Request Body​

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "document-collection",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"name": "string",
  
  
  
"directory": "string",
  
  
  
"recursive": true,
  
  
  
"format": "string",
  
  
  
"documentTitleKey": "string",
  
  
  
"documentDescriptionKey": "string",
  
  
  
"documentStatusKey": "string",
  
  
  
"unpublishedStatuses": {
  
  
  
  
"additionalProperties": {
  
  
  
  
  
"directory": "string",
  
  
  
  
  
"name": "string"
  
  
  
  
}
  
  
  
},
  
  
  
"revisionDirectory": "string",
  
  
  
"draftDirectory": "string",
  
  
  
"archiveDirectory": "string",
  
  
  
"trashDirectory": "string"
  
  
}
  
}
}

Responses​

The submitted collection as decoded, echoed back; it is not read back from the settings provider.

application/vnd.api+json
JSON
{
  
"data": {
  
  
"type": "document-collection",
  
  
"id": "string",
  
  
"attributes": {
  
  
  
"name": "string",
  
  
  
"directory": "string",
  
  
  
"recursive": true,
  
  
  
"format": "string",
  
  
  
"documentTitleKey": "string",
  
  
  
"documentDescriptionKey": "string",
  
  
  
"documentStatusKey": "string",
  
  
  
"unpublishedStatuses": {
  
  
  
  
"additionalProperties": {
  
  
  
  
  
"directory": "string",
  
  
  
  
  
"name": "string"
  
  
  
  
}
  
  
  
},
  
  
  
"revisionDirectory": "string",
  
  
  
"draftDirectory": "string",
  
  
  
"archiveDirectory": "string",
  
  
  
"trashDirectory": "string"
  
  
}
  
}
}

Samples​