Find Change Requests

Find change requests. The command uses the PV_CHANGE_REQUEST public view to find data.

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

Request

Parameters

command	findChangeRequests
format	properties - (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. csv - Comma separated values tsv - Tab separated values xml - Extensible Markup Language
delimiter	The delimiter to use between values for csv, properties formats
returnColumns	The names of the columns to return. returnColumns may be a CSV list of multiple column names. The returnColumns parameter may also be listed multiple times (ie returnColumns=col1,col2&returnColumns=col3,col4) Refer to Columns table below.
returnMaxRows	The maximum number of objects to return
distinct	true, false Returns only distinct values similar to the distinct keyword in SQL.
sortByColumns	The results will be sorted based on the columns listed using comma as the delimiter if multiple columns are specified. Refer to Columns table below.
sortDirection	This determines sorting order. When defined as 'asc' the sorting is in ascending order else in 'desc' descending order. If this parameter is not specified, the natural order of rows returned by database is used.
includeHeaderRow	true, false To include column headers when the return format is csv, tsv. (Default) true
ignoreCase	true, false Returns case insensitive search result for specified filter parameters. (Default) false

Columns

id	[Primary Key] Unique change request identifier
name	Change request name
type	Change request type. Has the following values: System Role RoleSet
requestor_id	[Foreign Key referencing USERS.ID] User id that created this change request
request_date	Date stamp when this change request was created
completed_date	Date stamp when this change request was completed.
notes	Notes associated with this change request.
current_state	Current state of the change request. Has the following values: Open PendingApprovals Rejected PendingVerification PendingUndoVerification Completed Cancelled ER
is_undone	true, false Whether this change request was undone.
description	Description for this entry
delay_date	Delay date
violations	Violations
is_alldirectevent	true, false Indicates whether all direct changes have been fulfilled (indirect changes may be still outstanding).
undoworkflow_id	The id of the workflow being used to undo the request (the request has been canceled).
source_type	Source type. Has the following values: ExplicitAccess RuleViolations RoleManagement RoleSetManagement AccessCertification UserReview AccountReview RoleReview GroupReview DataResourceReview DataResourceOwnershipReview
source_object	Source object
editable	Y, N Editable
fulfillcancel	Y, NIndicates whether cancel of the request is allowed once the request is in the fulfillment phase
session_id	Session id
session_time	Session time
attachment_set_id	Attachment set id
form_id	Form id
form_data	Form data
visible_to_target	Y, N Specifies whether the pending change request initiated through the form appears under a user’s Requests tab.You typically might not want a pending termination request to be visible to a user for whom the request was generated.
cancellable	Y, N Specifies whether a change request can be canceled
review_def_id	The identifier of the review definition
review_date	Date the review was generated
delegate_id	Specifies the person to whom the delegation capabilities are granted.
version	Indicates whether the new change request needs to be handled differently than legacy on restart
archive_id	???
approval_phase_completed_date	Date, with time, that approval phase of change request was completed.
fulfillment_phase_start_date	Date, with time, that fulfillment phase of change request was started. May be null if request is not moving on to fulfillment phase (ie. request may have been cancelled, rejected, etc).
total_approval_time_value	Total approval time, as a decimal in days. Use this value and format appropriately when the exact value is desired.
total_approval_time_days	Total approval time, as an integer in days. Use this value mainly for grouping and sorting. Use the _value column when the exact value is desired.
total_approval_time_hours	Total approval time, as an integer in hours. Use this value mainly for grouping and sorting. Use the _value column when the exact value is desired.
total_approval_time_text	Total approval time, as string value in the format of "x days y hours", where x and y are both integers. Use this column as a helper for display in reports.
total_fulfillment_time_value	Total fulfillment time, as a decimal in days. Use this value and format appropriately when the exact value is desired.
total_fulfillment_time_days	Total fulfillment time, as an integer in days. Use this value mainly for grouping and sorting. Use the _value column when the exact value is desired.
total_fulfillment_time_hours	Total fulfillment time, as an integer in hours. Use this value mainly for grouping and sorting. Use the _value column when the exact value is desired.
total_fulfillment_time_text	Total fulfillment time, as string value in the format of "x days y hours", where x and y are both integers. Use this column as a helper for display in reports.
total_time_value	Total time, as a decimal in days. Use this value and format appropriately when the exact value is desired.
total_time_hours	Total time, as an integer in hours. Use this value mainly for grouping and sorting. Use the _value column when the exact value is desired.
total_time_days	Total time, as an integer in days. Use this value mainly for grouping and sorting. Use the _value column when the exact value is desired
total_time_text	Total time, as string value in the format of "x days y hours", where x and y are both integers. Use this column as a helper for display in reports.
request_date_no_time	Date, without time, extracted from REQUEST_DATE
request_date_year	Year, as integer, extracted from REQUEST_DATE
request_date_month	Month, as integer, extracted from REQUEST_DATE.
request_date_month_text	Month, as string, extracted from REQUEST_DATE. (ie. January)
request_date_month_abv	Month abbreviation, as string extracted from REQUEST_DATE. (ie. Jan)
request_date_day	Day of Month, as integer, extracted from REQUEST_DATE.
request_week_of_year	Week of the year, as integer, extracted from REQUEST_DATE.
completed_date_no_time	Date, without time, extracted from COMPLETED_DATE
completed_date_year	Year, as integer, extracted from COMPLETED_DATE
completed_date_month	Month, as integer, extracted from COMPLETED_DATE.
completed_date_month_text	Month, as string, extracted from COMPLETED_DATE. (ie. January)
completed_date_month_abv	Month abbreviation, as string extracted from COMPLETED_DATE. (ie. Jan)
completed_date_day	Day of Month, as integer, extracted from COMPLETED_DATE.
completed_week_of_year	Week of the year, as integer, extracted from COMPLETED_DATE.
cau1	Value of custom user type attributes configured on the instance represented by their reference names
cad1	Value of custom date type attributes configured on the instance represented by their reference names
cas1	Value of custom string type attributes configured on the instance represented by their reference names

Headers

Authorization	Bearer token
Accept	application/json
Content-Type	application/json

Response

Parameters

The API returns the requested columns specified by returnColumns as output. If returnColumns is unspecified then all columns listed will be returned.

Examples

Request

Curl

curl -K -X GET  \
"https://instance.securid.com/aveksa/command.submit?cmd=findChangeRequests&format=json" \
"&returnColumns=id%2Cname%2Cdescription%2Ctype%2Ccurrent_state%2Csource_type%2Cnotes&returnMaxRows=10" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"

Python

import requests

url = "https://instance.securid.com/aveksa/command.submit"

params = {
    "cmd": "findChangeRequests",
    "format": "json",
    "returnColumns": "id,name,description,type,current_state,source_type,notes",
    "returnMaxRows": "50",
    "sortDirection": "asc"
}

headers = {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
}

response = requests.get(url, params=params, headers=headers)

if response.status_code == 200:
    data = response.json()
    print(data)
else:
    print(f"Request failed with status code {response.status_code}")

Node.js

const axios = require('axios');

const url = "https://instance.securid.com/aveksa/command.submit";

const params = {
    cmd: "findChangeRequests",
    format: "json",
    returnColumns: "id,name,description,type,current_state,source_type,notes",
    returnMaxRows: "50",
    sortDirection: "asc"
};

const headers = {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
};

axios.get(url, { params, headers })
    .then(response => {
        if (response.status === 200) {
            const data = response.data;
            console.log(data);
        } else {
            console.log(`Request failed with status code ${response.status}`);
        }
    })
    .catch(error => {
        console.error('Error:', error);
    });

Response

200

{
    "findChangeRequests": [
        {
            "id": "43",
            "name": "00043",
            "description": "",
            "type": "System",
            "current_state": "Cancelled",
            "source_type": "ExplicitAccess",
            "notes": ""
        },
        {
            "id": "221",
            "name": "Rule:Attribute Synchronization_41:Doe, James1_jdoe_225186_00221",
            "description": "Created from rule Attribute Synchronization",
            "type": "System",
            "current_state": "Completed",
            "source_type": "RuleViolations",
            "notes": "Created from rule Attribute Synchronization"
        },
        {
            "id": "143",
            "name": "00143",
            "description": "",
            "type": "System",
            "current_state": "PendingVerification",
            "source_type": "ExplicitAccess",
            "notes": ""
        },
        {
            "id": "64",
            "name": "00063 [This is an automatically generated revocation request.]",
            "description": "",
            "type": "System",
            "current_state": "ER",
            "source_type": "ExplicitAccess",
            "notes": ""
        }
    ]
}