{ "opencollection": "1.0.0", "info": { "name": "Adobe CC Libraries APIs Test", "version": "0.1" }, "items": [ { "info": { "name": "Library Service", "type": "folder" }, "items": [ { "info": { "name": "Retrieve libraries for a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/libraries", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "orderBy", "value": "", "type": "query", "description": "Sorting option for the response list. \nReverse sort is enabled with a - character ahead of the sorting vector. (ex: -modified_date) \nMulti-vector sort is enabled by including multiple vectors separated by commas. (ex: name,-modified_date) \nSorting is not available for public libraries. \n\n**Possible Values** \n- `name`: Sort by the name.\n- `modified_date`: Sort by the last modified date." }, { "name": "start", "value": "", "type": "query", "description": "The first result to include for a paged response, 0-based. \nThis parameter is required if a limit is specified. \nPaging is not available for public libraries." }, { "name": "limit", "value": "", "type": "query", "description": "The number of libraries to return for a paged response. \nPaging is not available for public libraries. \n\n**Possible Values** \n- Min: 1. \n- Max: 10." }, { "name": "owner", "value": "", "type": "query", "description": "Customize which libraries to include in the response, based on ownership. \n\n**Possible Values** \n- `private`: Libraries owned by the user. \n- `incoming`: Libraries shared with the user. This may include person-to-person shared libraries as well as libraries accessible via group ownership. \n- `public`: Libraries the user has followed. \n- `all`: All of the above except public." }, { "name": "selector", "value": "", "type": "query", "description": "Customize which data sets to include in the response. \nAll applications using this API will need the same sets of data, but different applications will not require different depths of details. \nCallers can specify a comma-separated list of selectors to either limit or expand the default response. The absence of selectors will yield the default response, while including selectors gives callers access to building-blocks to compose the response to their needs. \n\n**Possible Values** \n- `default`: Base data, use this to build out custom response. \n- `details`: All available data for in-depth display. \n- `collaboration`: Add collaboration data to a lesser-scoped selector. \n- `groups`: Include group data in the response. \n- `rendition_grid`: Provides a set of links to library element image renditions, which can be combined to create a thumbnail for the library. The `main` rendition link is the first asset uploaded to the library, while the `tiles` contain the three most recently updated library elements' rendition links. \n" }, { "name": "toolkit", "value": "", "type": "query", "description": "Customize which toolkit libraries to include in the response. \n\n**Possible Values**- `all`: Include all toolkit libraries. \n- `none`: Do not include any toolkit libraries. \n- ``: Include libraries matching a specific toolkit-id, or comma-separated list of toolkit-ids." } ] }, "docs": "Retrieve libraries for a user" }, { "info": { "name": "Create a library", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/libraries", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "invocation_mode", "value": "", "type": "query", "description": "Specifies the processing mode to invoke this request process with. \n\n**Possible Values** \n- `sync`: API call is processed synchronously. The response is delivered when processing is complete, unless there's a timeout. \n- `async`: The async monitor response is immediately returned and request processing occurs asynchronously. The caller is responsible for polling that endpoint until completion. \n- `sync,async`: (Default) Synchronous processing of the request is attempted. When the processing extends past 5000ms, the async monitor response is returned. The monitor URL should be polled until the request is complete." } ] }, "docs": "Create a library" }, { "info": { "name": "Retrieve a specific library", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/libraries/:libraryId", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "if-none-match", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" }, { "name": "selector", "value": "", "type": "query", "description": "Customize which data sets to include in the response. \nAll applications using this API will need the same sets of data, but different applications will not require different depths of details. \nCallers can specify a comma-separated list of selectors to either limit or expand the default response. The absence of selectors will yield the default response, while including selectors gives callers access to building-blocks to compose the response to their needs. \n\n**Possible Values** \n- `default`: Base data, use this to build out custom response. \n- `details`: All available data for in-depth display. \n- `collaboration`: Add collaboration data to a lesser-scoped selector. \n- `groups`: Include group data in the response. \n- `rendition_grid`: Provides a set of links to library element image renditions, which can be combined to create a thumbnail for the library. The `main` rendition link is the first asset uploaded to the library, while the `tiles` contain the three most recently updated library elements' rendition links. \n" }, { "name": "libraryVersion", "value": "", "type": "query", "description": "Retrieve a cached library response (if available) for the specified version. \nTo ensure the most recent cached version, use the `version`, which is provided when retrieving the library list. \nIf the cached version is unavailable for some reason, the live result will be returned. \nUsing this parameter is optional, but is likely to provide substantially faster performance. \n" } ] }, "docs": "Retrieve a specific library" }, { "info": { "name": "Apply multiple operations to a single library serially.", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/api/v1/libraries/:libraryId", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "if-match", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" }, { "name": "invocation_mode", "value": "", "type": "path", "description": "Specifies the processing mode to invoke this request process with. \n\n**Possible Values** \n- `sync`: API call is processed synchronously. The response is delivered when processing is complete, unless there's a timeout. \n- `async`: The async monitor response is immediately returned and request processing occurs asynchronously. The caller is responsible for polling that endpoint until completion. \n- `sync,async`: (Default) Synchronous processing of the request is attempted. When the processing extends past 5000ms, the async monitor response is returned. The monitor URL should be polled until the request is complete." } ] }, "docs": "Apply multiple operations to a library serially. \nThe request payload for this endpoint consists of an array of requests. \nRequests in this array may reference values from the response of requests preceding them. \nThis can be accomplished by using substitution variables, which are described here: https://wiki.corp.adobe.com/x/5xLOhw." }, { "info": { "name": "Delete a specific library", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/libraries/:libraryId", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" } ] }, "docs": "Delete a specific library" }, { "info": { "name": "Retrieve a specific library", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/api/v1/libraries/:libraryId", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" } ] }, "docs": "Retrieve a specific library" }, { "info": { "name": "Restore Archived Elements", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/libraries/:libraryId/archive", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" }, { "name": "invocation_mode", "value": "", "type": "path", "description": "Specifies the processing mode to invoke this request process with. \n\n**Possible Values** \n- `sync`: API call is processed synchronously. The response is delivered when processing is complete, unless there's a timeout. \n- `async`: The async monitor response is immediately returned and request processing occurs asynchronously. The caller is responsible for polling that endpoint until completion. \n- `sync,async`: (Default) Synchronous processing of the request is attempted. When the processing extends past 5000ms, the async monitor response is returned. The monitor URL should be polled until the request is complete." } ] }, "docs": "Restore Archived Elements" }, { "info": { "name": "Permanently delete archived elements", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/libraries/:libraryId/archive", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" } ] }, "docs": "Permanently delete archived elements" }, { "info": { "name": "Permanently delete an archived element", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/libraries/:libraryId/archive/:elementId", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" }, { "name": "elementId", "value": "", "type": "path", "description": "The ID of the requested element." } ] }, "docs": "Permanently delete an archived element" }, { "info": { "name": "Retrieve the elements within a library", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/libraries/:libraryId/elements", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "if-none-match", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" }, { "name": "orderBy", "value": "", "type": "query", "description": "Sorting option for the response list. \nReverse sort is enabled with a - character ahead of the sorting vector. (ex: -modified_date) \nMulti-vector sort is enabled by including multiple vectors separated by commas. (ex: name,-modified_date) \nSorting is not available for public libraries. \n\n**Possible Values** \n- `name`: Sort by the name.\n- `modified_date`: Sort by the last modified date." }, { "name": "start", "value": "", "type": "query", "description": "The first result to include for a paged response, 0-based. \nThis parameter is required if a limit is specified. \nPaging is not available for public libraries." }, { "name": "limit", "value": "", "type": "query", "description": "The number of results to return for a paged response. \nPaging is not available for public libraries. \n\n**Possible Values** \n- Min: 1. \n- Max: 100." }, { "name": "type", "value": "", "type": "query", "description": "Limits results to those identified with the provided element mimetype." }, { "name": "group", "value": "", "type": "query", "description": "Limits results to those assigned to the provided `group_id` (can be either `group_id` or `classifier#group_id`). \nParameters without a classifier will populate as `$default#group_id`. \nTo specify ungrouped elements, use `$none$`" }, { "name": "selector", "value": "", "type": "query", "description": "Customize which data sets to include in the response. \nAll applications using this API will need the same sets of data, but different applications will not require different depths of details. \nCallers can specify a comma-separated list of selectors to either limit or expand the default response. The absence of selectors will yield the default response, while including selectors gives callers access to building-blocks to compose the response to their needs. \n\n**Possible Values** \n- `default`: Base data, use this to build out custom response. \n- `details`: All available data for in-depth display. \n- `representations`: Flattened list of assets associated with the library element." } ] }, "docs": "Retrieve the elements within a library" }, { "info": { "name": "Create, copy, or move elements", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/libraries/:libraryId/elements", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" }, { "name": "invocation_mode", "value": "", "type": "path", "description": "Specifies the processing mode to invoke this request process with. \n\n**Possible Values** \n- `sync`: API call is processed synchronously. The response is delivered when processing is complete, unless there's a timeout. \n- `async`: The async monitor response is immediately returned and request processing occurs asynchronously. The caller is responsible for polling that endpoint until completion. \n- `sync,async`: (Default) Synchronous processing of the request is attempted. When the processing extends past 5000ms, the async monitor response is returned. The monitor URL should be polled until the request is complete." } ] }, "docs": "Create a new element, or copy/move existing elements. \n\n**Create Element** \nCreate a single element. All elements require at least one asset-based or literal representation. \nWhen creating a new asset-based element (ex: images, thumbnails, video), upload the asset(s) BEFORE creating the element. \nUse the response(s) from the Upload Asset API call(s) as objects in the `representations` array when using this API to create a new element. \n\n**Move Elements** \nMove one or more elements, which means d" }, { "info": { "name": "Move a library's elements to the archive", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/libraries/:libraryId/elements", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" } ] }, "docs": "Move a library's elements to the archive" }, { "info": { "name": "Update a specific library's element", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/libraries/:libraryId/elements/metadata", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" } ] }, "docs": "Update a specific library's element. \nThis API is intended solely for top-level element attribute updates. \nPlease look to `PUT /api/v1/libraries/{libraryId}/elements/{elementId}/representations` for updates to element assets and representations." }, { "info": { "name": "Retrieve a specific library's element", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/libraries/:libraryId/elements/:elementId", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "if-none-match", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" }, { "name": "elementId", "value": "", "type": "path", "description": "The ID of the requested element." }, { "name": "selector", "value": "", "type": "query", "description": "Customize which data sets to include in the response. \nAll applications using this API will need the same sets of data, but different applications will not require different depths of details. \nCallers can specify a comma-separated list of selectors to either limit or expand the default response. The absence of selectors will yield the default response, while including selectors gives callers access to building-blocks to compose the response to their needs. \n\n**Possible Values** \n- `default`: Base data, use this to build out custom response. \n- `details`: All available data for in-depth display. \n- `representations`: Flattened list of assets associated with the library element." } ] }, "docs": "Retrieve a specific library's element" }, { "info": { "name": "Move a library's element to the archive", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/libraries/:libraryId/elements/:elementId", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" }, { "name": "elementId", "value": "", "type": "path", "description": "The ID of the requested element." } ] }, "docs": "Move a library's element to the archive" }, { "info": { "name": "Add/Update/Delete element representations in existing library", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/libraries/:libraryId/elements/:elementId/representations", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" }, { "name": "elementId", "value": "", "type": "path", "description": "The ID of the requested element." }, { "name": "invocation_mode", "value": "", "type": "path", "description": "Specifies the processing mode to invoke this request process with. \n\n**Possible Values** \n- `sync`: API call is processed synchronously. The response is delivered when processing is complete, unless there's a timeout. \n- `async`: The async monitor response is immediately returned and request processing occurs asynchronously. The caller is responsible for polling that endpoint until completion. \n- `sync,async`: (Default) Synchronous processing of the request is attempted. When the processing extends past 5000ms, the async monitor response is returned. The monitor URL should be polled until the request is complete." } ] }, "docs": "Add/Update/Delete element representations in existing library. \nThe `representations` array input includes all representations to be created, retained, or updated. \n\n**Special Cases** \n- `Create`: New representations can be submitted alongside the existing renditions, but with no `id` field. \n- `Retain`: Existing representations with no changes should be submitted exactly as returned by the element. \n- `Update`: Changes to representations must include the accurate id for the exising entry and sh" }, { "info": { "name": "Update a specific library", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/libraries/:libraryId/metadata", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" } ] }, "docs": "Update a specific library" }, { "info": { "name": "Upload an asset to a library", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/libraries/:libraryId/representations/content", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" }, { "name": "invocation_mode", "value": "", "type": "path", "description": "Specifies the processing mode to invoke this request process with. \n\n**Possible Values** \n- `sync`: API call is processed synchronously. The response is delivered when processing is complete, unless there's a timeout. \n- `async`: The async monitor response is immediately returned and request processing occurs asynchronously. The caller is responsible for polling that endpoint until completion. \n- `sync,async`: (Default) Synchronous processing of the request is attempted. When the processing extends past 5000ms, the async monitor response is returned. The monitor URL should be polled until the request is complete." } ] }, "docs": "Upload a small file asset to an existing library. \nFile asset size must be <5mb to use this API call. \nAfter uploading a file asset with this API, you can use the response in the `representations` array in the request body of a Create New Element API call. \n" }, { "info": { "name": "Search for Libraries and Library Elements", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/search", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ] }, "docs": "Search for Libraries and Library Elements" } ] }, { "info": { "name": "Library Service - Bookmarks", "type": "folder" }, "items": [ { "info": { "name": "Retrieves all bookmarks for a user", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/libraries/bookmarks", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ] }, "docs": "Retrieves all bookmarks for a user" }, { "info": { "name": "Add bookmarks for user, one or multiple", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/v1/libraries/bookmarks", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ] }, "docs": "Add bookmarks for user, one or multiple" }, { "info": { "name": "Update an existing bookmark by ID", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/api/v1/libraries/bookmarks/:bookmarkId", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "bookmarkId", "value": "", "type": "path", "description": "The ID of the requested bookmark." } ] }, "docs": "Update an existing bookmark by ID" }, { "info": { "name": "Remove a bookmark", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/v1/libraries/bookmarks/:bookmarkId", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" } ], "params": [ { "name": "bookmarkId", "value": "", "type": "path", "description": "The ID of the requested bookmark." } ] }, "docs": "Remove a bookmark" } ] }, { "info": { "name": "Library Service - Public", "type": "folder" }, "items": [ { "info": { "name": "Retrieve a specific library", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/public/libraries/:libraryId", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "if-none-match", "value": "" }, { "name": "if-match", "value": "" }, { "name": "x-use-cdn", "value": "" }, { "name": "x-cdn-origin", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" }, { "name": "selector", "value": "", "type": "query", "description": "Customize which data sets to include in the response. \nAll applications using this API will need the same sets of data, but different applications will not require different depths of details. \nCallers can specify a comma-separated list of selectors to either limit or expand the default response. The absence of selectors will yield the default response, while including selectors gives callers access to building-blocks to compose the response to their needs. \n\n**Possible Values** \n- `default`: Base data, use this to build out custom response. \n- `details`: All available data for in-depth display. \n- `collaboration`: Add collaboration data to a lesser-scoped selector. \n- `groups`: Include group data in the response. \n- `rendition_grid`: Provides a set of links to library element image renditions, which can be combined to create a thumbnail for the library. The `main` rendition link is the first asset uploaded to the library, while the `tiles` contain the three most recently updated library elements' rendition links. \n" }, { "name": "linkId", "value": "", "type": "query", "description": "The ID associating the request with the public library landing page URL." } ] }, "docs": "Retrieve a specific library" }, { "info": { "name": "Check the presence and fetch headers of a public library", "type": "http" }, "http": { "method": "HEAD", "url": "{{baseUrl}}/api/v1/public/libraries/:libraryId", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "x-use-cdn", "value": "" }, { "name": "x-cdn-origin", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" }, { "name": "linkId", "value": "", "type": "query", "description": "The ID associating the request with the public library landing page URL." } ] }, "docs": "Check the presence and fetch headers of a public library" }, { "info": { "name": "Retrieve a specific library's list of elements", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/public/libraries/:libraryId/elements", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "if-none-match", "value": "" }, { "name": "if-match", "value": "" }, { "name": "x-use-cdn", "value": "" }, { "name": "x-cdn-origin", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" }, { "name": "orderBy", "value": "", "type": "query", "description": "Sorting option for the response list. \nReverse sort is enabled with a - character ahead of the sorting vector. (ex: -modified_date) \nMulti-vector sort is enabled by including multiple vectors separated by commas. (ex: name,-modified_date) \nSorting is not available for public libraries. \n\n**Possible Values** \n- `name`: Sort by the name.\n- `modified_date`: Sort by the last modified date." }, { "name": "start", "value": "", "type": "query", "description": "The first result to include for a paged response, 0-based. \nThis parameter is required if a limit is specified. \nPaging is not available for public libraries." }, { "name": "limit", "value": "", "type": "query", "description": "The number of results to return for a paged response. \nPaging is not available for public libraries. \n\n**Possible Values** \n- Min: 1. \n- Max: 100." }, { "name": "type", "value": "", "type": "query", "description": "Limits results to those identified with the provided element mimetype." }, { "name": "group", "value": "", "type": "query", "description": "Limits results to those assigned to the provided `group_id` (can be either `group_id` or `classifier#group_id`). \nParameters without a classifier will populate as `$default#group_id`. \nTo specify ungrouped elements, use `$none$`" }, { "name": "selector", "value": "", "type": "query", "description": "Customize which data sets to include in the response. \nAll applications using this API will need the same sets of data, but different applications will not require different depths of details. \nCallers can specify a comma-separated list of selectors to either limit or expand the default response. The absence of selectors will yield the default response, while including selectors gives callers access to building-blocks to compose the response to their needs. \n\n**Possible Values** \n- `default`: Base data, use this to build out custom response. \n- `details`: All available data for in-depth display. \n- `collaboration`: Add collaboration data to a lesser-scoped selector. \n- `groups`: Include group data in the response. \n- `rendition_grid`: Provides a set of links to library element image renditions, which can be combined to create a thumbnail for the library. The `main` rendition link is the first asset uploaded to the library, while the `tiles` contain the three most recently updated library elements' rendition links. \n" }, { "name": "linkId", "value": "", "type": "query", "description": "The ID associating the request with the public library landing page URL." } ] }, "docs": "Retrieve a specific library's list of elements" }, { "info": { "name": "Retrieve a public library's element", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/v1/public/libraries/:libraryId/elements/:elementId", "headers": [ { "name": "authorization", "value": "" }, { "name": "x-api-key", "value": "" }, { "name": "x-request-id", "value": "" }, { "name": "if-none-match", "value": "" }, { "name": "if-match", "value": "" }, { "name": "x-use-cdn", "value": "" }, { "name": "x-cdn-origin", "value": "" } ], "params": [ { "name": "libraryId", "value": "", "type": "path", "description": "The ID of the requested library. \nFor private libraries, the `library_urn` should be used. (ex: urn:aaid:sc:US:1c2327c6-ca3a-8f74-11ac-d5bca13a8fc7) \nFor public libraries, the public library `id` should be used. (ex: 1UTOX1PQ9YWOTFIPUEQUV0Z2XFTFFF)" }, { "name": "elementId", "value": "", "type": "path", "description": "The ID of the requested element." }, { "name": "selector", "value": "", "type": "query", "description": "Customize which data sets to include in the response. \nAll applications using this API will need the same sets of data, but different applications will not require different depths of details. \nCallers can specify a comma-separated list of selectors to either limit or expand the default response. The absence of selectors will yield the default response, while including selectors gives callers access to building-blocks to compose the response to their needs. \n\n**Possible Values** \n- `default`: Base data, use this to build out custom response. \n- `details`: All available data for in-depth display. \n- `representations`: Flattened list of assets associated with the library element." }, { "name": "linkId", "value": "", "type": "query", "description": "The ID associating the request with the public library landing page URL." } ] }, "docs": "Retrieve a public library's element" } ] } ], "bundled": true }