Get project files

GET/projects/{projectId}/files

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

Look up files associated with a project. Use the begin and end query parameters to fetch only files with timestamps that fall within the time range. Use the tag parameter to fetch files with a matching tag. And use the contentType parameter to fetch only files that match the given content type.

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.

Query parameters

Name	Type	Required	Constraints	Description
`begin`	string	No		The beginning time to search for files in RFC3339 format.
`contentType`	string	No		MIME type of the project file to search for.
`end`	string	No		The end time to search for files in RFC3339 format.
`limit`	integer	No		The maximum number of project files to return.
`skip`	integer	No		The number of project files to skip.
`sortBy`	string	No		A sort key. timestamp is the valid field. (e.g. "timestamp:asc" or "timestamp:desc") The default order is ascending.
`tag`	array<string>	No		If specified, return files that contain the specified tag. If this parameter is repeated, files matching at least one of the tags will be returned.

Responses

`200` Successful query for project files.

Content type: application/json

An arbitrary file associated with an entity.

An array of objects with the following shape:

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.

`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.

`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.