General Information
...
| Service | API | Method |
|---|
| urac | /admin/group/edit |
GET
Data Model: %Link to Data Model% Groups
Workflow: %Link to Architecture Page% Edit Group Flow
Input
...
Type: application/json
| Name | Source | Mandatory | Type | Special Format | Description |
|---|
|
|---|
| gId | Query | YES | String | N/A | The Group ID |
| name | Body | YES | String | N/A |
|
| description | Body | YES | String | N/A |
|
| Name | Source | Mandatory | Type | Special Format | Description |
|---|
| gId | Query | YES | String | N/A | The Group ID |
| name | Body | YES | String | N/A |
|
| description | Body | YES | String | N/A |
|
| config | Body | YES | Object | N/A |
|
| allowedPackages |
| YES | Object | N/A |
|
|
| ^([A-Za-z0-9]+)$ |
| YES | Array of strings |
| 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. |
| allowedEnvironments |
| NO | Object | N/A |
|
|
| ^([A-Za-z]+)$ |
| NO | Object | N/A | The environment code with empty object for now |
Output
...
Valid Response
| Code Block |
|---|
| language | js |
|---|
| title | Valid Response Sample |
|---|
|
{
"result": true,
"data": {
"..."
}true
} |
...
Invalid Response
| Code Block |
|---|
| language | js |
|---|
| title | Error Response Sample |
|---|
|
{
"result":false,
"errors":{
"codes":[400417],
"details":[
{
"code":400417,
"message":"ProblemInvalid withgroup theid provided password"
}
]
}
} |
Error Codes
| 400 | Database Error |
|---|
| 417 | Invalid group id provided |
| 418 | Unable to edit Group. |
Example (CURL)
...
Request
| Code Block |
|---|
| language | bash |
|---|
| title | Calling YOUR Edit Group API |
|---|
|
> CURL -X POST http://127.0.0.1:4000/... |
Response
| Code Block |
|---|
| language | js |
|---|
| title | YOUR API response |
|---|
|
{
"result": true,
"data/urac/admin/group/edit?gId=5 -d '{
"name": "Silver Group",
"description": "grp description",
"config": {
"allowedPackages": {
"_idprod": ["57063608622c47b5c097d19bpack"]
},
"allowedEnvironments": {
"..."PROD": {}
}
}
}' |
Response
| Code Block |
|---|
| language | js |
|---|
| title | Edit Group API response |
|---|
|
{
"result": true,
"data": true
} |