GET Request

Table 1. API: GET Request
Element Description
API Request
Description

This API Returns all request associated to user.

* Refer Accessibility Matrix for permission.
Method GET
URL
Http(s)://xx.xxx.xx.xx:xxx/v3/requests? queryParams=
{"filter":"status='Fulfilment In-Progress'","sortby":"","sortorder":"","pagenumber":"1","pagesize":"20000" }
URL Parameters (test in curly {} braces)
  • queryParams (Optional): It is used for filtering and sorting of records. It has three properties, which are as follows:
  • Filter: To filter records based on column name received from output. E.g., Filter="keyname='keyvalue'"
  • Sort Order: To define sorting order either ASC (Ascending) or DESC (descending). E.g., Sortorder="ASC".
  • Page Number: To get the records for related page number. Eg. Pagenumber="1”
  • Page Size: To get the number of records on selected page. Eg. Pagesize="10”
  • For e.g. 
    {"filter": "cityName=’Virginia’","sortorder": "desc", "pagenumber" : "1", "pagesize" : "10"}
Header
  • Authorization Key: The initial step that needs to be performed before consuming HCL BigFix CLM APIs is to obtain the Token Value for an authorization key. Once a Token value is obtained, it remains valid for all API calls made in a session. For more information on how to do that, refer Token API description.
  • Content-type: application/json
Response 
{
"totalRecords": 1,
"records": [
{
"requestId": "SRREQ000001",
"requestNumber": 1,
"requestDate": "2022-02-22",
"requestedBy": "USER-870AF6A3-5DB1-45D1-A314-5DDB43EC0935",
"requestForEmail": "",
"status": "Fulfilment In-Progress",
"statusId": 5,
"isDraft": "N",
"comments": "",
"associatedItems": [
{
"requestDetailId": 1,
"itemNumber": 1,
"objectType": "VM",
"provisionRequestDate": "2022-02-22",
"itemStatus": "Fulfilment In-Progress",
"itemStatusId": 5,
"platformEntityId": "ARM-58B227EC-707F-4549-9EB3-8EB1D06F55D2",
"platformName": "AzureDev",
"environment": "Microsoft Azure",
"regionName": "eastus",
"locationName": "",
"serviceCatalogId": 1,
"serviceCatalogName": "API Testing Service Catalog",
"actionProcessTemplateId": 0,
"requestedAction": "",
"uiTemplateId": 0,
"ciId": 285,
"objectId": "testVMs",
"srNumber": "",
"srRequestNumber": "SRREQ000001-1",
"cwTimeZone": "",
"cwChangeDay": "",
"cwDateTime": ""
}
]
}
]
}
Response Parameters
  • totalRecords:
  • records
  • requestId
  • requestNumber
  • requestDate
  • requestedBy
  • requestForEmail
  • status
  • statusId
  • isDraft
  • comments
  • associatedItems
  • requestDetailId
  • itemNumber
  • objectType
  • provisionRequestDate
  • itemStatus
  • itemStatusId
  • platformEntityId
  • platformName
  • environment
  • regionName
  • locationName
  • serviceCatalogId
  • serviceCatalogName
  • actionProcessTemplateId
  • requestedAction
  • uiTemplateId
  • ciId
  • objectId
  • srNumber
  • srRequestNumber
  • cwTimeZone
  • cwTimeZone
  • cwDateTime