Page Comparison

...

Available

Tip

Available from CRM.COM R9.0.0

Deprecated from CRM.COM R9R18.0.0

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

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

entity

(mandatory)

String

The name of the entity related

with

to the workflow rules that should be returned as a result. The supported entities are the following:

ACCOUNTSRECEIVABLE
ACTIVITIES

SERVICEREQUESTS

ADHOCDISCOUNT
CONTACTINFORMATION
CREDITNOTES
INVOICES
INVOICECANCELLATIONS
JOBS
LEADS
PAYMENTS
PAYMENTCANCELLATIONS
REFUNDS
REWARDOFFERS
SERVICEREQUESTS
SUBSCRIPTIONS
WALLETS
WALLETTRANSACTIONS

REWARDOFFERS

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

life_cycle_state

(optional)

String

The 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.

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

Tip
Available from CRM.COM R13.0.0

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise, the results will begin from the provided offset number

Tip
Available from CRM.COM R13.0.0

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 at least one of the semi-optional parameters. Multiple of those parameters are allowed to be specified.

...

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "log_information":
            {
                "updated_date": "2015-11-05T18:44:33",
                "created_date": "2015-10-30T10:39:06",
                "created_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "0C3B5CB66ED4AACF5C2FDDAE984704E8",
                    "name": "Installation Team 4",
                    "group_name": "Paphos",
                    "description": null,
                    "alternative_code": "IT4"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "m_michael_user",
                    "username": "m_michael_user",
                    "id": "970A84FDE9784FCF807597FEA26FA0F1",
                    "email": "m_michael@crm.com"
                }
            },
            "processing_order": "UPDATES_FIRST_AND_THEN_ACTIONS",
            "entity": "ACTIVITIES",
            "priority": "HIGH",
            "life_cycle_state": "EFFECTIVE",
            "id": "A94ABA3BDF2745FA8AE8F5B71DD4CA8F",
            "name": "Activity Rule",
            "description": null,
            "entity_types":
            [
                {
                    "id": "09EE47872CF8414A98C2EC5655936BF5",
                    "name": "Customer Training",
                    "description": null,
                    "alternative_code": "CT"
                }
            ]
        },
        {
            "log_information":
            {
                "updated_date": "2015-11-05T18:44:41",
                "created_date": "2015-11-02T11:13:58",
                "created_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "0C3B5CB66ED4AACF5C2FDDAE984704E8",
                    "name": "Installation Team 4",
                    "group_name": "Paphos",
                    "description": null,
                    "alternative_code": "IT4"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "m_michael_user",
                    "username": "m_michael_user",
                    "id": "970A84FDE9784FCF807597FEA26FA0F1",
                    "email": "m_michael@crm.com"
                }
            },
            "processing_order": "UPDATES_FIRST_AND_THEN_ACTIONS",
            "entity": "ACTIVITIES",
            "priority": "MEDIUM",
            "life_cycle_state": "EFFECTIVE",
            "id": "9A41E58E151C4B3D822943B140F9A9EB",
            "name": "Activity rule 2",
            "description": null,
            "entity_types":
            [
                {
                    "id": "09EE47872CF8414A98C2EC5655936BF5",
                    "name": "Customer Training",
                    "description": null,
                    "alternative_code": "CT"
                }
            ]
        },
        {
            "log_information":
            {
                "updated_date": "2015-11-05T18:45:23",
                "created_date": "2015-11-03T09:42:05",
                "created_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "0C3B5CB66ED4AACF5C2FDDAE984704E8",
                    "name": "Installation Team 4",
                    "group_name": "Paphos",
                    "description": null,
                    "alternative_code": "IT4"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "m_michael_user",
                    "username": "m_michael_user",
                    "id": "970A84FDE9784FCF807597FEA26FA0F1",
                    "email": "m_michael@crm.com"
                }
            },
            "processing_order": "ANY_ACTION_AND_THEN_UPDATES",
            "entity": "ACTIVITIES",
            "priority": "MEDIUM",
            "life_cycle_state": "EFFECTIVE",
            "id": "5DB96A77C25B4D19A65C4515D4E0D394",
            "name": "Workflow Rule Activity On Update",
            "description": null,
            "entity_types":
            [
                {
                    "id": "09EE47872CF8414A98C2EC5655936BF5",
                    "name": "Customer Training",
                    "description": null,
                    "alternative_code": "CT"
                }
            ]
        },
        {
            "log_information":
            {
                "updated_date": "2015-11-05T18:56:42",
                "created_date": "2015-11-02T16:06:33",
                "created_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "0C3B5CB66ED4AACF5C2FDDAE984704E8",
                    "name": "Installation Team 4",
                    "group_name": "Paphos",
                    "description": null,
                    "alternative_code": "IT4"
                },
                "updated_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "0C3B5CB66ED4AACF5C2FDDAE984704E8",
                    "name": "Installation Team 4",
                    "group_name": "Paphos",
                    "description": null,
                    "alternative_code": "IT4"
                },
                "created_by_user":
                {
                    "person_name": "m_ioannou",
                    "username": "m_ioannou",
                    "id": "C5D6D95C71C4484F9168A5444FC928EF",
                    "email": "m_ioannou@crm.com"
                },
                "updated_by_user":
                {
                    "person_name": "m_michael_user",
                    "username": "m_michael_user",
                    "id": "970A84FDE9784FCF807597FEA26FA0F1",
                    "email": "m_michael@crm.com"
                }
            },
            "processing_order": "UPDATES_FIRST_AND_THEN_ACTIONS",
            "entity": "ACTIVITIES",
            "priority": "LOW",
            "life_cycle_state": "EFFECTIVE",
            "id": "9E8A2D055DBA483F8978E5ACB0DE528B",
            "name": "Activity Rule Low",
            "description": null,
            "entity_types":
            [
                {
                    "id": "09EE47872CF8414A98C2EC5655936BF5",
                    "name": "Customer Training",
                    "description": null,
                    "alternative_code": "CT"
                }
            ]
        },
        {
            "log_information":
            {
                "updated_date": "2015-11-05T18:44:23",
                "created_date": "2015-11-05T14:47:26",
                "created_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                    "name": "Admin Unit",
                    "group_name": "Main Group",
                    "description": "r1 Test Description for resource  request tab.Test Description for resource  request tab.",
                    "alternative_code": "MG"
                },
                "updated_by_unit":
                {
                    "community_name": "Internal Community",
                    "id": "0C3B5CB66ED4AACF5C2FDDAE984704E8",
                    "name": "Installation Team 4",
                    "group_name": "Paphos",
                    "description": null,
                    "alternative_code": "IT4"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "m_michael_user",
                    "username": "m_michael_user",
                    "id": "970A84FDE9784FCF807597FEA26FA0F1",
                    "email": "m_michael@crm.com"
                }
            },
            "processing_order": "ANY_ACTION_AND_THEN_UPDATES",
            "entity": "ACTIVITIES",
            "priority": "LOW",
            "life_cycle_state": "EFFECTIVE",
            "id": "7BAB68ADE8A940D2AA7D8300384D7630",
            "name": "Workflow Rule",
            "description": null,
            "entity_types":
            [
                {
                    "id": "8963F9337B1C4CA1BC86D17C29E0A382",
                    "name": "MKInstall",
                    "description": null,
                    "alternative_code": "MK"
                },
                {
                    "id": "FF7750B1E1C14509B8F7F866414FEA2E",
                    "name": "Activity Status Transition",
                    "description": null,
                    "alternative_code": "AST"
                }
            ]
        }
    ]
}

...

Versions Compared

Old Version 2

New Version Current

Key

Resource URL

Parameters

Restrictions