Skip to main content

Get Request Items

Get information about the changes encompassed by a particular change request or approval. The user specified by the token must have access to the change request or approval.

GET https://instance.securid.com/aveksa/command.submit?cmd=getRequestItems

Request​

Parameters​

getRequestItems
formatproperties - (Default) key=value. most useful when requesting a single object. If multiple objects are returned, values is a csv. ie key=value1,value2,value3 where value1 is the value for the first object, value2 is the value for the 2nd object, etc.

json - Useful format for parsing into javascript or other languages. See www.json.org for details.
The id of the approval work item, retrieved from getApprovalsForUser. Either approval-id or request-id must be provided.
The id of the change request, retrieved from createChangeRequest. Either approval-id or request-id must be provided.
page-sizeThe number of request items to return for this page. (Default 20)
start-pageThe page number to start from. (Default 1)

Headers​

Bearer token
Acceptapplication/json
Content-Typeapplication/json

Response​

Parameters​

The command returns detailed information about the approval in XML format.

Examples​

Request​

curl -K -X GET  \
"https://instance.securid.com/aveksa/command.submit?cmd=getRequestItems&format=json&approval-id=id" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"

Response​

<?xml version="1.0" encoding="UTF-8"?>
<getRequestItems>
    <NumRequestItems>2</NumRequestItems>
    <WorkItemId>2585:WPDS:1</WorkItemId>
    <RequestId>324</RequestId>
    <RequestStatus>Approvals Phase</RequestStatus>
    <RequestItems>
        <RequestItem>
            <ItemId>773</ItemId>
            <TypeDescription>Add user to group</TypeDescription>
            <Operation>Add</Operation>
            <OperandType>User</OperandType>
            <ValueType>UserGroup</ValueType>
            <EntitlementType>Group</EntitlementType>
            <EntitlementName>Fredwin Cycling Product</EntitlementName>
            <EntitlementRawName>Fredwin Cycling Product</EntitlementRawName>
            <BusinessSource>Aha!</BusinessSource>
            <BusinessSourceAltName>Aha!</BusinessSourceAltName>
            <State>Pending Approval</State>
            <ItemDescription/>
            <DerivedType>Direct</DerivedType>
            <IsChangeToApprove>true</IsChangeToApprove>
            <UserName>Wayne, Bruce</UserName>
            <UserId>225142</UserId>
            <ApplicationRoleName/>
            <UserGroupName/>
            <GlobalRoleName/>
            <GlobalRoleSetName/>
            <Data_Resource_Name/>
            <AccountName/>
        </RequestItem>
        <RequestItem>
            <ItemId>775</ItemId>
            <TypeDescription>code.ChangeItemOperation.RequestForm</TypeDescription>
            <Operation>Create</Operation>
            <OperandType>RequestForm</OperandType>
            <ValueType>User</ValueType>
            <EntitlementType>Owner</EntitlementType>
            <EntitlementName>Wayne, Bruce</EntitlementName>
            <EntitlementRawName>Wayne, Bruce</EntitlementRawName>
            <BusinessSource/>
            <BusinessSourceAltName/>
            <State>Pending Approval</State>
            <ItemDescription/>
            <DerivedType>Direct</DerivedType>
            <IsChangeToApprove>false</IsChangeToApprove>
            <UserName/>
            <ApplicationRoleName/>
            <UserGroupName/>
            <GlobalRoleName/>
            <GlobalRoleSetName/>
            <Data_Resource_Name/>
            <AccountName/>
        </RequestItem>
    </RequestItems>
</getRequestItems>
Last updated on