---
canonical: https://amplience.com/developers/docs/apis/content-management-reference/events-editions/
title: "Events and editions"
description: "API reference for event and edition endpoints. Covers campaign events, scheduled editions, slots, and conflict resolution."
audience: Developer
date_published: 2023-08-29
date_modified: 2026-07-05
---
# Events and editions
**Base URL:** `https://api.amplience.net/v2/content`
> **Note: Authorization and status codes**
> For authorization and status codes see the [API Reference overview](https://amplience.com/developers/docs/apis/content-management-reference/).
## Events
| Method | Endpoint | Summary |
|--------|----------|---------|
| `GET` | `/events/{eventId}` | [Get an event](#get-an-event) |
| `DELETE` | `/events/{eventId}` | [Delete an event](#delete-an-event) |
| `PATCH` | `/events/{eventId}` | [Update an event](#update-an-event) |
| `POST` | `/events/{eventId}/archive` | [Archive events](#archive-events) |
| `GET` | `/events/search/findByDateRange` | [Search events by date](#search-events-by-date) |
| `GET` | `/events/search/findByDateRangeAndSlots` | [Search events by date range and slots](#search-events-by-date-range-and-slots) |
| `GET` | `/hubs/{hubId}/events` | [List events](#list-events) |
| `POST` | `/hubs/{hubId}/events` | [Create a new event](#create-a-new-event) |
### Get an event
`GET /events/{eventId}`
`https://api.amplience.net/v2/content/events/{eventId}`
Get an Event by ID
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `eventId` | path | string | ✓ | Event ID
Example: `00112233445566778899aabb` |
| `projection` | query | string (withEditions) | | Include related Editions |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | The requested Event, including corresponding Editions if `projection=withEditions` was supplied |
Response example (200): Single event
```json
{
"id": "00112233445566778899aabb",
"name": "Event",
"comment": "This is an example Event",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"brief": "http://external.doc/mybrief",
"locales": [
"en-GB",
"it"
],
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"event": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"hub": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
},
"update": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"archive": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/archive"
},
"create-edition": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?sourceEditionId}"
},
"editions": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?page,size,sort}"
}
}
}
```
Response example (200): With edition projection
```json
{
"id": "00112233445566778899aabb",
"name": "Event2",
"comment": "This is an example Event",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"brief": "http://external.doc/mybrief",
"locales": [
"en-GB",
"it"
],
"editions": [
{
"id": "00112233445566778899aabb",
"name": "My Edition",
"comment": "This is an example edition.",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"eventId": "00112233445566778899aabb",
"publishingStatus": "DRAFT",
"slotsRemaining": 200,
"schedulingErrors": null,
"activeEndDate": false,
"publishingJobId": null,
"statusUpdated": "2019-01-01T00:00:00.000Z",
"schedulingUser": null,
"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",
"stagedDate": null,
"slotCollisions": false
}
],
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"event": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"hub": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
},
"update": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"archive": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/archive"
},
"create-edition": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?sourceEditionId}"
},
"editions": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?page,size,sort}"
}
}
}
```
### Delete an event
`DELETE /events/{eventId}`
`https://api.amplience.net/v2/content/events/{eventId}`
Delete an Event by ID
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `eventId` | path | string | ✓ | Event ID
Example: `00112233445566778899aabb` |
**Responses**
| Status | Description |
|--------|-------------|
| 204 | No Content |
### Update an event
`PATCH /events/{eventId}`
`https://api.amplience.net/v2/content/events/{eventId}`
Update an Event by ID
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `eventId` | path | string | ✓ | Event ID
Example: `00112233445566778899aabb` |
**Request Body**
Content-Type: `application/json`
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `name` | string | | Name |
| `comment` | string | | Comment |
| `start` | string | | The Event start date |
| `end` | string | | The Event end date |
| `brief` | string | | Brief - external URI that related to this Event |
| `locales` | | | Locales |
Request example
```json
{
"name": "Event",
"comment": "This is an example Event",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"brief": "http://external.doc/mybrief",
"locales": [
"en-GB",
"it"
]
}
```
**Responses**
| Status | Description |
|--------|-------------|
| 200 | The requested Event |
Response Example (200)
```json
{
"id": "00112233445566778899aabb",
"name": "Event",
"comment": "This is an example Event",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"brief": "http://external.doc/mybrief",
"locales": [
"en-GB",
"it"
],
"_links": {
"update": {
"href": "https://api.amplience.net/..."
},
"delete": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"archive": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/archive"
},
"create-edition": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?sourceEditionId}",
"templated": true
}
}
}
```
### Archive events
`POST /events/{eventId}/archive`
`https://api.amplience.net/v2/content/events/{eventId}/archive`
Archiving an event is irreversible, you cannot unarchive. Archiving an event will also archive all editions contained within the event.
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `eventId` | path | string | ✓ | Event ID
Example: `00112233445566778899aabb` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Archived Event |
Response Example (200)
```json
{
"id": "00112233445566778899aabb",
"name": "Event",
"comment": "This is an example Event",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"brief": "http://external.doc/mybrief",
"status": "ARCHIVED",
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"event": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"hub": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
},
"editions": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?page,size,sort}",
"templated": true
}
}
}
```
### Search events by date
`GET /events/search/findByDateRange`
`https://api.amplience.net/v2/content/events/search/findByDateRange`
List all of the Events for a given date
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `hubId` | query | string | ✓ | Hub ID
Example: `00112233445566778899aabb` |
| `rangeStart` | query | string | ✓ | The start date to search from
Example: `2019-01-01T00:00:00.000Z` |
| `rangeEnd` | query | string | | The end date to search to
Example: `2019-01-01T00:00:00.000Z` |
| `projection` | query | string (withEditions) | | Include child Editions |
| `bounded` | query | integer | | Find events that have either started or ended within the date range
Example: `1` |
| `size` | query | integer | | Set the number of results per page
Example: `10` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Paginated Event List |
Response example (200): Paginated event list
```json
{
"_embedded": {
"events": [
{
"id": "00112233445566778899aabb",
"name": "Event",
"comment": "This is an example Event",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"brief": "http://external.doc/mybrief",
"locales": [
"en-GB",
"it"
],
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"event": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"hub": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
},
"update": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"archive": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/archive"
},
"create-edition": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?sourceEditionId}"
},
"editions": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?page,size,sort}"
}
}
}
]
},
"_links": {
"self": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20",
"first": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20",
"last": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20",
"search": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events/search"
},
"page": {
"size": 20,
"totalElements": 5,
"totalPages": 1,
"number": 0
}
}
```
Response example (200): With editions projection
```json
{
"_embedded": {
"events": [
{
"id": "00112233445566778899aabb",
"name": "Event",
"comment": "This is an example Event",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"brief": "http://external.doc/mybrief",
"locales": [
"en-GB",
"it"
],
"editions": [
{
"id": "00112233445566778899aabb",
"name": "My Edition",
"comment": "This is an example edition.",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"eventId": "00112233445566778899aabb",
"publishingStatus": "DRAFT",
"slotsRemaining": 200,
"schedulingErrors": null,
"activeEndDate": false,
"publishingJobId": null,
"statusUpdated": "2019-01-01T00:00:00.000Z",
"schedulingUser": null,
"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",
"stagedDate": null,
"slotCollisions": false
}
],
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"event": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"hub": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
},
"update": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"archive": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/archive"
},
"create-edition": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?sourceEditionId}"
},
"editions": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?page,size,sort}"
}
}
}
]
},
"_links": {
"self": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20",
"first": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20",
"last": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20",
"search": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events/search"
},
"page": {
"size": 20,
"totalElements": 5,
"totalPages": 1,
"number": 0
}
}
```
### Search events by date range and slots
`GET /events/search/findByDateRangeAndSlots`
`https://api.amplience.net/v2/content/events/search/findByDateRangeAndSlots`
List all of the Events for a given date range and slot ID
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `hubId` | query | string | ✓ | Hub ID
Example: `00112233445566778899aabb` |
| `rangeStart` | query | string | ✓ | The start date to search from
Example: `2019-01-01T00:00:00.000Z` |
| `rangeEnd` | query | string | | The end date to search to
Example: `2019-01-01T00:00:00.000Z` |
| `projection` | query | string (withEditions) | | Include child Editions |
| `bounded` | query | integer | | Find events that have either started or ended within the date range
Example: `1` |
| `slots` | query | string | ✓ | Slot ID
Example: `00112233-4455-6677-8899-aabbccddeeff` |
| `locales` | query | string | | Locale to match
Example: `en-GB` |
| `size` | query | integer | | Set the number of results per page
Example: `10` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Paginated Event List |
Response example (200): Paginated event list
```json
{
"_embedded": {
"events": [
{
"id": "00112233445566778899aabb",
"name": "Event",
"comment": "This is an example Event",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"brief": "http://external.doc/mybrief",
"locales": [
"en-GB",
"it"
],
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"event": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"hub": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
},
"update": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"archive": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/archive"
},
"create-edition": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?sourceEditionId}"
},
"editions": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?page,size,sort}"
}
}
}
]
},
"_links": {
"self": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20",
"first": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20",
"last": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20",
"search": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events/search"
},
"page": {
"size": 20,
"totalElements": 5,
"totalPages": 1,
"number": 0
}
}
```
Response example (200): With editions projection
```json
{
"_embedded": {
"events": [
{
"id": "00112233445566778899aabb",
"name": "Event",
"comment": "This is an example Event",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"brief": "http://external.doc/mybrief",
"locales": [
"en-GB",
"it"
],
"editions": [
{
"id": "00112233445566778899aabb",
"name": "My Edition",
"comment": "This is an example edition.",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"eventId": "00112233445566778899aabb",
"publishingStatus": "DRAFT",
"slotsRemaining": 200,
"schedulingErrors": null,
"activeEndDate": false,
"publishingJobId": null,
"statusUpdated": "2019-01-01T00:00:00.000Z",
"schedulingUser": null,
"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",
"stagedDate": null,
"slotCollisions": false
}
],
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"event": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"hub": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
},
"update": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"archive": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/archive"
},
"create-edition": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?sourceEditionId}"
},
"editions": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?page,size,sort}"
}
}
}
]
},
"_links": {
"self": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20",
"first": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20",
"last": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20",
"search": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events/search"
},
"page": {
"size": 20,
"totalElements": 5,
"totalPages": 1,
"number": 0
}
}
```
### List events
`GET /hubs/{hubId}/events`
`https://api.amplience.net/v2/content/hubs/{hubId}/events`
List all of the Events created for a hub
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `hubId` | path | string | ✓ | Hub ID
Example: `00112233445566778899aabb` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Paginated Event List |
Response Example (200)
```json
{
"_embedded": {
"events": [
{
"id": "00112233445566778899aabb",
"name": "Event",
"comment": "This is an example Event",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"brief": "http://external.doc/mybrief",
"locales": [
"en-GB",
"it"
],
"_links": {
"update": {
"href": "https://api.amplience.net/..."
},
"delete": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"archive": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/archive"
},
"create-edition": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?sourceEditionId}",
"templated": true
}
}
}
]
},
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20"
},
"first": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20"
},
"last": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events?page=0&size=20"
},
"search": {
"href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events/search"
}
},
"page": {
"size": 20,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}
```
### Create a new event
`POST /hubs/{hubId}/events`
`https://api.amplience.net/v2/content/hubs/{hubId}/events`
Create a new Event for a particular Hub.
**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 |
| `comment` | string | | Comment |
| `start` | string | ✓ | The Event start date |
| `end` | string | ✓ | The Event end date |
| `brief` | string | | Brief - external URI that related to this Event |
| `locales` | | | Locales |
Request example
```json
{
"name": "Event",
"comment": "This is an example Event",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"brief": "http://external.doc/mybrief",
"locales": [
"en-GB",
"it"
]
}
```
**Responses**
| Status | Description |
|--------|-------------|
| 200 | The created Event |
Response Example (200)
```json
{
"id": "00112233445566778899aabb",
"name": "Event",
"comment": "This is an example Event",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"brief": "http://external.doc/mybrief",
"locales": [
"en-GB",
"it"
],
"_links": {
"update": {
"href": "https://api.amplience.net/..."
},
"delete": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"archive": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/archive"
},
"create-edition": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions{?sourceEditionId}",
"templated": true
}
}
}
```
## Editions
| Method | Endpoint | Summary |
|--------|----------|---------|
| `GET` | `/editions/{editionId}` | [Get edition](#get-edition) |
| `PATCH` | `/editions/{editionId}` | [Update edition](#update-edition) |
| `DELETE` | `/editions/{editionId}` | [Delete edition](#delete-edition) |
| `POST` | `/editions/{editionId}/archive` | [Archive edition](#archive-edition) |
| `GET` | `/editions/{editionId}/conflicts` | [Get edition conflicts](#get-edition-conflicts) |
| `PUT` | `/editions/{editionId}/conflicts` | [Resolve edition conflicts](#resolve-edition-conflicts) |
| `GET` | `/editions/{editionId}/conflicts/findByIdAndVersion` | [Get edition conflict by id and version](#get-edition-conflict-by-id-and-version) |
| `POST` | `/editions/{editionId}/edition-contents` | [Create edition content](#create-edition-content) |
| `GET` | `/editions/{editionId}/edition-contents` | [List edition contents](#list-edition-contents) |
| `GET` | `/editions/{editionId}`
`/edition-contents/{editionContentsId}` | [Get edition content](#get-edition-content) |
| `DELETE` | `/editions/{editionId}`
`/edition-contents/{editionContentsId}` | [Delete edition content](#delete-edition-content) |
| `PATCH` | `/editions/{editionId}`
`/edition-contents/{editionContentsId}/content` | [Associate edition content](#associate-edition-content) |
| `POST` | `/editions/{editionId}/preview` | [Create edition preview](#create-edition-preview) |
| `GET` | `/editions/{editionId}/preview` | [Get edition preview](#get-edition-preview) |
| `DELETE` | `/editions/{editionId}/preview` | [Delete edition preview](#delete-edition-preview) |
| `POST` | `/editions/{editionId}/schedule` | [Schedule edition](#schedule-edition) |
| `DELETE` | `/editions/{editionId}/schedule` | [Unschedule edition](#unschedule-edition) |
| `GET` | `/editions/{editionId}/slot-collisions` | [Get edition slot collisions](#get-edition-slot-collisions) |
| `POST` | `/editions/{editionId}/slots` | [Assign edition slots](#assign-edition-slots) |
| `GET` | `/editions/{editionId}/slots` | [Get edition slots](#get-edition-slots) |
| `GET` | `/editions/{editionId}/slots/{slotId}` | [Get edition slot](#get-edition-slot) |
| `DELETE` | `/editions/{editionId}/slots/{slotId}` | [Delete edition slot](#delete-edition-slot) |
| `PUT` | `/editions/{editionId}/slots/{slotId}/content` | [Create edition slot content](#create-edition-slot-content) |
| `POST` | `/editions/{editionId}/slots/{slotId}/preview` | [Create edition slot preview](#create-edition-slot-preview) |
| `GET` | `/editions/search/findByDate` | [Find by date range](#find-by-date-range) |
| `GET` | `/editions/search/findByEvent` | [Find by event](#find-by-event) |
| `POST` | `/events/{eventId}/editions` | [Create edition](#create-edition) |
| `GET` | `/events/{eventId}/editions` | [List editions](#list-editions) |
| `GET` | `/events/{eventid}/editions/search` | [Search editions](#search-editions) |
| `GET` | `/snapshots/{snapshotId}/edition-links` | [Get snapshot edition links](#get-snapshot-edition-links) |
| `DELETE` | `/snapshots/{snapshotId}/edition-links/{editionId}` | [Delete snapshot edition link](#delete-snapshot-edition-link) |
### Get edition
`GET /editions/{editionId}`
`https://api.amplience.net/v2/content/editions/{editionId}`
Get Edition
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Get Edition response |
Response Example (200)
```json
{
"id": "00112233445566778899aabb",
"name": "Edition",
"comment": "This is an Edition comment",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"eventId": "00112233445566778899aabb",
"publishingStatus": "DRAFT",
"slotsRemaining": 200,
"activeEndDate": false,
"publishingJobId": "00112233445566778899aabb",
"statusUpdated": "2019-01-01T00:00:00.000Z",
"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",
"stagedDate": "2019-01-01T00:00:00.000Z",
"slotCollisions": false,
"_links": {
"slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots"
},
"copy-slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots{?sourceEditionsSlotId}",
"templated": true
},
"list-slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots{?includedSlots}",
"templated": true
},
"schedule": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/schedule{?ignoreWarnings}",
"templated": true
},
"update": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
}
}
}
```
### Update edition
`PATCH /editions/{editionId}`
`https://api.amplience.net/v2/content/editions/{editionId}`
Update Edition
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
**Request Body**
Content-Type: `application/json`
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `name` | string | | Edition Name |
| `comment` | string | | Edition Comment |
| `activeEndDate` | boolean | | Active End Date |
Request example
```json
{
"name": "Edition",
"comment": "This is an Edition comment",
"activeEndDate": false
}
```
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Update Edition response |
Response Example (200)
```json
{
"id": "00112233445566778899aabb",
"name": "Edition",
"comment": "This is an Edition comment",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"eventId": "00112233445566778899aabb",
"publishingStatus": "DRAFT",
"slotsRemaining": 200,
"activeEndDate": false,
"publishingJobId": "00112233445566778899aabb",
"statusUpdated": "2019-01-01T00:00:00.000Z",
"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",
"stagedDate": "2019-01-01T00:00:00.000Z",
"slotCollisions": false,
"_links": {
"slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots"
},
"copy-slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots{?sourceEditionsSlotId}",
"templated": true
},
"list-slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots{?includedSlots}",
"templated": true
},
"schedule": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/schedule{?ignoreWarnings}",
"templated": true
},
"update": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
}
}
}
```
### Delete edition
`DELETE /editions/{editionId}`
`https://api.amplience.net/v2/content/editions/{editionId}`
Delete Edition
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
**Responses**
| Status | Description |
|--------|-------------|
| 204 | Delete Edition response |
### Archive edition
`POST /editions/{editionId}/archive`
`https://api.amplience.net/v2/content/editions/{editionId}/archive`
Archiving an edition is irreversible, you cannot unarchive.
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Archive Edition response |
Response Example (200)
```json
{
"id": "00112233445566778899aabb",
"name": "Edition",
"comment": "This is an Edition comment",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"eventId": "00112233445566778899aabb",
"publishingStatus": "PUBLISHED",
"slotsRemaining": 200,
"activeEndDate": false,
"publishingJobId": "00112233445566778899aabb",
"statusUpdated": "2019-01-01T00:00:00.000Z",
"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",
"stagedDate": "2019-01-01T00:00:00.000Z",
"slotCollisions": false,
"status": "ARCHIVED",
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"edition": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"create-preview": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/preview"
},
"preview": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/preview"
},
"event": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
},
"edition-conflicts": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/conflicts"
},
"edition-conflict": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/conflicts/findByIdAndVersion{?id,version}",
"templated": true
},
"slot-collisions": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slot-collisions"
}
}
}
```
### Get edition conflicts
`GET /editions/{editionId}/conflicts`
`https://api.amplience.net/v2/content/editions/{editionId}/conflicts`
Get Edition Conflicts
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Get Edition Conflicts response |
Response Example (200)
```json
{
"conflictedItems": [
{
"contentItemId": "00112233445566778899aabb",
"contentItemLabel": "Banner Ad Homepage",
"versions": [
{
"version": 1,
"instances": 1,
"slots": 1
}
]
}
],
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/conflict"
},
"edition": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"edition-conflict": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/conflicts/findByIdAndVersion{?id,version}",
"templated": true
}
}
}
```
### Resolve edition conflicts
`PUT /editions/{editionId}/conflicts`
`https://api.amplience.net/v2/content/editions/{editionId}/conflicts`
Resolve Edition Conflicts
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
**Request Body**
Content-Type: `application/json`
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `comment` | string | | Comment |
| `lastModifiedDate` | string | | Last Modified Date |
| `resolutions` | array | ✓ | |
Request example
```json
{
"comment": "Comment",
"lastModifiedDate": "2019-01-01T00:00:00.000Z",
"resolutions": [
{
"contentItemId": "00112233445566778899aabb",
"version": 1
}
]
}
```
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Resolve Edition Conflicts response |
### Get edition conflict by id and version
`GET /editions/{editionId}/conflicts/findByIdAndVersion`
`https://api.amplience.net/v2/content/editions/{editionId}/conflicts/findByIdAndVersion`
Get Edition Conflict by Id and Version
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
| `version` | query | number | ✓ | Version
Example: `1` |
| `id` | query | string | ✓ | Id
Example: `00112233445566778899aabb` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Edition Conflict by Id and Version response |
Response Example (200)
```json
{
"editionId": "00112233445566778899aabb",
"contentItemId": "00112233445566778899aabb",
"version": 1,
"instances": [
{
"snapshot": {
"snapshotId": "00112233445566778899aabb",
"createdBy": "00112233-4455-6677-8899-aabbccddeeff",
"createdDate": "2019-01-01T00:00:00.000Z",
"comment": "Comment",
"slotId": "00112233445566778899aabb",
"slotLabel": "Slot Label",
"itemHierarchy": [
{
"contentItemId": "00112233445566778899aabb",
"version": 1,
"label": "Label"
}
]
}
}
],
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/conflicts/findByIdAndVersion?id=00112233445566778899aabb&version=1"
},
"edition": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"edition-conflict": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/conflicts"
}
}
}
```
### Create edition content
`POST /editions/{editionId}/edition-contents`
`https://api.amplience.net/v2/content/editions/{editionId}/edition-contents`
Create Edition Content
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Create Edition Content Response |
Response example (200): Create edition content
```json
{
"id": "00112233445566778899aabb",
"eventId": "00112233445566778899aabb",
"editionId": "00112233445566778899aabb",
"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",
"content": {
"body": {
"_meta": {
"schema": "http://deliver.bigcontent.io/schema/hierarchy/hierarchy-schema.json",
"name": "Name"
}
}
},
"status": "Active",
"label": "Banner Ad Homepage",
"conflicts": false,
"empty": true,
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents"
},
"edition-contents": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents"
},
"edition": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
}
}
}
```
### List edition contents
`GET /editions/{editionId}/edition-contents`
`https://api.amplience.net/v2/content/editions/{editionId}/edition-contents`
List Edition Contents
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
| `page` | query | integer | | page to retrieve
Example: `1` |
| `size` | query | integer | | page size to retrieve
Example: `20` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | List Edition Content Response |
Response Example (200)
```json
{
"_embedded": {
"edition-contents": [
{
"id": "00112233445566778899aabb",
"eventId": "00112233445566778899aabb",
"editionId": "00112233445566778899aabb",
"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",
"content": "",
"label": "Banner Ad Homepage",
"conflicts": false,
"empty": true,
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents/00112233445566778899aabb"
},
"edition-content": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents/00112233445566778899aabb"
},
"edition": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
}
}
}
]
},
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents?page=0&size=20"
},
"first": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents?page=0&size=20"
},
"last": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents?page=0&size=20"
}
},
"page": {
"size": 20,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}
```
### Get edition content
`GET /editions/{editionId}/edition-contents/{editionContentsId}`
`https://api.amplience.net/v2/content/editions/{editionId}/edition-contents/{editionContentsId}`
Get Edition Content
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
| `editionContentId` | path | string | ✓ | Edition Content ID
Example: `00112233-4455-6677-8899-aabbccddeeff` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Edition Content Response |
Response Example (200)
```json
{
"id": "00112233445566778899aabb",
"eventId": "00112233445566778899aabb",
"editionId": "00112233445566778899aabb",
"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",
"content": "",
"label": "Banner Ad Homepage",
"conflicts": false,
"empty": true,
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents/00112233445566778899aabb"
},
"edition-content": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents/00112233445566778899aabb"
},
"edition": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
}
}
}
```
### Delete edition content
`DELETE /editions/{editionId}/edition-contents/{editionContentsId}`
`https://api.amplience.net/v2/content/editions/{editionId}/edition-contents/{editionContentsId}`
Delete Edition Content
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
| `editionContentId` | path | string | ✓ | Edition Content ID
Example: `00112233-4455-6677-8899-aabbccddeeff` |
**Responses**
| Status | Description |
|--------|-------------|
| 204 | No Content |
### Associate edition content
`PATCH /editions/{editionId}/edition-contents/{editionContentsId}/content`
`https://api.amplience.net/v2/content/editions/{editionId}/edition-contents/{editionContentsId}/content`
Associate Snapshot to Edition Content
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
| `editionContentId` | path | string | ✓ | Edition Content ID
Example: `00112233-4455-6677-8899-aabbccddeeff` |
**Request Body**
Content-Type: `application/json`
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `body` | object | | |
Request example
```json
{
"body": {
"contents": {
"_meta": {
"schema": "http://deliver.bigcontent.io/schema/hierarchy/hierarchy-schema.json",
"rootContentItemIds": [
"00112233-4455-6677-8899-aabbccddeeff"
],
"locked": true
},
"id": "00112233445566778899aabb",
"contentType": "http://example.com/banner.json"
}
}
}
```
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Associate Edition Content Response |
Response example (200): Associate edition content
```json
{
"id": "00112233445566778899aabb",
"eventId": "00112233445566778899aabb",
"editionId": "00112233445566778899aabb",
"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",
"content": {
"body": {
"_meta": {
"schema": "http://deliver.bigcontent.io/schema/hierarchy/hierarchy-schema.json",
"rootContentItemIds": [
"00112233-4455-6677-8899-aabbccddeeff"
],
"locked": true
},
"id": "00112233445566778899aabb,",
"contentType": "http://example.com/banner.json"
}
},
"status": "Active",
"empty": true,
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents"
},
"edition-contents": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/edition-contents"
},
"edition": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
}
}
}
```
### Create edition preview
`POST /editions/{editionId}/preview`
`https://api.amplience.net/v2/content/editions/{editionId}/preview`
If an Edition has been Previewed or is Scheduled then you can retrieve the Snapshot to be used with the Preview application or in Time Machine.
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
**Request Body**
Content-Type: `application/json`
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `lastModifiedDate` | string | | Last Modified Date |
| `type` | string | | Type |
Request example
```json
{
"lastModifiedDate": "2019-01-01T00:00:00.000Z",
"type": "QUICKPREVIEW"
}
```
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Paginated Edition List response |
Response Example (200)
```json
{
"snapshotId": "00112233445566778899aabb",
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb"
}
}
}
```
### Get edition preview
`GET /editions/{editionId}/preview`
`https://api.amplience.net/v2/content/editions/{editionId}/preview`
If an Edition has been Previewed or is Scheduled then you can retrieve the Snapshot to be used with the Preview application or in Time Machine.
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Paginated Edition List response |
Response Example (200)
```json
{
"snapshotId": "00112233445566778899aabb",
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb"
}
}
}
```
### Delete edition preview
`DELETE /editions/{editionId}/preview`
`https://api.amplience.net/v2/content/editions/{editionId}/preview`
If an Edition has been Previewed it can be deleted, if the Edition is Scheduled then it cannot be deleted.
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
**Responses**
| Status | Description |
|--------|-------------|
| 204 | Delete Edition Preview response |
### Schedule edition
`POST /editions/{editionId}/schedule`
`https://api.amplience.net/v2/content/editions/{editionId}/schedule`
Schedule an Edition for publishing. To schedule successfully, all of the following must be true:
- The Edition must be in the [`DRAFT` state](#get-edition)
- All Edition Slots must be in the [`VALID` state](#get-edition-slots) (if any slots are present)
- The Edition must have at least one Slot or Content Snapshot
- There must be no [conflicts in the Edition](#get-edition-conflicts)
If slot collisions exist with other scheduled editions, a `409` error is returned unless `ignoreWarnings=true` is passed. This will then trigger the publishing job to take place on the start date of the Edition.
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
| `ignoreWarnings` | query | boolean | | When `true`, scheduling proceeds even if slot collisions exist with other scheduled editions. |
**Request Body**
Content-Type: `application/json`
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `lastModifiedDate` | string | | Last Modified Date |
Request example
```json
{
"lastModifiedDate": "2019-01-01T00:00:00.000Z"
}
```
**Responses**
| Status | Description |
|--------|-------------|
| 204 | Schedule Edition response |
| 409 | Conflict. Slot collisions exist with another scheduled edition. Pass `ignoreWarnings=true` to override, or resolve conflicts first using [Get Edition Conflicts](#get-edition-conflicts) and [Resolve Edition Conflicts](#resolve-edition-conflicts). |
Error response (409)
```json
{
"errors": [
{
"message": "Edition has slot collisions",
"overlaps": [
{
"editionId": "00112233445566778899aabb"
}
]
}
]
}
```
### Unschedule edition
`DELETE /editions/{editionId}/schedule`
`https://api.amplience.net/v2/content/editions/{editionId}/schedule`
If the Edition has been scheduled it is possible to cancel the publishing job by unscheduling the edition.
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
**Responses**
| Status | Description |
|--------|-------------|
| 204 | Unschedule Edition response |
### Get edition slot collisions
`GET /editions/{editionId}/slot-collisions`
`https://api.amplience.net/v2/content/editions/{editionId}/slot-collisions`
Get Edition Slot Collisions
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Get Edition Slot Collisions response |
Response Example (200)
```json
{
"editionId": "00112233445566778899aabb",
"editionSlotCollisionsResponseEntries": [
{
"editionName": "Edition",
"startDateTime": "2019-01-01T00:00:00.000Z",
"endDateTime": "2019-01-01T00:00:00.000Z",
"editionId": "00112233445566778899aabb",
"collidingSlotsIds": [
[
"00112233-4455-6677-8899-aabbccddeeff",
"00112233-4455-6677-8899-aabbccddeeff"
]
],
"eventName": "Event",
"eventId": "00112233445566778899aabb"
}
],
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slot-collisions"
},
"slot-collisions": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slot-collisions"
}
}
}
```
### Assign edition slots
`POST /editions/{editionId}/slots`
`https://api.amplience.net/v2/content/editions/{editionId}/slots`
Assign Edition Slots
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
| `sourceEditionSlotId` | query | string | | Source Edition Slot ID used to copy Edition Slot to Edition
Example: `00112233445566778899aabb` |
**Request Body**
Content-Type: `application/json`
Request example
```json
[
{
"slot": "00112233-4455-6677-8899-aabbccddeeff"
}
]
```
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Edition Slot Response |
Response example (200): Associate slots to edition
```json
{
"_embedded": {
"slots": [
{
"id": "00112233445566778899aabb",
"eventId": "00112233445566778899aabb",
"editionId": "00112233445566778899aabb",
"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",
"content": {
"body": {
"_meta": {
"schema": "http://deliver.bigcontent.io/schema/simple-slot-type.json",
"name": "Name"
}
}
},
"status": "VALID",
"slotStatus": "ACTIVE",
"contentTypeId": "00112233445566778899aabb",
"slotId": "00112233445566778899aabb",
"slotLabel": "Slot Label",
"conflicts": false,
"locale": null,
"empty": true,
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb"
},
"edition-slot": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb"
},
"edition": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"slot": {
"href": "https://api.amplience.net/v2/content/content-items/00112233445566778899aabb?projection",
"templated": true
},
"content": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb/content"
},
"safe-update-content": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb/content?lastModifiedDatepagesizesort",
"templated": true
}
}
}
]
},
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots?page=0&size=20"
},
"first": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots?page=0&size=20"
},
"last": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots?page=0&size=20"
}
},
"page": {
"size": 20,
"totalElements": 2,
"totalPages": 1,
"number": 0
}
}
```
Response example (200): Copy edition slot to edition
```json
{
"id": "00112233445566778899aabb",
"eventId": "00112233445566778899aabb",
"editionId": "00112233445566778899aabb",
"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",
"content": {
"body": {
"_meta": {
"schema": "http://deliver.bigcontent.io/schema/simple-slot-type.json",
"name": "Name"
}
}
},
"status": "VALID",
"slotStatus": "ACTIVE",
"contentTypeId": "00112233445566778899aabb",
"slotId": "00112233445566778899aabb",
"slotLabel": "Slot Label",
"conflicts": false,
"locale": null,
"empty": true,
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb"
},
"edition-slot": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb"
},
"edition": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"slot": {
"href": "https://api.amplience.net/v2/content/content-items/00112233445566778899aabb?projection",
"templated": true
},
"content": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb/content"
},
"safe-update-content": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb/content?lastModifiedDatepagesizesort",
"templated": true
}
}
}
```
### Get edition slots
`GET /editions/{editionId}/slots`
`https://api.amplience.net/v2/content/editions/{editionId}/slots`
Get Edition Slots
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
| `page` | query | integer | | page to retrieve
Example: `1` |
| `size` | query | integer | | page size to retrieve
Example: `20` |
| `includedSlots` | query | string | | Retrieving Slots associated to an Edition filtered by content item
Example: `00112233-4455-6677-8899-aabbccddeeff` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Edition Slot Response |
Response Example (200)
```json
{
"_embedded": {
"slots": [
{
"id": "00112233445566778899aabb",
"eventId": "00112233445566778899aabb",
"editionId": "00112233445566778899aabb",
"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",
"contentTypeId": "00112233445566778899aabb",
"slotId": "00112233445566778899aabb",
"slotLabel": "Slot Label",
"conflicts": false,
"empty": true,
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb"
},
"edition-slot": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb"
},
"edition": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"slot": {
"href": "https://api.amplience.net/v2/content/content-items/00112233445566778899aabb{?projection}",
"templated": true
},
"content": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb/content"
},
"safe-update-content": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb/content{?lastModifiedDate,page,size,sort}",
"templated": true
}
}
}
]
},
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots?page=0&size=20"
},
"first": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots?page=0&size=20"
},
"last": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots?page=0&size=20"
}
},
"page": {
"size": 20,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}
```
### Get edition slot
`GET /editions/{editionId}/slots/{slotId}`
`https://api.amplience.net/v2/content/editions/{editionId}/slots/{slotId}`
Get Edition Slot
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
| `slotId` | path | string | ✓ | Slot ID
Example: `00112233-4455-6677-8899-aabbccddeeff` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Edition Slot Response |
Response Example (200)
```json
{
"id": "00112233445566778899aabb",
"eventId": "00112233445566778899aabb",
"editionId": "00112233445566778899aabb",
"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",
"content": {
"body": {
"_meta": {
"schema": "http://deliver.bigcontent.io/schema/simple-slot-type.json",
"name": "Name"
}
}
},
"contentTypeId": "00112233445566778899aabb",
"slotId": "00112233445566778899aabb",
"slotLabel": "Slot Label",
"conflicts": false,
"empty": true,
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb"
},
"edition-slot": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb"
},
"edition": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"slot": {
"href": "https://api.amplience.net/v2/content/content-items/00112233445566778899aabb{?projection}",
"templated": true
},
"content": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb/content"
},
"safe-update-content": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb/content{?lastModifiedDate,page,size,sort}",
"templated": true
}
}
}
```
### Delete edition slot
`DELETE /editions/{editionId}/slots/{slotId}`
`https://api.amplience.net/v2/content/editions/{editionId}/slots/{slotId}`
Delete Edition Slot
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
| `slotId` | path | string | ✓ | Slot ID
Example: `00112233-4455-6677-8899-aabbccddeeff` |
**Responses**
| Status | Description |
|--------|-------------|
| 204 | No Content |
### Create edition slot content
`PUT /editions/{editionId}/slots/{slotId}/content`
`https://api.amplience.net/v2/content/editions/{editionId}/slots/{slotId}/content`
Create Edition Slot Content
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
| `slotId` | path | string | ✓ | Slot ID
Example: `00112233-4455-6677-8899-aabbccddeeff` |
**Request Body**
Content-Type: `application/json`
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `body` | object | | |
| `label` | string | | |
Request example
```json
{
"body": {
"_meta": {
"name": "Slot",
"schema": "http://deliver.bigcontent.io/schema/simple-slot-type.json"
},
"slot": {
"_meta": {
"schema": "http://bigcontent.io/cms/schema/v1/core#/definitions/content-link",
"rootContentItem": "00112233-4455-6677-8899-aabbccddeeff",
"locked": true
},
"id": "00112233445566778899aabb",
"contentType": "http://deliver.bigcontent.io/schema/nested/nested-type.json"
}
},
"label": "Simple Slot"
}
```
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Edition Slot Response |
Response Example (200)
```json
{
"id": "00112233445566778899aabb",
"eventId": "00112233445566778899aabb",
"editionId": "00112233445566778899aabb",
"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",
"content": {
"body": {
"_meta": {
"name": "Slot",
"schema": "http://deliver.bigcontent.io/schema/simple-slot-type.json"
},
"slot": {
"_meta": {
"schema": "http://bigcontent.io/cms/schema/v1/core#/definitions/content-link",
"rootContentItem": "00112233-4455-6677-8899-aabbccddeeff",
"locked": true
},
"id": "00112233445566778899aabb",
"contentType": "http://deliver.bigcontent.io/schema/nested/nested-type.json"
}
},
"label": "Simple Slot"
},
"contentTypeId": "00112233445566778899aabb",
"slotId": "00112233445566778899aabb",
"slotLabel": "Slot Label",
"conflicts": false,
"empty": true,
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb"
},
"edition-slot": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb"
},
"edition": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"slot": {
"href": "https://api.amplience.net/v2/content/content-items/00112233445566778899aabb{?projection}",
"templated": true
},
"content": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb/content"
},
"safe-update-content": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots/00112233445566778899aabb/content{?lastModifiedDate,page,size,sort}",
"templated": true
}
}
}
```
### Create edition slot preview
`POST /editions/{editionId}/slots/{slotId}/preview`
`https://api.amplience.net/v2/content/editions/{editionId}/slots/{slotId}/preview`
Allows for creating a preview snapshot of an edition slot, without creating a full edition preview.
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
| `editionSlotId` | path | string | ✓ | Edition Slot ID
Example: `00112233445566778899aabb` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Snapshot ID response |
Response Example (200)
```json
{
"snapshotId": "00112233445566778899aabb",
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb"
}
}
}
```
### Find by date range
`GET /editions/search/findByDate`
`https://api.amplience.net/v2/content/editions/search/findByDate`
Find Editions using a Date Range
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `hubId` | query | string | ✓ | Hub ID
Example: `00112233445566778899aabb` |
| `rangeStart` | query | string | | The start date to search from
Example: `2019-01-01T00:00:00.000Z` |
| `rangeEnd` | query | string | | The end date to search to
Example: `2019-01-01T00:00:00.000Z` |
| `projection` | query | string (withEvent) | | Include child Editions |
| `bounded` | query | integer | | Find editions that have either started or ended within the date range. This parameter is ignored if `expiringIn` is set to true.
Example: `1` |
| `publishingStatus` | query | string (DRAFT, SCHEDULING, SCHEDULED, PUBLISHED, UNSCHEDULING, PUBLISHING) | | Publishing Status
Example: `DRAFT` |
| `expiringIn` | query | boolean | | Find editions that will end within the date range. When this is true, `bounded` is ignored.
Example: `True` |
| `size` | query | integer | | Set the number of results per page
Example: `10` |
| `page` | query | integer | | Page number
Example: `0` |
| `sort` | query | string | | Sort parameter
Example: `createdDate,asc` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Paginated Edition List response |
Response example (200): Paginated editions list
```json
{
"_embedded": {
"editions": [
{
"id": "00112233445566778899aabb",
"name": "Edition",
"comment": "This is an Edition",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"eventId": "00112233445566778899aabb",
"publishingStatus": "DRAFT",
"slotsRemaining": 200,
"schedulingErrors": null,
"activeEndDate": false,
"publishingJobId": "00112233445566778899aabb",
"statusUpdated": "2019-01-01T00:00:00.000Z",
"schedulingUser": null,
"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",
"stagedDate": "2019-01-01T00:00:00.000Z",
"slotCollisions": false,
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"editions": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"create-preview": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/preview"
},
"preview": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/preview"
},
"schedule": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/schedule{?ignoreWarnings}",
"templated": true
},
"update": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"list-slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots{?includedSlots}",
"templated": true
},
"slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots"
},
"copy-slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots{?sourceEditionsSlotId}",
"templated": null
},
"event": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"edition-conflicts": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/conflicts"
},
"edition-conflict": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/conflicts/findByIdVersion{?id,version}",
"templated": true
},
"slot-collisions": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slot-collisions"
}
}
}
]
},
"_links": {
"self": "https://api.amplience.net/v2/content/editions/search/findByDate?hubId=00112233445566778899aabb&rangeStart=2019-01-01T00:00:00.000Z&rangeEnd=2019-01-01T00:00:00.000Z&bounded=false&page=0&size=20",
"first": "https://api.amplience.net/v2/content/editions/search/findByDate?hubId=00112233445566778899aabb&rangeStart=2019-01-01T00:00:00.000Z&rangeEnd=2019-01-01T00:00:00.000Z&bounded=false&page=0&size=20",
"last": "https://api.amplience.net/v2/content/editions/search/findByDate?hubId=00112233445566778899aabb&rangeStart=2019-01-01T00:00:00.000Z&rangeEnd=2019-01-01T00:00:00.000Z&bounded=false&page=0&size=20",
"search": "https://api.amplience.net/v2/content/editions/search/findByDate?hubId=00112233445566778899aabb&rangeStart=2019-01-01T00:00:00.000Z&rangeEnd=2019-01-01T00:00:00.000Z&bounded=false&page=0&size=20"
},
"page": {
"size": 20,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}
```
Response example (200): With event projection
```json
{
"_embedded": {
"editions": [
{
"id": "00112233445566778899aabb",
"name": "Edition",
"comment": "This is an Edition",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"eventId": "00112233445566778899aabb",
"publishingStatus": "DRAFT",
"slotsRemaining": 200,
"schedulingErrors": null,
"activeEndDate": false,
"publishingJobId": "00112233445566778899aabb",
"statusUpdated": "2019-01-01T00:00:00.000Z",
"schedulingUser": null,
"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",
"stagedDate": "2019-01-01T00:00:00.000Z",
"slotCollisions": false,
"event": {
"id": "00112233445566778899aabb",
"name": "Event",
"comment": "This is an Event",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"brief": "http://host/test/brief",
"locales": [
"en-GB"
]
},
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"editions": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"create-preview": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/preview"
},
"preview": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/preview"
},
"schedule": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/schedule{?ignoreWarnings}",
"templated": true
},
"update": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"list-slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots{?includedSlots}",
"templated": true
},
"slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots"
},
"copy-slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots{?sourceEditionsSlotId}",
"templated": null
},
"event": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"edition-conflicts": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/conflicts"
},
"edition-conflict": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/conflicts/findByIdVersion{?id,version}",
"templated": true
},
"slot-collisions": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slot-collisions"
}
}
}
]
},
"_links": {
"self": "https://api.amplience.net/v2/content/editions/search/findByDate?hubId=00112233445566778899aabb&rangeStart=2019-01-01T00:00:00.000Z&rangeEnd=2019-01-01T00:00:00.000Z&bounded=false&page=0&size=20",
"first": "https://api.amplience.net/v2/content/editions/search/findByDate?hubId=00112233445566778899aabb&rangeStart=2019-01-01T00:00:00.000Z&rangeEnd=2019-01-01T00:00:00.000Z&bounded=false&page=0&size=20",
"last": "https://api.amplience.net/v2/content/editions/search/findByDate?hubId=00112233445566778899aabb&rangeStart=2019-01-01T00:00:00.000Z&rangeEnd=2019-01-01T00:00:00.000Z&bounded=false&page=0&size=20",
"search": "https://api.amplience.net/v2/content/editions/search/findByDate?hubId=00112233445566778899aabb&rangeStart=2019-01-01T00:00:00.000Z&rangeEnd=2019-01-01T00:00:00.000Z&bounded=false&page=0&size=20"
},
"page": {
"size": 20,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}
```
### Find by event
`GET /editions/search/findByEvent`
`https://api.amplience.net/v2/content/editions/search/findByEvent`
Find Event by Id
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `eventId` | query | string | ✓ | Event Id
Example: `00112233445566778899aabb` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Paginated Edition List response |
Response Example (200)
```json
{
"_embedded": {
"editions": [
{
"id": "00112233445566778899aabb",
"name": "Edition",
"comment": "This is an Edition comment",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"eventId": "00112233445566778899aabb",
"publishingStatus": "DRAFT",
"slotsRemaining": 200,
"activeEndDate": false,
"publishingJobId": "00112233445566778899aabb",
"statusUpdated": "2019-01-01T00:00:00.000Z",
"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",
"stagedDate": "2019-01-01T00:00:00.000Z",
"slotCollisions": false,
"_links": {
"slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots"
},
"copy-slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots{?sourceEditionsSlotId}",
"templated": true
},
"list-slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots{?includedSlots}",
"templated": true
},
"schedule": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/schedule{?ignoreWarnings}",
"templated": true
},
"update": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
}
}
}
]
},
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions?page=0&size=20"
},
"first": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions?page=0&size=20"
},
"last": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions?page=0&size=20"
},
"search": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions/search"
}
},
"page": {
"size": 20,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}
```
### Create edition
`POST /events/{eventId}/editions`
`https://api.amplience.net/v2/content/events/{eventId}/editions`
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition Id
Example: `00112233445566778899aabb` |
| `sourceEditionId` | query | string | | Duplicate an Edition by providing an Edition Id
Example: `00112233445566778899aabb` |
| `projection` | query | string (withEvent) | | Include parent event for edition |
**Request Body**
Content-Type: `application/json`
| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `name` | string | ✓ | Edition Name |
| `comment` | string | | Edition Comment |
| `activeEndDate` | boolean | | Active End Date |
Request example
```json
{
"name": "Edition",
"comment": "This is an Edition comment",
"activeEndDate": false
}
```
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Create Edition response |
Response Example (200)
```json
{
"id": "00112233445566778899aabb",
"name": "Edition",
"comment": "This is an Edition comment",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"eventId": "00112233445566778899aabb",
"publishingStatus": "DRAFT",
"slotsRemaining": 200,
"activeEndDate": false,
"publishingJobId": "00112233445566778899aabb",
"statusUpdated": "2019-01-01T00:00:00.000Z",
"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",
"stagedDate": "2019-01-01T00:00:00.000Z",
"slotCollisions": false,
"_links": {
"slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots"
},
"copy-slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots{?sourceEditionsSlotId}",
"templated": true
},
"list-slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots{?includedSlots}",
"templated": true
},
"schedule": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/schedule{?ignoreWarnings}",
"templated": true
},
"update": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
}
}
}
```
### List editions
`GET /events/{eventId}/editions`
`https://api.amplience.net/v2/content/events/{eventId}/editions`
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `page` | query | integer | | Page number
Example: `0` |
| `size` | query | integer | | Page size
Example: `20` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Paginated Edition List response |
Response Example (200)
```json
{
"_embedded": {
"editions": [
{
"id": "00112233445566778899aabb",
"name": "Edition",
"comment": "This is an Edition comment",
"start": "2019-01-01T00:00:00.000Z",
"end": "2019-01-01T00:00:00.000Z",
"eventId": "00112233445566778899aabb",
"publishingStatus": "DRAFT",
"slotsRemaining": 200,
"activeEndDate": false,
"publishingJobId": "00112233445566778899aabb",
"statusUpdated": "2019-01-01T00:00:00.000Z",
"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",
"stagedDate": "2019-01-01T00:00:00.000Z",
"slotCollisions": false,
"_links": {
"slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots"
},
"copy-slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots{?sourceEditionsSlotId}",
"templated": true
},
"list-slots": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/slots{?includedSlots}",
"templated": true
},
"schedule": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb/schedule{?ignoreWarnings}",
"templated": true
},
"update": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
}
}
}
]
},
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions?page=0&size=20"
},
"first": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions?page=0&size=20"
},
"last": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions?page=0&size=20"
},
"search": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb/editions/search"
}
},
"page": {
"size": 20,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}
```
### Search editions
`GET /events/{eventid}/editions/search`
`https://api.amplience.net/v2/content/events/{eventid}/editions/search`
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `eventId` | path | string | ✓ | Event Id
Example: `00112233445566778899aabb` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Search Editions response |
Response Example (200)
```json
{
"_links": {
"findOneByPublishManifestId": {
"href": "https://api.amplience.net/v2/content/editions/search/findOneByPublishManifestId"
},
"findByEvent": {
"href": "https://api.amplience.net/v2/content/editions/search/findByEvent?eventId=00112233445566778899aabb{&page,size,sort}",
"templated": true
},
"findOneByPublishingJobId": {
"href": "https://api.amplience.net/v2/content/editions/search/findOneByPublishingJobId"
},
"self": {
"href": "https://api.amplience.net/v2/content/events/00112233445566778899aabb"
}
}
}
```
### Get snapshot edition links
`GET /snapshots/{snapshotId}/edition-links`
`https://api.amplience.net/v2/content/snapshots/{snapshotId}/edition-links`
Return a list of edition links for the specified snapshot.
Simply follow the HAL link with rel "snapshot-edition-links" from a snapshot response.
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `snapshotId` | path | string | ✓ | Snapshot ID
Example: `00112233445566778899aabb` |
| `page` | query | integer | | Page number
Example: `0` |
| `size` | query | integer | | Page size
Example: `20` |
| `sort` | query | string | | Sort paramter
Example: `createdDate,asc` |
**Responses**
| Status | Description |
|--------|-------------|
| 200 | Snapshot Edition Get Links Response |
Response Example (200)
```json
{
"_embedded": {
"edition-links": [
{
"editionId": "00112233445566778899aabb",
"createdDate": "2019-01-01T00:00:00Z",
"createdBy": "00112233-4455-6677-8899-aabbccddeeff",
"edition": "00112233445566778899aabb",
"_links": {
"edition": {
"href": "https://api.amplience.net/v2/content/editions/00112233445566778899aabb"
},
"delete": {
"href": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb/edition-links/00112233445566778899aabb"
}
}
}
]
},
"_links": {
"self": {
"href": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb/edition-links?page=0&size=20"
},
"first": {
"href": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb/edition-links?page=0&size=20"
},
"last": {
"href": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb/edition-links?page=0&size=20"
}
},
"page": {
"size": 20,
"totalElements": 1,
"totalPages": 1,
"number": 0
}
}
```
### Delete snapshot edition link
`DELETE /snapshots/{snapshotId}/edition-links/{editionId}`
`https://api.amplience.net/v2/content/snapshots/{snapshotId}/edition-links/{editionId}`
Delete a Snapshot Edition Link
**Parameters**
| Name | In | Type | Required | Description |
|------|----|------|----------|-------------|
| `editionId` | path | string | ✓ | Edition ID
Example: `00112233445566778899aabb` |
**Responses**
| Status | Description |
|--------|-------------|
| 204 | Successfully removed the Snapshot Edition link |
## Slots
"Slots" are content-items which are stored in separate repositories from other content-items. Their role is to be placeholders for snapshots.
### Example slot content type
```json
{
"$schema" : "http://bigcontent.io/cms/schema/v1/schema#",
"id" : "http://deliver.bigcontent.io/schema/simple-slot-type.json",
"title" : "slot",
"description" : "Slot Container",
"type":"object",
"properties": {
"slot": {
"title": "simple slot container",
"allOf":[
{"$ref": "http://bigcontent.io/cms/schema/v1/core#/definitions/content-link" },
{
"properties": {
"contentType": { "enum": [ "http://deliver.bigcontent.io/schema/nested/nested-type.json" ] }
}
}
]
}
}
}
```
You will need to register a content type capable of holding nested content in order to create a slot.
### Pre-requsites
##### Creating a slot repository
A Slot Repository is just a Content Repository with the "slots" feature. See [adding features to repositories](https://amplience.com/developers/docs/apis/content-management-reference/content-repositories/#assign-a-feature) for more information
##### Creating a slot
A Slot is a Content Item in a Slot Repository. Please refer to [creating a content item](https://amplience.com/developers/docs/apis/content-management-reference/content-items/#create-content-item) for more information.
### Associating slots to editions
Once you have a Slot Repository with some Slots you can then associate them with an Edition in order make them available for publishing.
* Multiple Slots can be associated to an Edition, up to 200
* A Slot can be associated with multiple Editions
* A Slot can only be associated to an Edition once
When you associate Slots to an Edition, the `slotsRemaining` property on the Edition will decrease. If you attempt to associate more Slots than there are remaining on the Edition, the operation will fail.
Please refer to the [Assign Edition Slots section](#assign-edition-slots) for an example request.
##### Retrieving slots associated to an edition
Please refer to the [Retrieving Edition Slots section](#get-edition-slots) for an example request.
##### Retrieving slots associated to an edition filter by content item
To filter by content item, we supply the `includedSlots` query parameter. Please refer to the [Get Edition Slots section](#get-edition-slots) for an example request.
##### Retrieving an single slot associated to an edition
Please refer to the [Get Edition Slot section](#get-edition-slot) for an example request.
##### Removing the association between a slot and an edition
Please refer to the [Delete Edition Slot section](#delete-edition-slot) for an example request.
### Associating snapshots to slots
A slot is a placeholder for one or more snapshots. In order to associate those snapshots to this slot you will need to post the resulting content-item to the slot url.
Notice that in the below request, `body.slot.id` is the path to a snapshot. Not a content item.
The `body.slot.id` can also be set to null when the user hasn't currently assigned all of the fields. The service will accept this data, however the `valid` field will be set to false.
Please refer to the [Create Edition Slot Content section](#create-edition-slot-content) for an example request.