Summary
Gets all services and service groups
Description
Returns all available services and service group documents.
Route
GET /policy-manager/services-and-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"
},
"type": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"protocol": {
"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 and service group documents. |
Copied to Clipboard
{
"results": [
{
"id": "qui dolore",
"type": "serviceGroup",
"name": "proident",
"description": "laboris",
"created": "1950-04-21T22:05:06.979Z",
"createdBy": "Ut qui do mollit",
"lastUpdated": "1995-07-25T04:37:42.688Z",
"lastUpdatedBy": "mollit Excepteur incididunt sit aliquip",
"traffic": {
"protocol": 20047423
},
"services": [
"in deserunt esse dolor",
"dolor do Lorem",
"consectetur do",
"mollit eiusmod non commodo do"
]
},
{
"id": "velit tempor nisi non",
"type": "serviceGroup",
"name": "labore ullamco veniam dolor",
"description": "est fugiat veniam in",
"created": "1987-07-08T23:03:10.658Z",
"createdBy": "amet labore voluptate",
"lastUpdated": "1948-12-05T13:02:38.012Z",
"lastUpdatedBy": "enim qui dolor",
"traffic": {
"protocol": -66327762
},
"services": [
"exercitation amet et",
"quis veniam consequat fugiat",
"culpa officia quis",
"adipisicing aliquip qui tempor",
"Duis voluptate"
]
}
],
"pageData": {
"total": 8902105,
"skip": 86927386,
"limit": 90735950
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"title": "serviceOrServiceGroup",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"enum": [
"service",
"serviceGroup"
]
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"traffic": {
"type": "object",
"properties": {
"protocol": {
"type": [
"null",
"integer"
]
}
},
"required": [
"protocol"
],
"additionalProperties": true
},
"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",
"type",
"name",
"description",
"created",
"createdBy",
"lastUpdated",
"lastUpdatedBy"
]
}
},
"pageData": {
"type": "object",
"properties": {
"total": {
"type": "integer"
},
"skip": {
"type": "integer"
},
"limit": {
"type": "integer"
}
},
"required": [
"total",
"skip",
"limit"
]
}
},
"required": [
"results",
"pageData"
]
}
