Summary
Gets all service groups
Description
Returns all available service group documents.
Route
GET /policy-manager/service-groups
Roles
admin
other
readonly
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| query |
object |
yes |
Optional query parameters |
Copied to Clipboard
{
"query": {
"limit": 10,
"sort": "name",
"skip": 10
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"query": {
"title": "query",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"limit": {
"type": "integer"
},
"sort": {
"type": "string"
},
"skip": {
"type": "integer"
},
"order": {
"type": "integer"
}
},
"type": "object",
"examples": [
{
"limit": 10,
"sort": "name",
"skip": 10
}
]
}
},
"required": [
"query"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
object |
All service group documents. |
Copied to Clipboard
{
"results": [
{
"id": "do consectetur sed aliqua anim",
"name": "nisi Excepteur occaecat eiusmod incididunt",
"description": "labore anim ad",
"services": [
"incididunt eu in irure",
"amet exercitation adipisicing irure quis",
"incididunt elit exercitation commodo"
],
"created": "1976-01-06T10:27:21.717Z",
"createdBy": "laborum",
"lastUpdated": "2016-11-24T11:16:59.257Z",
"lastUpdatedBy": "Duis sit nostrud nisi"
},
{
"id": "aliquip",
"name": "amet reprehenderit eiusmod mollit Excepteur",
"description": "dolore dolore nulla",
"services": [
"esse ullamco",
"sunt nostrud Excepteur exercitation Ut"
],
"created": "1948-05-04T14:36:00.219Z",
"createdBy": "esse labore Duis laboris mollit",
"lastUpdated": "1998-03-01T05:12:26.187Z",
"lastUpdatedBy": "culpa commodo laboris dolore"
}
],
"pageData": {
"total": -97805524,
"skip": -77030953,
"limit": 10481133
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"title": "serviceGroup",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"services": {
"type": "array",
"items": {
"title": "serviceId",
"type": "string"
}
},
"created": {
"type": "string",
"format": "date-time"
},
"createdBy": {
"type": "string"
},
"lastUpdated": {
"type": "string",
"format": "date-time"
},
"lastUpdatedBy": {
"type": "string"
}
},
"required": [
"id",
"name",
"description",
"services",
"created",
"createdBy",
"lastUpdated",
"lastUpdatedBy"
]
}
},
"pageData": {
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"skip": {
"type": "integer"
},
"limit": {
"type": "integer"
}
},
"required": [
"total",
"skip",
"limit"
]
}
},
"required": [
"results",
"pageData"
]
}
