GET workflow_rules/show

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

Resource URL

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

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(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:

...

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

...

Examples

{
    "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"
            }
        ]
    }
}

GET workflow_rules/list

This method returns information related with workflow rules having specific attributes. Multiple workflow rules are returned by each call.

Resource URL

Parameters

Restrictions

• It is mandatory to specify at least one of the semi-optional parameters. Multiple of those parameters are allowed to be specified.

Response Data

...

Examples

GET workflow_rules/trigger

This method triggers an existing Workflow Rule. Only one Workflow rule can be triggered in each call.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

(mandatory)

...

Workflow Rule Identifier

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

...

entity

(mandatory)

...

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

• ACTIVITIES

...

entity_id

(mandatory)

...

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

...

Examples

HTTP Method: GET

Request:

Response: