Get a list of media files
query Parameters
| ids | Array of strings Comma-separated list of media file identifiers |
| cursor | string <byte> Paging cursor |
| direction | string (PagingCommand.Direction) Enum: "NEXT" "PREVIOUS" Paging direction |
| pageSize | integer [ 1 .. 100 ] Page size |
header Parameters
| X-Scope-OrgID required | string Scope header |
| Api-Version | string API version |
Responses
Response samples
- 200
- 401
- 500
Content type
application/json
{- "data": [
- { }
], - "paging": {
- "cursor": {
- "firstUploadedAt": "2019-08-24T14:15:22Z",
- "lastUploadedAt": "2019-08-24T14:15:22Z",
- "firstId": "84373935-3264-4376-b971-148e6d9f73c0",
- "lastId": "5d237c8b-b229-4873-82bc-27c473efbd3c"
}, - "hasNext": true,
- "hasPrevious": true
}
}Upload a file
header Parameters
| X-Scope-OrgID required | string Scope header |
| User-ID | string Current user identifier |
| Api-Version | string API version |
Request Body schema: multipart/form-data
| file | string <binary> |
| metadata | string or null |
Responses
Response samples
- 200
- 400
- 401
- 500
Content type
application/json
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}Delete all media files for the current scope
header Parameters
| X-Scope-OrgID required | string Scope header |
| Api-Version | string API version |
Responses
Response samples
- 401
- 500
Content type
application/json
{- "_links": { },
- "_embedded": {
- "property1": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
], - "property2": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
]
}, - "message": "string",
- "logref": "string",
- "path": "string"
}Delete a media file
path Parameters
| id required | string <uuid> Media file identifier |
header Parameters
| X-Scope-OrgID required | string Scope header |
| Api-Version | string API version |
Responses
Response samples
- 401
- 404
- 500
Content type
application/json
{- "_links": { },
- "_embedded": {
- "property1": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
], - "property2": [
- {
- "_links": {
- "empty": true
}, - "_embedded": {
- "empty": true
}
}
]
}, - "message": "string",
- "logref": "string",
- "path": "string"
}Patch metadata for a media file
path Parameters
| id required | string <uuid> Media file identifier |
header Parameters
| X-Scope-OrgID required | string Scope header |
| Api-Version | string API version |
Request Body schema: required
Schema not provided Responses
Request samples
- Payload
Content type
No sample
Response samples
- 200
- 400
- 401
- 404
- 500
Content type
application/json
{ }