Recover the status of the time series processing job

Presentation

Description Authorization Method Request
This query is used to retrieve the status of the time series processing job in order to inform the sender of the data if the processing is finished, if it has happened correctly or if there is an error in the formatting of Its archive. Required by Basic HTTP (username and password) GET /v1/users/:userID/sites/:siteID/jobs/:jobID

URL parameters

Parameter Type Description
:userID String Unique identifier of the user. If you do not know your username, you can use the keyword " current " in place.
:siteID String Unique site identifier.
:jobID String Unique identifier of the job.

Request parameters

Required

None

Optional

None

Successful message

Sample request

            curl -i -X GET 'https://api.openrj.eu/v1/users/current/sites/test_site/jobs/1' -u cstb_test:cstb2014

            200 OK

            {
                "siteID": "test_site",
                "jobID": "1",
                "status": "Completed.",
                "code": 201
            }
            

Details

Parameter Type Description
siteID String Unique site identifier.
jobID String Unique identifier of the job.
status & code String, Integer Job status. The value can be either:
  • "Ongoing": code 100,
  • "Completed": code 201,
  • "Bad file format": code 400,
  • "Missing variable name": code 400,
  • "Unknown variable name": code 404,
  • "Database connection problem": code 500,

Error message "Missing authorization headers"

Sample request

            curl -i -X GET 'https://api.openrj.eu/v1/users/current/sites/test_site/jobs/1'

            400 BAD REQUEST

            {
                "error": "Missing authorization headers"
            }
            

Causes

You forgot the settings "username" and "password" nécessaire à l'authentification dans votre requête.

Error message "Unauthorized"

Sample request

            curl -i -X GET 'https://api.openrj.eu/v1/users/current/sites/test_site/jobs/1' -u rtyui:ertyui

            401 Unauthorized

            {
                "error": "Unauthorized"
            }
            

Causes

You have made a mistake or you do not have access to this information.

Error message "Site not found"

Sample request

            curl -i -X GET 'https://api.openrj.eu/v1/users/current/sites/test_site2/jobs/1' -u rtyui:ertyui

            404 Not Found

            {
                "error":"Site not found."
            }
            

Causes

This site does not exist.

Error message "Job not found"

Sample request

            curl -i -X GET 'https://api.openrj.eu/v1/users/current/sites/test_site/jobs/a' -u cstb_test:cstb2014

            404 Not Found

            {
                "error":"Job not found."
            }
            

Causes

This job does not exist.