Retrieve a media
get
/api/medias/{id} Retrieves a Media resource.
Returns a single media by id, including its contentUrl, mimeType, type, hash and image dimensions.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | string | required | Media identifier |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
properties[] | string[] | - | Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty} |
Response
200 - Media resource
Content-Type: application/ld+json
| Property | Type | Required | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@context | string | object | - | |||||||||||||
@id | string | required | |||||||||||||
@type | string | required | |||||||||||||
contentUrl | string | null | - | The URL to fetch the uploaded file. | ||||||||||||
createdAt | string | null | - | |||||||||||||
dimensions | EmbeddedImageDimensionResource | null | - | Image dimensions (width and height in pixels). Only present for image files. | ||||||||||||
Show | |||||||||||||||
| Property | Type | Required | Description |
|---|---|---|---|
height | integer | required | Image height in pixels |
width | integer | required | Image width in pixels |
hashstring | nullidstringmimeTypestring | nulltype"image" | "video" | "file"updatedAtstring | nullErrors
403 - Access denied. The caller is missing one or more permissions required for this operation.
Content-Type: application/problem+json
| Property | Type | Required | Description |
|---|---|---|---|
@context | string | object | - | |
@id | string | required | |
@type | string | required | |
detail | string | - | |
missingPermissions | string[] | - | Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission. |
status | integer | - | |
title | string | - | |
type | string | - |
404 - Not found
| Property | Type | Required | Description |
|---|---|---|---|
@context | string | object | - | |
@id | string | required | |
@type | string | required | |
code | string | - | Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only. |
description | string | null | - | |
detail | string | null | - | A human-readable explanation specific to this occurrence of the problem. |
instance | string | null | - | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. |
message | string | - | End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only. |
slug | string | - | Stable, readable key of the error in the error code catalogue. Present on catalogued errors only. |
status | integer | null | - | |
title | string | null | - | A short, human-readable summary of the problem. For a catalogued error it repeats the slug. |
type | string | - | A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}. |
| Property | Type | Required | Description |
|---|---|---|---|
code | string | - | Stable identifier of the error in the error code catalogue (see /api/error-codes). Present on catalogued errors only. |
detail | string | null | - | A human-readable explanation specific to this occurrence of the problem. |
instance | string | null | - | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. |
message | string | - | End-user message localized in the request locale, with this occurrence's values substituted. Present on catalogued errors only. |
slug | string | - | Stable, readable key of the error in the error code catalogue. Present on catalogued errors only. |
status | integer | null | - | |
title | string | null | - | A short, human-readable summary of the problem. For a catalogued error it repeats the slug. |
type | string | - | A URI reference that identifies the problem type. For a catalogued error it is the error code resource, /api/error-codes/{code}. |