Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: (tasklist) update tasklist-rest-api overview #2313

Merged
merged 1 commit into from
Jul 11, 2023
Merged

docs: (tasklist) update tasklist-rest-api overview #2313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 17 additions & 14 deletions docs/apis-tools/tasklist-api-rest/tasklist-api-rest-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,23 @@ Requests and responses are in JSON notation. Some objects have additional endpoi

## API documentation as Swagger

A detailed API description is also available as Swagger UI at `https://${base-url}/swagger-ui/index.html`. For SaaS: `https://${REGION}.tasklist.camunda.io:443/${CLUSTER_ID}/swagger-ui/index.html`, and for Self-Managed installations: `http://localhost:8080/swagger-ui/index.html`.
A detailed API description is also available as Swagger UI at `https://${base-url}/swagger-ui/index.html`.<br/>
For SaaS: `https://${REGION}.tasklist.camunda.io:443/${CLUSTER_ID}/swagger-ui/index.html`,<br/>
and for Self-Managed installations: [`http://localhost:8080/swagger-ui/index.html`](http://localhost:8080/swagger-ui/index.html).

## Endpoints

| Endpoint (HTTP verb + URL path) | Description |
| :----------------------------------------- | ----------------------------------------------------------------------------: |
| **Tasks** | |
| `GET /v1/tasks/{taskId}` | Return a task by taskId. |
| `POST /v1/tasks/search` | Returns the list of tasks that satisfy search request params. |
| `POST /v1/tasks/{taskId}/variables/search` | Returns a list of task variables for the specified taskId and variableName. |
| `PATCH /v1/tasks/{taskId}/assign` | Assign a task with `taskId` to `assignee` or the active user. |
| `PATCH /v1/tasks/{taskId}/unassign` | Unassign a task with provided `taskId`. |
| `PATCH /v1/tasks/{taskId}/complete` | Complete a task with taskId and optional variables. |
| **Forms** | |
| `POST /v1/forms/{formId}` | Get the form details by formId and processDefinitionKey required query param. |
| **Variables** | |
| `POST /v1/variables/{variableId}` | Get the variable details by variable id. |
| Endpoint (HTTP verb + URL path) | Description |
| :-------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------: |
| **Tasks** | |
| [`GET /v1/tasks/{taskId}`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#get-task) | Return a task by `taskId`. |
| [`POST /v1/tasks/search`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#search-tasks) | Returns the list of tasks that satisfy search request params. |
| [`POST /v1/tasks/{taskId}/variables`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#save-draft-task-variables) | Saves draft variables for a specific task. |
| [`POST /v1/tasks/{taskId}/variables/search`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#search-task-variables) | Returns a list of task variables for the specified `taskId` and `variableNames`. |
| [`PATCH /v1/tasks/{taskId}/assign`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#assign-task) | Assign a task with `taskId` to `assignee` or the active user. |
| [`PATCH /v1/tasks/{taskId}/unassign`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#unassign-task) | Unassign a task with provided `taskId`. |
| [`PATCH /v1/tasks/{taskId}/complete`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#complete-task) | Complete a task with `taskId` and optional variables. |
| **Forms** | |
| [`GET /v1/forms/{formId}?processDefinitionKey={processDefinitionKey}`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-form-controller.md#get-form) | Get the form details by `formId` and `processDefinitionKey` required query param. |
| **Variables** | |
| [`GET /v1/variables/{variableId}`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-variables-controller.md#get-variable) | Get the variable details by `variableId`. |
30 changes: 16 additions & 14 deletions ...ned_docs/version-8.2/apis-tools/tasklist-api-rest/tasklist-api-rest-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,22 @@ Requests and responses are in JSON notation. Some objects have additional endpoi

## API documentation as Swagger

A detailed API description is also available as Swagger UI at `https://${base-url}/swagger-ui/index.html`.
A detailed API description is also available as Swagger UI at `https://${base-url}/swagger-ui/index.html`.<br/>
For SaaS: `https://${REGION}.tasklist.camunda.io:443/${CLUSTER_ID}/swagger-ui/index.html`,<br/>
and for Self-Managed installations: [`http://localhost:8080/swagger-ui/index.html`](http://localhost:8080/swagger-ui/index.html).

## Endpoints

| Endpoint (HTTP verb + URL path) | Description |
| :----------------------------------------- | ----------------------------------------------------------------------------: |
| **Tasks** | |
| `GET /v1/tasks/{taskId}` | Return a task by taskId. |
| `POST /v1/tasks/search` | Returns the list of tasks that satisfy search request params. |
| `POST /v1/tasks/{taskId}/variables/search` | Returns a list of task variables for the specified taskId and variableName. |
| `PATCH /v1/tasks/{taskId}/assign` | Assign a task with `taskId` to `assignee` or the active user. |
| `PATCH /v1/tasks/{taskId}/unassign` | Unassign a task with provided `taskId`. |
| `PATCH /v1/tasks/{taskId}/complete` | Complete a task with taskId and optional variables. |
| **Forms** | |
| `POST /v1/forms/{formId}` | Get the form details by formId and processDefinitionKey required query param. |
| **Variables** | |
| `POST /v1/variables/{variableId}` | Get the variable details by variable id. |
| Endpoint (HTTP verb + URL path) | Description |
| :-------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------: |
| **Tasks** | |
| [`GET /v1/tasks/{taskId}`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#get-task) | Return a task by `taskId`. |
| [`POST /v1/tasks/search`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#search-tasks) | Returns the list of tasks that satisfy search request params. |
| [`POST /v1/tasks/{taskId}/variables/search`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#search-task-variables) | Returns a list of task variables for the specified `taskId` and `variableNames.` |
| [`PATCH /v1/tasks/{taskId}/assign`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#assign-task) | Assign a task with `taskId` to `assignee` or the active user. |
| [`PATCH /v1/tasks/{taskId}/unassign`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#unassign-task) | Unassign a task with provided `taskId`. |
| [`PATCH /v1/tasks/{taskId}/complete`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-task-controller.md#complete-task) | Complete a task with `taskId` and optional variables. |
| **Forms** | |
| [`GET /v1/forms/{formId}?processDefinitionKey={processDefinitionKey}`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-form-controller.md#get-form) | Get the form details by `formId` and `processDefinitionKey` required query param. |
| **Variables** | |
| [`GET /v1/variables/{variableId}`](/apis-tools/tasklist-api-rest/controllers/tasklist-api-rest-variables-controller.md#get-variable) | Get the variable details by `variableId`. |
Loading