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": "commodo anim",
"type": "serviceGroup",
"name": "mollit veniam dolore commodo consequat",
"description": "consectetur dolore",
"created": "2017-07-02T06:37:15.165Z",
"createdBy": "enim irure voluptate laboris dolore",
"lastUpdated": "1960-02-21T15:39:28.621Z",
"lastUpdatedBy": "ullamco quis amet ut",
"traffic": {
"protocol": null
},
"services": [
"eiusmod aliqua pariatur velit dolore",
"minim",
"irure esse et eu"
]
},
{
"id": "cupidatat",
"type": "service",
"name": "Excepteur nulla id non consequat",
"description": "sed tempor",
"created": "1955-07-27T00:22:49.294Z",
"createdBy": "commodo sit tempor Excepteur",
"lastUpdated": "1948-02-19T14:19:14.318Z",
"lastUpdatedBy": "sit aliquip in dolor",
"traffic": {
"protocol": null
},
"services": [
"consectetur labore in qui",
"est cupidatat minim in et",
"irure",
"in"
]
},
{
"id": "Excepteur aliquip veniam eu",
"type": "serviceGroup",
"name": "labore ut aute veniam velit",
"description": "incididunt exercitation",
"created": "1986-10-28T03:01:15.928Z",
"createdBy": "proident aute deserunt",
"lastUpdated": "1959-07-07T00:09:24.156Z",
"lastUpdatedBy": "Excepteur tempor dolore proident",
"traffic": {
"protocol": 46325327
},
"services": [
"anim in mollit",
"eu consectetur",
"Lorem ipsum"
]
}
],
"pageData": {
"total": 51234436,
"skip": -47169143,
"limit": -2465654
}
}
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"
]
}