Task Templates
Permissions
Permissions for Task Templates can be checked
| Context | Endpoint | Location | Available perms |
|---|---|---|---|
| Any Class | GET /api/users/permissions/ | task_templates | list, view, edit, create |
| Specific Class | GET /api/task-templates/{id}/ | _meta.permissions | list, view, edit, create |
References
Task Templates API
POST /api/task-templates/
Creates Task Template.
Permissions
Requires authentication and task_templates.create permission.
Request
- Headers
Request Method: POST
Content-Type: application/json
Location: /api/task-templates/
Authorization: JWT access_token- Body
| Key | Type | Required | Notes |
|---|---|---|---|
| name | string | true | |
| complete_by | enum | true | |
| plugin_config | Object | true | |
| complete_by_date | date | false | |
| complete_by_time_unit | enum | false | |
| complete_by_time_value | int | false | |
| description | string | false | |
| expiry | enum | false | |
| expiry_time_unit | enum | false | |
| expiry_time_value | int | false | |
| expiry_time_rel_to | enum | false | |
| expiry_date | date | false | |
| expiry_day | int | false | |
| expiry_periodic_day | int | false | |
| expiry_periodic_month | int | false | |
| reminders | Object | false | |
| renewals | Object | false | |
| task_creation | enum | false |
Request plugin_config array
| Key | Type | Required |
|---|---|---|
| task_type | enum | true |
| configuration | Json | true |
| approval_conditions | Object | false |
Request reminders array
| Key | Type | Required |
|---|---|---|
| notice_type | enum | true |
| time_unit | enum | true |
| time_value | int | true |
Request renewals array
| Key | Type | Required |
|---|---|---|
| renewal_time_unit | enum | false |
| renewal_time_value | int | false |
Validations
Information about validators for individual fields is included in OPTIONS /api/task-templates/
Sample request body
json
{
"name": "test_template",
"complete_by": "asap",
"plugin_config": {
"task_type": "tt_form",
"configuration": {
"name": "some name"
}
}
}Response
| Key | Type | Notes |
|---|---|---|
| id | int | Automatically generated by the backend. |
| name | string | |
| task_creation | enum | |
| description | string | |
| created_at | datetime | |
| created_by | user | |
| modified_at | datetime | |
| modified_by | user | |
| num_of_tasks_created | int | |
| last_task_created | datetime | |
| instructions | string | |
| complete_by | enum | |
| complete_by_date | date | |
| complete_by_time_unit | enum | |
| complete_by_time_value | int | |
| complete_by_time_unit | enum | |
| reminders | Object | |
| expiry | enum | |
| expiry_time_unit | enum | |
| expiry_time_value | int | |
| expiry_time_rel_to | enum | |
| expiry_date | date | |
| expiry_day | int | |
| expiry_periodic_day | int | |
| expiry_periodic_month | int | |
| plugin_config | Object | |
| renewals | Object | |
| _meta.permissions | Object | Object describing permissions. |
Response plugin_config array
| Key | Type | Required |
|---|---|---|
| task_type | enum | true |
| configuration | Json | true |
| approval_conditions | Object | false |
Response reminders array
| Key | Type | Required |
|---|---|---|
| notice_type | enum | true |
| time_unit | enum | true |
| time_value | int | true |
Response renewals array
| Key | Type | Required |
|---|---|---|
| renewal_time_unit | enum | false |
| renewal_time_value | int | false |
- Successful status
201 Created - Response body schema
json
{
"id": 10,
"name": "test_template",
"task_creation": "automatic",
"description": "",
"created_at": "2023-07-26T10:49:43.842177+02:00",
"created_by": {
"id": 2,
"first_name": "ALX",
"last_name": "Developer",
"username": "alx.dev@autologyx.com",
"company_name": "",
"is_deleted": false,
"account_type": "super_admin"
},
"modified_at": "2023-07-26T10:49:43.842202+02:00",
"num_of_tasks_created": 0,
"last_task_created": null,
"instructions": "",
"complete_by": "asap",
"complete_by_date": null,
"complete_by_time_unit": null,
"complete_by_time_value": null,
"reminders": [],
"expiry": null,
"expiry_time_unit": null,
"expiry_time_value": null,
"expiry_time_rel_to": null,
"expiry_date": null,
"expiry_day": null,
"expiry_periodic_day": null,
"expiry_periodic_month": null,
"plugin_config": {
"prompt": "",
"allow_comment": false,
"task_type": "tt_form",
"approval_required": false,
"approval_conditions": [],
"_meta": {
"labels": {
"task_type": "Complete standalone form"
}
},
"configuration": {
"name": "some name"
}
},
"renewals": [],
"modified_by": {
"id": 2,
"first_name": "ALX",
"last_name": "Developer",
"username": "alx.dev@autologyx.com",
"company_name": "",
"is_deleted": false,
"account_type": "super_admin"
},
"_meta": {
"permissions": {
"list": true,
"view": true,
"create": true,
"edit": true,
"delete": true
}
}
}PATCH /api/task-templates/'id'
Update single Task Template.
Permissions
Requires authentication and task_templates.edit permission.
Request
- Headers
Request Method: PATCH
Content-Type: application/json
Location: /api/task-templates/1
Authorization: JWT access_token- Body
| Key | Type | Required | Notes |
|---|---|---|---|
| name | string | true | |
| complete_by | enum | true | |
| complete_by_date | date | false | |
| complete_by_time_unit | enum | false | |
| complete_by_time_value | int | false | |
| description | string | false | |
| expiry | enum | false | |
| expiry_time_unit | enum | false | |
| expiry_time_value | int | false | |
| expiry_time_rel_to | enum | false | |
| expiry_date | date | false | |
| expiry_day | int | false | |
| expiry_periodic_day | int | false | |
| expiry_periodic_month | int | false | |
| reminders | Object | false | |
| renewals | Object | false |
Any parameter not listed above are silently ignored if passed.
Request plugin_config array
| Key | Type | Required |
|---|---|---|
| task_type | enum | true |
| configuration | Json | true |
| approval_conditions | Object | false |
Request reminders array
| Key | Type | Required |
|---|---|---|
| notice_type | enum | true |
| time_unit | enum | true |
| time_value | int | true |
Request renewals array
| Key | Type | Required |
|---|---|---|
| renewal_time_unit | enum | false |
| renewal_time_value | int | false |
Validations
Information about validators for individual fields is included in OPTIONS /api/task-templates/
Sample request body
json
{
"name": "test_template",
"description": "some description"
}Response
| Key | Type | Notes |
|---|---|---|
| id | int | Automatically generated by the backend. |
| name | string | |
| task_creation | enum | |
| description | string | |
| created_at | datetime | |
| created_by | user | |
| modified_at | datetime | |
| modified_by | user | |
| num_of_tasks_created | int | |
| last_task_created | datetime | |
| instructions | string | |
| complete_by | enum | |
| complete_by_date | date | |
| complete_by_time_unit | enum | |
| complete_by_time_value | int | |
| complete_by_time_unit | enum | |
| reminders | Object | |
| expiry | enum | |
| expiry_time_unit | enum | |
| expiry_time_value | int | |
| expiry_time_rel_to | enum | |
| expiry_date | date | |
| expiry_day | int | |
| expiry_periodic_day | int | |
| expiry_periodic_month | int | |
| plugin_config | Object | |
| renewals | Object | |
| _meta.permissions | Object | Object describing permissions. |
Response plugin_config array
| Key | Type | Required |
|---|---|---|
| task_type | enum | true |
| configuration | Json | true |
| approval_conditions | Object | false |
Response reminders array
| Key | Type | Required |
|---|---|---|
| notice_type | enum | true |
| time_unit | enum | true |
| time_value | int | true |
Response renewals array
| Key | Type | Required |
|---|---|---|
| renewal_time_unit | enum | false |
| renewal_time_value | int | false |
- Successful status
200 OK - Response body schema
json
{
"id": 10,
"name": "test_template",
"task_creation": "automatic",
"description": "some description",
"created_at": "2023-07-26T10:49:43.842177+02:00",
"created_by": {
"id": 2,
"first_name": "ALX",
"last_name": "Developer",
"username": "alx.dev@autologyx.com",
"company_name": "",
"is_deleted": false,
"account_type": "super_admin"
},
"modified_at": "2023-07-26T10:49:43.842202+02:00",
"num_of_tasks_created": 0,
"last_task_created": null,
"instructions": "",
"complete_by": "asap",
"complete_by_date": null,
"complete_by_time_unit": null,
"complete_by_time_value": null,
"reminders": [],
"expiry": null,
"expiry_time_unit": null,
"expiry_time_value": null,
"expiry_time_rel_to": null,
"expiry_date": null,
"expiry_day": null,
"expiry_periodic_day": null,
"expiry_periodic_month": null,
"plugin_config": {
"prompt": "",
"allow_comment": false,
"task_type": "tt_form",
"approval_required": false,
"approval_conditions": [],
"_meta": {
"labels": {
"task_type": "Complete standalone form"
}
},
"configuration": {
"name": "some name"
}
},
"renewals": [],
"modified_by": {
"id": 2,
"first_name": "ALX",
"last_name": "Developer",
"username": "alx.dev@autologyx.com",
"company_name": "",
"is_deleted": false,
"account_type": "super_admin"
},
"_meta": {
"permissions": {
"list": true,
"view": true,
"create": true,
"edit": true,
"delete": true
}
}
}OPTIONS /api/task-templates/
Permissions
Requires authentication only.
Request
- Headers
Request Method: OPTIONS
Content-Type: application/json
Location: /api/task-templates/
Authorization: JWT access_tokenResponse
- Successful status
200 OK - Response body:
json
{
"list": {
"columns": [
{
"alias": "id",
"type": "int",
"predicates": [
"exact",
"gt",
"gte",
"lt",
"lte",
"range"
],
"sort_ok": true
},
{
"alias": "name",
"type": "string",
"predicates": [
"exact",
"iexact",
"contains",
"icontains",
"startswith",
"istartswith",
"endswith",
"iendswith"
],
"sort_ok": true
},
{
"alias": "task_type",
"type": "enum",
"predicates": [
"exact",
"in"
],
"sort_ok": false,
"values": [
{
"value": "tt_form",
"text": "Complete standalone form"
},
{
"value": "tt_object_record_update",
"text": "Object Record update"
}
]
},
{
"alias": "plugin_config",
"schema": [
{
"alias": "task_type",
"type": "enum",
"predicates": [
"exact",
"in"
],
"sort_ok": false,
"values": [
{
"value": "tt_form",
"text": "Complete standalone form"
},
{
"value": "tt_object_record_update",
"text": "Object Record update"
}
]
}
],
"schema_by_type": [
{
"task_type": "tt_form",
"schema": []
},
{
"task_type": "tt_object_record_update",
"schema": [
{
"alias": "object_class",
"type": "enum",
"predicates": [
"exact",
"isnull",
"in"
],
"sort_ok": true,
"autocomplete": "/api/object-classes/autocomplete/?text__icontains="
}
]
}
]
},
{
"alias": "task_creation",
"type": "enum",
"predicates": [
"exact"
],
"sort_ok": false,
"values": [
{
"value": "automatic",
"text": "Automatic"
},
{
"value": "manual",
"text": "Manual"
}
]
},
{
"alias": "description",
"type": "string",
"predicates": [],
"sort_ok": false
},
{
"alias": "created_at",
"type": "datetime",
"predicates": [
"exact",
"gt",
"gte",
"lt",
"lte",
"range"
],
"sort_ok": true
},
{
"alias": "created_by",
"type": "user",
"predicates": [
"exact",
"in"
],
"sort_ok": false,
"autocomplete": "/api/users/autocomplete/?text__icontains="
},
{
"alias": "modified_by",
"type": "user",
"predicates": [
"exact",
"in"
],
"sort_ok": false,
"autocomplete": "/api/users/autocomplete/?text__icontains="
},
{
"alias": "modified_at",
"type": "datetime",
"predicates": [
"exact",
"gt",
"gte",
"lt",
"lte",
"range"
],
"sort_ok": true
},
{
"alias": "num_of_tasks_created",
"type": "int",
"predicates": [
"exact",
"gt",
"gte",
"lt",
"lte",
"range"
],
"sort_ok": true
},
{
"alias": "last_task_created",
"type": "datetime",
"predicates": [],
"sort_ok": true
}
]
},
"details": {
"schema": [
{
"alias": "name",
"type": "string",
"required": true,
"validators": [
{
"type": "min_length",
"length": 1
},
{
"type": "max_length",
"length": 100
}
]
},
{
"alias": "complete_by",
"type": "enum",
"required": true,
"values": [
{
"value": "asap",
"text": "ASAP"
},
{
"value": "date",
"text": "Date"
},
{
"value": "time_frame",
"text": "Time frame"
}
]
},
{
"alias": "complete_by_date",
"type": "date",
"required": false,
"validators": [
{
"type": "date_in_future"
}
]
},
{
"alias": "complete_by_time_unit",
"type": "enum",
"required": false,
"values": [
{
"value": "days",
"text": "days"
},
{
"value": "weeks",
"text": "weeks"
},
{
"value": "months",
"text": "months"
}
]
},
{
"alias": "complete_by_time_value",
"type": "int",
"required": false,
"validators": [
{
"type": "min_value",
"value": 0
},
{
"type": "max_value",
"value": 100
}
]
},
{
"alias": "plugin_config",
"schema": [
{
"alias": "task_type",
"editable": false,
"type": "enum",
"required": true,
"values": [
{
"value": "tt_form",
"text": "Complete standalone form"
},
{
"value": "tt_object_record_update",
"text": "Object Record update"
}
]
},
{
"alias": "approval_conditions",
"required": false,
"schema": [
{
"alias": "name",
"type": "string",
"required": true,
"validators": [
{
"type": "min_length",
"length": 1
},
{
"type": "max_length",
"length": 255
}
]
}
],
"validators": [
{
"type": "max_length",
"length": 20
}
]
}
],
"schema_by_type": [
{
"task_type": "tt_form",
"schema": []
},
{
"task_type": "tt_object_record_update",
"schema": [
{
"alias": "object_class",
"type": "enum",
"required": true,
"editable": false,
"autocomplete": "/api/object-classes/autocomplete/owned/?text__icontains="
}
]
}
]
},
{
"alias": "description",
"type": "string",
"required": false,
"validators": [
{
"type": "max_length",
"length": 500
}
]
},
{
"alias": "expiry",
"type": "enum",
"required": false,
"values": [
{
"value": "time_frame",
"text": "Time frame"
},
{
"value": "date",
"text": "Date"
},
{
"value": "monthly",
"text": "Monthly"
},
{
"value": "annually",
"text": "Annually"
}
]
},
{
"alias": "expiry_time_unit",
"type": "enum",
"required": false,
"values": [
{
"value": "days",
"text": "days"
},
{
"value": "weeks",
"text": "weeks"
},
{
"value": "months",
"text": "months"
}
]
},
{
"alias": "expiry_time_value",
"type": "int",
"required": false,
"validators": [
{
"type": "min_value",
"value": 0
},
{
"type": "max_value",
"value": 100
}
]
},
{
"alias": "expiry_time_rel_to",
"type": "enum",
"required": false,
"values": [
{
"value": "completed",
"text": "Completed"
},
{
"value": "assigned",
"text": "Assigned"
}
]
},
{
"alias": "expiry_date",
"type": "date",
"required": false,
"validators": [
{
"type": "date_in_future"
}
]
},
{
"alias": "expiry_day",
"type": "int",
"required": false,
"validators": [
{
"type": "min_value",
"value": 1
},
{
"type": "max_value",
"value": 31
}
]
},
{
"alias": "expiry_periodic_day",
"type": "int",
"required": false,
"validators": [
{
"type": "min_value",
"value": 1
},
{
"type": "max_value",
"value": 31
}
]
},
{
"alias": "expiry_periodic_month",
"type": "int",
"required": false,
"validators": [
{
"type": "min_value",
"value": 1
},
{
"type": "max_value",
"value": 12
}
]
},
{
"alias": "reminders",
"schema": [
{
"alias": "notice_type",
"type": "enum",
"required": true,
"values": [
{
"value": "task_complete_by",
"text": "Task to Complete by"
},
{
"value": "task_overdue",
"text": "Task Overdue"
},
{
"value": "task_expiry",
"text": "Task Expiry"
}
]
},
{
"alias": "time_unit",
"type": "enum",
"required": true,
"values": [
{
"value": "days",
"text": "days"
},
{
"value": "weeks",
"text": "weeks"
},
{
"value": "months",
"text": "months"
}
]
},
{
"alias": "time_value",
"type": "int",
"required": true,
"validators": [
{
"type": "min_value",
"value": 0
},
{
"type": "max_value",
"value": 100
}
]
}
],
"validators": [
{
"type": "max_length",
"length": 1,
"apply_to": {
"alias": "notice_type",
"value": "task_complete_by"
}
},
{
"type": "max_length",
"length": 10,
"apply_to": {
"alias": "notice_type",
"value": "task_overdue"
}
},
{
"type": "max_length",
"length": 10,
"apply_to": {
"alias": "notice_type",
"value": "task_expiry"
}
}
]
},
{
"alias": "renewals",
"schema": [
{
"alias": "renewal_time_unit",
"type": "enum",
"required": false,
"values": [
{
"value": "days",
"text": "days"
},
{
"value": "weeks",
"text": "weeks"
},
{
"value": "months",
"text": "months"
}
]
},
{
"alias": "renewal_time_value",
"type": "int",
"required": false,
"validators": [
{
"type": "min_value",
"value": 0
},
{
"type": "max_value",
"value": 100
}
]
}
]
},
{
"alias": "task_creation",
"type": "enum",
"required": false,
"values": [
{
"value": "automatic",
"text": "Automatic"
},
{
"value": "manual",
"text": "Manual"
}
]
}
]
},
"restrictions": {
"limit_items": 10000
}
}GET /api/task-templates/
Returns list of Task Templates.
Permissions
Request example
- Headers
Content-Type: application/json
Authorization: JWT access_tokenResponse
| Key | Type | Notes |
|---|---|---|
| limit | int | |
| offset | int | |
| total_count | int | Total number of results visible to the user (based on permissions). |
| filtered_count | int | Number of results visible to the user (based on permissions) with filters applied. |
| next | url | Next page URL (null if there is no next page) |
| previous | url | Previous page URL (null if there is no previous page) |
| results | Array | List of results. Described in the next table. |
Response results array
| Key | Type | Notes |
|---|---|---|
| id | int | |
| name | str | |
| task_type | str | Task response type |
| plugin_config | Object | Object describing task type details |
| task_creation | str | Task creation type automatic/manual |
| description | str | |
| created_at | datetime | |
| created_by | user | |
| modified_at | datetime | |
| modified_by | user | |
| num_of_tasks_created | int | |
| last_task_created | datetime | |
| _meta.permissions | Object | Object describing permissions. |
- Successful status
200 OK - Response body schema
json
{
"limit": 100,
"offset": 0,
"filtered_count": 2,
"total_count": 2,
"next": null,
"previous": null,
"results": [
{
"id": 1,
"name": "test_name",
"task_type": "tt_form",
"plugin_config": {
"task_type": "tt_form",
"_meta": {
"labels": {
"task_type": "Complete standalone form"
}
}
},
"task_creation": "automatic",
"description": "some test description",
"created_at": "2022-06-01T09:43:39.659685+02:00",
"created_by": {
"id": 2,
"first_name": "ALX",
"last_name": "Developer",
"username": "alx.dev@autologyx.com",
"company_name": "",
"is_deleted": false,
"account_type": "super_admin"
},
"modified_by": {
"id": 2,
"first_name": "ALX",
"last_name": "Developer",
"username": "alx.dev@autologyx.com",
"company_name": "",
"is_deleted": false,
"account_type": "super_admin"
},
"modified_at": "2022-06-01T09:43:39.659715+02:00",
"num_of_tasks_created": 0,
"last_task_created": null,
"_meta": {
"permissions": {
"list": true,
"view": true,
"create": true,
"edit": true,
"delete": true
}
}
}
]
}Sorting
Will be completed in the future
Filtering
Will be completed in the future
Errors
Will be completed in the future
GET /task-templates/id/
Returns single task templates by id.
Permissions
Requires authentication and task_templates.view permission.
URL parameters
| Key | Type | Notes |
|---|---|---|
| id | int |
Request example
- Headers
Content-Type: application/json
Authorization: JWT access_tokenResponse
| Key | Type | Notes |
|---|---|---|
| id | int | |
| name | str | |
| task_type | str | Task response type |
| plugin_config | Object | Object describing task type details |
| task_creation | str | Task creation type automatic/manual |
| description | str | |
| created_at | datetime | |
| created_by | user | |
| modified_at | datetime | |
| modified_by | user | |
| num_of_tasks_created | int | |
| instructions | str | |
| complete_by | str | |
| complete_by_date | date | |
| complete_by_time_unit | str | |
| reminders: | Array | |
| expiry | str | |
| expiry_time_unit | str | |
| expiry_time_value | int | |
| expiry_time_rel_to | str | |
| expiry_date | date | |
| expiry_day | int | |
| expiry_periodic_month | int | |
| last_task_created | datetime | |
| renewals | Array | |
| _meta.permissions | Object | Object describing permissions. |
- Successful status
200 OK - Response body schema:
json
{
"id": 1,
"name": "test_name",
"task_creation": "automatic",
"description": "some test description",
"created_at": "2022-06-01T09:43:39.659685+02:00",
"created_by": {
"id": 2,
"first_name": "ALX",
"last_name": "Developer",
"username": "alx.dev@autologyx.com",
"company_name": "",
"is_deleted": false,
"account_type": "super_admin"
},
"modified_at": "2022-06-01T09:43:39.659715+02:00",
"num_of_tasks_created": 0,
"last_task_created": null,
"instructions": "",
"complete_by": "time_frame",
"complete_by_date": null,
"complete_by_time_unit": "months",
"complete_by_time_value": 1,
"reminders": [],
"expiry": "time_frame",
"expiry_time_unit": "weeks",
"expiry_time_value": 2,
"expiry_time_rel_to": "assigned",
"expiry_date": null,
"expiry_day": null,
"expiry_periodic_day": null,
"expiry_periodic_month": null,
"plugin_config": {
"prompt": "",
"allow_comment": false,
"task_type": "tt_form",
"approval_required": false,
"approval_conditions": [],
"_meta": {
"labels": {
"task_type": "Complete standalone form"
}
},
"configuration": {
"name": "some name"
}
},
"renewals": [],
"modified_by": {
"id": 2,
"first_name": "ALX",
"last_name": "Developer",
"username": "alx.dev@autologyx.com",
"company_name": "",
"is_deleted": false,
"account_type": "super_admin"
},
"_meta": {
"permissions": {
"list": true,
"view": true,
"create": true,
"edit": true,
"delete": true
}
}
}Errors
| Error | Response code | Message |
|---|---|---|
| task_template with "id" does not exist | 404 Not Found | "detail": "Not found." |
| Insufficient permissions | 403 Forbidden | "detail": "You do not have permission to perform this action." |
DELETE /api/task-templates/id/
Remove a Task Template with checking if no used anywhere.
Permissions
Requires authentication and task_templates.delete permission.
Request example
- Headers
Request Method: DELETE
Location: /api/task-templates/1/
Authorization: JWT access_tokenResponse example
- Status
204 No Content - Body
Errors
| Error | Response code | Message |
|---|---|---|
| Target template in use | 400 Forbidden | "detail": "Criteria is in use by Sequences." |
| Insufficient permissions | 403 Forbidden | "detail": "You do not have permission to perform this action." |
| Task template does not exist | 404 Forbidden | "detail": "Not found" |
GET /api/task-templates/autocomplete/
Lists Task Templates based on query parameters for autocomplete widgets.
Permissions
Requires authentication and returns all items for any authenticated users.
Request example
- Headers
Request Method: GET
Location: /api/task-templates/autocomplete
Authorization: JWT access_tokenResponse
| Key | Type | Notes |
|---|---|---|
| limit | int | |
| offset | int | |
| total_count | int | Total number of forms visible to the user (based on permissions). |
| filtered_count | int | Number of forms visible to the user (based on permissions) with filters applied. |
| next | URL / null | Next page URL (null if there is no next page) |
| previous | URL / null | Previous page URL (null if there is no previous page) |
| results | Array | Described in the next table. |
Response results array
| Key | Type | Notes |
|---|---|---|
| value | int | Task Template ID |
| text | str | Task Template representation text |
| object_class | int | Object Class ID for tt_object_record_update Task Templates type. Is empty for other types. |
| task_type | str | Task Template type |
Response example
- Status
200 OK - Body
json
{
"limit": 100,
"offset": 0,
"filtered_count": 1,
"total_count": 20,
"next": null,
"previous": null,
"results": [
{
"value": "12",
"tesst": "Task Template 12",
"object_class": 235,
"task_type": "tt_object_record_update"
}
]
}Sorting
| Parameter | Example | Notes |
|---|---|---|
| name | {build}/api/object-class-forms/?ordering=name | Ascending |
| name | {build}/api/object-class-forms/?ordering=-name | Descending (-) |
| text | {build}/api/object-class-forms/?ordering=text | Ascending |
| text | {build}/api/object-class-forms/?ordering=-text | Descending (-) |
Filtering
For the full description of standard predicates see ALX API standards - Developers guide.
| Parameter | Predicates | Example | Values |
|---|---|---|---|
| text | standard string | {build}/api/object-class-forms/?text__icontains=template | |
| creation | standard enum | {build}/api/object-class-forms/?creation=automatic | automatic, manual |
| object_class | standard set | {build}/api/object-class-forms/?object_class__in=5,10,15 | |
| task_type | standard enum | {build}/api/object-class-forms/?task_type=tt_object_record_update | tt_form, tt_object_record_update |
Errors
| Error | Response code | Message |
|---|---|---|
| Wrong ordering value | 400 Bad Request | "ordering": ["Select a valid choice. {value} is not one of the available choices."] |
| Invalid object_class | 400 Bad Request | "object_class": [ "'Select a valid choice. That choice is not one of the available choices." ] |
GET /api/task-templates/id/usage/
Request example
- Headers
Request Method: GET
Location: /api/task-templates/1/usage/
Authorization: JWT access_tokenResponse
| Key | Type | Notes |
|---|---|---|
| num_of_sequences | int | |
| num_of_task_group_templates | int | |
| sequences | array | |
| task_group_templates | array |
Response sequences array
| Key | Type | Notes |
|---|---|---|
| id | int | Sequence id |
| name | str | Name of sequence |
Response task_group_templates array
| Key | Type | Notes |
|---|---|---|
| id | int | Target Group Templates id |
| name | str | Name of Target Group Template |
Response example
- Status
200 OK - Body
json
{
"sequences": [
{
"id": 3,
"name": "Sample sequence"
}
],
"task_group_templates": [
{
"id": 3,
"name": "Sample sequence"
}
],
"num_of_sequences": 1,
"num_of_task_group_templates": 1
}Errors
| Error | Response code | Message |
|---|---|---|
id is invalid | 404 Bad Request | 'detail': "Not found." |
| Unauthorized API call | 403 Bad Request | 'detail': "You do not have permission to perform this action." |