Endpoint
/api/v2/tenants/{tenantId}/rosters/search
Path Parameters
tenantId
string

Query Parameters
pageNo
integer

{pageNo}

pageSize
integer

{pageSize}

isDescendingOrder
boolean

{true/false}

sortName
string

{field}

queryString
string

{queryString}

name
string

The roster name (must be identical to match)

allList
boolean

If true, get both partner and client level rosters and if false (the default), get partner level rosters.

Responses

OK

descendingOrder
boolean

nextPage
boolean

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

results.allClients
results.client
results.createdTime
results.description
results.id
results.name
results.timeZone
results.updatedTime
totalPages
integer

totalResults
integer

{
  "descendingOrder": false,
  "nextPage": false,
  "pageNo": 1,
  "pageSize": 20,
  "previousPageNo": 0,
  "results": [
    {
      "client": {
        "activated": true,
        "name": "Test  Client",
        "uniqueId": "client_7"
      },
      "createdTime": "2017-02-09T11:59:25+0000",
      "description": "Network Issues Support - Asia Region",
      "id": "ES-1f43a99c-469e-a62a-b452-aacf6ad81e3b",
      "name": "Network Issues Support",
      "timeZone": {
        "code": "IST",
        "id": "19",
        "label": "GMT +05:30 India",
        "name": "Asia/Calcutta"
      },
      "updatedTime": "2017-03-08T07:25:02+0000"
    },
    {
      "allClients": true,
      "createdTime": "2017-03-14T11:42:04+0000",
      "description": "Implementation Support - Level 1",
      "id": "ES-d89ca222-1ee8-50ef-e40a-ba89fb23586b",
      "name": "Implementation Support",
      "timeZone": {
        "code": "IST",
        "id": "19",
        "label": "GMT +05:30 India",
        "name": "Asia/Calcutta"
      },
      "updatedTime": "2017-06-28T11:33:49+0000"
    },
    {
      "client": {
        "activated": true,
        "name": "Test  Client",
        "uniqueId": "client_7"
      },
      "createdTime": "2017-05-04T10:12:23+0000",
      "description": "Alerts Support - Level 1",
      "id": "ES-157ce85f-2f91-94e9-dc2d-ec4591ef2ed5",
      "name": "Alerts Support",
      "timeZone": {
        "code": "IST",
        "id": "19",
        "label": "GMT +05:30 India",
        "name": "Asia/Calcutta"
      },
      "updatedTime": "2017-06-28T11:33:49+0000"
    },
    {
      "allClients": true,
      "createdTime": "2017-06-16T07:08:35+0000",
      "description": "Maintenance team to address Jobs and Patches issues",
      "id": "ES-9f0e489c-8c00-4dba-8a7e-9c81f710d0d3",
      "name": "Maintenance Team",
      "timeZone": {
        "code": "IST",
        "id": "19",
        "label": "GMT +05:30 India",
        "name": "Asia/Calcutta"
      },
      "updatedTime": "2017-06-27T13:07:19+0000"
    },
    {
      "client": {
        "activated": true,
        "name": "Test  Client",
        "uniqueId": "client_7"
      },
      "createdTime": "2017-06-27T12:38:23+0000",
      "description": "Network management team to address critical network issues.",
      "id": "ES-b519563f-5b9f-4bcf-9a90-ce3cddf5c268",
      "name": "Network Management Team - Level 1",
      "timeZone": {
        "code": "IST",
        "id": "19",
        "label": "GMT +05:30 India",
        "name": "Asia/Calcutta"
      },
      "updatedTime": "2017-06-28T10:59:20+0000"
    }
  ],
  "totalPages": 1,
  "totalResults": 5
}