Folders and hierarchy

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

Authorization and status codes

For authorization and status codes see the API Reference overview.

Folders
Link copied!

Method	Endpoint	Summary
`POST`	`/content-repositories/{contentRepositoryId}/folders`	Create folder
`GET`	`/content-repositories/{contentRepositoryId}/folders`	List folders
`PATCH`	`/folders/{folderId}`	Update folder
`GET`	`/folders/{folderId}`	Get folder
`DELETE`	`/folders/{folderId}`	Delete folder
`POST`	`/folders/{folderId}/folders`	Create sub-folder
`GET`	`/folders/{folderId}/folders`	List sub-folders

Create folder
Link copied!

POST /content-repositories/{contentRepositoryId}/folders

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

Folders are used to organise items in a hierarchical structure. Currently only enabled for organising content items within a content repository.

To create a new folder follow the "create-folder" link from a content repository.

Parameters

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

Request Body

Content-Type: application/json

Field	Type	Required	Description
`name`	string	✓	Folder name

Request example

{
  "name": "New folder"
}

Responses

Status	Description
201	Created Content Repository Folder

Response Example (201)

{
  "id": "00112233445566778899aabb",
  "name": "New folder",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
    },
    "folder": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
    },
    "content-repository": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb"
    },
    "content-items": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/content-items?folderId=00112233445566778899aabb{&page,projection,size,sort,status}",
      "templated": true
    },
    "create-folder": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb/folders"
    },
    "delete-folder": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
    },
    "update-folder": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
    }
  }
}

List folders
Link copied!

GET /content-repositories/{contentRepositoryId}/folders

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

List all of the top-level Folders for a Content Repository

Parameters

Name	In	Type	Required	Description
`contentRepositoryId`	path	string	✓	Content Repository 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	Top-level Folders

Response Example (200)

{
  "_embedded": {
    "folders": [
      {
        "id": "00112233445566778899aabb",
        "name": "New folder",
        "_links": {
          "self": {
            "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
          },
          "folder": {
            "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
          },
          "content-repository": {
            "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb"
          },
          "content-items": {
            "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/content-items?folderId=00112233445566778899aabb{&page,projection,size,sort,status}",
            "templated": true
          },
          "create-folder": {
            "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb/folders"
          },
          "delete-folder": {
            "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
          },
          "update-folder": {
            "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-repositories/5d5bc1dfc9e77c035fede5c7/folders?page=0&size=20"
    },
    "first": {
      "href": "https://api.amplience.net/v2/content/content-repositories/5d5bc1dfc9e77c035fede5c7/folders?page=0&size=20"
    },
    "last": {
      "href": "https://api.amplience.net/v2/content/content-repositories/5d5bc1dfc9e77c035fede5c7/folders?page=0&size=20"
    },
    "search": {
      "href": "https://api.amplience.net/v2/content/content-repositories/5d5bc1dfc9e77c035fede5c7/folders/search"
    }
  },
  "page": {
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  }
}

Update folder
Link copied!

PATCH /folders/{folderId}

https://api.amplience.net/v2/content/folders/{folderId}

Update a folder

Parameters

Name	In	Type	Required	Description
`folderId`	path	string	✓	Folder ID Example: `00112233445566778899aabb`

Request Body

Content-Type: application/json

Field	Type	Required	Description
`name`	string		Folder name

Request example

{
  "name": "New folder"
}

Responses

Status	Description
200	Updated Folder

Response Example (200)

{
  "id": "00112233445566778899aabb",
  "name": "New folder",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
    },
    "folder": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
    },
    "content-repository": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb"
    },
    "content-items": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/content-items?folderId=00112233445566778899aabb{&page,projection,size,sort,status}",
      "templated": true
    },
    "create-folder": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb/folders"
    },
    "delete-folder": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
    },
    "update-folder": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
    }
  }
}

Get folder
Link copied!

GET /folders/{folderId}

https://api.amplience.net/v2/content/folders/{folderId}

Get a folder

Parameters

Name	In	Type	Required	Description
`folderId`	path	string	✓	Folder ID Example: `00112233445566778899aabb`

Responses

Status	Description
200	Folder

Response Example (200)

{
  "id": "00112233445566778899aabb",
  "name": "New folder",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
    },
    "folder": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
    },
    "content-repository": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb"
    },
    "content-items": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/content-items?folderId=00112233445566778899aabb{&page,projection,size,sort,status}",
      "templated": true
    },
    "create-folder": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb/folders"
    },
    "delete-folder": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
    },
    "update-folder": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
    }
  }
}

Delete folder
Link copied!

DELETE /folders/{folderId}

https://api.amplience.net/v2/content/folders/{folderId}

Delete a folder

Parameters

Name	In	Type	Required	Description
`folderId`	path	string	✓	Folder ID Example: `00112233445566778899aabb`

Responses

Status	Description
204	Success

Create sub-folder
Link copied!

POST /folders/{folderId}/folders

https://api.amplience.net/v2/content/folders/{folderId}/folders

Create a new sub-folder.

Parameters

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

Request Body

Content-Type: application/json

Field	Type	Required	Description
`name`	string	✓	Folder name

Request example

{
  "name": "New folder"
}

Responses

Status	Description
201	Created Sub-Folder

Response Example (201)

{
  "id": "00112233445566778899aabb",
  "name": "New folder",
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
    },
    "folder": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
    },
    "content-repository": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb"
    },
    "content-items": {
      "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/content-items?folderId=00112233445566778899aabb{&page,projection,size,sort,status}",
      "templated": true
    },
    "create-folder": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb/folders"
    },
    "delete-folder": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
    },
    "update-folder": {
      "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
    }
  }
}

List sub-folders
Link copied!

GET /folders/{folderId}/folders

https://api.amplience.net/v2/content/folders/{folderId}/folders

List the sub-folders of a folder

Parameters

Name	In	Type	Required	Description
`folderId`	path	string	✓	Folder ID Example: `00112233445566778899aabb`

Responses

Status	Description
200	Folder

Response Example (200)

{
  "_embedded": {
    "folders": [
      {
        "id": "00112233445566778899aabb",
        "name": "New folder",
        "_links": {
          "self": {
            "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
          },
          "folder": {
            "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
          },
          "content-repository": {
            "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb"
          },
          "content-items": {
            "href": "https://api.amplience.net/v2/content/content-repositories/00112233445566778899aabb/content-items?folderId=00112233445566778899aabb{&page,projection,size,sort,status}",
            "templated": true
          },
          "create-folder": {
            "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb/folders"
          },
          "delete-folder": {
            "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
          },
          "update-folder": {
            "href": "https://api.amplience.net/v2/content/folders/00112233445566778899aabb"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/content-repositories/5d5bc1dfc9e77c035fede5c7/folders?page=0&size=20"
    },
    "first": {
      "href": "https://api.amplience.net/v2/content/content-repositories/5d5bc1dfc9e77c035fede5c7/folders?page=0&size=20"
    },
    "last": {
      "href": "https://api.amplience.net/v2/content/content-repositories/5d5bc1dfc9e77c035fede5c7/folders?page=0&size=20"
    },
    "search": {
      "href": "https://api.amplience.net/v2/content/content-repositories/5d5bc1dfc9e77c035fede5c7/folders/search"
    }
  },
  "page": {
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  }
}

Hierarchy node
Link copied!

Method	Endpoint	Summary
`GET`	`/hierarchy-node/{id}/children`	Get child hierarchy nodes
`GET`	`/hierarchy-node/{id}/parents`	Get parent hierarchy nodes
`POST`	`/hierarchy-node/{id}/position`	Change a hierarchy node's position

Get child hierarchy nodes
Link copied!

GET /hierarchy-node/{id}/children

https://api.amplience.net/v2/content/hierarchy-node/{id}/children

Get a List of Child Hierarchy Nodes

Parameters

Name	In	Type	Required	Description
`contentItemId`	path	string	✓	Content Item ID Example: `00112233-4455-6677-8899-aabbccddeeff`

Responses

Status	Description
200	List of Child Hierarchy Nodes

Response Example (200)

{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "label": "Banner Ad Homepage",
  "root": true,
  "children": [
    {
      "id": "00112233-4455-6677-8899-aabbccddeeff",
      "label": "Banner Ad Homepage",
      "root": false,
      "parentId": "00112233-4455-6677-8899-aabbccddeeff",
      "_links": {
        "content-item": {
          "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
        },
        "archive": {
          "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/archive"
        },
        "get-hierarchy-parents": {
          "href": "https://api.amplience.net/v2/content/hierarchy-node/00112233-4455-6677-8899-aabbccddeeff/parents"
        },
        "get-hierarchy-children": {
          "href": "https://api.amplience.net/v2/content/hierarchy-node/00112233-4455-6677-8899-aabbccddeeff/children"
        }
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hierarchy-node/00112233-4455-6677-8899-aabbccddeeff/children"
    },
    "content-item": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
    }
  }
}

Get parent hierarchy nodes
Link copied!

GET /hierarchy-node/{id}/parents

https://api.amplience.net/v2/content/hierarchy-node/{id}/parents

Get a List of Parent Hierarchy Nodes

Parameters

Name	In	Type	Required	Description
`contentItemId`	path	string	✓	Content Item ID Example: `00112233-4455-6677-8899-aabbccddeeff`

Responses

Status	Description
200	List of Parent Hierarchy Nodes

Response Example (200)

{
  "id": "00112233-4455-6677-8899-aabbccddeeff",
  "label": "Banner Ad Homepage",
  "root": false,
  "parents": [
    {
      "id": "00112233-4455-6677-8899-aabbccddeeff",
      "label": "Banner Ad Homepage",
      "root": true,
      "_links": {
        "content-item": {
          "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
        },
        "archive": {
          "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff/archive"
        },
        "get-hierarchy-parents": {
          "href": "https://api.amplience.net/v2/content/hierarchy-node/00112233-4455-6677-8899-aabbccddeeff/parents"
        },
        "get-hierarchy-children": {
          "href": "https://api.amplience.net/v2/content/hierarchy-node/00112233-4455-6677-8899-aabbccddeeff/children"
        }
      }
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/hierarchy-node/00112233-4455-6677-8899-aabbccddeeff/parents"
    },
    "content-item": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233-4455-6677-8899-aabbccddeeff"
    }
  }
}

Change a hierarchy node's position
Link copied!

POST /hierarchy-node/{id}/position

https://api.amplience.net/v2/content/hierarchy-node/{id}/position

Change a Hierarchy Node's position

Parameters

Name	In	Type	Required	Description
`contentItemId`	path	string	✓	Content Item ID Example: `00112233-4455-6677-8899-aabbccddeeff`

Responses

Status	Description
200	List of Hierarchy Node Position Changes

Hierarchies publish
Link copied!

Method	Endpoint	Summary
`POST`	`/hierarchies/publish`	Publish hierarchy nodes

Publish hierarchy nodes
Link copied!

POST /hierarchies/publish

https://api.amplience.net/v2/content/hierarchies/publish

To publish a hierarchy tree, you need to specify the root node and set getDescendants to true.

To publish a hierarchy branch, you need to specify the parent node and set getDescendants to true.

To publish a hierarchy node without any children and set getDescendants to false.

To publish multiple nodes individually supply their IDs, you cannot publish multiple nodes with getDescendants set to true.

Request Body

Content-Type: application/json

Request example

[
  {
    "hierarchyNodeIds": [
      "00112233-4455-6677-8899-aabbccddeeff"
    ],
    "getDescendants": false
  }
]

Responses

Status	Description
204	No Content

Hierarchies snapshot
Link copied!

Method	Endpoint	Summary
`POST`	`/hierarchies/snapshot`	Snapshot hierarchy nodes

Snapshot hierarchy nodes
Link copied!

POST /hierarchies/snapshot

https://api.amplience.net/v2/content/hierarchies/snapshot

To snapshot a hierarchy tree, you need to specify the root node and set getDescendants to true.

To snapshot a hierarchy branch, you need to specify the parent node and set getDescendants to true.

To snapshot a hierarchy node without any children and set getDescendants to false.

To snapshot multiple nodes individually supply their IDs, you cannot snapshot multiple nodes with getDescendants set to true.

Request Body

Content-Type: application/json

Field	Type	Description
`hierarchyNodeIds`	array	ID's
`getDescendants`	boolean
`type`	string (USER, SYSTEM)	Indicates the type of Snapshot (USER or SYSTEM)
`comment`	string	Comment

Request example

{
  "hierarchyNodeIds": [
    "00112233-4455-6677-8899-aabbccddeeff"
  ],
  "getDescendants": false,
  "comment": "This is a example snapshot."
}

Responses

Status	Description
201	Snapshot

Response Example (201)

{
  "id": "00112233445566778899aabb",
  "comment": "This is a example snapshot.",
  "createdDate": "2019-01-01T00:00:00.000Z",
  "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
  "createdFrom": "content-item",
  "type": "USER",
  "meta": [
    {
      "key": "example-key",
      "value": "example value"
    }
  ],
  "taggedEdition": [
    {
      "editionId": "00112233445566778899aabb",
      "createdDate": "2019-01-01T00:00:00.000Z",
      "createdBy": "00112233-4455-6677-8899-aabbccddeeff",
      "name": "Example Edition 1",
      "editionName": "Example Edition 1"
    }
  ],
  "locale": "en-US",
  "contentRoot": "00112233-4455-6677-8899-aabbccddeeff",
  "rootContentItem": {
    "label": "Banner Ad Homepage",
    "contentTypeUri": "Banner Ad Homepage",
    "id": "00112233-4455-6677-8899-aabbccddeeff"
  },
  "rootContentItems": [
    {
      "label": "Banner Ad Homepage",
      "contentTypeUri": "Banner Ad Homepage",
      "id": "00112233-4455-6677-8899-aabbccddeeff"
    }
  ],
  "_links": {
    "self": {
      "href": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb"
    },
    "snapshot": {
      "href": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb"
    },
    "publishing-jobs": {
      "href": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb/publishing-jobs{?page,size,sort}",
      "templated": true
    },
    "create-publishing-job": {
      "href": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb/publishing-jobs"
    },
    "edition-links": {
      "href": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb/edition-links"
    },
    "hub": {
      "href": "https://api.amplience.net/v2/content/hubs/00112233445566778899aabb"
    },
    "content-root": {
      "href": "https://api.amplience.net/v2/content/content-items/00112233445566778899aabb"
    },
    "snapshot-content-item": {
      "href": "https://api.amplience.net/v2/content/snapshots/00112233445566778899aabb/content-items{/id}",
      "templated": true
    }
  }
}

Authorization and status codes

FoldersLink copied!

Create folderLink copied!

List foldersLink copied!

Update folderLink copied!

Get folderLink copied!

Delete folderLink copied!

Create sub-folderLink copied!

List sub-foldersLink copied!

Hierarchy nodeLink copied!

Get child hierarchy nodesLink copied!

Get parent hierarchy nodesLink copied!

Change a hierarchy node's positionLink copied!

Hierarchies publishLink copied!

Publish hierarchy nodesLink copied!

Hierarchies snapshotLink copied!

Snapshot hierarchy nodesLink copied!

Folders
Link copied!

Create folder
Link copied!

List folders
Link copied!

Update folder
Link copied!

Get folder
Link copied!

Delete folder
Link copied!

Create sub-folder
Link copied!

List sub-folders
Link copied!

Hierarchy node
Link copied!

Get child hierarchy nodes
Link copied!

Get parent hierarchy nodes
Link copied!

Change a hierarchy node's position
Link copied!

Hierarchies publish
Link copied!

Publish hierarchy nodes
Link copied!

Hierarchies snapshot
Link copied!

Snapshot hierarchy nodes
Link copied!