Content types

Base URL: https://api.amplience.net/v2/content

Authorization and status codes

For authorization and status codes see the API Reference overview.

Content types
Link copied!

Method	Endpoint	Summary
`POST`	`/content-repositories/{contentRepositoryId}` `/content-types`	Assign content type to content repository
`DELETE`	`/content-repositories/{contentRepositoryId}` `/content-types/{contentTypeId}`	Remove content type from content repository
`GET`	`/content-types/{contentTypeId}`	Get content type
`PATCH`	`/content-types/{contentTypeId}`	Update content type
`POST`	`/content-types/{contentTypeId}/archive`	Archive content type
`POST`	`/content-types/{contentTypeId}/unarchive`	Unarchive content type
`POST`	`/hubs/{hubId}/content-types`	Create content type
`GET`	`/hubs/{hubId}/content-types`	List content types

Assign content type to content repository
Link copied!

POST /content-repositories/{contentRepositoryId}/content-types

https://api.amplience.net/v2/content/content-repositories/{contentRepositoryId}/content-types

Assign Content Type to a Content Repository

Parameters

Name	In	Type	Required	Description
`contentRepositoryId`	path	string	✓	Content Repository ID Example: `00112233445566778899aabb`

Request Body

Content-Type: application/json

Field	Type	Required	Description
`contentTypeId`	string	✓	Content Type ID

Request example

{
  "contentTypeId": "00112233445566778899aabb"
}

Responses

Status	Description
201	Updated Content Repository

Response Example (201)

{
  "id": "00112233445566778899aabb",
  "name": "inspiration",
  "label": "inspiration",
  "status": "ACTIVE",
  "features": [
    "slots"
  ],
  "type": "CONTENT",
  "contentTypes": [
    {
      "hubContentTypeId": "00112233445566778899aabb",
      "contentTypeUri": "http://example.com/content-type.json"
    }
  ],
  "itemLocales": [
    "en_US"
  ],
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb"
    },
    "content-repository": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb"
    },
    "update": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb"
    },
    "delete": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb"
    }
  }
}

Abbreviated response

The _links object in this example is truncated for readability: it shows 4 of the 19 links the API actually returns. Every content repository response includes the full standard set. See Content repository response links for the complete list.

Remove content type from content repository
Link copied!

DELETE /content-repositories/{contentRepositoryId}/content-types/{contentTypeId}

https://api.amplience.net/v2/content/content-repositories/{contentRepositoryId}/content-types/{contentTypeId}

Remove a Content Type from a Content Repository

Parameters

Name	In	Type	Required	Description
`contentRepositoryId`	path	string	✓	Content Repository ID Example: `00112233445566778899aabb`
`contentTypeId`	path	string	✓	Content Type ID Example: `00112233445566778899aabb`

Responses

Status	Description
200	Updated Content Repository

Response Example (200)

{
  "id": "00112233445566778899aabb",
  "name": "inspiration",
  "label": "inspiration",
  "status": "ACTIVE",
  "features": [
    "slots"
  ],
  "type": "CONTENT",
  "contentTypes": [
    {
      "hubContentTypeId": "00112233445566778899aabb",
      "contentTypeUri": "http://example.com/content-type.json"
    }
  ],
  "itemLocales": [
    "en_US"
  ],
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb"
    },
    "content-repository": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb"
    },
    "update": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb"
    },
    "delete": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb"
    }
  }
}

Abbreviated response

Get content type
Link copied!

GET /content-types/{contentTypeId}

https://api.amplience.net/v2/content/content-types/{contentTypeId}

Get the request Content Type

Parameters

Name	In	Type	Required	Description
`contentTypeId`	path	string	✓	Content Type ID Example: `00112233445566778899aabb`

Responses

Status	Description
200	Content Type

Response Example (200)

{
  "id": "00112233445566778899aabb",
  "contentTypeUri": "http://example.com/content-type.json",
  "status": "ACTIVE",
  "settings": {
    "label": "New Content Type",
    "icons": [
      {
        "size": 256,
        "url": "http://example.com/icon.png"
      }
    ],
    "visualizations": [
      {
        "label": "Desktop Website",
        "templatedUri": "http://example.com?vse={{vse}}",
        "default": true
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb"
    },
    "archive": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/archive"
    },
    "unarchive": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/unarchive"
    },
    "content-type": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb"
    },
    "effective-content-type": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/effective-content-type"
    },
    "content-type-schema": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/schema"
    }
  }
}

Update content type
Link copied!

PATCH /content-types/{contentTypeId}

https://api.amplience.net/v2/content/content-types/{contentTypeId}

Update the Content Type

Parameters

Name	In	Type	Required	Description
`contentTypeId`	path	string	✓	Content Type ID Example: `00112233445566778899aabb`

Request Body

Content-Type: application/json

Field	Type	Required	Description
`settings`	object

Request example

{
  "settings": {
    "label": "New Content Type",
    "icons": [
      {
        "size": 256,
        "url": "http://example.com/icon.png"
      }
    ],
    "visualizations": [
      {
        "label": "Desktop Website",
        "templatedUri": "http://example.com?vse={{vse}}",
        "default": true
      }
    ]
  }
}

Responses

Status	Description
200	Updated Content Type

Response Example (200)

{
  "id": "00112233445566778899aabb",
  "contentTypeUri": "http://example.com/content-type.json",
  "status": "ACTIVE",
  "settings": {
    "label": "New Content Type",
    "icons": [
      {
        "size": 256,
        "url": "http://example.com/icon.png"
      }
    ],
    "visualizations": [
      {
        "label": "Desktop Website",
        "templatedUri": "http://example.com?vse={{vse}}",
        "default": true
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb"
    },
    "archive": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/archive"
    },
    "unarchive": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/unarchive"
    },
    "content-type": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb"
    },
    "effective-content-type": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/effective-content-type"
    },
    "content-type-schema": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/schema"
    }
  }
}

Archive content type
Link copied!

POST /content-types/{contentTypeId}/archive

https://api.amplience.net/v2/content/content-types/{contentTypeId}/archive

Archive a Content Type

Parameters

Name	In	Type	Required	Description
`contentTypeId`	path	string	✓	Content Type ID Example: `00112233445566778899aabb`

Responses

Status	Description
200	Archived Content Type

Response Example (200)

{
  "id": "00112233445566778899aabb",
  "contentTypeUri": "http://example.com/content-type.json",
  "status": "ARCHIVED",
  "settings": {
    "label": "New Content Type",
    "icons": [
      {
        "size": 256,
        "url": "http://example.com/icon.png"
      }
    ],
    "visualizations": [
      {
        "label": "Desktop Website",
        "templatedUri": "http://example.com?vse={{vse}}",
        "default": true
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb"
    },
    "archive": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/archive"
    },
    "unarchive": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/unarchive"
    },
    "content-type": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb"
    },
    "effective-content-type": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/effective-content-type"
    },
    "content-type-schema": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/schema"
    }
  }
}

Unarchive content type
Link copied!

POST /content-types/{contentTypeId}/unarchive

https://api.amplience.net/v2/content/content-types/{contentTypeId}/unarchive

Unarchive a Content Type

Parameters

Name	In	Type	Required	Description
`contentTypeId`	path	string	✓	Content Type ID Example: `00112233445566778899aabb`

Responses

Status	Description
200	Unarchived Content Type

Response Example (200)

{
  "id": "00112233445566778899aabb",
  "contentTypeUri": "http://example.com/content-type.json",
  "status": "ACTIVE",
  "settings": {
    "label": "New Content Type",
    "icons": [
      {
        "size": 256,
        "url": "http://example.com/icon.png"
      }
    ],
    "visualizations": [
      {
        "label": "Desktop Website",
        "templatedUri": "http://example.com?vse={{vse}}",
        "default": true
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb"
    },
    "archive": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/archive"
    },
    "unarchive": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/unarchive"
    },
    "content-type": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb"
    },
    "effective-content-type": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/effective-content-type"
    },
    "content-type-schema": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/schema"
    }
  }
}

Create content type
Link copied!

POST /hubs/{hubId}/content-types

https://api.amplience.net/v2/content/hubs/{hubId}/content-types

Create a new Content Type

Parameters

Name	In	Type	Required	Description
`hubId`	path	string	✓	Hub ID Example: `00112233445566778899aabb`

Request Body

Content-Type: application/json

Field	Type	Required	Description
`contentTypeUri`	string	✓	Content Type URI
`settings`	object	✓

Request example

{
  "contentTypeUri": "http://example.com/content-type.json",
  "settings": {
    "icons": [],
    "visualizations": []
  }
}

Responses

Status	Description
201	Created Content Type

Response Example (201)

{
  "id": "00112233445566778899aabb",
  "contentTypeUri": "http://example.com/content-type.json",
  "status": "ACTIVE",
  "settings": {
    "label": "New Content Type",
    "icons": [
      {
        "size": 256,
        "url": "http://example.com/icon.png"
      }
    ],
    "visualizations": [
      {
        "label": "Desktop Website",
        "templatedUri": "http://example.com?vse={{vse}}",
        "default": true
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb"
    },
    "archive": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/archive"
    },
    "unarchive": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/unarchive"
    },
    "content-type": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb"
    },
    "effective-content-type": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/effective-content-type"
    },
    "content-type-schema": {
      "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/schema"
    }
  }
}

List content types
Link copied!

GET /hubs/{hubId}/content-types

https://api.amplience.net/v2/content/hubs/{hubId}/content-types

List Content Types for a Hub

Parameters

Name	In	Type	Required	Description
`hubId`	path	string	✓	Hub ID Example: `00112233445566778899aabb`
`page`	query	integer		Page number Example: `0`
`size`	query	integer		Page size Example: `20`
`sort`	query	string		Sort paramter Example: `contentTypeUri,asc`
`status`	query	string		Comma seperated list of statuses Example: `ACTIVE,ARCHIVED`

Responses

Status	Description
200	Paginated Content Types

Response Example (200)

{
  "_embedded": {
    "content-types": [
      {
        "id": "00112233445566778899aabb",
        "contentTypeUri": "http://example.com/content-type.json",
        "status": "ACTIVE",
        "settings": {
          "label": "New Content Type",
          "icons": [],
          "visualizations": []
        },
        "_links": {
          "self": {
            "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb"
          },
          "archive": {
            "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/archive"
          },
          "unarchive": {
            "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/unarchive"
          },
          "content-type": {
            "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb"
          },
          "effective-content-type": {
            "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/effective-content-type"
          },
          "content-type-schema": {
            "href": "https://api.amplience.net/v2/content/content-types/00112233445566778899aabb/schema"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-type/00112233445566778899aabb?page=0&size=20"
    },
    "first": {
      "href": "https://api.amplience.net/v2/content/content-type/00112233445566778899aabb?page=0&size=20"
    },
    "last": {
      "href": "https://api.amplience.net/v2/content/content-type/00112233445566778899aabb?page=0&size=20"
    }
  },
  "page": {
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  }
}

Authorization and status codes

Content typesLink copied!

Assign content type to content repositoryLink copied!

Abbreviated response

Remove content type from content repositoryLink copied!

Abbreviated response

Get content typeLink copied!

Update content typeLink copied!

Archive content typeLink copied!

Unarchive content typeLink copied!

Create content typeLink copied!

List content typesLink copied!

Content types
Link copied!

Assign content type to content repository
Link copied!

Remove content type from content repository
Link copied!

Get content type
Link copied!

Update content type
Link copied!

Archive content type
Link copied!

Unarchive content type
Link copied!

Create content type
Link copied!

List content types
Link copied!