Versions Compared

Key

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

Name

Type

Description

id

String

The ID of the Workflow Rule workflow rule

name

String

The name of the Workflow Rule workflow rule

life_cycle_stateString

The life cycle state of the Workflow Rule workflow rule which can be EFFECTIVE or NOT EFFECTIVE

descriptionStringThe description of the  Workflow Rule workflow rule
processing_orderStringThe Processing order of the Workflow Rule workflow rule which can be ACTIONS THEN UPDATES, UPDATES THEN ACTIONS or ANY
priorityStringThe Workflow Rule's Priority which can be LOW, MEDIUM, HIGH
entityString

The name of the entity with which the Workflow Rule workflow rule is related to. The supported entities are the following:

  • ACCOUNTSRECEIVABLE
  • ACTIVITIES
  • ADHOCDISCOUNT
  • CONTACTINFORMATION
  • CREDITNOTES

  • INVOICES

  • INVOICECANCELLATIONS

  • JOBS

  • LEADS
  • PAYMENTS
  • PAYMENTCANCELLATIONS
  • REFUNDS
  • REWARDOFFERS
  • SERVICEREQUESTS
  • SUBSCRIPTIONS
  • WALLETS
  • WALLETTRANSACTIONS
  • WRITEOFFS
Tip
  • REWARDOFFERS entity available from CRM.COM R11.0.0
  • LEADS entity available from CRM.COM R14.0.0
  • ACCOUNTSRECEIVABLE, ADHOCDISCOUNT, CONTACTINFORMATION, CREDITNOTES, INVOICES, INVOICECANCELLATIONS, PAYMENTS, PAYMENTCANCELLATIONS, REFUNDS, WALLETS, WALLETTRANSACTIONS, WRITEOFFS are available from CRM.COM R15.0.0
entity_typesEntity Type ObjectThe Entity Types which are applicable for the Workflow Rule.
entity_idStringThe ID of the entity for which the Workflow Rule was triggered
   
workflow rule
log_information

Log Information Object

The log information related with the retrieved workflow rule

Anchor
workflow rule referred objects
workflow rule referred objects
Referred Objects Response Data 

Include Page
entity_type_short
entity_type_short

Include Page
log_information_short
log_information_short