getRoutes

This method is used to return the list of Routes in HCL BigFix CLM.

Method Signature:

getRoutes (controlId, async, callback, addlparam, provisioningEndPointId, namespaceuid)

Sample Response:

 [{"resourceVersion":"462530304","annotations":
{"openshift.io/host.generated":"true"},"labels":{"app":"httpd"},
"specHost":"mycnewroute17-default.apps.openshift.com",
"specToName":"mycnewroute17","specToKind":"Service",
"specToWeight":100,"specPort":{"targetPort":8080},
"statusIngressHost":"mycnewroute17-default.apps.openshift.com",
"statusIngressRouterName":"default","statusIngressContainers":
[{"type":"Admitted","status":"True","lastTransitionTime":"2025-01-31T07:30:27Z"}],
"entityId":"OCPROUTE-C702CD16-86BA-47DE-9007-837E3E797C2C","platformEntityId":
"OCP-CD351169-215D-44A6-9584-37DAAFE7A2A0","uid":"d35e0a1c-9e4c-4021-b76f-e967f3e2ce96",
"name":"mycnewroute17","nameSpaceName":"default","nameSpaceUid":"xxxxxx","createdBy":
"USER-E500C5C5-0F49-45EB-8297-7418F9C82E3F","createdDate":"2025-01-31T08:06:07.513",
"modifiedBy":"USER-E500C5C5-0F49-45EB-8297-7418F9C82E3F"}]

Parameter Details:

Table 1. getRoutes
Parameter Name Type Mandatory Description
controlId String N

Id of ‘Select’ control to be populated.

If Id Control of dynamic UI is passed, then control will be populated with values return from this function else “Result set” will be returned in JSON format.
async Boolean N

In case it’s False:

Function will be called in synchronous mode. i.e., Current execution will wait for method execution to complete

In case it’s True:

Function will be called asynchronously. Execution will not wait for method execution completion. It will jump to next statement.
callback Function N User can pass function name that can be executed on completion of Parent function call.
addlparam Object N

Addlparam is used for filtering and sorting the records. It contains 3 properties filter/sortby/sortorder.

To Filter:

To filter records based on column name received from output. e.g., filter="keyname='keyvalue'"

To Sort By:

To sort the data based on column name. e.g., sortby="keyname"

To Sort Order:

To define sorting order either ASC (Ascending) or DESC (descending). e.g., sortorder="ASC”
provisioningEndPointId string N User can provide provisioning Cloud Account Id.
namespaceuid String N User has to pass namespaceuid, then details of passed namespaceuid are returned.