Skip to main content

Media service (v1)

Download OpenAPI specification:Download

Media

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

Tenant header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "paging": {
    }
}

Upload a file

header Parameters
X-Scope-OrgID
required
string

Tenant 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

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Delete all media files for the current tenant

header Parameters
X-Scope-OrgID
required
string

Tenant header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "message": "string",
  • "logref": "string",
  • "path": "string"
}

Download a file

path Parameters
id
required
string <uuid>

Media file identifier

header Parameters
X-Scope-OrgID
required
string

Tenant header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
{ }

Delete a media file

path Parameters
id
required
string <uuid>

Media file identifier

header Parameters
X-Scope-OrgID
required
string

Tenant header

Api-Version
string

API version

Responses

Response samples

Content type
application/json
{
  • "_links": { },
  • "_embedded": {
    },
  • "message": "string",
  • "logref": "string",
  • "path": "string"
}