POST api/group/{groupId}/bulksetsearchteam

Set the Team Group for multiple searching roles Processes this group API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
groupId

The unique identifier of the group resource.

integer

Required

Body Parameters

The bulk set group search team command data contract supplied with the request.

BulkSetGroupSearchTeamCommandDataContract
NameDescriptionTypeAdditional information
TeamGroupId

The unique identifier of the related team group resource.

integer

None.

GroupSearchingRoleIds

The unique identifiers of the related group searching role resources.

Collection of integer

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:
{
  "TeamGroupId": 1,
  "GroupSearchingRoleIds": [
    1,
    2
  ]
}

Response Information

Resource Description

The response returned after the operation completes.

JobInvocationDetailsDataContract
NameDescriptionTypeAdditional information
SupportsCancellation

Indicates whether supports cancellation is true.

boolean

None.

ReportsProgress

Indicates whether reports progress is true.

boolean

None.

InitialStatusText

The initial status text value.

string

None.

JobReference

The job reference globally unique identifier.

globally unique identifier

None.

Success

Indicates whether success is true.

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "23d4eba1-0296-4fc6-93ea-76cc51729f40",
  "Success": true
}