Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...


Expand
titlesubscription action object response data


Name

Type

Description

id

String

The ID of the retrieved subscription action

number

String

The number of the retrieved subscription action

transaction_reference_numberString

The unique transaction reference number of the retrieved subscription action

Tip

Available from CRM.COM R13.1.0


life_cycle_state

String

The life cycle state of the subscription action. One of the following values is returned:

EXECUTED, EXECUTEDWITHERRORS, REJECTEDSYSTEMFAILURE, REJECTEDSYSTEMVALIDATION, SCHEDULED, CANCELLED

Tip

From CRM.COM R15.0.0 the available life cycle states are:

  • PENDING_VERIFICATION
  • EXECUTED
  • SCHEDULED
  • CANCELLED
  • REJECTED


classificationString

The classification that was provided when the subscription action was submitted.

Tip

Available from CRM.COM R17.0.0


behavior_codeString

The behavior code of the subscription action

business_classification_codeString

The business classification code of the subscription action

scheduled_dateDate

The date that the subscription was scheduled to be executed

executed_onDateThe date that the subscription action is executed
submitted_onDateThe date that the business action was submitted into the system
performed_onDateThe date that the business action was actually performed, which might be different than the date that was submitted into the system

udf_string_1

String

User Defined Field of type String

Tip

Available from CRM.COM R14.2.0


udf_string_2String

User Defined Field of type String

Tip

Available from CRM.COM R14.2.0


udf_string_3String

User Defined Field of type String

Tip

Available from CRM.COM R14.2.0


udf_string_4String

User Defined Field of type String

Tip

Available from CRM.COM R14.2.0


udf_string_5String

User Defined Field of type String 

Tip

Available from CRM.COM R14.2.0


udf_string_6String

User Defined Field of type String 

Tip

Available from CRM.COM R14.2.0


udf_string_7String

User Defined Field of type String 

Tip

Available from CRM.COM R14.2.0


udf_string_8 String

User Defined Field of type String 

Tip

Available from CRM.COM R14.2.0


udf_string_9String

User Defined Field of type String 

Tip

Available from CRM.COM R14.2.0

submitted_by


 User udf_string_10String

User Defined Field of type String 

Tip

Available from CRM.COM R14.2.0


udf_string_11String

User Defined Field of type String 

Tip

Available from CRM.COM R14.2.0


udf_string_12String

User Defined Field of type String 

Tip

Available from CRM.COM R14.2.0


udf_string_13String

User Defined Field of type String 

Tip

Available from CRM.COM R14.2.0


udf_string_14String

User Defined Field of type String

Tip

Available from CRM.COM R14.2.0


udf_string_15String

User Defined Field of type String

Tip

Available from CRM.COM R14.2.0


udf_string_16String

User Defined Field of type String

Tip

Available from CRM.COM R14.2.0


udf_float_1Float

User Defined Field of type Float

Tip

Available from CRM.COM R14.2.0


udf_float_2Float

User Defined Field of type Float

Tip

Available from CRM.COM R14.2.0


udf_float_3Float

User Defined Field of type Float

Tip

Available from CRM.COM R14.2.0


udf_float_4Float

User Defined Field of type Float

Tip

Available from CRM.COM R14.2.0


udf_float_5Float

User Defined Field of type Float

Tip

Available from CRM.COM R14.2.0


udf_float_6Float

User Defined Field of type Float

Tip

Available from CRM.COM R14.2.0


udf_float_7Float

User Defined Field of type Float

Tip

Available from CRM.COM R14.2.0


udf_float_8Float

User Defined Field of type Float

Tip

Available from CRM.COM R14.2.0


udf_date_1Date

 User Defined Field of type Date

Tip

Available from CRM.COM R14.2.0


udf_date_2Date

 User Defined Field of type Date

Tip

Available from CRM.COM R14.2.0


udf_date_3Date

 User Defined Field of type Date

Tip

Available from CRM.COM R14.2.0


udf_date_4Date

 User Defined Field of type Date

Tip

Available from CRM.COM R14.2.0


submitted_byUser ObjectThe user that  submitted the action into the system
performed_by User User ObjectThe user that actually performed the subscription action, which might be different than the user that submitted the action into the system
performed_by_unit Unit Unit Object

The unit that performed the subscription action

Tip

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R18.0.0


performed_by_business_unitBusiness Unit Object

The business unit that performed the subscription action

Tip

Available from CRM.COM R18.0.0


action_typeSubscription Action Type Object

The action type of the subscription action

Tip

Deprecated from CRM.COM R15.0.0


sub_action_typeSubscription Sub Action Type Object

The sub action type of the subscription action

Tip

Deprecated from CRM.COM R15.0.0


subscriptionSubscription ObjectThe subscription that was or will be modified by the execution of the subscription action
jobJob Object

The Job for which the subscription action was performed

Tip

Available from CRM.COM R9.0.0


resubmitted_bySubscription Action Object

The subscription action that was generated when the retrieved subscription was re-submitted. Applicable only if the retrieved subscription action is in Rejected life cycle state

Tip

Available from CRM.COM R17.0.0


subscription_action_affected_services_setSet of subscription action affected services

A list of subscription services which are affected by the specified subscription action. Each subscription service might be affected if it is being added or removed by the subscription action, or if its life cycle changes because of the action.

Tip

Available from CRM.COM R15.0.0


subscription_action_affected_installed_items_setSet of subscription action affected installed items

A list of subscription installed items which are affected by the specified subscription action. Each subscription installed item might be affected if it is being added or removed by the subscription action

Tip

Available from CRM.COM R15.0.0


Anchor
subscription_action referred objects
subscription_action referred objects
Referred Objects Response Data

Include Page
user_short
user_short

Include Page
unit_short
unit_short

Include Page
business_unit_short
business_unit_short

Include Page
subscription_action_type_short
subscription_action_type_short

Include Page
subscription_sub_action_type_short
subscription_sub_action_type_short

Include Page
subscription_short
subscription_short

Include Page
job_short
job_short

Include Page
subscription_action_short
subscription_action_short

Include Page
subscription_action_affected_service_short
subscription_action_affected_service_short

Include Page
subscription_action_affected_installed_item_short
subscription_action_affected_installed_item_short