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": "in",
"name": "Lorem eiusmod consequat Duis tempor",
"description": "culpa",
"services": [
"culpa ea elit",
"velit",
"qui labore"
],
"created": "2019-06-05T20:22:20.046Z",
"createdBy": "occaecat",
"lastUpdated": "1973-04-11T05:37:30.519Z",
"lastUpdatedBy": "aute pariatur"
},
{
"id": "deserunt do Ut",
"name": "anim",
"description": "dolore incididunt nulla",
"services": [
"commodo Duis nostrud exercitation",
"tempor cillum",
"nulla pariatur",
"sint sit ad voluptate anim",
"sint velit sed id"
],
"created": "2010-10-27T18:06:04.929Z",
"createdBy": "Ut et sunt",
"lastUpdated": "1984-04-01T13:06:13.335Z",
"lastUpdatedBy": "fugiat proident minim ex"
},
{
"id": "laborum Lorem",
"name": "ullamco",
"description": "amet incididunt nulla consectetur",
"services": [
"eu reprehenderit in velit nostrud",
"amet ex ipsum"
],
"created": "1965-10-24T05:27:31.558Z",
"createdBy": "reprehenderit tempor non ut veniam",
"lastUpdated": "1952-03-28T11:47:23.336Z",
"lastUpdatedBy": "quis"
},
{
"id": "commodo",
"name": "proident dolor commodo veniam",
"description": "ut",
"services": [
"in"
],
"created": "1948-10-28T05:55:55.332Z",
"createdBy": "laborum",
"lastUpdated": "2003-01-10T04:25:22.422Z",
"lastUpdatedBy": "sit enim nulla ut voluptate"
}
],
"pageData": {
"total": 41148095,
"skip": -14566864,
"limit": 26155924
}
}
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"
]
}
