Jobs endpoint

This endpoint allows the consumer to download the data file for a completed data loader job.
There are two ways of getting this link:

  • Once the job is complete, a request to the GET fullData status endpoint will offer the link in the response body.
  • By getting the id of the job and, once it is complete, call directly to this endpoint.

Take into account that

  • In case the resulting data contains zero registers, an empty file will be created.
  • The file containing the data is stored in our systems for 24 hours. After this time the file is deleted. The “expirationDate” field of the GET status endpoint will provide the exact date and time when this will happen.
  • We have included a header called “X-Content-MD5” that contains the MD5 hash of the file requested. That way, the consumer can validate that the file is complete and downloaded correctly.
  • Each AppId/client can have a maximum of 25 file downloads in progress at the same time. If this limit is exceeded, the API returns: 429 Too Many Requests.
  • When this occurs, wait until this limit can’t be exceeded and retry the request again.

Developer tips

  • Monitor the operation status and download files as soon as their status becomes Complete. Do not wait for all requested files to reach the Complete.
  • Processing completed files immediately helps avoid reaching the AppId download limit and improves overall throughput.
  • Keep track of the amount of files you are requesting at the same time.

Url: https://data.youforce.com/data/v1/jobs

GET → /data/v1/jobs/{jobId}

Parameters

  • Header parameters: Authorization (Bearer)
  • Path parameters:
    • JobId: Id of the job that has been completed and it is ready to be downloaded.
  • Query parameters: None
  • Body parameters: None
curl --location curl --location 'https://data.youforce.com/data/v1/jobs/8a1c7cba-cbf4-43b5-9e9b-dbcb7ebb5543' \
--header 'Authorization: Bearer abc’


Response

If all went well it will return an OK response code → 200 OK