...
...
...
...
General Information
...
| Service | API | Method | Data Models | Workflow |
|---|---|---|---|---|
| urac | /admin/group | GET |
Data Model: Groups
| Groups | N/A |
Description
This API gets the group record that has the id or code that matches the one in the query. 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 | Query |
| NO | String | N/A | Group ID | |
| code | Query | NO | String | N/A |
| Group Code |
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": {
"..."
}
} |
Invalid Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
{ _id: "5d95da834dcd8a4d1d822ef5", code: "AAAA", name: "resultUnit test":false, "errors":description: "Added by unit test importer.", config: { "codes":[411],allowedPackages: { "details"DSBRD: [ "DSBRD_DEVOP" { ] "code":417,}, allowedEnvironments: { "message":"invalid group id provided" DEV: { } ]} } } |
...
Code | Description |
|---|---|
| 405 | Unable to find User. Please try again. |
| 411 | invalid user id provided |
...
Request
| Code Block | ||||
|---|---|---|---|---|
| ||||
> CURL -X GET http://127.0.0.1:4000/urac/admin/group?id=5d382063be668052c9cab94e |
Response
| Code Block | ||||
|---|---|---|---|---|
| ||||
, tenant: { "result": true, id: "5d9321f8b40e09438afbd0c9", code: "data": {test", "_id": ObjectId('5d382063be668052c9cab94e'),pin: { "locked": true, "code": "owner1235", "owner"allowed: true, "name": "Owner Group",} "description": "this is the owner group that owns the dashboard", } } } |
Invalid Response
| Code Block | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{ "result":false, "configerrors": { "allowedPackagescodes": { [602], "DSBRDdetails":[ [ { "DSBRD_OWNER" "code":602, ] } }, "message":"Model error: + "tenant%model_error%": { "id": "5c0e74ba9acc3c5a84a51259", } "code": "TES0" ] } } } |
Code | Description |
|---|---|
| 400 | Business logic required data are missing |
| 420 | Unable to find group |
| 602 | Model error: + %model_error% |