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": "in aliquip Lorem est",
"type": "serviceGroup",
"name": "esse sunt exercitation eu",
"description": "sit magna veniam esse",
"created": "2014-08-09T17:11:51.97Z",
"createdBy": "ullamco fugiat amet irure",
"lastUpdated": "1956-09-29T11:22:39.898Z",
"lastUpdatedBy": "dolore proident aliqua consequat",
"traffic": {
"protocol": null
},
"services": [
"id Lorem culpa",
"ipsum culpa dolor ut"
]
},
{
"id": "enim nulla",
"type": "serviceGroup",
"name": "nostrud Excepteur occaecat",
"description": "nisi aute dolor",
"created": "2006-01-25T16:56:58.577Z",
"createdBy": "qui",
"lastUpdated": "1973-06-28T16:00:31.277Z",
"lastUpdatedBy": "culpa fugiat Excepteur",
"traffic": {
"protocol": -75363310
},
"services": [
"veniam non",
"enim eiusmod sunt"
]
},
{
"id": "id sunt",
"type": "serviceGroup",
"name": "anim",
"description": "et deserunt Ut",
"created": "2011-10-13T15:08:19.008Z",
"createdBy": "nisi nulla eu id mollit",
"lastUpdated": "1980-04-05T23:28:48.617Z",
"lastUpdatedBy": "incididunt consequat nostrud",
"traffic": {
"protocol": -50642936
},
"services": [
"veniam voluptate",
"nostrud fugiat aliquip"
]
},
{
"id": "velit nulla",
"type": "serviceGroup",
"name": "dolore in pariatur in cillum",
"description": "sed cupidatat irure cillum",
"created": "1992-12-25T23:50:13.349Z",
"createdBy": "irure dolor amet consequat esse",
"lastUpdated": "1991-01-30T01:00:59.084Z",
"lastUpdatedBy": "aliqua ullamco amet sint",
"traffic": {
"protocol": null
},
"services": [
"ad laborum",
"consectetur nisi sed pariatur do"
]
},
{
"id": "cillum ut reprehenderit",
"type": "serviceGroup",
"name": "dolore",
"description": "sed dolor do laborum",
"created": "1961-05-31T14:23:39.714Z",
"createdBy": "laboris proident",
"lastUpdated": "1999-07-07T16:08:39.084Z",
"lastUpdatedBy": "pariatur amet esse commodo minim",
"traffic": {
"protocol": -92707807
},
"services": [
"aute ipsum mollit ad"
]
}
],
"pageData": {
"total": 97789516,
"skip": 25905758,
"limit": 24011588
}
}
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"
]
}