Upsert Composite RG Members

Upserts runtime groups as a member of a composite runtime group.

put

Path Parameters

idstringrequired

ID of a composite runtime group

Body

application/json

Request body for upserting a list of child runtime groups to a composite runtime group membership.

membersarray[object]
Show Child Parameters

Response

No Content

put/runtime-groups/{id}/composite-memberships

Body

{ "members": [ { "id": "1beb9ad3-d21b-4090-b6e3-574784d1166d" }, { "id": "778a0474-687d-41af-8e51-a0488d790586" }, { "id": "fa85f8e8-2e5a-496e-b6d0-4e534eaab459" } ] }
 

Add Composite RG Members

Adds one or more runtime groups as a member of a composite runtime group.

post

Path Parameters

idstringrequired

ID of a composite runtime group

Body

application/json

Request body for adding a list of child runtime groups to a composite runtime group membership.

membersarray[object]
Show Child Parameters

Response

No Content

post/runtime-groups/{id}/composite-memberships/add

Body

{ "members": [ { "id": "1beb9ad3-d21b-4090-b6e3-574784d1166d" }, { "id": "778a0474-687d-41af-8e51-a0488d790586" }, { "id": "fa85f8e8-2e5a-496e-b6d0-4e534eaab459" } ] }
 

Remove Composite RG Members

Removes one or more runtime groups from the members of a composite runtime group.

post

Path Parameters

idstringrequired

ID of a composite runtime group

Body

application/json

Request body for removing a list of child runtime groups from a composite runtime group membership.

membersarray[object]
Show Child Parameters

Response

No Content

post/runtime-groups/{id}/composite-memberships/remove

Body

{ "members": [ { "id": "1beb9ad3-d21b-4090-b6e3-574784d1166d" }, { "id": "778a0474-687d-41af-8e51-a0488d790586" }, { "id": "fa85f8e8-2e5a-496e-b6d0-4e534eaab459" } ] }
 

Get Composite Membership Status

Determines the composite membership status of a runtime group.

get

Path Parameters

idstringrequired

ID of a runtime group

Response

application/json

Determines the composite membership status of a runtime group.

CompositeMemberStatus

Object with information determining the composite membership status of a runtime group.

is_memberbooleanrequiredread-only

Boolean indicating if a runtime group is a member of a composite runtime group.

Example:true

get/runtime-groups/{id}/composite-member-status
 
application/json

Get Composite RG Status

Returns the status of a composite runtime group, including existing conflicts.

get

Path Parameters

idstringrequired

ID of a composite runtime group

Response

application/json

Status of a composite runtime group, including existing conflicts.

CompositeStatus

The Composite Status object contains information about the status of a composite runtime group.

idstring(uuid)read-only

The composite runtime group ID.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)read-only

An ISO-8604 timestamp representation of composite runtime group status creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8604 timestamp representation of composite runtime group status update date.

Example:2022-11-04T20:10:06.927Z

conflictsarray[object]

The Composite Conflict object contains information about a conflict in a composite runtime group.

<= 256 items

Show Child Parameters
statestringread-only

The state of the composite runtime group.

Allowed values:COMPOSITE_STATE_OKCOMPOSITE_STATE_CONFLICTCOMPOSITE_STATE_UNKNOWN

Example:COMPOSITE_STATE_CONFLICT

get/runtime-groups/{id}/composite-status
 
application/json