Get Snapshots

• endPointId (Mandatory): This is a unique identifier of Cloud Endpoint created in HCL BigFix CLM. It can be any value either PlatformEntityId or Name of the Platform available on Manage Provisioning Platform screen.
• 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": "location=’westeurope’","sortorder": "desc", "pagenumber" : "1", "pagesize" : "10"}

• 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

A Sample Response:

{
 "totalRecords": 1,
 "records": [
 {
 "entityId": "SNAP-7A333840-E080-4CEB-B43F-976151DB1900",
 "snapshotId": "/subscriptions/xxxxxx",
 "name": "CRHVMGMSUSP003-OSDisk-TBD-31-jan-2022",
 "location": "westeurope",
 "resourceGroupName": "CITISHAREDSERVICES-WE-P-APP-RG",
 "skuName": "Standard_LRS",
 "skuTier": "Standard",
 "osType": "Windows",
 "provisioningState": "Succeeded",
 "diskSizeGB": "128",
 "diskState": "Unattached",
 "createOption": "Copy",
 "imageReferenceId": "",
 "sourceResourceId": "/subscriptions/50f13d47-2873-4d19-a5de-583677a7c591/resourceGroups/CITISHAREDSERVICES-WE-P-APP-RG/providers/Microsoft.Compute/disks/CRHVMGMSUSP003_OSDISK_001",
 "encryptionType": "EncryptionAtRestWithPlatformKey",
 "incremental": "false",
 "networkAccessPolicy": "AllowAll",
 "diskSizeBytes": "137438953472",
 "platformEntityId": "ARM-58B227EC-707F-4549-9EB3-8EB1D06F55D2",
 "tags": [
 {
 "Application_x0020_Name": "CITIAPP"
 },
 {
 "Application_x0020_Owner": "CRH"
 },
 {
 "Application_x0020_Priority": "Critical"
 },
 {
 "Compliance": "Numberne"
 },
 {
 "Cost_x0020_Center": "CITI"
 },
 {
 "Description": "CITI SHAREDSERVICES APP"
 },
 {
 "Environment": "PRD"
 },
 {
 "role": "CITIAPP"
 }
 ],
 "associatedServicePlans": [
 {
 "servicePlanId": "2",
 "servicePlanName": "silver"
 }
 ]
 }
 ]
}

• Result:
• entityId
• snapshotId
• name
• location
• resourceGroupName
• skuName
• skuTier
• osType
• provisioningState
• diskSizeGB
• diskState
• createOption
• imageReferenceId
• sourceResourceId
• encryptionType
• incremental
• networkAccessPolicy
• diskSizeBytes
• platformEntityId
• tags
• associatedServicePlans