Page Comparison

...

Tip

Available from CRM.COM R9.0.0

Deprecated from CRM.COM R18.0.0

Excerpt
This method returns information related to approval requests having specific attributes. Multiple approval requests are returned by each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

authorised_user_identifier
(semi-optional)

User Identifier

The identifier of the authorised user related with the approval requests that should be returned as a result. The allowed user identifier fields are the following:

Include Page

	V4:user_identifier
	V4:user_identifier

approval_definition_identifier

(semi-optional)

Approval Definition Identifier

The identifier of the approval definition related to the approval requests that should be returned as a result. The allowed approval definition identifier fields are the following:

Include Page

	V4:approval_definition_identifier
	V4:approval_definition_identifier

workflow_rule_identifier

(semi-optional)

Workflow Rule Identifier

The identifier of the workflow rule that triggered the approval requests 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

entity

(semi-optional)

String

The name of the entity related to the approval requests that should be returned as a result. The supported entities are the following:

ACTIVITIES
ADHOCDISCOUNT
CREDITNOTES
INVOICES
JOBS
LEADS
PAYMENTS
REFUNDS
REWARDOFFERS
SERVICEREQUESTS
SUBSCRIPTIONS

Tip
REWARDOFFERS entity is available from CRM.COM R11.0.0 LEADS entity is available from CRM.COM R14.0.0 ADHOCDISCOUNT, CREDITNOTES, INVOICES, PAYMENTS, REFUNDS are available from CRM.COM R15.0.0

entity_id

(semi-optional)

String

The ID of the entity related to the approval requests that should be returned as a result

responded_by_user_identifier

(optional)

User Identifier

The identifier of the responded by the user related with the approval requests that should be returned as a result. The allowed user identifier fields are the following:

Include Page

	V4:user_identifier
	V4:user_identifier

unified_code

(optional)

String

The unified code of the approval requests that should be returned as a result

life_cycle_state

(optional)

String

The life cycle state of the approval requests that should be returned as a result. The supported options are PENDING, ACCEPTED, REJECTED or CANCELLED

created_date

(optional)

Date

The created date of the approval requests that should be returned as a result.

response_date

(optional)

Date

The response date of the approval requests 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

language	js
theme	Confluence	language	js
linenumbers	true

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "authorised_users_set":
            [
                {
                    "person_name": "Rossides Giorkos",
                    "username": "g_rossides",
                    "id": "4AD9C84FA60F9FE407140E20F707726A",
                    "email": "george.rossides@crm.com"
                },
                {
                    "person_name": "name42 p",
                    "username": "FriniTest",
                    "id": "AD848CDF467C462BD4CF302EF131FA83",
                    "email": "f@f.com"
                },
                {
                    "person_name": "Katerina Argyrou",
                    "username": "k_argyrou",
                    "id": "4230DAC160797424CBFE356C1458E791",
                    "email": "k_argyrou@crm.com"
                },
                {
                    "person_name": "Eleni Michailidou",
                    "username": "emichailidou",
                    "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
                    "email": "e_michailidou@crm.com"
                },
                {
                    "person_name": "Marios Lannister",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                },
                {
                    "person_name": "Frini P",
                    "username": "f_pouyiouka",
                    "id": "823EEDAC57825DF996956E480068A6A9",
                    "email": null
                },
                {
                    "person_name": "George Rossides",
                    "username": "g.rossides",
                    "id": "39E7AF1A9950A0E28322D930BD83ECFF",
                    "email": "g_rossides@crm.com"
                },
                {
                    "person_name": "Omar Sawalha",
                    "username": "Omar",
                    "id": "8A759CCAAC38498FA65F5AAF0D66BD70",
                    "email": "se.aya@hotmail.com"
                },
                {
                    "person_name": "user 123456789",
                    "username": "user123456789",
                    "id": "811EB82DFDA34A7EB00C6A5AA7DA923A",
                    "email": null
                },
                {
                    "person_name": "Andreas Hadjigeorgiou",
                    "username": "lightblack",
                    "id": "2B7FD8F1E4AE4AE5BDC280BB478009BA",
                    "email": "andreas@lightblack.eu"
                },
                {
                    "person_name": "Katerina Argyrou",
                    "username": "kat_arg",
                    "id": "533382BA44A946E5A36AE3762011A824",
                    "email": null
                },
                {
                    "person_name": "Panayiota Demou",
                    "username": "p_demou",
                    "id": "4927E7EE8BBB4047A35F4F313D0EC6D3",
                    "email": "panayiota.demou@crm.com"
                },
                {
                    "person_name": "e_michailidou",
                    "username": "e_michailidou",
                    "id": "B90BAAC08F28D4F9D11D4B08C7919A50"
                },
                {
                    "person_name": "Christie Miltiadou",
                    "username": "c_miltiadou",
                    "id": "1A9637ADB7444373BAE1C814CA0C2678",
                    "email": "c_miltiadou@crm.com"
                },
                {
                    "person_name": "Andreas Hadjigeorgiou",
                    "username": "lightblack",
                    "id": "2B7FD8F1E4AE4AE5BDC280BB478009BA",
                    "email": "andreas@lightblack.eu"
                },
                {
                    "person_name": "Persia Xenopoulou",
                    "username": "persia_xenopoulou",
                    "id": "2A15084589E81D3DA7ABA3C7563F805E",
                    "email": "p_xenopoulou@crm.com"
                },
                {
                    "person_name": "Test Space",
                    "username": "test_space",
                    "id": "76D6BF53349BF8000BD05FCC2A5B9513",
                    "email": null
                },
                {
                    "person_name": "emailtest emailtest",
                    "username": "emailtest",
                    "id": "BA4A49C11F384ED692585BFE104CAB97",
                    "email": "crm.com.tst@gmail.com"
                },
                {
                    "person_name": "Super Visor",
                    "username": "supervisor",
                    "id": "018CA08BC267612F6206D85011FFC5D1",
                    "email": "super@visor.com"
                },
                {
                    "person_name": "Persia Xenopoullou ",
                    "username": "persy",
                    "id": "3274FDE75239692B81B2526BC1A9E429",
                    "email": "p_xenopoulou@crm.com"
                },
                {
                    "person_name": "George Rossides A",
                    "username": "g_rossides1",
                    "id": "6FB3038B8EB2403A9F213EF67D45256C",
                    "email": "g_rossides@crm.com"
                },
                {
                    "person_name": "CRM DEMO",
                    "username": "crmdemo",
                    "id": "EE45E7939403344B3AA5F7B8BAC55455",
                    "email": null
                },
                {
                    "person_name": "Panayiota2test Demou2test",
                    "username": "pdemoutesttest",
                    "id": "BF3024F212ED4FAE90FA5393449F43EB",
                    "email": "test@crm.com"
                },
                {
                    "person_name": "Sam Chae",
                    "username": "cleverbirds",
                    "id": "A39311615E272614164632817CCB2A38",
                    "email": "eleni.sites@gmail.com"
                },
                {
                    "person_name": "Persiaew XenopouLlou ",
                    "username": "p_xenopoulou",
                    "id": "159C17D9C4B1E48DC129FBC701D38438",
                    "email": "p_xenopoulou@crm.com"
                },
                {
                    "person_name": "Alex Themistos",
                    "username": "a_themistos",
                    "id": "6B2220643DBC7E7B151B4229AB0D8F17",
                    "email": null
                },
                {
                    "person_name": "Jack Hadjicosti",
                    "username": "J_Hadjicosti",
                    "id": "C3F78056AD2C2CC2D7CEE5741F6103C8",
                    "email": "j_hadjicosti@crm.com"
                },
                {
                    "person_name": "George Rossides A",
                    "username": "g_rossides1",
                    "id": "6FB3038B8EB2403A9F213EF67D45256C",
                    "email": "g_rossides@crm.com"
                },
                {
                    "person_name": "Simon Brown",
                    "username": "DELBOY",
                    "id": "29DE94EBF89A885822BAB8179F2F2686",
                    "email": null
                },
                {
                    "person_name": "Georgia Kountouri",
                    "username": "g_kountouri",
                    "id": "B0CF852BA7364BC6887E00F570903FFD",
                    "email": "georgia.kountouri@crm.com"
                },
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                {
                    "person_name": "Petros Petrou",
                    "username": "m_clerides",
                    "id": "D502772234A6A5F3DEBF0D77D06D9703",
                    "email": "maria.clerides@crm.com"
                },
                {
                    "person_name": "Eleni Michailidou",
                    "username": "e_michailidou",
                    "id": "B90BAAC08F28D4F9D11D4B08C7919A50",
                    "email": "eleni.michailidou@crm.com"
                },
                {
                    "person_name": "George Neocleous",
                    "username": "g_neocleous",
                    "id": "D2E3AEB6D8C04A018AB137AD93E7011C",
                    "email": null
                },
                {
                    "person_name": "Maria Jones",
                    "username": "m.jones",
                    "id": "97DD1255B4D061EB0552ECFD10AFDF8A",
                    "email": "m.jones@companyTV.com"
                },
                {
                    "person_name": "Vasilis 2 Kleanthous",
                    "username": "v_kleanthous",
                    "id": "69FFC727904A4B359D12C1CE4A528829",
                    "email": "v_kleanthous@crm.com"
                },
                {
                    "person_name": "giorgos nikolaou",
                    "username": "Sales_Branch1",
                    "id": "785EACB7C0C6964E97BF14649116BEEC",
                    "email": null
                }
            ],
            "response": null,
            "responded_by": null,
            "entity": null,
            "number": "40",
            "subject": "Test Activities Approval def",
            "response_date": null,
            "approval_definition":
            {
                "life_cycle_state": "EFFECTIVE",
                "id": "0189846123CC4F528A409DD590505159",
                "name": "Activity Approval",
                "alternative_code": "ACT_APPR"
            },
            "log_information":
            {
                "updated_date": "2015-11-05T09:06:22",
                "created_date": "2015-11-05T09:06:22",
                "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": "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"
                },
                "created_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                },
                "updated_by_user":
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                }
            },
            "life_cycle_state": "PENDING",
            "entity_id": "9FF8FCDAC2BD433AB7D3043EB43875A4",
            "unified_code": "13",
            "id": "EF0B62DAA97146F0BC243276C2599EB2",
            "workflow_rule":
            {
                "life_cycle_state": "EFFECTIVE",
                "id": "A94ABA3BDF2745FA8AE8F5B71DD4CA8F",
                "name": "Activity Rule",
                "alternative_code": "AR"
            }
        },
        {
            "authorised_users_set":
            [
                {
                    "person_name": "Eleni Michailidou",
                    "username": "e_michailidou",
                    "id": "B90BAAC08F28D4F9D11D4B08C7919A50",
                    "email": "eleni.michailidou@crm.com"
                },
                {
                    "person_name": "user 123456789",
                    "username": "user123456789",
                    "id": "811EB82DFDA34A7EB00C6A5AA7DA923A",
                    "email": null
                },
                {
                    "person_name": "name42 p",
                    "username": "FriniTest",
                    "id": "AD848CDF467C462BD4CF302EF131FA83",
                    "email": "f@f.com"
                },
                {
                    "person_name": "George Rossides A",
                    "username": "g_rossides1",
                    "id": "6FB3038B8EB2403A9F213EF67D45256C",
                    "email": "g_rossides@crm.com"
                },
                {
                    "person_name": "Marios Lannister",
                    "username": "MPAdministrator",
                    "id": "1",
                    "email": "sakkascy1986@hotmail.com"
                },
                {
                    "person_name": "Persia Xenopoulou",
                    "username": "persia_xenopoulou",
                    "id": "2A15084589E81D3DA7ABA3C7563F805E",
                    "email": "p_xenopoulou@crm.com"
                },
                {
                    "person_name": "Omar Sawalha",
                    "username": "Omar",
                    "id": "8A759CCAAC38498FA65F5AAF0D66BD70",
                    "email": "se.aya@hotmail.com"
                },
                {
                    "person_name": "Frini P",
                    "username": "f_pouyiouka",
                    "id": "823EEDAC57825DF996956E480068A6A9",
                    "email": null
                },
                {
                    "person_name": "Georgia Kountouri",
                    "username": "g_kountouri",
                    "id": "B0CF852BA7364BC6887E00F570903FFD",
                    "email": "georgia.kountouri@crm.com"
                },
                {
                    "person_name": "CRM DEMO",
                    "username": "crmdemo",
                    "id": "EE45E7939403344B3AA5F7B8BAC55455",
                    "email": null
                },
                {
                    "person_name": "Christie Miltiadou",
                    "username": "c_miltiadou",
                    "id": "1A9637ADB7444373BAE1C814CA0C2678",
                    "email": "c_miltiadou@crm.com"
                },
                {
                    "person_name": "MPAdministrator",
                    "username": "MPAdministrator",
                    "id": "1"
                },
                {
                    "person_name": "Sam Chae",
                    "username": "cleverbirds",
                    "id": "A39311615E272614164632817CCB2A38",
                    "email": "eleni.sites@gmail.com"
                },
                {
                    "person_name": "emailtest emailtest",
                    "username": "emailtest",
                    "id": "BA4A49C11F384ED692585BFE104CAB97",
                    "email": "crm.com.tst@gmail.com"
                },
                {
                    "person_name": "George Rossides A",
                    "username": "g_rossides1",
                    "id": "6FB3038B8EB2403A9F213EF67D45256C",
                    "email": "g_rossides@crm.com"
                },
                {
                    "person_name": "George Neocleous",
                    "username": "g_neocleous",
                    "id": "D2E3AEB6D8C04A018AB137AD93E7011C",
                    "email": null
                },
                {
                    "person_name": "Andreas Hadjigeorgiou",
                    "username": "lightblack",
                    "id": "2B7FD8F1E4AE4AE5BDC280BB478009BA",
                    "email": "andreas@lightblack.eu"
                },
                {
                    "person_name": "Persiaew XenopouLlou ",
                    "username": "p_xenopoulou",
                    "id": "159C17D9C4B1E48DC129FBC701D38438",
                    "email": "p_xenopoulou@crm.com"
                },
                {
                    "person_name": "George Rossides",
                    "username": "g.rossides",
                    "id": "39E7AF1A9950A0E28322D930BD83ECFF",
                    "email": "g_rossides@crm.com"
                },
                {
                    "person_name": "giorgos nikolaou",
                    "username": "Sales_Branch1",
                    "id": "785EACB7C0C6964E97BF14649116BEEC",
                    "email": null
                },
                {
                    "person_name": "Panayiota Demou",
                    "username": "p_demou",
                    "id": "4927E7EE8BBB4047A35F4F313D0EC6D3",
                    "email": "panayiota.demou@crm.com"
                },
                {
                    "person_name": "Andreas Hadjigeorgiou",
                    "username": "lightblack",
                    "id": "2B7FD8F1E4AE4AE5BDC280BB478009BA",
                    "email": "andreas@lightblack.eu"
                },
                {
                    "person_name": "Persia Xenopoullou ",
                    "username": "persy",
                    "id": "3274FDE75239692B81B2526BC1A9E429",
                    "email": "p_xenopoulou@crm.com"
                },
                {
                    "person_name": "Test Space",
                    "username": "test_space",
                    "id": "76D6BF53349BF8000BD05FCC2A5B9513",
                    "email": null
                },
                {
                    "person_name": "Katerina Argyrou",
                    "username": "k_argyrou",
                    "id": "4230DAC160797424CBFE356C1458E791",
                    "email": "k_argyrou@crm.com"
                },
                {
                    "person_name": "Simon Brown",
                    "username": "DELBOY",
                    "id": "29DE94EBF89A885822BAB8179F2F2686",
                    "email": null
                },
                {
                    "person_name": "Rossides Giorkos",
                    "username": "g_rossides",
                    "id": "4AD9C84FA60F9FE407140E20F707726A",
                    "email": "george.rossides@crm.com"
                },
                {
                    "person_name": "Jack Hadjicosti",
                    "username": "J_Hadjicosti",
                    "id": "C3F78056AD2C2CC2D7CEE5741F6103C8",
                    "email": "j_hadjicosti@crm.com"
                },
                {
                    "person_name": "Panayiota2test Demou2test",
                    "username": "pdemoutesttest",
                    "id": "BF3024F212ED4FAE90FA5393449F43EB",
                    "email": "test@crm.com"
                },
                {
                    "person_name": "Petros Petrou",
                    "username": "m_clerides",
                    "id": "D502772234A6A5F3DEBF0D77D06D9703",
                    "email": "maria.clerides@crm.com"
                },
                {
                    "person_name": "e_michailidou",
                    "username": "e_michailidou",
                    "id": "B90BAAC08F28D4F9D11D4B08C7919A50"
                },
                {
                    "person_name": "Maria Jones",
                    "username": "m.jones",
                    "id": "97DD1255B4D061EB0552ECFD10AFDF8A",
                    "email": "m.jones@companyTV.com"
                },
                {
                    "person_name": "Vasilis 2 Kleanthous",
                    "username": "v_kleanthous",
                    "id": "69FFC727904A4B359D12C1CE4A528829",
                    "email": "v_kleanthous@crm.com"
                },
                {
                    "person_name": "Super Visor",
                    "username": "supervisor",
                    "id": "018CA08BC267612F6206D85011FFC5D1",
                    "email": "super@visor.com"
                },
                {
                    "person_name": "Alex Themistos",
                    "username": "a_themistos",
                    "id": "6B2220643DBC7E7B151B4229AB0D8F17",
                    "email": null
                },
                {
                    "person_name": "Eleni Michailidou",
                    "username": "emichailidou",
                    "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
                    "email": "e_michailidou@crm.com"
                },
                {
                    "person_name": "Katerina Argyrou",
                    "username": "kat_arg",
                    "id": "533382BA44A946E5A36AE3762011A824",
                    "email": null
                }
            ],
            "response": null,
            "responded_by": null,
            "entity": null,
            "number": "41",
            "subject": "Test Activities Approval def",
            "response_date": null,
            "approval_definition":
            {
                "life_cycle_state": "EFFECTIVE",
                "id": "0189846123CC4F528A409DD590505159",
                "name": "Activity Approval",
                "alternative_code": "ACT_APPR"
            },
            "log_information":
            {
                "updated_date": "2015-11-05T17:44:36",
                "created_date": "2015-11-05T17:44:36",
                "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_michael_user",
                    "username": "m_michael_user",
                    "id": "970A84FDE9784FCF807597FEA26FA0F1",
                    "email": "m_michael@crm.com"
                },
                "updated_by_user":
                {
                    "person_name": "m_michael_user",
                    "username": "m_michael_user",
                    "id": "970A84FDE9784FCF807597FEA26FA0F1",
                    "email": "m_michael@crm.com"
                }
            },
            "life_cycle_state": "PENDING",
            "entity_id": "1D7C94CAC7AB4BB39B85E91183872F11",
            "unified_code": "14",
            "id": "1548C92A94B34AB7B73612A7889DBE62",
            "workflow_rule":
            {
                "life_cycle_state": "EFFECTIVE",
                "id": "A94ABA3BDF2745FA8AE8F5B71DD4CA8F",
                "name": "Activity Rule",
                "alternative_code": "AR"
            }
        },
    ....
   ]
}

...

Versions Compared

Old Version 12

New Version Current

Key

Resource URL

Parameters

Restrictions