Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...


Tip

Available from CRM.COM R9.0.0

Deprecated from CRM.COM R18.0.0


Excerpt

This method is used to cancel pending approval requests.  A single approval request can be cancelled through this method

Resource URL

Parameters

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

 

fields_set

(optional)

List of Strings, comma separatedA 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.

...

Expand
titleExample 1

HTTP Method: POST 


Request:

Body:

Code Block
languagejs
themeConfluence
languagejs
linenumberstrue
{
          "token":"438BA44BD33B44EEBC77746030A92629",
          "approval_request_identifier":{"number":"31"},
          "response":"Test from API"
}  


Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
    "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"
        }
    }
} 


...