Get project file metadata

GET/projects/{projectId}/files/{fileId}

Base URL: https://api.tinkermode.com

Get the metadata of the specified project file.

Authentication

Send an Authorization header of the form ModeCloud <AUTH_CODE>.

Must contain a user API key of a user with permission to read project files, a service account token with the same permission, or a project API key.

Path parameters

Name	Type	Required	Constraints	Description
`projectId`	integer	Yes		The unique ID for a specified project.
`fileId`	string	Yes		Project file ID.

Responses

`200` Successful retrieval of project file metadata.

Content type: application/json

Property	Type	Required	Constraints	Description
`attributes`	object	No		Attributes associated with the entity file, separated as key-value pairs.
`contentType`	string	No		MIME type of the entity file.
`entityId`	string	Yes	read-only (server-generated)	Entity that this entity file belongs to.
`expirationDate`	string	No	format: date-time	Timestamp indicating when the entity file should expire.
`fileId`	string	No	read-only (server-generated)	ID of the entity file.
`fileName`	string	No	read-only (server-generated)	Name of the entity file.
`projectId`	integer	Yes	read-only (server-generated)	Project that this entity file belongs to.
`tags`	array	No		A collection of unique string identifiers associated with the entity file.
`timestamp`	string	No	read-only (server-generated); format: date-time	Timestamp of the entity file.
`url`	string	No		A pre-signed URL for file download.

Response example

{
  "attributes": {
    "errorCode": 42,
    "eventId": "20231101",
    "eventType": "crash"
  },
  "contentType": "video/mp4",
  "entityId": "root",
  "fileId": "3a0b1b2b4d4e5f6a0a1b2a1a",
  "fileName": "video.mp4",
  "projectId": 111,
  "tags": [
    "camera1",
    "eventId:20231101",
    "eventType:crash"
  ],
  "timestamp": "2023-11-01T12:17:56Z",
  "url": "https://download.tinkermode.com/download/XXXXXXXXXXXXXX"
}

`401` Authorization is required to access this resource.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`403` Request failed because of denied permission.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`404` The requested file does not exist or is not accessible.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`429` Request failed because of rate limit.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`500` An unexpected error has occurred.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`503` The service is temporarily unavailable.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.