Page Comparison

Tip
Available from CRM.COM R9.0.0

Table of Contents

maxLevel	2

...

Name

Type

Description

token

String

The token retrieved from the login method

approval_request_identifier

(mandatory)

Approval Request Identifier

The identifier of the approval request that should be returned as a result. The allowed approval request Identifier fields are the following:

Include Page

	V4:approval_request_identifier
	V4:approval_request_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

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 with 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 with the approval requests that should be returned as a result. The supported entities are the following:

ACTIVITIES

entity_id

(semi-optional)

String

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

responded_by_user_identifier

(optional)

User Identifier

The identifier of the responded by 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.

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

approval_request_identifier

(mandatory)

Approval Request Identifier

The identifier of the approval request that should be approved. The allowed approval request Identifier fields are the following:

Include Page

	V4:approval_request_identifier
	V4:approval_request_identifier

Note that only pending approval requests are allowed to be specified

response

(mandatory)

String

The response to the approval request as provided by the user that approved the approval request

...

Include Page

	V4:approval_request_complete
	V4:approval_request_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

{
          "token":"438BA44BD33B44EEBC77746030A92629",
          "approval_request_identifier":{"number":"40"},
          "response":"Test from API"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "authorised_users_set":
        [
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Eleni Michailidou",
                "username": "emichailidou",
                "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
                "email": "crm.com.tst@gmail.com"
            }
        ],
        "response": "Test from API",
        "responded_by":
        {
            "person_name": "Marios Lannister",
            "username": "MPAdministrator",
            "id": "1"
        },
        "entity": "ACTIVITIES",
        "number": "40",
        "subject": "Approval for Activities by Manager and Assigned to User",
        "response_date": "2016-01-19T11:01:00",
        "approval_definition":
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "D159E061650D40E689CADDF17ABB424A",
            "name": "Installation Approval WT",
            "alternative_code": "IAW"
        },
        "log_information":
        {
            "updated_date": "2016-01-19T11:01:00",
            "created_date": "2016-01-22T12:19:47",
            "created_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1",
                "alternative_code": "MG"
            },
            "updated_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "MPAdministrator",
                "username": "MPAdministrator",
                "id": "1",
                "email": "crm.com.tst@gmail.com"
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1"
            }
        },
        "life_cycle_state": "APPROVED",
        "entity_id": "05B26D3F1B494780B9108B8876AD2A5A",
        "unified_code": "31",
        "id": "E7FA4634AF0D435E8DF926E53BD2A0B3",
        "workflow_rule":
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "F935C2C73CB948DCBD5101DFFF79FC6E",
            "name": "Installations Activities - Approvals WT",
            "alternative_code": "IA-AW"
        }
    }
}

...

Name

Type

Description

token

String

The token retrieved from the login method

approval_request_identifier

(mandatory)

Approval Request Identifier

The identifier of the approval request that should be rejected. The allowed approval request Identifier fields are the following:

Include Page

	V4:approval_request_identifier
	V4:approval_request_identifier

Note that only pending approval requests are allowed to be specified

response

(mandatory)

String

The response to the approval request as provided by the user that rejected the approval request

...

Include Page

	V4:approval_request_complete
	V4:approval_request_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

{
          "token":"438BA44BD33B44EEBC77746030A92629",
          "approval_request_identifier":{"number":"35"},
          "response":"Test from API"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "authorised_users_set":
        [
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Eleni Michailidou",
                "username": "emichailidou",
                "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
                "email": "crm.com.tst@gmail.com"
            }
        ],
        "response": "Test from API",
        "responded_by":
        {
            "person_name": "Marios Lannister",
            "username": "MPAdministrator",
            "id": "1"
        },
        "entity": "ACTIVITIES",
        "number": "35",
        "subject": "Approval for Activities by Manager and Assigned to User",
        "response_date": "2016-01-19T11:05:01",
        "approval_definition":
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "D159E061650D40E689CADDF17ABB424A",
            "name": "Installation Approval WT",
            "alternative_code": "IAW"
        },
        "log_information":
        {
            "updated_date": "2016-01-19T11:05:01",
            "created_date": "2016-01-15T12:46:37",
            "created_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1",
                "alternative_code": "MG"
            },
            "updated_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "emichailidou",
                "username": "emichailidou",
                "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
                "email": "crm.com.tst@gmail.com"
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1"
            }
        },
        "life_cycle_state": "REJECTED",
        "entity_id": "8EA429235CA8401BB9DFAF2CBBDB53B1",
        "unified_code": "27",
        "id": "D36C79EDCD024309ADB9F1AAC1B9046C",
        "workflow_rule":
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "F935C2C73CB948DCBD5101DFFF79FC6E",
            "name": "Installations Activities - Approvals WT",
            "alternative_code": "IA-AW"
        }
    }
}

...

Name

Type

Description

token

String

The token retrieved from the login method

approval_request_identifier

(mandatory)

Approval Request Identifier

The identifier of the approval request that should be cancelled. The allowed approval request Identifier fields are the following:

Include Page

	V4:approval_request_identifier
	V4:approval_request_identifier

Note that only pending approval requests are allowed to be specified

response

(mandatory)

String

The response to the approval request as provided by the user that cancelled the approval request

...

Include Page

	V4:approval_request_complete
	V4:approval_request_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

{
          "token":"438BA44BD33B44EEBC77746030A92629",
          "approval_request_identifier":{"number":"31"},
          "response":"Test from API"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "authorised_users_set":
        [
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Eleni Michailidou",
                "username": "emichailidou",
                "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
                "email": "crm.com.tst@gmail.com"
            }
        ],
        "response": "Test from API",
        "responded_by":
        {
            "person_name": "Marios Lannister",
            "username": "MPAdministrator",
            "id": "1"
        },
        "entity": "ACTIVITIES",
        "number": "31",
        "subject": "Approval for Activities by Manager and Assigned to User",
        "response_date": "2016-01-19T11:08:22",
        "approval_definition":
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "D159E061650D40E689CADDF17ABB424A",
            "name": "Installation Approval WT",
            "alternative_code": "IAW"
        },
        "log_information":
        {
            "updated_date": "2016-01-19T11:08:22",
            "created_date": "2016-01-15T12:24:57",
            "created_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1",
                "alternative_code": "MG"
            },
            "updated_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "emichailidou",
                "username": "emichailidou",
                "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
                "email": "crm.com.tst@gmail.com"
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1"
            }
        },
        "life_cycle_state": "CANCELLED",
        "entity_id": "62CBD15D374A409EBD84445ACB5B0AD1",
        "unified_code": "24",
        "id": "3A27633CD3D64779BC21E5281362563C",
        "workflow_rule":
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "F935C2C73CB948DCBD5101DFFF79FC6E",
            "name": "Installations Activities - Approvals WT",
            "alternative_code": "IA-AW"
        }
    }
}

...

Name

Type

Description

token

String

The token retrieved from the login method

approval_request_identifier

(mandatory)

Approval Request Identifier

The identifier of the approval request that should be deleted. The allowed approval request Identifier fields are the following:

Include Page

	V4:approval_request_identifier
	V4:approval_request_identifier

Note that only rejected, approved or cancelled approval requests are allowed to be specified

...

Include Page

	V4:approval_request_complete
	V4:approval_request_complete

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	js
linenumbers	true

{
          "token":"438BA44BD33B44EEBC77746030A92629",
          "approval_request_identifier":{"number":"22"},
          "response":"Test from API"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "authorised_users_set":
        [
            {
                "person_name": "Eleni M2",
                "username": "testuser24",
                "id": "06A60C01C15542C187390ECABB0B657F",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "George Rossides",
                "username": "g.rossides",
                "id": "39E7AF1A9950A0E28322D930BD83ECFF",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Katerina Kyriacou",
                "username": "k.kyriacou",
                "id": "A6685D251DF7405D80D953B40D0C7523",
                "email": null
            },
            {
                "person_name": "Katerina Argyrou",
                "username": "k_argyrou",
                "id": "4230DAC160797424CBFE356C1458E791",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Panayiota2test Demou2test",
                "username": "pdemou",
                "id": "BF3024F212ED4FAE90FA5393449F43EB",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Maria Jones",
                "username": "m.jones",
                "id": "97DD1255B4D061EB0552ECFD10AFDF8A",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Mai Doan",
                "username": "m_doan",
                "id": "A4057D6B1BF445D19F8C89FAABDDEBA0",
                "email": null
            },
            {
                "person_name": "Vasilis Kleanthous",
                "username": "v_kleanthous",
                "id": "FF7F0B0AED065136B0A7B0A883BF48E3",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Elena Michael",
                "username": "E_Michael",
                "id": "A9F1C80F38C44F548B836A33CB2CB743",
                "email": null
            },
            {
                "person_name": "Persy Xen",
                "username": "persy",
                "id": "3274FDE75239692B81B2526BC1A9E429",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "giorgos nikolaou",
                "username": "Sales_Branch1",
                "id": "785EACB7C0C6964E97BF14649116BEEC",
                "email": null
            },
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "VTVCab  R7 Demo",
                "username": "VTVCAB",
                "id": "036653F80439476698B82FE1A6EA30F9",
                "email": null
            },
            {
                "person_name": "Eleni Michailidou",
                "username": "e_michailidou",
                "id": "B90BAAC08F28D4F9D11D4B08C7919A50",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Super Visor",
                "username": "supervisor",
                "id": "018CA08BC267612F6206D85011FFC5D1",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Panayiota Demou",
                "username": "p_demou",
                "id": "4927E7EE8BBB4047A35F4F313D0EC6D3",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Alex Themistos",
                "username": "a_themistos",
                "id": "6B2220643DBC7E7B151B4229AB0D8F17",
                "email": null
            },
            {
                "person_name": "Frini P",
                "username": "f_pouyiouka",
                "id": "823EEDAC57825DF996956E480068A6A9",
                "email": null
            },
            {
                "person_name": "Marios Ioannou",
                "username": "vtvcab1",
                "id": "B2DBFE2ACF2148689A4245175DC8F729",
                "email": null
            },
            {
                "person_name": "Christie Miltiadou",
                "username": "c_miltiadou",
                "id": "1A9637ADB7444373BAE1C814CA0C2678",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Simon Brown",
                "username": "DELBOY",
                "id": "29DE94EBF89A885822BAB8179F2F2686",
                "email": null
            },
            {
                "person_name": "Petros Petrou",
                "username": "m_clerides",
                "id": "D502772234A6A5F3DEBF0D77D06D9703",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Persia Xenopoulou",
                "username": "p_xenopoulou",
                "id": "5FFEA386E967401CB983DCF7A4CF2993",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "George Famous",
                "username": "analytics",
                "id": "8B92DDD80CD14BA7AE932CF0597907C6",
                "email": "g_famous@crm.com"
            },
            {
                "person_name": "firstname1 lastname1",
                "username": "user1",
                "id": "F873D942AFEF441B88C43B66A956A77D",
                "email": null
            },
            {
                "person_name": "Georgia Kountouri2",
                "username": "g_kountouri",
                "id": "B0CF852BA7364BC6887E00F570903FFD",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Rossides Giorkos",
                "username": "g_rossides",
                "id": "4AD9C84FA60F9FE407140E20F707726A",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "firstname2 lastname2",
                "username": "user2",
                "id": "F4604A49C89240F29357D634B0EFB83C",
                "email": null
            },
            {
                "person_name": "Andreas Hadjigeorgiou",
                "username": "lightblack",
                "id": "2B7FD8F1E4AE4AE5BDC280BB478009BA",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "michael may",
                "username": "may4life",
                "id": "281439D1E8C34481AA4B6F355513899C",
                "email": null
            },
            {
                "person_name": "name42 p",
                "username": "FriniTest",
                "id": "AD848CDF467C462BD4CF302EF131FA83",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Jack Hadjicosti",
                "username": "J_Hadjicosti",
                "id": "C3F78056AD2C2CC2D7CEE5741F6103C8",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Eleni 6 Mich",
                "username": "emichailidou2",
                "id": "DE1483BF011C48828CA8F7A9307620DE",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Ekaterini Tzirtzipi",
                "username": "E_Tzirtzipi",
                "id": "FED57FF8145B470B82DD1F10BC92F791",
                "email": null
            },
            {
                "person_name": "CRM DEMO",
                "username": "crmdemo",
                "id": "EE45E7939403344B3AA5F7B8BAC55455",
                "email": null
            },
            {
                "person_name": "Test Space",
                "username": "test_space",
                "id": "76D6BF53349BF8000BD05FCC2A5B9513",
                "email": null
            },
            {
                "person_name": "Eleni Michailidou",
                "username": "emichailidou",
                "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Pania Xeno",
                "username": "pania_xeno",
                "id": "2A15084589E81D3DA7ABA3C7563F805E",
                "email": "crm.com.tst@gmail.com"
            },
            {
                "person_name": "Katerina Lambrou",
                "username": "k.argyrou",
                "id": "339D08E81F54400B91E107642DBDFC22",
                "email": "katerina_argyrou@crm.com"
            }
        ],
        "response": "Testing API reject.",
        "responded_by":
        {
            "person_name": "emichailidou",
            "username": "emichailidou",
            "id": "63ACDBBC5B39AD2DF5B167FA70EE57DD",
            "email": "crm.com.tst@gmail.com"
        },
        "entity": "SERVICEREQUESTS",
        "number": "22",
        "subject": "Service Request Approvals by Specific Users and Profiles",
        "response_date": "2016-01-15T10:26:25",
        "approval_definition":
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "46DAB81EB8914CAAA3C6183F57DE0946",
            "name": "Service Request Approval WT",
            "alternative_code": "SRAW"
        },
        "log_information":
        {
            "updated_date": "2016-01-19T11:13:19",
            "created_date": "2016-01-13T12:58:23",
            "created_by_unit":
            {
                "community_name": "Internal Community",
                "id": "0330B56C29264E97920B0D7F710DB664",
                "name": "Manchester Unit",
                "group_name": "Manchester Group",
                "description": null,
                "alternative_code": "MU"
            },
            "updated_by_unit":
            {
                "community_name": "Internal Community",
                "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                "name": "Admin Unit",
                "group_name": "Main Group",
                "description": "r1",
                "alternative_code": "MG"
            },
            "created_by_user":
            {
                "person_name": "emichailidou2",
                "username": "emichailidou2",
                "id": "DE1483BF011C48828CA8F7A9307620DE",
                "email": "crm.com.tst@gmail.com"
            },
            "updated_by_user":
            {
                "person_name": "Marios Lannister",
                "username": "MPAdministrator",
                "id": "1"
            }
        },
        "life_cycle_state": "REJECTED",
        "entity_id": "67CE2CA694754423B62E4A1C2D4DC7D4",
        "unified_code": "17",
        "id": "1D772F2CCEDB494AAD6F1F4FD7ACE03E",
        "workflow_rule":
        {
            "life_cycle_state": "EFFECTIVE",
            "id": "4D4E0F0B6DDA4BA7B8B7D378F27D6ED8",
            "name": "New Service Requests WTC7",
            "alternative_code": "NSRW"
        }
    }
}

Versions Compared

Old Version 9

New Version 10

Key

Examples

Examples

Examples

Examples