Update the File with predefined ID

Update the File with predefined ID. Note that file can be uploaded with POST. only.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

Request Body schema: application/json

File resource.

name
string

Original File name.

extension
string

The File extension.

description
string

The File description.

sourceType
string or null

The File source type.

Enum: "upload" "camera"
tags
Array of strings

The tags list.

isPublic
boolean

Is the file available publicly (without authentication). If true, the permalink in the _links section contains the public URL.

Responses
200

File was updated.

Response Schema: application/json
id
string <= 50 characters

The resource ID. Defaults to UUID v4.

name
string

Original File name.

extension
string

The File extension.

description
string

The File description.

sourceType
string or null

The File source type.

Enum: "upload" "camera"
tags
Array of strings

The tags list.

mime
string

The mime type.

Enum: "image/png" "image/jpeg" "image/gif" "application/pdf" "audio/mpeg"
size
integer

The File size in bytes.

width
integer

Image width, applicable to images only.

height
integer

Image height, applicable to images only.

sha1
string

Hash sum of the file.

createdTime
string <date-time>

The upload date/time.

updatedTime
string <date-time> (UpdatedTime)

Read-only timestamp updates when the resource is updated.

isPublic
boolean

Is the file available publicly (without authentication). If true, the permalink in the _links section contains the public URL.

Array of Self (object) or FileDownloadLink (object) or SignedLinkLink (object) or PermalinkLink (object) >= 3 items

The links related to resource.

Array (>= 3 items)
Any of:
href
required
string

The link URL.

rel
required
string

The link type.

Value: "self"
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

422

Invalid data was sent.

put/files/{id}
Request samples
application/json
{
  • "name": "string",
  • "extension": "string",
  • "description": "string",
  • "sourceType": "upload",
  • "tags": [
    ],
  • "isPublic": true
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "name": "string",
  • "extension": "string",
  • "description": "string",
  • "sourceType": "upload",
  • "tags": [
    ],
  • "mime": "image/png",
  • "size": 0,
  • "width": 0,
  • "height": 0,
  • "sha1": "string",
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "isPublic": true,
  • "_links": [
    ]
}