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) | Group Identifier | 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) | Unit Identifier | 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
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved activity type |
name | String | The name of the retrieved activity type |
alternative_code | String | The alternative code of the retrieved activity type |
description | String | A description of the retrieved activity type |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
estimated_completion_time | Time Period Object | The time that is estimated to be required in order complete activities of this type, measured in MINUTES, HOURS, DAYS, WEEKS, YEARS From CRM.COM R17.0.0, YEARS is deprecated |
log_information | Log Information Object | The log information of the retrieved activity type |
Referred Objects Response Data
Examples
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) | activity Type Identifier | 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
Name | Type | Description |
---|---|---|
id | String | The id of the retrieved category |
name | String | The name of the retrieved category |
code | String | The code of the retrieved category |
description | String | The description of the retrieved category |
parent_id | String | The id of the retrieved category's parent category |
Examples
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) | activity Type Identifier | 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
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved activity type service |
mandatory | Boolean | Determines if the activity type service is mandatory or not |
time_spent_logging_method | String | Determines the time spend logging method of the retrieved activity type service. The supported values are the following: FIXED or FLEXIBLE |
automatically_applied | Boolean | Determines if the activity type service will be added automatically or not |
minimum_time_spent | Time Period Object | The minimum time that should be spent on the retrieved activity type service |
Product Object | The actual product provided by the activity type service |
Referred Objects Response Data
Examples
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) | activity Type Identifier | 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) | Sting | The life cycle state that the status should have. If specified then only statuses related with the specified life cycle state will be retrieved. Life cycle state options are: PENDING, IN_PROGRESS, COMPLETED and CANCELLED | ||||||||||||
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
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved activity type status |
default | Boolean | Determines if the activity type status is the default status or not |
status | Activity Status Object | The actual status provided by the activity type status |
Referred Objects Response Data
Examples
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
Name | Type | Description |
---|---|---|
id | String | The ID of the retrieved activity cancellation reason |
name | String | The name of the retrieved activity cancellation reason |
alternative_code | String | The alternative code of the retrieved activity cancellation reason |
description | String | A description of the retrieved activity cancellation reason |