Hubs

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

Authorization and status codes

For authorization and status codes see the API Reference overview.

Hubs
Link copied!

Method	Endpoint	Summary
`GET`	`/hubs`	List hubs
`POST`	`/hubs`	Create hub
`GET`	`/hubs/{hubId}`	Get hub
`PATCH`	`/hubs/{hubId}`	Update hub
`GET`	`/hubs/{hubId}/asset-management`	Get hub asset management settings
`PUT`	`/hubs/{hubId}/asset-management`	Update hub asset management settings
`GET`	`/hubs/{hubId}/asset-repositories`	Get hub asset repositories
`POST`	`/hubs/{hubId}/bulk-apply-locale`	Post bulk apply locale job
`GET`	`/hubs/{hubId}/bulk-apply-locale/{bulkJobId}`	Get bulk apply locale job
`POST`	`/hubs/{hubId}/bulk-archive`	Post bulk archive job
`GET`	`/hubs/{hubId}/bulk-archive/{jobId}`	Get bulk archive job
`POST`	`/hubs/{hubId}/bulk-assign-users`	Post bulk assign users job
`GET`	`/hubs/{hubId}/bulk-assign-users/{jobId}`	Get bulk assign users job
`POST`	`/hubs/{hubId}/bulk-copy-item`	Post bulk copy item job
`GET`	`/hubs/{hubId}/bulk-copy-item/{jobId}`	Get bulk copy item job
`POST`	`/hubs/{hubId}/bulk-publish-items`	Post bulk publish job
`GET`	`/hubs/{hubId}/bulk-publish-items/{bulkJobId}`	Get bulk publish job
`POST`	`/hubs/{hubId}/bulk-unarchive`	Post bulk unarchive job
`GET`	`/hubs/{hubId}/bulk-unarchive/{jobId}`	Get bulk unarchive job
`POST`	`/hubs/{hubId}/bulk-update-workflow`	Post bulk update workflow job
`GET`	`/hubs/{hubId}/bulk-update-workflow/{bulkJobId}`	Get bulk update workflow job
`PUT`	`/hubs/{hubid}/linked-content-repositories`	Create linked content repositories
`PATCH`	`/hubs/{hubId}/plan`	Update hub plan
`PATCH`	`/hubs/{hubId}/settings`	Update hub settings
`POST`	`/hubs/{hubId}/share`	Share hub

Hub response links
Link copied!

Most hub 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 hub response looks like this:

  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
    },
    "hub": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
    },
    "snapshots": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/snapshots{?page,size,sort,types}",
      "templated": true
    },
    "create-snapshot": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/snapshots"
    },
    "batch-create-snapshot": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/snapshots/batch"
    },
    "events": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events{?page,size,sort}",
      "templated": true
    },
    "create-event": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/events"
    },
    "archive": {
      "href": "https://api.amplience.net/v2/content/events/{id}/archive",
      "templated": true
    },
    "update": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
    },
    "delete": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
    },
    "update-settings": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/settings"
    },
    "share": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/share"
    },
    "content-repositories": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/content-repositories{?page,size,sort}",
      "templated": true
    },
    "create-content-repository": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/content-repositories"
    },
    "register-content-types": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/content-types"
    },
    "create-content-type-schema": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/content-type-schemas"
    },
    "content-types": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/content-types{?page,size,sort,status}",
      "templated": true
    },
    "list-content-type-schemas": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/content-type-schemas{?page,size,sort}",
      "templated": true
    },
    "resolve-content-type-schema": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/content-type-schemas/resolve"
    },
    "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
    },
    "search-localization-jobs": {
      "href": "https://api.amplience.net/v2/content/localization-jobs/search"
    },
    "webhooks": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks{?page,size,sort}",
      "templated": true
    },
    "create-webhook": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/webhooks"
    },
    "integrations": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/integrations{?page,size,sort}",
      "templated": true
    },
    "create-workflow-state": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/workflow-states"
    },
    "workflow-states": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/workflow-states{?page,size,sort}",
      "templated": true
    },
    "create-algolia-search-index": {
      "href": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes"
    },
    "algolia-search-indexes": {
      "href": "https://api.amplience.net/v2/content/algolia-search/00112233445566778899aabb/indexes{?parentId,projection,page,size,sort,status}",
      "templated": true
    }
  }

Which links you'll actually see

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

List hubs
Link copied!

GET /hubs

https://api.amplience.net/v2/content/hubs

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 Hub List

Response Example (200)

{
  "_embedded": {
    "hubs": [
      {
        "id": "00112233445566778899aabb",
        "name": "anya-finn",
        "label": "Anya Finn",
        "description": "Content for anyafinn.com",
        "plan": "DEVELOPER",
        "algoliaSearch": "ENABLED",
        "cdv2": "ENABLED",
        "organizationId": "org_cDQVi4ww5y6cMPtN",
        "settings": {
          "devices": [],
          "applications": []
        },
        "_links": {
          "self": {
            "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
          },
          "hub": {
            "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
          },
          "snapshots": {
            "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/snapshots{?page,size,sort,types}",
            "templated": true
          },
          "create-snapshot": {
            "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/snapshots"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs?page=0&size=20"
    },
    "first": {
      "href": "https://api.amplience.net/v2/content/hubs?page=0&size=20"
    },
    "last": {
      "href": "https://api.amplience.net/v2/content/hubs?page=0&size=20"
    }
  },
  "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 29 links the API actually returns. Every hub response includes the full standard set. See Hub response links for the complete list.

Create hub
Link copied!

POST /hubs

https://api.amplience.net/v2/content/hubs

A Hub is a container for multiple repositories including media, content, content types.

Request Body

Content-Type: application/json

Field	Type	Required	Description
`name`	string	✓	Hub name
`label`	string	✓	Hub label
`description`			Hub description
`plan`	string (DEVELOPER)		Hub Plan
`algoliaSearch`	string (ENABLED)		Algolia Search enabled flag
`cdv2`	string (ENABLED)		CD2 enabled flag
`organizationId`	string		Organization ID
`settings`	object		Hub settings

Request example

{
  "name": "anya-finn",
  "label": "Anya Finn",
  "description": "Content for anyafinn.com",
  "plan": "DEVELOPER",
  "algoliaSearch": "ENABLED",
  "cdv2": "ENABLED",
  "organizationId": "org_cDQVi4ww5y6cMPtN",
  "settings": {
    "publishing": {
      "platforms": {
        "amplience_dam": {
          "API_KEY": "DAM_CLIENT_KEY",
          "endpoint": "endpoint"
        }
      }
    },
    "devices": [
      {
        "name": "New Device",
        "width": 2048,
        "height": 1024,
        "orientate": false
      }
    ],
    "localization": {
      "locales": [
        "en-GB",
        "fr-FR"
      ]
    },
    "applications": [
      {
        "name": "Preview Site",
        "templatedUri": "http://example.com"
      }
    ],
    "previewVirtualStagingEnvironment": {
      "hostname": "unique-id.staging.bigcontent.io"
    },
    "virtualStagingEnvironment": {
      "hostname": "unique-id.staging.bigcontent.io"
    },
    "assetManagement": {
      "enabled": false,
      "clientConfig": "HUB"
    },
    "contentItems": {
      "validation": {
        "ignoreSchemaValidation": false
      }
    }
  }
}

Responses

Status	Description
201	Created

Response Example (201)

{
  "id": "00112233445566778899aabb",
  "name": "anya-finn",
  "label": "Anya Finn",
  "description": "Content for anyafinn.com",
  "plan": "DEVELOPER",
  "algoliaSearch": "ENABLED",
  "cdv2": "ENABLED",
  "organizationId": "org_cDQVi4ww5y6cMPtN",
  "settings": {
    "publishing": {
      "platforms": {
        "amplience_dam": {
          "API_KEY": "DAM_CLIENT_KEY",
          "endpoint": "endpoint"
        }
      }
    },
    "devices": [
      {
        "name": "New Device",
        "width": 2048,
        "height": 1024,
        "orientate": false
      }
    ],
    "localization": {
      "locales": [
        "en-GB",
        "fr-FR"
      ]
    },
    "applications": [
      {
        "name": "Preview Site",
        "templatedUri": "http://example.com"
      }
    ],
    "previewVirtualStagingEnvironment": {
      "hostname": "unique-id.staging.bigcontent.io"
    },
    "virtualStagingEnvironment": {
      "hostname": "unique-id.staging.bigcontent.io"
    },
    "assetManagement": {
      "enabled": false,
      "clientConfig": "HUB"
    },
    "contentItems": {
      "validation": {
        "ignoreSchemaValidation": false
      }
    }
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
    },
    "hub": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
    },
    "snapshots": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/snapshots{?page,size,sort,types}",
      "templated": true
    },
    "create-snapshot": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/snapshots"
    }
  }
}

Abbreviated response

Get hub
Link copied!

GET /hubs/{hubId}

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

Hub is the root resource in Dynamic Content, all other resources can be accessed from a Hub

Parameters

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

Responses

Status	Description
200	Hub response

Response Example (200)

{
  "id": "00112233445566778899aabb",
  "name": "anya-finn",
  "label": "Anya Finn",
  "description": "Content for anyafinn.com",
  "plan": "DEVELOPER",
  "algoliaSearch": "ENABLED",
  "cdv2": "ENABLED",
  "organizationId": "org_cDQVi4ww5y6cMPtN",
  "settings": {
    "publishing": {
      "platforms": {
        "amplience_dam": {
          "API_KEY": "DAM_CLIENT_KEY",
          "endpoint": "endpoint"
        }
      }
    },
    "devices": [
      {
        "name": "New Device",
        "width": 2048,
        "height": 1024,
        "orientate": false
      }
    ],
    "localization": {
      "locales": [
        "en-GB",
        "fr-FR"
      ]
    },
    "applications": [
      {
        "name": "Preview Site",
        "templatedUri": "http://example.com"
      }
    ],
    "previewVirtualStagingEnvironment": {
      "hostname": "unique-id.staging.bigcontent.io"
    },
    "virtualStagingEnvironment": {
      "hostname": "unique-id.staging.bigcontent.io"
    },
    "assetManagement": {
      "enabled": false,
      "clientConfig": "HUB"
    },
    "contentItems": {
      "validation": {
        "ignoreSchemaValidation": false
      }
    }
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
    },
    "hub": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
    },
    "snapshots": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/snapshots{?page,size,sort,types}",
      "templated": true
    },
    "create-snapshot": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/snapshots"
    }
  }
}

Abbreviated response

Update hub
Link copied!

PATCH /hubs/{hubId}

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

Hub is the root resource in Dynamic Content, all other resources can be accessed from a Hub

Parameters

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

Request Body

Content-Type: application/json

Field	Type	Description
`name`	string	Hub name
`label`	string	Hub label
`description`		Hub description
`plan`	string (DEVELOPER)	Hub Plan
`algoliaSearch`	string (ENABLED)	Algolia Search enabled flag
`cdv2`	string (ENABLED)	CD2 enabled flag
`organizationId`	string	Organization ID
`settings`	object	Hub settings

Request example

{
  "name": "anya-finn",
  "label": "Anya Finn",
  "description": "Content for anyafinn.com",
  "plan": "DEVELOPER",
  "algoliaSearch": "ENABLED",
  "cdv2": "ENABLED",
  "organizationId": "org_cDQVi4ww5y6cMPtN",
  "settings": {
    "publishing": {
      "platforms": {
        "amplience_dam": {
          "API_KEY": "DAM_CLIENT_KEY",
          "endpoint": "endpoint"
        }
      }
    },
    "devices": [
      {
        "name": "New Device",
        "width": 2048,
        "height": 1024,
        "orientate": false
      }
    ],
    "localization": {
      "locales": [
        "en-GB",
        "fr-FR"
      ]
    },
    "applications": [
      {
        "name": "Preview Site",
        "templatedUri": "http://example.com"
      }
    ],
    "previewVirtualStagingEnvironment": {
      "hostname": "unique-id.staging.bigcontent.io"
    },
    "virtualStagingEnvironment": {
      "hostname": "unique-id.staging.bigcontent.io"
    },
    "assetManagement": {
      "enabled": false,
      "clientConfig": "HUB"
    },
    "contentItems": {
      "validation": {
        "ignoreSchemaValidation": false
      }
    }
  }
}

Responses

Status	Description
200	Updated Hub response

Response Example (200)

{
  "id": "00112233445566778899aabb",
  "name": "anya-finn",
  "label": "Anya Finn",
  "description": "Content for anyafinn.com",
  "plan": "DEVELOPER",
  "algoliaSearch": "ENABLED",
  "cdv2": "ENABLED",
  "organizationId": "org_cDQVi4ww5y6cMPtN",
  "settings": {
    "publishing": {
      "platforms": {
        "amplience_dam": {
          "API_KEY": "DAM_CLIENT_KEY",
          "endpoint": "endpoint"
        }
      }
    },
    "devices": [
      {
        "name": "New Device",
        "width": 2048,
        "height": 1024,
        "orientate": false
      }
    ],
    "localization": {
      "locales": [
        "en-GB",
        "fr-FR"
      ]
    },
    "applications": [
      {
        "name": "Preview Site",
        "templatedUri": "http://example.com"
      }
    ],
    "previewVirtualStagingEnvironment": {
      "hostname": "unique-id.staging.bigcontent.io"
    },
    "virtualStagingEnvironment": {
      "hostname": "unique-id.staging.bigcontent.io"
    },
    "assetManagement": {
      "enabled": false,
      "clientConfig": "HUB"
    },
    "contentItems": {
      "validation": {
        "ignoreSchemaValidation": false
      }
    }
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
    },
    "hub": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
    },
    "snapshots": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/snapshots{?page,size,sort,types}",
      "templated": true
    },
    "create-snapshot": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/snapshots"
    }
  }
}

Abbreviated response

Get hub asset management settings
Link copied!

GET /hubs/{hubId}/asset-management

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

Parameters

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

Responses

Status	Description
200	Updated Hub

Response Example (200)

{
  "enabled": false,
  "clientConfig": "HUB",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/asset-management"
    },
    "hub": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
    },
    "asset-management": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/asset-management"
    }
  }
}

Update hub asset management settings
Link copied!

PUT /hubs/{hubId}/asset-management

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

Parameters

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

Request Body

Content-Type: application/json

Field	Type	Required	Description
`enabled`	boolean
`clientConfig`	string (HUB, USER)

Request example

{
  "enabled": false,
  "clientConfig": "HUB"
}

Responses

Status	Description
200	Updated Hub

Response Example (200)

{
  "enabled": false,
  "clientConfig": "HUB",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/asset-management"
    },
    "hub": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
    },
    "asset-management": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/asset-management"
    }
  }
}

Get hub asset repositories
Link copied!

GET /hubs/{hubId}/asset-repositories

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

Parameters

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

Responses

Status	Description
200	Asset Repositories for a Hub

Response Example (200)

{
  "assetRepositories": [
    {
      "assetRepositoryId": "00112233-4455-6677-8899-aabbccddeeff",
      "assetRepositoryLabel": "asset repository label",
      "accessLevel": "READ/EDIT"
    }
  ]
}

Post bulk apply locale job
Link copied!

POST /hubs/{hubId}/bulk-apply-locale

https://api.amplience.net/v2/content/hubs/{hubId}/bulk-apply-locale

Parameters

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

Request Body

Content-Type: application/json

Field	Type	Required	Description
`selection`	array
`localization`	object

Request example

{
  "selection": [
    {
      "contentItemId": "00112233-4455-6677-8899-aabbccddeeff",
      "version": 1
    }
  ],
  "localization": {
    "locale": "en-gb"
  }
}

Responses

Status	Description
200	Bulk Job

Response Example (200)

{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "type": "LOCALE",
  "status": "CREATED",
  "results": {
    "succeeded": [],
    "failed": []
  },
  "createdDate": "2019-01-01T00:00:00.000Z",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-apply-locale/00112233445566778899bbcc/"
    },
    "bulk-apply-locale": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-apply-locale/00112233445566778899bbcc/"
    }
  }
}

Get bulk apply locale job
Link copied!

GET /hubs/{hubId}/bulk-apply-locale/{bulkJobId}

https://api.amplience.net/v2/content/hubs/{hubId}/bulk-apply-locale/{bulkJobId}

Parameters

Name	In	Type	Required	Description
`hubId`	path	string	✓	Hub ID Example: `00112233445566778899aabb`
`bulkJobId`	path	string	✓	Bulk Job Id Example: `00112233445566778899bbcc`

Responses

Status	Description
200	Get bulk update workflow response

Response Example (200)

{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "type": "LOCALE",
  "status": "CREATED",
  "results": {
    "succeeded": [
      {
        "contentItemId": "00112233-4455-6677-8899-aabbccddeeff"
      }
    ],
    "failed": [
      {
        "contentItemId": "00112233-4455-6677-8899-aabbccddeeff",
        "Code": "NULL_VERSION",
        "message": "version must not be null"
      }
    ]
  },
  "createdDate": "2019-01-01T00:00:00.000Z",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-apply-locale/00112233445566778899bbcc/"
    },
    "bulk-apply-locale": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-apply-locale/00112233445566778899bbcc/"
    }
  }
}

Post bulk archive job
Link copied!

POST /hubs/{hubId}/bulk-archive

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

Parameters

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

Request Body

Content-Type: application/json

Field	Type	Required	Description
`selection`	array

Request example

{
  "selection": [
    {
      "contentItemId": "00112233-4455-6677-8899-aabbccddeeff",
      "version": 1
    }
  ]
}

Responses

Status	Description
200	Bulk Job

Response Example (200)

{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "type": "ARCHIVE",
  "status": "CREATED",
  "results": {
    "succeeded": [],
    "failed": []
  },
  "createdDate": "2019-01-01T00:00:00.000Z",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-archive/00112233445566778899bbcc/"
    },
    "bulk-archive": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-archive/00112233445566778899bbcc/"
    }
  }
}

Get bulk archive job
Link copied!

GET /hubs/{hubId}/bulk-archive/{jobId}

https://api.amplience.net/v2/content/hubs/{hubId}/bulk-archive/{jobId}

Parameters

Name	In	Type	Required	Description
`hubId`	path	string	✓	Hub ID Example: `00112233445566778899aabb`
`jobId`	path	string	✓	Bulk Job Id Example: `00112233445566778899bbcc`

Responses

Status	Description
200	Get bulk archive response

Response Example (200)

{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "type": "ARCHIVE",
  "status": "CREATED",
  "results": {
    "succeeded": [
      {
        "id": "00112233-4455-6677-8899-aabbccddeeff"
      }
    ],
    "failed": [
      {
        "id": "00112233-4455-6677-8899-aabbccddeeff",
        "Code": "NULL_VERSION",
        "message": "version must not be null"
      }
    ]
  },
  "createdDate": "2019-01-01T00:00:00.000Z",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-archive/00112233445566778899bbcc/"
    },
    "bulk-archive": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-archive/00112233445566778899bbcc/"
    }
  }
}

Post bulk assign users job
Link copied!

POST /hubs/{hubId}/bulk-assign-users

https://api.amplience.net/v2/content/hubs/{hubId}/bulk-assign-users

Parameters

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

Request Body

Content-Type: application/json

Field	Type	Required	Description
`selection`	array

Request example

{
  "selection": [
    {
      "contentItemId": "00112233-4455-6677-8899-aabbccddeeff",
      "assignees": [
        "00112233445566778899aabb"
      ]
    }
  ]
}

Responses

Status	Description
200	Bulk Job

Response Example (200)

{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "type": "ASSIGN_USERS",
  "status": "CREATED",
  "results": {
    "succeeded": [],
    "failed": []
  },
  "createdDate": "2019-01-01T00:00:00.000Z",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-assign-users/00112233445566778899bbcc/"
    },
    "bulk-assign-users": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-assign-users/00112233445566778899bbcc/"
    }
  }
}

Get bulk assign users job
Link copied!

GET /hubs/{hubId}/bulk-assign-users/{jobId}

https://api.amplience.net/v2/content/hubs/{hubId}/bulk-assign-users/{jobId}

Parameters

Name	In	Type	Required	Description
`hubId`	path	string	✓	Hub ID Example: `00112233445566778899aabb`
`jobId`	path	string	✓	Bulk Job Id Example: `00112233445566778899bbcc`

Responses

Status	Description
200	Get bulk assign users response

Response Example (200)

{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "type": "ASSIGN_USERS",
  "status": "CREATED",
  "results": {
    "succeeded": [
      {
        "id": "00112233-4455-6677-8899-aabbccddeeff"
      }
    ],
    "failed": [
      {
        "id": "00112233-4455-6677-8899-aabbccddeeff",
        "Code": "EMPTY_BULK_JOB_REQUEST",
        "message": "No items were supplied in this request"
      }
    ]
  },
  "createdDate": "2019-01-01T00:00:00.000Z",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-assign-users/00112233445566778899bbcc/"
    },
    "bulk-assign-users": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-assign-users/00112233445566778899bbcc/"
    }
  }
}

Post bulk copy item job
Link copied!

POST /hubs/{hubId}/bulk-copy-item

https://api.amplience.net/v2/content/hubs/{hubId}/bulk-copy-item

Parameters

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

Request Body

Content-Type: application/json

Field	Type	Required	Description
`selection`	array

Request example

{
  "selection": [
    {
      "contentItemId": "00112233-4455-6677-8899-aabbccddeeff",
      "version": 1,
      "contentRepositoryId": "00112233-4455-6677-8899-aabbccddaabb",
      "folderId": "00112233-4455-6677-8899-aabbccddddcc",
      "name": "New Name",
      "label": "label1"
    }
  ]
}

Responses

Status	Description
200	Updated Hub

Response Example (200)

{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "type": "COPY",
  "status": "CREATED",
  "results": {
    "succeeded": [],
    "failed": []
  },
  "createdDate": "2019-01-01T00:00:00.000Z",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-copy-item/00112233445566778899bbcc/"
    },
    "bulk-copy-item": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-copy-item/00112233445566778899bbcc/"
    }
  }
}

Get bulk copy item job
Link copied!

GET /hubs/{hubId}/bulk-copy-item/{jobId}

https://api.amplience.net/v2/content/hubs/{hubId}/bulk-copy-item/{jobId}

Parameters

Name	In	Type	Required	Description
`hubId`	path	string	✓	Hub ID Example: `00112233445566778899aabb`
`jobId`	path	string	✓	Bulk Job Id Example: `00112233445566778899bbcc`

Responses

Status	Description
200	Updated Hub

Response Example (200)

{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "type": "COPY",
  "status": "CREATED",
  "results": {
    "succeeded": [
      {
        "id": "00112233-4455-6677-8899-aabbccddeeff"
      }
    ],
    "failed": [
      {
        "id": "00112233-4455-6677-8899-aabbccddeeff",
        "Code": "UNAUTHORISED",
        "message": "Authorization required."
      }
    ]
  },
  "createdDate": "2019-01-01T00:00:00.000Z",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-copy-item/00112233445566778899bbcc/"
    },
    "bulk-copy-item": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-copy-item/00112233445566778899bbcc/"
    }
  }
}

Post bulk publish job
Link copied!

POST /hubs/{hubId}/bulk-publish-items

https://api.amplience.net/v2/content/hubs/{hubId}/bulk-publish-items

Parameters

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

Request Body

Content-Type: application/json

Field	Type	Required	Description
`selection`	array

Request example

{
  "selection": [
    {
      "contentItemId": "00112233-4455-6677-8899-aabbccddeeff",
      "version": 1
    }
  ]
}

Responses

Status	Description
200	Bulk Job

Response Example (200)

{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "type": "PUBLISH",
  "status": "CREATED",
  "results": {
    "succeeded": [],
    "failed": []
  },
  "createdDate": "2019-01-01T00:00:00.000Z",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-publish-items/00112233445566778899bbcc/"
    },
    "bulk-publish-items": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-publish-items/00112233445566778899bbcc/"
    }
  }
}

Get bulk publish job
Link copied!

GET /hubs/{hubId}/bulk-publish-items/{bulkJobId}

https://api.amplience.net/v2/content/hubs/{hubId}/bulk-publish-items/{bulkJobId}

Parameters

Name	In	Type	Required	Description
`hubId`	path	string	✓	Hub ID Example: `00112233445566778899aabb`
`bulkJobId`	path	string	✓	Bulk Job Id Example: `00112233445566778899bbcc`

Responses

Status	Description
200	Get bulk publish response

Response Example (200)

{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "type": "PUBLISH",
  "status": "CREATED",
  "results": {
    "succeeded": [
      {
        "contentItemId": "00112233-4455-6677-8899-aabbccddeeff",
        "publishingJobId": "00112233445566778899aabb",
        "_links": {
          "publishing-job": {
            "href": "https://api.amplience.net/v2/content/publishing-jobs/00112233445566778899aabb"
          }
        }
      }
    ],
    "failed": [
      {
        "id": "00112233-4455-6677-8899-aabbccddeeff",
        "Code": "NULL_VERSION",
        "message": "version must not be null"
      }
    ]
  },
  "createdDate": "2019-01-01T00:00:00.000Z",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-publish-items/00112233445566778899bbcc/"
    },
    "bulk-publish-items": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-publish-items/00112233445566778899bbcc/"
    }
  }
}

Post bulk unarchive job
Link copied!

POST /hubs/{hubId}/bulk-unarchive

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

Parameters

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

Request Body

Content-Type: application/json

Field	Type	Required	Description
`selection`	array

Request example

{
  "selection": [
    {
      "contentItemId": "00112233-4455-6677-8899-aabbccddeeff",
      "version": 1
    }
  ]
}

Responses

Status	Description
200	Updated Hub

Response Example (200)

{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "type": "UNARCHIVE",
  "status": "CREATED",
  "results": {
    "succeeded": [],
    "failed": []
  },
  "createdDate": "2019-01-01T00:00:00.000Z",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-unarchive/00112233445566778899bbcc/"
    },
    "bulk-unarchive": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-unarchive/00112233445566778899bbcc/"
    }
  }
}

Get bulk unarchive job
Link copied!

GET /hubs/{hubId}/bulk-unarchive/{jobId}

https://api.amplience.net/v2/content/hubs/{hubId}/bulk-unarchive/{jobId}

Parameters

Name	In	Type	Required	Description
`hubId`	path	string	✓	Hub ID Example: `00112233445566778899aabb`
`jobId`	path	string	✓	Bulk Job Id Example: `00112233445566778899bbcc`

Responses

Status	Description
200	Updated Hub

Response Example (200)

{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "type": "UNARCHIVE",
  "status": "CREATED",
  "results": {
    "succeeded": [
      {
        "contentItemId": "00112233-4455-6677-8899-aabbccddeeff"
      }
    ],
    "failed": [
      {
        "contentItemId": "00112233-4455-6677-8899-aabbccddeeff",
        "Code": "NULL_VERSION",
        "message": "version must not be null"
      }
    ]
  },
  "createdDate": "2019-01-01T00:00:00.000Z",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-unarchive/00112233445566778899bbcc/"
    },
    "bulk-unarchive": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-unarchive/00112233445566778899bbcc/"
    }
  }
}

Post bulk update workflow job
Link copied!

POST /hubs/{hubId}/bulk-update-workflow

https://api.amplience.net/v2/content/hubs/{hubId}/bulk-update-workflow

Parameters

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

Request Body

Content-Type: application/json

Field	Type	Required	Description
`selection`	array
`workflow`	object

Request example

{
  "selection": [
    {
      "contentItemId": "00112233-4455-6677-8899-aabbccddeeff",
      "version": 1
    }
  ],
  "workflow": {
    "state": "00112233445566778899aabb"
  }
}

Responses

Status	Description
200	Bulk Job

Response Example (200)

{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "type": "UPDATE_WORKFLOW",
  "status": "CREATED",
  "results": {
    "succeeded": [],
    "failed": []
  },
  "createdDate": "2019-01-01T00:00:00.000Z",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-update-workflow/00112233445566778899bbcc/"
    },
    "bulk-update-workflow": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-update-workflow/00112233445566778899bbcc/"
    }
  }
}

Get bulk update workflow job
Link copied!

GET /hubs/{hubId}/bulk-update-workflow/{bulkJobId}

https://api.amplience.net/v2/content/hubs/{hubId}/bulk-update-workflow/{bulkJobId}

Parameters

Name	In	Type	Required	Description
`hubId`	path	string	✓	Hub ID Example: `00112233445566778899aabb`
`bulkJobId`	path	string	✓	Bulk Job Id Example: `00112233445566778899bbcc`

Responses

Status	Description
200	Get bulk update workflow response

Response Example (200)

{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "type": "UPDATE_WORKFLOW",
  "status": "CREATED",
  "results": {
    "succeeded": [
      {
        "id": "00112233-4455-6677-8899-aabbccddeeff"
      }
    ],
    "failed": [
      {
        "id": "00112233-4455-6677-8899-aabbccddeeff",
        "Code": "NULL_VERSION",
        "message": "version must not be null"
      }
    ]
  },
  "createdDate": "2019-01-01T00:00:00.000Z",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-update-workflow/00112233445566778899bbcc/"
    },
    "bulk-update-workflow": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb/bulk-update-workflow/00112233445566778899bbcc/"
    }
  }
}

Create linked content repositories
Link copied!

PUT /hubs/{hubid}/linked-content-repositories

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

Create a link for content repositories between different hubs to allow the coping or syncing of content

Parameters

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

Request Body

Content-Type: application/json

Field	Type	Description
`originHubId`	string	Defines the hub id to use as a starting point for unidirectional relationships
`hubIds`	array
`bidirectional`	boolean	Defines the directionality of the linked repositories
`relationships`	array

Request example

{
  "originHubId": "00112233445566778899aabb",
  "hubIds": [
    "00112233445566778899aabb",
    "00112233445566778899ccdd"
  ],
  "bidirectional": false,
  "relationships": [
    {
      "originRepositoryId": "00112233-4455-6677-8899-aabbccddeeff",
      "dstRepositoryId": "00112233-4455-6677-8899-aabbccddeeff"
    }
  ]
}

Responses

Status	Description
200	Created Linked Content Repository

Response Example (200)

{
  "originHubId": "00112233445566778899aabb",
  "hubIds": [
    "00112233445566778899aabb",
    "00112233445566778899ccdd"
  ],
  "bidirectional": false,
  "relationships": [
    {
      "originRepositoryId": "00112233-4455-6677-8899-aabbccddeeff",
      "dstRepositoryId": "00112233-4455-6677-8899-aabbccddeeff"
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hub/00112233445566778899aabb/linked-content-repositories"
    },
    "linked-content-repositories": {
      "href": "https://api.amplience.net/v2/content/hub/00112233445566778899aabb/linked-content-repositories"
    }
  }
}

Update hub plan
Link copied!

PATCH /hubs/{hubId}/plan

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

Parameters

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

Request Body

Content-Type: application/json

Field	Type	Required	Description
`plan`	string (DEVELOPER)		Hub Plan

Request example

{
  "plan": "DEVELOPER"
}

Responses

Status	Description
204	Updated Hub

Update hub settings
Link copied!

PATCH /hubs/{hubId}/settings

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

Parameters

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

Request Body

Content-Type: application/json

Field	Type	Required	Description
`publishing`	object
`devices`	array
`localization`	object
`applications`	array
`previewVirtualStagingEnvironment`	object
`virtualStagingEnvironment`	object
`assetManagement`	object
`contentItems`	object

Request example

{
  "publishing": {
    "platforms": {
      "amplience_dam": {
        "API_KEY": "DAM_CLIENT_KEY",
        "endpoint": "endpoint"
      }
    }
  },
  "devices": [
    {
      "name": "New Device",
      "width": 2048,
      "height": 1024,
      "orientate": false
    }
  ],
  "localization": {
    "locales": [
      "en-GB",
      "fr-FR"
    ]
  },
  "applications": [
    {
      "name": "Preview Site",
      "templatedUri": "http://example.com"
    }
  ],
  "previewVirtualStagingEnvironment": {
    "hostname": "unique-id.staging.bigcontent.io"
  },
  "virtualStagingEnvironment": {
    "hostname": "unique-id.staging.bigcontent.io"
  },
  "assetManagement": {
    "enabled": false,
    "clientConfig": "HUB"
  },
  "contentItems": {
    "validation": {
      "ignoreSchemaValidation": false
    }
  }
}

Responses

Status	Description
204	Updated Hub

POST /hubs/{hubId}/share

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

Hub is the root resource in Dynamic Content, all other resources can be accessed from a Hub

Parameters

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

Request Body

Content-Type: application/json

Field	Type	Required	Description
`user`	string	✓	User Id
`additionalPermissions`	array	✓	Permissions to share

Request example

{
  "user": "00112233-4455-6677-8899-aabbccddeeff",
  "additionalPermissions": [
    "READ"
  ]
}

Responses

Status	Description
204	No Content

Authorization and status codes

HubsLink copied!

Hub response linksLink copied!

Which links you'll actually see

List hubsLink copied!

Abbreviated response

Create hubLink copied!

Abbreviated response

Get hubLink copied!

Abbreviated response

Update hubLink copied!

Abbreviated response

Get hub asset management settingsLink copied!

Update hub asset management settingsLink copied!

Get hub asset repositoriesLink copied!

Post bulk apply locale jobLink copied!

Get bulk apply locale jobLink copied!

Post bulk archive jobLink copied!

Get bulk archive jobLink copied!

Post bulk assign users jobLink copied!

Get bulk assign users jobLink copied!

Post bulk copy item jobLink copied!

Get bulk copy item jobLink copied!

Post bulk publish jobLink copied!

Get bulk publish jobLink copied!

Post bulk unarchive jobLink copied!

Get bulk unarchive jobLink copied!

Post bulk update workflow jobLink copied!

Get bulk update workflow jobLink copied!

Create linked content repositoriesLink copied!

Update hub planLink copied!

Update hub settingsLink copied!

Share hubLink copied!

Hubs
Link copied!

Hub response links
Link copied!

List hubs
Link copied!

Create hub
Link copied!

Get hub
Link copied!

Update hub
Link copied!

Get hub asset management settings
Link copied!

Update hub asset management settings
Link copied!

Get hub asset repositories
Link copied!

Post bulk apply locale job
Link copied!

Get bulk apply locale job
Link copied!

Post bulk archive job
Link copied!

Get bulk archive job
Link copied!

Post bulk assign users job
Link copied!

Get bulk assign users job
Link copied!

Post bulk copy item job
Link copied!

Get bulk copy item job
Link copied!

Post bulk publish job
Link copied!

Get bulk publish job
Link copied!

Post bulk unarchive job
Link copied!

Get bulk unarchive job
Link copied!

Post bulk update workflow job
Link copied!

Get bulk update workflow job
Link copied!

Create linked content repositories
Link copied!

Update hub plan
Link copied!

Update hub settings
Link copied!

Share hub
Link copied!