Content repositories

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

Authorization and status codes

For authorization and status codes see the API Reference overview.

Content repositories
Link copied!

Method	Endpoint	Summary
`GET`	`/content-repositories/{contentRepositoryId}`	Get content repository
`PATCH`	`/content-repositories/{contentRepositoryId}`	Update content repository
`GET`	`/content-repositories/{contentRepositoryId}` `/content-items`	List content items
`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
`POST`	`/content-repositories/{contentRepositoryId}/features`	Assign a feature
`DELETE`	`/content-repositories/{contentRepositoryId}/features`	Remove a feature
`POST`	`/content-repositories/{contentRepositoryId}/share`	Share a content repository
`POST`	`/hubs/{hubId}/content-repositories`	Create content repository
`GET`	`/hubs/{hubId}/content-repositories`	List content repositories
`GET`	`/hubs/{hubId}` `/content-repositories/search/findByFeaturesContaining`	Find by feature

Content repository response links
Link copied!

Most content repository API responses include a standard set of HAL _links describing the actions and related resources available. The examples throughout this page show an abbreviated set of links for readability. The full set returned in a typical content repository response looks like this:

  "_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"
    },
    "hub": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
    },
    "create-content-item": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/content-items{?ignoreSchemaValidation}",
      "templated": true
    },
    "search-content-items": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/content-items/find{?page,projection,query,size,sort}",
      "templated": true
    },
    "facet-content-items": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/content-items/facet{?page,projection,query,size,sort}",
      "templated": true
    },
    "content-items": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/content-items{?folderId,page,projection,size,sort,status}",
      "templated": true
    },
    "share": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/share"
    },
    "assign-content-type": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/content-types"
    },
    "unassign-content-type": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/content-types/{id}",
      "templated": true
    },
    "folders": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/folders{?page,size,sort}",
      "templated": true
    },
    "create-folder": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/folders"
    },
    "features": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/features?feature={feature}",
      "templated": true
    },
    "update-content-items": {
      "href": "https://api.amplience.net/v2/content/content-items"
    },
    "set-item-locales": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/item-locales"
    },
    "join-localization-group": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/localization-group"
    },
    "localization-group-locales": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/localization-group/locales"
    }
  }

Which links you'll actually see

The exact set of links returned can vary slightly by content repository state. Endpoints that return a partial or list representation may include a smaller subset of these links rather than the full set shown above.

Get content repository
Link copied!

GET /content-repositories/{contentRepositoryId}

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

Get a new Content Repository

Parameters

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

Responses

Status	Description
200	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

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.

Update content repository
Link copied!

PATCH /content-repositories/{contentRepositoryId}

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

Update the 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
`name`	string		Name
`label`	string		Name

Request example

{
  "name": "inspiration",
  "label": "inspiration"
}

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

List content items
Link copied!

GET /content-repositories/{contentRepositoryId}/content-items

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

This lists all of the Content Items within this Content Repository

Parameters

Name	In	Type	Required	Description
`contentRepositoryId`	path	string	✓	Content Repository ID Example: `00112233445566778899aabb`
`projection`	query	string (projection)		"basic" - omits the body property from the return Content Items Example: `basic`
`page`	query	integer		Page number Example: `0`
`folderId`	query	string		Folder ID Example: `00112233445566778899aabb`
`status`	query	string		Status
`excludeHierarchicalChildren`	query	boolean		Exclude hierarchical child items Example: `True`
`size`	query	integer		Page size Example: `20`
`sort`	query	string		Sort paramter Example: `createdDate,asc`

Responses

Status	Description
200	Content Repository

Response Example (200)

{
  "_embedded": {
    "content-items": [
      {
        "id": "00112233-4455-6677-8899-aabbccddeeff",
        "contentRepositoryId": "00112233445566778899aabb",
        "body": {
          "_meta": {
            "name": "main-banner",
            "schema": "http://example.com/banner.json",
            "deliveryKey": "promo-page/main-banner"
          },
          "heading": "Buy more stuff!!",
          "link": "http://anyafinn.com/buymore?campaign=shouting"
        },
        "label": "Banner Ad Homepage",
        "folderId": "00112233445566778899aabb",
        "assignees": [
          "00112233445566778899aabb"
        ],
        "assignedDate": "2019-01-01T00:00:00.000Z",
        "locale": "en-GB",
        "version": 1,
        "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
        "createdDate": "2019-01-01T00:00:00.000Z",
        "lastModifiedBy": "00112233-4455-6677-8899-aabbccddeeff",
        "lastModifiedDate": "2019-01-01T00:00:00.000Z",
        "lastPublishedDate": "2019-01-01T00:00:00.000Z",
        "lastPublishedVersion": 1,
        "lastUnpublishedDate": "2019-01-01T00:00:00.000Z",
        "lastUnpublishedVersion": 1,
        "publishingStatus": "NONE",
        "deliveryId": "00112233-4455-6677-8899-aabbccddeeff",
        "workflow": {
          "state": "00112233445566778899aabb"
        },
        "_links": {
          "self": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
          },
          "content-item": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff{?projection}",
            "templated": true
          },
          "planned": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/planned{?epoch,time}",
            "templated": true
          },
          "publish": {
            "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/publish"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-type/00112233-4455-6677-8899-aabbccddeeff?page=0&size=20"
    },
    "first": {
      "href": "https://api.amplience.net/v2/content/content-type/00112233-4455-6677-8899-aabbccddeeff?page=0&size=20"
    },
    "last": {
      "href": "https://api.amplience.net/v2/content/content-type/00112233-4455-6677-8899-aabbccddeeff?page=0&size=20"
    },
    "search": {
      "href": "https://api.amplience.net/v2/content/content-type/00112233-4455-6677-8899-aabbccddeeff/search"
    }
  },
  "page": {
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  }
}

Abbreviated response

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

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

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

Assign a feature
Link copied!

POST /content-repositories/{contentRepositoryId}/features

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

Assign a feature to a Content Repository

Parameters

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

Responses

Status	Description
204	No Content Response

Remove a feature
Link copied!

DELETE /content-repositories/{contentRepositoryId}/features

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

Remove a feature from a Content Repository

Parameters

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

Responses

Status	Description
204	No Content Response

POST /content-repositories/{contentRepositoryId}/share

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

Share a Content Repository with another user

Parameters

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

Request Body

Content-Type: application/json

Field	Type	Required	Description
`user`	string	✓	User ID
`additionalPermissions`	array	✓	Additional Permissions

Request example

{
  "additionalPermissions": []
}

Responses

Status	Description
204	No Content Response

Create content repository
Link copied!

POST /hubs/{hubId}/content-repositories

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

Create a new Content Repository

Parameters

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

Request Body

Content-Type: application/json

Field	Type	Required	Description
`name`	string	✓	Name
`label`	string	✓	Name

Request example

{
  "name": "inspiration",
  "label": "inspiration"
}

Responses

Status	Description
201	Created 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

List content repositories
Link copied!

GET /hubs/{hubId}/content-repositories

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

List Content Repositories 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: `label,asc`

Responses

Status	Description
200	Paginated Content Repository

Response Example (200)

{
  "_embedded": {
    "content-repositories": [
      {
        "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"
          }
        }
      }
    ]
  },
  "_links": {
    "search:findByFeaturesContaining": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/search/findByFeaturesContaining?feature={feature}{&page,size,sort}",
      "templated": true
    }
  },
  "page": {
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  }
}

Abbreviated response

Find by feature
Link copied!

GET /hubs/{hubId}/content-repositories/search/findByFeaturesContaining

https://api.amplience.net/v2/content/hubs/{hubId}/content-repositories/search/findByFeaturesContaining

Find all the Content Repositories that contain a feature

Parameters

Name	In	Type	Required	Description
`hubId`	path	string	✓	Hub ID Example: `00112233445566778899aabb`
`feature`	query	string	✓	Feature Example: `slots`
`page`	query	integer		Page number Example: `0`
`size`	query	integer		Page size Example: `20`
`sort`	query	string		Sort paramter Example: `label,asc`

Responses

Status	Description
200	Paginated Content Repository

Response Example (200)

{
  "_embedded": {
    "content-repositories": [
      {
        "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"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/content-repositories?page=0&size=20"
    },
    "first": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/content-repositories?page=0&size=20"
    },
    "last": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/content-repositories?page=0&size=20"
    }
  },
  "page": {
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  }
}

Authorization and status codes

Content repositoriesLink copied!

Content repository response linksLink copied!

Which links you'll actually see

Get content repositoryLink copied!

Abbreviated response

Update content repositoryLink copied!

Abbreviated response

List content itemsLink copied!

Abbreviated response

Assign content type to content repositoryLink copied!

Abbreviated response

Remove content type from content repositoryLink copied!

Abbreviated response

Assign a featureLink copied!

Remove a featureLink copied!

Share a content repositoryLink copied!

Create content repositoryLink copied!

Abbreviated response

List content repositoriesLink copied!

Abbreviated response

Find by featureLink copied!

Abbreviated response

Content repositories
Link copied!

Content repository response links
Link copied!

Get content repository
Link copied!

Update content repository
Link copied!

List content items
Link copied!

Assign content type to content repository
Link copied!

Remove content type from content repository
Link copied!

Assign a feature
Link copied!

Remove a feature
Link copied!

Share a content repository
Link copied!

Create content repository
Link copied!

List content repositories
Link copied!

Find by feature
Link copied!