Summary
Updates a service group
Description
Updates a service group based on given option properties.
Route
PUT /policy-manager/service-groups/:id
Roles
admin
other
readonly
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| id |
string |
yes |
ID of the service group. |
| details |
object |
yes |
Object containing the fields to be updated |
Copied to Clipboard
{
"details": {
"name": "esse dolore in aliquip Duis",
"description": "ut quis laborum",
"services": [
"pariatur ut qui labore Excepteur",
"aliqua veniam sed aliquip",
"laborum qui enim magna",
"voluptate"
]
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"details": {
"title": "details",
"type": "object",
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"services": {
"type": "array",
"items": {
"title": "serviceId",
"type": "string"
}
}
},
"required": [
"name"
]
}
},
"required": [
"details"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| response |
object |
Response of the updates to the service. |
Copied to Clipboard
{
"status": "failure",
"message": "ipsum ad incididunt Excepteur",
"doc": {
"id": "nisi laboris consequat in",
"name": "reprehenderit deserunt et qui consequat",
"description": "Duis ad enim",
"services": [
"veniam amet minim",
"aliqua consectetur enim do ut"
],
"created": "2020-07-09T14:25:32.036Z",
"createdBy": "consectetur",
"lastUpdated": "2012-11-22T14:33:27.86Z",
"lastUpdatedBy": "nostrud"
}
}
Copied to Clipboard
{
"title": "response",
"type": "object",
"properties": {
"status": {
"enum": [
"success",
"failure"
]
},
"message": {
"type": "string"
},
"doc": {
"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"
]
}
}
}
