Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

General Information

...

ServiceAPIMethodData ModelWorkflow
urac

/admin/groups/environments

PUTGroups

Description

This API updates the environments of all the groups in groups array sent in the request body.

Input

...

Type: application/json
NameSourceMandatoryTypeSpecial FormatDescription
environmentsBodyYESArrayArray of StringsGroup Environments
groupsBodyYESObjectIncludes one of id or code arraysGroups object

One of the following should exist under the groups object:

NameMandatoryTypeSpecial FormatDescription
idsYESArrayArray of StringsUser ID
codesYESArrayArray of StringsUsername


Output

...

Response

SOAJS has a unified response. Check out this link to understand more the schema of SOAJS response 

Valid Response

Code Block
languagejs
titleValid Response Sample
linenumberstrue
collapsetrue
{ 
  result: true,
  data: true
}

Invalid Response

Code Block
languagejs
titleError Response Sample
linenumberstrue
collapsetrue
{
    "result":false,
    "errors":{
        "codes":[602],
        "details":[
            {
                "code":602,
                "message":"Model error: + %model_error%"
            }
        ]
    }
}

Response schema

Follow this link to check out the response JSON Schema

SOAJS Error Codes



Code
Description
400

Business logic required data are missing

602Model error: + %model_error%