Skip to content

Paths for job

Entry points that interact with Job entities.

/api/v1/jobs/

GET

Return an array of all jobs.

Note

When the authorization feature is activated (available in the Enterprise edition only), the endpoint requires TAIPY_READER role.

Code example:

  curl -X GET http://localhost:5000/api/v1/jobs

Responses

POST

Create a job from a task config_id. If the config does not exist, a 404 error is returned.

Note

When the authorization feature is activated (available in the Enterprise edition only), the endpoint requires TAIPY_EDITOR role.

Code example:

  curl -X POST http://localhost:5000/api/v1/jobs?task_id=TASK_my_config_75750ed8-4e09-4e00-958d-e352ee426cc9

Parameters

Name Type Required Description
task_id string Yes The identifier of the task configuration.

Responses

/api/v1/jobs/cancel/{job_id}/

POST

Cancel a job by job_id. If the job does not exist, a 404 error is returned.

Note

When the authorization feature is activated (available in the Enterprise edition only), the endpoint requires TAIPY_EXECUTOR role.

Code example:

  curl -X POST http://localhost:5000/api/v1/jobs/cancel/JOB_my_task_config_75750ed8-4e09-4e00-958d-e352ee426cc9

Parameters

Name Type Required Description
job_id string Yes -

Responses

/api/v1/jobs/{job_id}/

DELETE

Delete a job. If the job does not exist, a 404 error is returned.

Note

When the authorization feature is activated (available in the Enterprise edition only), the endpoint requires TAIPY_EDITOR role.

Code example:

  curl -X DELETE http://localhost:5000/api/v1/jobs/JOB_my_task_config_75750ed8-4e09-4e00-958d-e352ee426cc9

Parameters

Name Type Required Description
job_id string Yes The identifier of the job.

Responses

  • 200
    Status: OK

    Name Type
    message string
  • 404
    Status: Not Found

    No job has the job_id identifier.

GET

Return a single job by job_id. If the job does not exist, a 404 error is returned.

Note

When the authorization feature is activated (available in the Enterprise edition only), the endpoint requires TAIPY_READER role.

Code example:

  curl -X GET http://localhost:5000/api/v1/jobs/JOB_my_task_config_75750ed8-4e09-4e00-958d-e352ee426cc9

Parameters

Name Type Required Description
job_id string Yes The identifier of the job.

Responses