Get Provisioning Endpoints

Table 1. API: GET Provisioning Endpoints
Element Description
API GetProvisioningEndpoints
Description API Returns all endpoints accessible to user.
Method GET
URL Http(s)://{xx.xxxx.xx.xx:xxx}/v3/platforms/provisioningEndpoints
URL Parameters (fields 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": "email=’saxenaga@hcl.com’","sortorder": "desc", "pagenumber" : "1", "pagesize" : "10"}
Header
  • Authorization Key: The initial step that needs to be performed before consuming HCL BigFix CLM API 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

A Sample Response:

{
"totalRecords": 0,
"records": [
{
"endPoinName": "string",
"entityId": "string",
"organizationCode": "string",
"createdOn": "string"
}
]
}
Response Parameters
  • totalRecords:
  • records
  • endPoinName
  • entityId
  • organizationCode
  • createdOn