Versions Compared

Key

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

Available from CRM.COM R9.0.0


Table of Contents
maxLevel2

...

http://host_name/crmapi/rest/$version/workflow_rulerules/show

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

workflow_rule_identifier

(mandatory)

Webhook Request Identifier

The identifier of the workflow rule that should be returned as a result. The allowed workflow rule identifier fields are the following:

Include Page
V4:workflow_rule_identifier
V4:workflow_rule_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

entity

(mandatory)

String

The name of the entity related with the workflow rules that should be returned as a result. The supported entities are the following:

  • ACTIVITIES

life_cycle_state

(optional)

StringThe life cycle state of the workflow rules that should be returned as a result. The supported options are EFFECTIVE or NOT EFFECTIVE. By default, all workflow rules are returned.

created_date

(optional)

Date The created date of the workflow rule that should be returned as a result.

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

...

Name

Type

Description

token

String

The token retrieved from the login method

workflow_rule_identifier

(mandatory)

Workflow Rule Identifier

The identifier of the Workflow Rule that should be triggered. The allowed Workflow Rule request identifier fields are the following:

Include Page
V4:workflow_rule_request_identifier
V4:workflow_rule_request_identifier

entity

(mandatory)

String

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

  • ACTIVITIES

entity_id

(mandatory)

StringThe ID of the entity instance for which the Workflow Rule is enforced to be triggered.  

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

...