Create zips on the fly using our ZipService endpoint or use the API to create mediacontainers for usage in your AdmiralCloud Digital Asset Management platform.
Reference
Create ZIP
Creates a new mediacontainer with a ZIP file from the given existing mediacontainer ids or an ES search query.
If you use SEARCH, the query is automatically limited to video, audio, image and documents. You can still use ES filter to reduce the allowed types, but you cannot extend types beyond [video, audio, image and documents]
Note: The maximum number of mediacontainers in a file is 1,000.
POST/v6/zip
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| controlGroupIds | array | ✗ | TBA Please use search query instead |
| controlGroupIdsAll | array | ✗ | TBA Please use search query instead |
| controlGroupIdsNot | array | ✗ | TBA Please use search query instead |
| field | string | ✗ | Field to serach the searchTerm in |
| flags | array | ✗ | Flags of mediacontainers to include in ZIP allowed values: 09 |
| ids | array | ✗ | mediaContainerIds to use for the zip file. Required if you do not use a search query |
| languages | array | ✗ | TBA |
| mediaContainerIds | array | ✗ | mediaContainerIds to use for the zip file. Required if you do not use a search query |
| query | object | ✗ | Search query to determine the mediacontainers that should be part of the zip file. A maximum of 1,000 items can be selected to zip. |
| searchTerm | string | ✗ | Search term to determine the mediacontainers that should be part of the zip file. A maximum of 1,000 items can be selected to zip. |
| zipParams | object | ✗ | Additional settings for the zip |
| └ formatIds | array | ✗ | FormatIds to use in the zip |
| └ container_name | string | ✗ | Please use metadata array |
| └ container_description | string | ✗ | Please use metadata array |
| └ publicAreaId | integer | ✗ | If set, metadata for files is used from publicarea |
| └ metadata | array | ✗ | Optional metadata for this zip file |
| └ title | string | ✗ | allowed values: container_namecontainer_description |
| └ content | string | ✗ | |
| └ language | iso-639-2 | ✗ |
Response
| Field | Type | Description |
|---|---|---|
| ids | array | mediaContainerIds to use for the zip file. Please use mediaContainerIds from response object |
| ignored | array | mediaContainerIds that could not be added to |
| jobId | string | JobId for this zip creation |
| mediaContainerIds | array | mediaContainerIds used for the zip file. |
| processed | array | mediaContainerIds that will be added to zip file |
| size | integer | Number of items in zip file |
Create ZIP on the fly
This endpoint will stream a zip file to your browser. It can be used with a publicarea or with authenticated users.
The base url for this service is https://zipservice.admiralcloud.com
POST/v2/zip
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| formatIds | base64 | ✗ | Optional list of formatIds to use in ZIP. If none given, the original file is used. |
| ids | hashids | ✓ | List/array of mediaContainerIds Please use mediaContainerIds instead |
| link | string | ✓ | Link of publicarea |
| mediaContainerIds | base64 | ✓ | List/array of mediaContainerIds |