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": "non commodo amet deserunt",
"type": "service",
"name": "aliquip Lorem mollit elit Excepteur",
"description": "Lorem officia ad occaecat",
"created": "1966-12-09T19:54:36.02Z",
"createdBy": "deserunt ad",
"lastUpdated": "1976-04-17T15:40:46.877Z",
"lastUpdatedBy": "eu",
"traffic": {
"protocol": 33851413
},
"services": [
"qui",
"id consectetur Duis irure",
"Ut ullamco mollit reprehenderit ad",
"irure eiusmod proident occaecat",
"non in cupidatat sint"
]
},
{
"id": "nisi quis",
"type": "serviceGroup",
"name": "irure",
"description": "sint adipisicing",
"created": "1978-05-29T05:59:28.913Z",
"createdBy": "enim dolor",
"lastUpdated": "1952-02-04T22:48:37.257Z",
"lastUpdatedBy": "eu cupidatat officia adipisicing ut",
"traffic": {
"protocol": 22288186
},
"services": [
"exercitation et",
"laborum Ut",
"eiusmod"
]
}
],
"pageData": {
"total": 10272920,
"skip": 9977006,
"limit": -56773523
}
}
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"
]
}