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": "mollit irure",
"name": "eu reprehenderit",
"description": "esse",
"services": [
"qui occaecat do ea"
],
"created": "2018-12-03T09:26:09.868Z",
"createdBy": "adipisicing cupidatat et",
"lastUpdated": "2010-03-16T12:49:34.109Z",
"lastUpdatedBy": "in"
},
{
"id": "voluptate dolor deserunt",
"name": "non sit tempor quis qui",
"description": "in non Ut ut Excepteur",
"services": [
"incididunt dolore officia",
"ad",
"reprehenderit ullamco laborum"
],
"created": "1959-11-08T14:12:02.937Z",
"createdBy": "ex sed magna",
"lastUpdated": "2010-09-16T12:01:10.87Z",
"lastUpdatedBy": "consectetur in do non"
},
{
"id": "labore mollit Lorem culpa pariatur",
"name": "tempor",
"description": "nisi officia proident incididunt",
"services": [
"in incididunt in"
],
"created": "1978-06-27T02:44:29.568Z",
"createdBy": "et in dolor sint labore",
"lastUpdated": "2008-11-03T05:53:20.489Z",
"lastUpdatedBy": "velit enim dolore nostrud fugiat"
},
{
"id": "Duis nostrud",
"name": "veniam laborum ut",
"description": "tempor",
"services": [
"incididunt",
"minim ea esse velit enim",
"ullamco",
"commodo sit proident dolor consequat",
"proident in"
],
"created": "1969-08-22T19:14:02.893Z",
"createdBy": "dolore ullamco tempor",
"lastUpdated": "1996-12-13T17:47:26.919Z",
"lastUpdatedBy": "exercitation commodo cillum sunt eiusmod"
}
],
"pageData": {
"total": 28838528,
"skip": -20177747,
"limit": -1222056
}
}
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"
]
}
