| Tip |
|---|
| Table of Contents | ||
|---|---|---|
|
GET activities/configuration/types/list
This method returns the activity types that are allowed to be used in the system. Multiple activity types are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
group_identifier
(optional)
...
The identifier of the group that will be providing the activity type. The group is filtered against the activity types' allowed organisational units. The allowed group identifier fields are the following:
...
unit_identifier
(optional)
...
The identifier of the unit that will be providing the activity type. The unit is filtered against the activity types' allowed organisational units. The allowed unit identifier fields are the following:
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET activities/configuration/categories/list
This method returns the activity categories that are allowed to be used by activities of specific type. Multiple activity categories are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
activity_type_identifier
(mandatory)
...
The identifier of the type of the activity that will be using the categories. The categories are filtered against the allowed categories of the specified type. The allowed activity type identifier fields are the following:
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET activities/configuration/services/list
This method returns the services that are allowed to be used by activities of specific type. Multiple services are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
activity_type_identifier
(mandatory)
...
The identifier of the type of the activity that will be using the services. The services are filtered against the allowed services of the specified type. The allowed activity type identifier fields are the following:
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET activities/configuration/statuses/list
This method returns the statuses that are allowed to be used by activities of specific type. Multiple statuses are returned by each call
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
activity_type_identifier
(mandatory)
...
The identifier of the type of the activity that will be using the statuses. The statuses are filtered against the allowed statuses of the specified type. The allowed activity type identifier fields are the following:
...
life_cycle_state
(optional)
...
fields_set
(optional)
...
List of Strings, comma separated
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Response Data
...
Examples
| Expand | |||||||||
|---|---|---|---|---|---|---|---|---|---|
| |||||||||
HTTP Method: GET
Request: Response:
|
GET activities/configuration/cancellation_reasons/list
This method returns the cancellation reasons that are allowed to be used by activities, as defined on the active activity definition. Multiple cancellation reasons are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Response Data
...
Examples
| Expand | ||||||
|---|---|---|---|---|---|---|
| ||||||
| Code Block | ||||||
| ||||||
| Panel | ||||||
| ||||||
|