...
...
General Information
...
| Service | API | Method | Data Model | Workflow |
|---|---|---|---|---|
| urac | /admin/group | PUT | Groups | Edit Group Flow |
Description
This API updates the record of a group that has an id that matches the one sent in the request body. The group should be in the tenant that has the external key sent in the request headers.
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id | Body | YES | String | N/A | Group ID | ||||||||||
| name | Body | YES | String | Group Name | |||||||||||
| description | Body | NO | String | Group Description | |||||||||||
| packages | Body | NO | Array | Array of Objects | Packages | ||||||||||
| |||||||||||||||
| environments | Body | NO | Array | Array of Strings | Environments | ||||||||||
Output
...
Response
SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response
Valid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
result: true,
data: 1true
} |
Invalid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"result":false,
"errors":{
"codes":[602],
"details":[
{
"code":602,
"message":"Model error: + %model_error%"
}
]
}
} |
Response schema
Follow this link to check out the response JSON response JSON Schema
SOAJS Error Codes
Code | Description |
|---|---|
| 400 | Business logic required data are missing |
| 602 | Model error: + %model_error% |