URL
GET https://{api-url}/api/v2/tenants/{varId}/clients/searchSample URLs
https://{api-url}/api/v2/tenants/msp_6/clients/search?pageNo=2&pageSize=5&isDescendingOrder=true&sortName=client.id&queryString=startUpdationDate:2016-08-25T18:56:04 0000+endUpdationDate:2016-08-28T18:56:04 0000Parameters
| Field | Default Value |
|---|---|
| pageNo={pageNo} | 1 |
| pageSize={pageSize} | 100 |
| isDescendingOrder={true/false} | true |
| sortName={field} | id |
| queryString={queryString} | NA |
NA indicates that the value is not applicable.
Query variables
| Query Variables | Values | Description |
|---|---|---|
| uniqueId | NA | Client ID. |
| name | NA | Client name. |
| activeStatus | true, false | Active status of client. |
| startCreationDate | NA | Client created within a period of time. Provide the from date. Example: 2016-08-18T06:52:24 0000 |
| endCreationDate | NA | Client created within a period of time. Provide the to date. Example: 2016-08-20T06:52:24 0000 |
| startUpdationDate | NA | Client updated within a period of time. Provide the from update date. Example: 2016-08-25T18:56:04 0000 |
| endUpdationDate | NA | Client updated within a period of time. Provide to update date. Example: 2016-08-25T18:56:04 0000 |
Status code
200 OK
Notes
There are special characters that can be used in a query string:
- (+) represents the next field and must be URL-encoded.
- (:) represents equals. An example is
key : value. - Space characters must be URL-encoded.
- Date format must be yyyy-MM-ddTHH:mm:ssZ (GMT).
Sample response
{
"results": [{
"id": 14,
"uniqueId": "client_14",
"name": "Brocade Services",
"activated": true,
"updatedTime": "2016-08-25T18:56:04+0000",
"createdTime": "2016-08-18T06:52:24+0000",
"createdBy": {
"loginName": "superadmin",
"lastName": "Admin",
"firstName": "OpsRamp",
"email": "escalationmails@opsramp.com"
},
"lastUpdatedBy": {
"loginName": "superadmin",
"lastName": "Admin",
"firstName": "OpsRamp",
"email": "escalationmails@opsramp.com"
}
},
{
"id": 9,
"uniqueId": "client_9",
"name": "Brocade Corp.",
"activated": true,
"updatedTime": "2016-07-23T16:18:42+0000",
"createdTime": "2016-07-23T16:18:42+0000",
"createdBy": {
"loginName": "superadmin",
"lastName": "Admin",
"firstName": "OpsRamp",
"email": "escalationmails@opsramp.com"
},
"lastUpdatedBy": {
"loginName": "superadmin",
"lastName": "Admin",
"firstName": "OpsRamp",
"email": "escalationmails@opsramp.com"
}
},
{
"id": 8,
"uniqueId": "client_8",
"name": "Brocade Lab",
"activated": true,
"updatedTime": "2016-08-29T12:05:08+0000",
"createdTime": "2016-07-23T16:17:12+0000",
"createdBy": {
"loginName": "superadmin",
"lastName": "Admin",
"firstName": "OpsRamp",
"email": "escalationmails@opsramp.com"
},
"lastUpdatedBy": {
"loginName": "superadmin",
"lastName": "Admin",
"firstName": "OpsRamp",
"email": "escalationmails@opsramp.com"
}
}
],
"totalResults": 3,
"orderBy": "client.id",
"pageNo": 1,
"pageSize": 10,
"totalPages": 1,
"nextPage": false,
"previousPageNo": 0,
"descendingOrder": true
}