Table of Contents | ||
---|---|---|
|
...
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
subscription_identifier (mandatory) | Subscription identifier | The subscription to be modified. The allowed subscription identifier fields are the following:
| ||||||||
action_type_identifier (optional) | Subscription action type identifier | The action type that should be used. The allowed subscription action type identifier fields are the following:
| ||||||||
sub_action_type_identifier (optional) | Subscription sub action type identifier | The sub action type that should be used. The allowed subscription sub action type identifier fields are the following:
| ||||||||
job_identifier (optional) | Job identifier | The Job for which the subscription action is performed. The allowed job identifier fields are the following:
| ||||||||
performed_by_user_identifier (optional) | User identifier | The user that actually performed the action. The allowed user identifier fields are the following:
| ||||||||
performed_on (optional) | Date | The date that the action was actually performed | ||||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||||
(mandatory) | Set of subscription installed item objects | The installed items that should be added on the subscription | ||||||||
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
|
...
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST subscriptions/installed_items/remove
It removes one or multiple subscription installed items from a specific subscription
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
subscription_identifier
(mandatory)
...
The subscription to be modified. The allowed subscription identifier fields are the following:
...
action_type_identifier
(optional)
...
The action type that should be used. The allowed subscription action type identifier fields are the following:
...
sub_action_type_identifier
(optional)
...
The sub action type that should be used. The allowed subscription sub action type identifier fields are the following:
...
performed_by_user_identifier
(optional)
...
The user that actually performed the action. The allowed user identifier fields are the following:
...
performed_on
(optional)
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
User Defined Field of type String
...
udf_float_1
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_2
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_3
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_4
(optional)
...
Float
...
User Defined Field of type Float
...
udf_date_1
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_2
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_3
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_4
(optional)
...
Date
...
User Defined Field of type Date
...
(optional)
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
Expand | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
Code Block | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
Expand | |||||||||||||||||||||||||||
| |||||||||||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
Response:
|
POST subscriptions/installed_items/remove
It removes one or multiple subscription installed items from a specific subscription
Resource URL
Parameters
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
subscription_identifier (mandatory) | Subscription identifier | The subscription to be modified. The allowed subscription identifier fields are the following:
| ||||||
action_type_identifier (optional) | Subscription action type identifier | The action type that should be used. The allowed subscription action type identifier fields are the following:
| ||||||
sub_action_type_identifier (optional) | Subscription sub action type identifier | The sub action type that should be used. The allowed subscription sub action type identifier fields are the following:
| ||||||
performed_by_user_identifier (optional) | User identifier | The user that actually performed the action. The allowed user identifier fields are the following:
| ||||||
performed_on (optional) | Date | The date that the action was actually performed | ||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||
(optional) | Set of subscription installed item objects | The installed items that should be added on the subscription |
Anchor installed_items_add referred objects parameters installed_items_add referred objects parameters
Referred Parameter Objects Data
installed_items_add referred objects parameters | |
installed_items_add referred objects parameters |
Include Page | ||||
---|---|---|---|---|
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Include Page | ||||
---|---|---|---|---|
|
Examples
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST subscriptions/installed_items/swap
It swaps one or multiple installed items belonging to a specific subscription with other installed items
Resource URL
Parameters
...
Name
...
Type
...
Description
...
token
...
String
...
The token retrieved from the login method
...
subscription_identifier
(mandatory)
...
The subscription to be modified. The allowed subscription identifier fields are the following:
...
action_type_identifier
(optional)
...
The action type that should be used. The allowed subscription action type identifier fields are the following:
...
sub_action_type_identifier
(optional)
...
The sub action type that should be used. The allowed subscription sub action type identifier fields are the following:
...
job_identifier
(optional)
...
The Job for which the subscription action is performed. The allowed job identifier fields are the following:
...
Tip |
---|
Available from CRM.COM R9.0.0 |
...
performed_by_user_identifier
(optional)
...
The user that actually performed the action. The allowed user identifier fields are the following:
...
performed_on
(optional)
...
udf_string_1
(optional)
...
User Defined Field of type String
...
udf_string_2
(optional)
...
User Defined Field of type String
...
udf_string_3
(optional)
...
User Defined Field of type String
...
udf_string_4
(optional)
...
User Defined Field of type String
...
udf_string_5
(optional)
...
User Defined Field of type String
...
udf_string_6
(optional)
...
User Defined Field of type String
...
udf_string_7
(optional)
...
User Defined Field of type String
...
udf_string_8
(optional)
...
User Defined Field of type String
...
udf_float_1
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_2
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_3
(optional)
...
Float
...
User Defined Field of type Float
...
udf_float_4
(optional)
...
Float
...
User Defined Field of type Float
...
udf_date_1
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_2
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_3
(optional)
...
Date
...
User Defined Field of type Date
...
udf_date_4
(optional)
...
Date
...
User Defined Field of type Date
...
(mandatory)
...
fields_set
(optional)
...
A list of fields that should be included in the results. If not specified then all the available fields will be returned
Tip |
---|
Available from CRM.COM R10.0.0 |
...
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
...
Examples
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST subscriptions/installed_items/swap
It swaps one or multiple installed items belonging to a specific subscription with other installed items
Resource URL
Parameters
Name | Type | Description | ||||||||
token | String | The token retrieved from the login method | ||||||||
subscription_identifier (mandatory) | Subscription identifier | The subscription to be modified. The allowed subscription identifier fields are the following:
| ||||||||
action_type_identifier (optional) | Subscription action type identifier | The action type that should be used. The allowed subscription action type identifier fields are the following:
| ||||||||
sub_action_type_identifier (optional) | Subscription sub action type identifier | The sub action type that should be used. The allowed subscription sub action type identifier fields are the following:
| ||||||||
job_identifier (optional) | Job identifier | The Job for which the subscription action is performed. The allowed job identifier fields are the following:
| ||||||||
performed_by_user_identifier (optional) | User identifier | The user that actually performed the action. The allowed user identifier fields are the following:
| ||||||||
performed_on (optional) | Date | The date that the action was actually performed | ||||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||||
(mandatory) | Set of subscription installed items swap objects | A set of installed item pairs that should be swapped. | ||||||||
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
|
Anchor installed_items_swapping referred objects parameters installed_items_swapping referred objects parameters
Referred Parameter Objects Data
installed_items_swapping referred objects parameters | |
installed_items_swapping referred objects parameters |
Include Page | ||||
---|---|---|---|---|
|
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Include Page | ||||
---|---|---|---|---|
|
Examples
Expand | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||
HTTP Method: POST
Request: Body:
Response:
|
POST subscriptions/installed_items/move_to_another_subscription
...
Name | Type | Description | ||||||
token | String | The token retrieved from the login method | ||||||
subscription_identifier (mandatory) | Source Subscription identifier | The source subscription of the installed item (i.e the subscription from which the installed item will be removed from). The allowed subscription identifier fields are the following:
| ||||||
action_type_identifier (optional) | Subscription action type identifier | The action type that should be used. The allowed subscription action type identifier fields are the following:
| ||||||
sub_action_type_identifier (optional) | Subscription sub action type identifier | The sub action type that should be used. The allowed subscription sub action type identifier fields are the following:
| ||||||
performed_by_user_identifier (optional) | User identifier | The user that actually performed the action. The allowed user identifier fields are the following:
| ||||||
performed_on (optional) | Date | The date that the action was actually performed | ||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||
(mandatory) | Set of subscription installed items swap objects | A set of installed item pairs that should be swapped. |
...