/api/v1/files/{fileId}/display

PUT

const url = 'https://example.com/api/v1/files/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/display';
const options = {method: 'PUT'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/v1/files/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/display

Parameters

Path Parameters

fileId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Responses

200

Default Response

application/json

object

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

sha256

required

string

bytes

required

number

mime

required

string

class

required

string

Allowed values: evidence photo document video

hasGps

required

boolean

width

required

number | null

height

required

number | null

derivativeState

required

string

Allowed values: ready unavailable not_applicable

thumbUrl

required

string | null

displayUrl

required

string | null

Example

{
  "class": "evidence",
  "derivativeState": "ready"
}