POST Agents/Archive/SetChosenEntitiesV2

Some tooltip text!

• 2 minutes to read

 • 2 minutes to read

POST /api/v1/Agents/Archive/SetChosenEntitiesV2

Set the currently chosen entities for the given gui name/provider name combination.

This service corresponds to the SetSelected method of the SelectableMDOList service, for a list called archiveEntities: plus the archive provider name and gui name as its additionalInfo.

Query String Parameters

Parameter Name	Type	Description
$select	string	Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

POST /api/v1/Agents/Archive/SetChosenEntitiesV2?$select=name,department,category/id

Request Headers

Parameter Name	Description
Authorization	Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN	If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type	Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept	Content-type(s) you would like the response in:
SO-AppToken	The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

GuiName, ProviderName, Context, OwnerKeys, Entities

Property Name	Type	Description
GuiName	String
ProviderName	String
Context	String
OwnerKeys	String
Entities	Array

Response:

No Content

Response	Description
204	No Content

Response body: TimeZoneData

Sample request

POST /api/v1/Agents/Archive/SetChosenEntitiesV2
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Content-Type: application/json; charset=utf-8

{
  "GuiName": "Tromp-Barton",
  "ProviderName": "Gleichner-Dicki",
  "Context": "error",
  "OwnerKeys": "perspiciatis",
  "Entities": [
    "aut",
    "quia"
  ]
}

Sample response

HTTP/1.1 204 No Content
Content-Type: application/json; charset=utf-8

null