Get File by Id

GET 
/api/workspaces/:workspace_id/files/:id/

Get a file by its id.

Request

Path Parameters

workspace_id stringrequired
id integerrequired

A unique integer value identifying this field file.

Query Parameters

editor_session uuid

UUID of the editor session. This field is only required when used from public endpoints.

Responses

200

application/json

Schema

Schema

id integer
scope stringrequired

Possible values: [entity, session]

Scope of the file. Can be one of: entity, session.

entity_id integerrequired

Id of entity which the file is bound.

editor_session uuidrequired

Editor session to be scoped under. This field should be provided on editor app type only.

filename stringrequired

Possible values: non-empty and <= 512 characters

Name of the file to be uploaded.

file_size integerrequired

Size of the file in bytes.

created_at date-timerequired

Creation date and time of the file.

created_by integernullable

ID of the user that created the file.

Example (from schema)

{
  "id": 0,
  "scope": "entity",
  "entity_id": 0,
  "editor_session": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "filename": "string",
  "file_size": 0,
  "created_at": "2024-06-11T11:45:44.614Z",
  "created_by": 0
}

401

No authentication found or authentication is not correct.

403

Specified path is not allowed

Permission evaluation:

((Is Authenticated Organization Admin OR Workspace Context Permission) OR Public Permission)

Descriptions:

Is Authenticated Organization Admin : User must be an Organization Admin.

Public Permission : Checks corresponding workspace is public.

Workspace Context Permission : Workspace must be available to the User.

Loading...