Read file data / Get file

The GET method can be used in two ways:

  • Read data associated with the file.
  • Download the file.

Reading data from the endpoint is done like in the CRUD READ endpoint.

To download the file you simply need to specify a single uniqueId and use the parameter fileOnly=true in the URL.

Request data#

HTTP method: GET

URL format: https://baseUrl/versionNumber/customEndpointRoute/userEndpoint?key=apiKey[&uniqueId=uniqueId][&fileOnly=true]

Example:

https://app.yawe.dev/api/1/ce/examples/unsecure-endpoint?key=d59eb2859c284168ac48aef65046d5dd[&uniqueId=45e964d5b6ed49b1a2e14d8ac724109e][&fileOnly=true]

Request Headers#

HeaderDescriptionRequired
Cache-Controlhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-ControlNo

Request Cookies#

NameDescriptionRequired
yawe_access_tokenThe Access token is required for secure endpoints.

It is obtained when doing a login. To automatically include it in the request you need to set the following property:

// using fetch
{ credentials: 'include' }
// using axios
{ withCredentials: true }

For more information check Secure Endpoints.

No

Request Parameters#

The following table describes the Request parameters.

ParameterDescriptionRequired
baseUrlBase url for calling the API.

Value: app.yawe.dev/api

Yes
versionNumberService version.

Value: The current value is 1.

Yes
customEndpointRouteThe route which identifies custom endpoints.

Default value: ce

Yes
userEndpointThe endpoint name generated by the user.

Value: the name created at https://app.yawe.dev

Yes
apiKeyThe API Key of the project.Yes
uniqueIdIf used, the endpoint will only serve the record with a matching uniqueId.

It is also possible to provide multiple uniqueId's.

If none is passed, the endpoint will serve all the records.

No
fileOnlyUse this to download the file, or use it in a HTML tag, such as img or video.

To use this you must provide a single uniqueId.

Value: true
No
dataOnlyIf used, the endpoint will only serve the user data. It won’t include fields such as uniqueId, createdAt, updateAt.

Value: true

No
masterKeyOverrides the need for Access tokens or restrictions applied to Authentication endpoints.

Don't use this key in your client application.

For more information please refer to projects.

Value: the masterKey created at https://app.yawe.dev.

No
jsonata

Use this parameter to query, filter, sort and transform your data (and more!)

It accepts JSONata compatible expressions.

The evaluation of the expression is applied to the output of the endpoint, including when other parameters are used (e.g. dataOnly).

Check the JSONata documentation on their page, or check our quick guide, JSONata, query and transform.

Note: Not applicable when fileOnly is used.

No

Example:

// to get all the data associated with files existing in the endpoint:
https://app.yawe.dev/api/1/ce/examples/unsecure-endpoint?key=d59eb2859c284168ac48aef65046d5dd
// With a single uniqueId:
https://app.yawe.dev/api/1/ce/examples/unsecure-endpoint?key=d59eb2859c284168ac48aef65046d5dd&uniqueId=45e964d5b6ed49b1a2e14d8ac724109e
// With multiple uniqueIds:
https://app.yawe.dev/api/1/ce/examples/unsecure-endpoint?key=d59eb2859c284168ac48aef65046d5dd&uniqueId=45e964d5b6ed49b1a2e14d8ac724109e&uniqueId=3f38bf9e1bb54d2396d1f1b8fbba1630
// To download the file:
https://app.yawe.dev/api/1/ce/examples/unsecure-endpoint?key=d59eb2859c284168ac48aef65046d5dd&uniqueId=45e964d5b6ed49b1a2e14d8ac724109e&fileOnly=true

Response data#

Error codes#

Error codeDescription
400Possible reasons:
  • Endpoint or API Key not valid.
  • No file.
  • fileOnly parameter used without a single uniqueId.
401If the endpoint is secure and the access token is missing or is not valid.

It may also return this error if the user no longer exists.

403Missing API Key, not allowed origin or disallowed request without orign.

Successful response#

{
"uniqueId": "0bbf487842334d2d906d7473689886d5",
"data": {
"metadata": {},
"contentType": "image/png",
"mimetype": "image/png",
"size": 295217,
"originalname": "Screenshot from 2021-01-12 11-09-05.png",
"fileURL": "https://localhost:8443/api/1/ce/files%3E%3E%3EScreenshot%20from%202021-01-12%2011-09-05.png?key=1ca09ab323ac4c12b82c4ca4591e922e&uniqueId=0bbf487842334d2d906d7473689886d5&fileOnly=true"
},
"createdAt": "2021-02-19T15:56:13.000Z",
"updatedAt": "2021-02-19T15:56:13.000Z"
}

To download the file you can use the fileURL provided in the response.