Documentation is now available for the Fall 2020 Update release!

Search clients

This endpoint is used to search for the clients.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{varId}/clients/search

Sample 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 0000

Parameters

FieldDefault 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 VariablesValuesDescription
uniqueIdNAClient ID.
nameNAClient name.
activeStatustrue, falseActive status of client.
startCreationDateNAClient created within a period of time. Provide the from date.
Example: 2016-08-18T06:52:24 0000
endCreationDateNAClient created within a period of time. Provide the to date.
Example: 2016-08-20T06:52:24 0000
startUpdationDateNAClient updated within a period of time. Provide the from update date.
Example: 2016-08-25T18:56:04 0000
endUpdationDateNAClient updated within a period of time. Provide to update date.
Example: 2016-08-25T18:56:04 0000

Status code

200 OK

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
}