GET workflow_rules/show

Available from CRM.COM R9.0.0

Deprecated from CRM.COM R18.0.0

This method returns information related with a Workflow Rule. A single Workflow Rule request is returned by each call

Resource URL

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the workflow rule

name

(semi-optional)

String

The name of the workflow rule

alternative_code

(semi-optional)

String

The alternative code of the workflow rule

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

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name	Type	Description
id	String	The ID of the workflow rule
name	String	The name of the workflow rule
life_cycle_state	String	The life cycle state of the workflow rule which can be EFFECTIVE or NOT EFFECTIVE
description	String	The description of the workflow rule
processing_order	String	The Processing order of the workflow rule which can be ACTIONS THEN UPDATES, UPDATES THEN ACTIONS
priority	String	The Workflow Rule's Priority which can be LOW, MEDIUM, HIGH
entity	String	The name of the entity with which the 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 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_types	Entity Type Object	The Entity Types which are applicable for the workflow rule
log_information	Log Information Object	The log information related with the retrieved workflow rule

Referred Objects Response Data

entity_type object response data

Name	Type	Description
id	String	The ID of the retrieved entity type
name	String	The name of the retrieved entity type
alternative_code	String	The alternative code of the retrieved entity type
description	String	A description of the retrieved entity type

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

Examples

Example 1

HTTP Method: GET

Request:

Response:

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "log_information":
        {
            "updated_date": "2015-11-05T18:44:23",
            "created_date": "2015-11-05T14:47:26",
            "created_by_unit":
            {
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                "alternative_code": "MG"
            },
            "updated_by_unit":
            {
                "id": "0C3B5CB66ED4AACF5C2FDDAE984704E8",
                "name": "Installation Team 4",
                "description": null,
                "alternative_code": "IT4"
            },
            "created_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1"
            },
            "updated_by_user":
            {
                "person_name": "m_michael_user",
                "username": "m_michael_user",
                "id": "970A84FDE9784FCF807597FEA26FA0F1"
            }
        },
        "processing_order": "ANY_ACTION_AND_THEN_UPDATES",
        "entity": "ACTIVITIES",
        "priority": "LOW",
        "life_cycle_state": "EFFECTIVE",
        "name": "Workflow Rule",
        "id": "7BAB68ADE8A940D2AA7D8300384D7630",
        "description": null,
        "entity_types":
        [
            {
                "id": "FF7750B1E1C14509B8F7F866414FEA2E",
                "name": "Activity Status Transition",
                "description": null,
                "alternative_code": "AST"
            },
            {
                "id": "8963F9337B1C4CA1BC86D17C29E0A382",
                "name": "MKInstall",
                "description": null,
                "alternative_code": "MK"
            }
        ]
    }
}