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": "fugiat",
"name": "officia exercitation eiusmod dolore ipsum",
"description": "laborum",
"services": [
"sunt",
"consectetur velit Duis ex aute"
],
"created": "1986-06-06T20:08:00.818Z",
"createdBy": "cupidatat Lorem fugiat aliquip",
"lastUpdated": "1978-05-07T09:20:10.648Z",
"lastUpdatedBy": "dolore sit et irure proident"
},
{
"id": "eu adipisicing ea dolor officia",
"name": "incididunt do anim exercitation ad",
"description": "aliqua aliquip aute esse",
"services": [
"ea do",
"incididunt aute in adipisicing",
"ea labore",
"nostrud in nulla"
],
"created": "2018-11-06T16:52:03.143Z",
"createdBy": "sit veniam consequat cillum",
"lastUpdated": "1992-07-02T15:59:41.22Z",
"lastUpdatedBy": "aliqua aute"
},
{
"id": "sint in voluptate exercitation",
"name": "cillum ipsum officia nisi",
"description": "pariatur esse",
"services": [
"aute eu irure exercitation ut",
"veniam sunt"
],
"created": "1967-09-24T19:28:16.295Z",
"createdBy": "aute dolor ut",
"lastUpdated": "1983-02-22T12:53:10.989Z",
"lastUpdatedBy": "in"
},
{
"id": "laborum",
"name": "nostrud culpa Duis incididunt aliqua",
"description": "Excepteur",
"services": [
"minim nostrud"
],
"created": "1951-01-19T09:26:17.977Z",
"createdBy": "non",
"lastUpdated": "2018-08-31T05:08:40.185Z",
"lastUpdatedBy": "eiusmod labore dolor consectetur"
}
],
"pageData": {
"total": -57375368,
"skip": -26171587,
"limit": 31747592
}
}
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"
]
}