REST API

Find an interactive API explorer at REDOC API Speification

GET /groups

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• groups[] (string) –

POST /groups

Request JSON Object:

• groupname (string) –

• name (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Created group

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• create_time (string) –

• groupname (string) –

• name (string) –

• tasks (string) –

• uri (string) –

• users (string) –

GET /groups/{id}

Parameters:

• id (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find group

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• create_time (string) –

• groupname (string) –

• name (string) –

• tasks (string) –

• uri (string) –

• users (string) –

PUT /groups/{id}

Parameters:

• id (string) –

Request JSON Object:

• groupname (string) –

• name (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find group

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• create_time (string) –

• groupname (string) –

• name (string) –

• tasks (string) –

• uri (string) –

• users (string) –

DELETE /groups/{id}

Parameters:

• id (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find group

GET /groups/{id}/users

Parameters:

• id (string) –

Status Codes:

• 200 OK – Success

• 403 Forbidden – You are not authorized to get this information

• 404 Not Found – Could not find group

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• users[] (string) –

GET /meta

Status Codes:

• 200 OK – Success

• 403 Forbidden – You are not authorized to get this information

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• meta[].history[].id (integer) –

• meta[].history[].timestamp (string) –

• meta[].history[].value (string) –

• meta[].id (integer) –

• meta[].label (string) –

• meta[].value (string) –

POST /meta

Request JSON Object:

• label (string) –

• value (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Added new Meta entry

• 403 Forbidden – You are not authorized to do this operation

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• history[].id (integer) –

• history[].timestamp (string) –

• history[].value (string) –

• id (integer) –

• label (string) –

• value (string) –

GET /meta/{id}

Parameters:

• id (string) –

Status Codes:

• 200 OK – Success

• 403 Forbidden – You are not authorized to get this information

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• history[].id (integer) –

• history[].timestamp (string) –

• history[].value (string) –

• id (integer) –

• label (string) –

• value (string) –

PUT /meta/{id}

Parameters:

• id (string) –

Request JSON Object:

• label (string) –

• value (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find Meta entry

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• history[].id (integer) –

• history[].timestamp (string) –

• history[].value (string) –

• id (integer) –

• label (string) –

• value (string) –

GET /roles

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• roles[] (string) –

GET /roles/{id}

Parameters:

• id (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find role

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• description (string) –

• name (string) –

• permissions[] (string) –

• update_datetime (string) –

PUT /service/config/import-config

Request JSON Object:

• config_definition (string) –

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• groups[].groupname (string) –

• groups[].name (string) –

• roles[].id (integer) –

• roles[].name (string) –

• roles[].uri (string) –

• tags[] (string) –

• updated_at (string) –

• users[].assignment_weight (number) –

• users[].email (string) –

• users[].id (integer) –

• users[].name (string) –

• users[].uri (string) –

• users[].username (string) –

POST /service/config/import-config

Request JSON Object:

• config_definition (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Created group

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• groups[].groupname (string) –

• groups[].name (string) –

• roles[].id (integer) –

• roles[].name (string) –

• roles[].uri (string) –

• tags[] (string) –

• updated_at (string) –

• users[].assignment_weight (number) –

• users[].email (string) –

• users[].id (integer) –

• users[].name (string) –

• users[].uri (string) –

• users[].username (string) –

GET /tags

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• tags[].name (string) –

• tags[].uri (string) –

POST /tags

Request JSON Object:

• name (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Created tag

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• name (string) –

• tasks (string) –

• uri (string) –

GET /tags/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find tag

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• name (string) –

• tasks (string) –

• uri (string) –

PUT /tags/{id}

Parameters:

• id (integer) –

Request JSON Object:

• name (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find tag

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• name (string) –

• tasks (string) –

• uri (string) –

DELETE /tags/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find tag

GET /tags/{id}/tasks

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find tag

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• limit (integer) –

• offset (integer) –

• tasks[].id (string) –

• tasks[].project (string) –

• tasks[].status (string) –

• tasks[].tags[].name (string) –

• tasks[].tags[].uri (string) –

• tasks[].template (string) –

• tasks[].uri (string) –

• total_tasks (integer) –

GET /task-at-timepoint/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find selected task

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• application_name (string) –

• application_version (string) –

• callback_content (string) –

• callback_url (string) –

• content (string) –

• create_time (string) –

• generator_url (string) –

• groups[] (string) –

• lock (string) –

• project (string) –

• status (string) –

• tags[] (string) –

• template (string) –

• update_time (string) –

• uri (string) –

• users[] (string) –

• users_via_group[] (string) –

GET /task_templates

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• task_templates[] (string) –

POST /task_templates

Request JSON Object:

• content (object) –

• label (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Create task template

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• content (string) –

• label (string) –

• uri (string) –

GET /task_templates/{id}

Parameters:

• id (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find task template

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• content (string) –

• label (string) –

• uri (string) –

PUT /task_templates/{id}

Parameters:

• id (string) –

Request JSON Object:

• content (object) –

• label (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find task template

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• content (string) –

• label (string) –

• uri (string) –

DELETE /task_templates/{id}

Parameters:

• id (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find task template

GET /taskgroups

Query Parameters:

• status (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find user or template

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• taskgroups[].id (string) –

• taskgroups[].label (string) –

• taskgroups[].status (string) –

• taskgroups[].url (string) –

POST /taskgroups

Request JSON Object:

• callback_content (string) –

• callback_url (string) –

• distribute_in_group (string) –

• distribute_method (string) –

• label (string) –

• tasks[].application_name (string) –

• tasks[].application_version (string) –

• tasks[].callback_content (string) –

• tasks[].callback_url (string) –

• tasks[].content (string) –

• tasks[].distribute_in_group (string) –

• tasks[].generator_url (string) –

• tasks[].groups[] (string) –

• tasks[].project (string) –

• tasks[].raw_callback_url (string) –

• tasks[].raw_content (string) –

• tasks[].tags[] (string) –

• tasks[].template (string) –

• tasks[].tracking_id (string) –

• tasks[].users[] (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Created

• 404 Not Found – Could not find a required resource

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• callback_content (string) –

• callback_url (string) –

• label (string) –

• tasks[] (integer) –

GET /taskgroups/{id}

Parameters:

• id (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find selected taskgroup

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• callback_content (string) –

• callback_url (string) –

• label (string) –

• tasks[] (integer) –

PUT /taskgroups/{id}

Parameters:

• id (string) –

Request JSON Object:

• callback_content (string) –

• callback_url (string) –

• label (string) –

• tasks[] (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Taskgroup or child task not found

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• callback_content (string) –

• callback_url (string) –

• label (string) –

• tasks[] (integer) –

GET /tasks

Query Parameters:

• project (string) – Filter on project name

• template (string) – Filter on template label

• user (string) – Filter on user by id or label

• status (string) – Filter on status.

• tag (array) – Tag name or list of tag names to filter on. When multiple tag args are given AND filter logic is applied.

• application_name (string) – Filter on application name

• offset (integer) – Offset for pagination

• limit (integer) – Maximum number of rows returned

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find user or template

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• limit (integer) –

• offset (integer) –

• tasks[].id (string) –

• tasks[].project (string) –

• tasks[].status (string) –

• tasks[].tags[].name (string) –

• tasks[].tags[].uri (string) –

• tasks[].template (string) –

• tasks[].uri (string) –

• total_tasks (integer) –

POST /tasks

Request JSON Object:

• application_name (string) –

• application_version (string) –

• callback_content (string) –

• callback_url (string) –

• content (string) –

• distribute_in_group (string) –

• generator_url (string) –

• groups[] (string) –

• project (string) –

• raw_callback_url (string) –

• raw_content (string) –

• tags[] (string) –

• template (string) –

• tracking_id (string) –

• users[] (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Created new task

• 400 Bad Request – Invalid request: specified both users/groups and a distribute in group directive

• 404 Not Found – Could not find all users, groups or template

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• application_name (string) –

• application_version (string) –

• callback_content (string) –

• callback_url (string) –

• content (string) –

• create_time (string) –

• generator_url (string) –

• groups[] (string) –

• lock (string) –

• project (string) –

• status (string) –

• tags[] (string) –

• template (string) –

• update_time (string) –

• uri (string) –

• users[] (string) –

• users_via_group[] (string) –

GET /tasks/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find selected task

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• application_name (string) –

• application_version (string) –

• callback_content (string) –

• callback_url (string) –

• content (string) –

• create_time (string) –

• generator_url (string) –

• groups[] (string) –

• lock (string) –

• project (string) –

• status (string) –

• tags[] (string) –

• template (string) –

• update_time (string) –

• uri (string) –

• users[] (string) –

• users_via_group[] (string) –

PUT /tasks/{id}

Parameters:

• id (integer) –

Request JSON Object:

• application_name (string) –

• application_version (string) –

• callback_content (string) –

• callback_url (string) –

• content (string) –

• generator_url (string) –

• groups[] (string) –

• project (string) –

• raw_callback_url (string) –

• raw_content (string) –

• status (string) –

• tags[] (string) –

• template (string) –

• tracking_id (string) –

• users[] (string) –

Status Codes:

• 200 OK – Success

• 403 Forbidden – You are not authorized to perform this operation

• 404 Not Found – Could not find selected task, user(s), group(s) or template

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• application_name (string) –

• application_version (string) –

• callback_content (string) –

• callback_url (string) –

• content (string) –

• create_time (string) –

• generator_url (string) –

• groups[] (string) –

• lock (string) –

• project (string) –

• status (string) –

• tags[] (string) –

• template (string) –

• update_time (string) –

• uri (string) –

• users[] (string) –

• users_via_group[] (string) –

DELETE /tasks/{id}

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find task

GET /tasks/{id}/lock

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find selected task

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• error (string) –

• lock (string) –

• username (string) –

PUT /tasks/{id}/lock

Parameters:

• id (integer) –

Request JSON Object:

• lock (string) –

Status Codes:

• 200 OK – Success

• 403 Forbidden – You are not authorized to update the lock this task to someone else

• 404 Not Found – Could not find selected task or user

• 409 Conflict – Task already locked by other user

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• error (string) –

• lock (string) –

• username (string) –

DELETE /tasks/{id}/lock

Parameters:

• id (integer) –

Status Codes:

• 200 OK – Success

• 403 Forbidden – You are not authorized to release the lock of another user

• 404 Not Found – Could not find selected task or user

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• error (string) –

• lock (string) –

• username (string) –

GET /users

Status Codes:

• 200 OK – Success

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• users[] (string) –

POST /users

Request JSON Object:

• active (boolean) –

• assignment_weight (number) –

• email (string) –

• name (string) –

• password (string) –

• username (string) –

Status Codes:

• 200 OK – Success

• 201 Created – Created user

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• active (boolean) –

• assignment_weight (number) –

• create_time (string) –

• email (string) –

• groups (string) –

• name (string) –

• tasks (string) –

• uri (string) –

• username (string) –

GET /users/{id}

Parameters:

• id (string) –

Status Codes:

• 200 OK – Success

• 403 Forbidden – You are not authorized to get this information

• 404 Not Found – Could not find user

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• active (boolean) –

• assignment_weight (number) –

• create_time (string) –

• email (string) –

• groups (string) –

• name (string) –

• tasks (string) –

• uri (string) –

• username (string) –

PUT /users/{id}

Parameters:

• id (string) –

Request JSON Object:

• active (boolean) –

• assignment_weight (number) –

• email (string) –

• name (string) –

• password (string) –

• username (string) –

Status Codes:

• 200 OK – Success

• 403 Forbidden – You are not authorized to perform this operation

• 404 Not Found – Could not find user

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• active (boolean) –

• assignment_weight (number) –

• create_time (string) –

• email (string) –

• groups (string) –

• name (string) –

• tasks (string) –

• uri (string) –

• username (string) –

DELETE /users/{id}

Parameters:

• id (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – Could not find user

GET /users/{id}/groups

Parameters:

• id (string) –

Status Codes:

• 200 OK – Success

• 403 Forbidden – You are not authorized to get this information

• 404 Not Found – User not found

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• groups[] (string) –

GET /users/{id}/tasks

Parameters:

• id (string) –

Status Codes:

• 200 OK – Success

• 403 Forbidden – You are not authorized to get this information

• 404 Not Found – Could not find user

Request Headers:

• X-Fields – An optional fields mask

Response JSON Object:

• limit (integer) –

• offset (integer) –

• tasks[].id (string) –

• tasks[].project (string) –

• tasks[].status (string) –

• tasks[].tags[].name (string) –

• tasks[].tags[].uri (string) –

• tasks[].template (string) –

• tasks[].uri (string) –

• total_tasks (integer) –

PUT /users/{user_id}/roles/{role_id}

Parameters:

• user_id (string) –

• role_id (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – User or Role not found

DELETE /users/{user_id}/roles/{role_id}

Parameters:

• user_id (string) –

• role_id (string) –

Status Codes:

• 200 OK – Success

• 404 Not Found – User or Role not found