...
...
...
...
...
...
...
...
General Information
...
| Service | API | Method | Data Model | Workflow |
|---|---|---|---|---|
| urac | /admin/group |
| PUT |
...
...
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 |
Then keys should follow the pattern :
^([A-Za-z0-9]+)$
The key is the product code.
The strings inside the array are the package codes.
Output
| 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": true
} |
Invalid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"result":false,
"errors":{
"codes":[417602],
"details":[
{
"code":417602,
"message":"InvalidModel grouperror: id+ provided%model_error%"
}
]
}
} |
Code | Description |
|---|
Request
| Code Block | ||||
|---|---|---|---|---|
| ||||
> CURL -X POST http://127.0.0.1:4000/urac/admin/group/edit?gId=5 -d '{
"name": "Some Group",
"description": "group description",
"config": {
"allowedPackages": {
"prod": ["pack"]
},
"allowedEnvironments": {
"PROD": {}
}
}
}' |
Response
...
| language | js |
|---|---|
| title | Edit Group API response |
...
| 400 | Business logic required data are missing |
| 602 | Model error: + %model_error% |