Taxonomies

These API’s are for creating, accessing, and updating taxonomies inside of CM Box.

POST /api/content/management/taxonomies

Creates a new taxonomy.

Headers

Content-Type: application/json

Request Body

name - Name of the taxonomy

description - Description of the taxonomy

Example Request

{
  "name": "New Taxonomy",
  "description": "This is an example taxonomy",
}

Response

200 - OK on success

Example Response

{
    "id": "TAXONOMY_8A186CFB394945D79780E075CA51CC6B"
}

GET /api/content/management/taxonomies

Retrieves a list of all taxonomies.

Response

200 - OK on success

Example Response

{
    "count": 1,
    "items": [
        {
            "name": "New Taxonomy",
            "displayName": "",
            "apiName": "newTaxonomy",
            "description": "This is an example taxonomy",
            "shortName": "new",
            "id": "TAXONOMY_8A186CFB394945D79780E075CA51CC6B",
            "properties": {}
        }
    ]
}

GET /api/content/management/taxonomies/:id

Retrieves the taxonomy with the provided Id.

Template Params

id - Taxonomy Id

Response

200 - OK on success

Example Response

{
    "name": "Example",
    "displayName": "",
    "apiName": "example",
    "description": "test",
    "shortName": "exa",
    "id": "TAXONOMY_DBDC8749CF754C88B06B0EC0618F5156",
    "properties": {}
}

PUT /api/content/management/:id

Update an existing taxonomy.

Headers

Content-Type: application/json

Template Params

id - Taxonomy Id

Request Body

name - Name of the taxonomy

description - Description of the taxonomy

properties - Object of custom properties listed key-value pairs

shortName - The prefix for all categories in this taxonomy

Example Request

Content-Type: application/json

{
    "name": "Updated Taxonomy",
    "description": "This is an updated taxonomy",
    "shortName": "newer",
    "properties": {
        "example": "update"
    }
}

Response

200 - OK on success

Example Response

{
    "name": "Updated Taxonomy",
    "displayName": "",
    "apiName": "newTaxonomy",
    "description": "This is an updated taxonomy",
    "shortName": "newer",
    "id": "TAXONOMY_8A186CFB394945D79780E075CA51CC6B",
    "properties": {
        "example": "update"
    }
}

DELETE /api/content/management/:id

Delete an taxonomy with the specified Id.

Template Params

id - Id of the requested taxonomy

Response

200 - OK on success