POST Agents/Selection/GetSelectionForFind

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Selection/GetSelectionForFind

Obtain a selection for the given entity, for the current user, of type WorkingSetForFind.

Optionally populate criteria from the TypicalSearches system

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/Selection/GetSelectionForFind?$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: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

EntityName, TypicalSearchId

Property Name Type Description
EntityName String
TypicalSearchId Integer

Response:

OK

Response Description
200 OK

Response body: SelectionForFind

Property Name Type Description
ProviderName string The name of the Archive Provider to use when working with this selection; this is the main entity provider, never Shadow, Combined or anything else fancy
SelectionId int32 Primary key
CanSaveAsSelection bool Most Find entities support saving the search as a Dynamic Selection: this bool indicates if that is the case
MainHeading string 'Sale', intended for the main headings in the Find front page; this string will contain resource references
FilterScreenHeading string 'Find sale', or whatever is appropriate for the Find <entity> filter page; this string will contain resource references
SelectionEntityHeading string 'Companies', or whatever else is appropriate - the plural form of the entity name, intended for the Selection.Details tab before it is saved (!!); this string will contain resource references
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Selection/GetSelectionForFind
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv
Content-Type: application/json; charset=utf-8

{
  "EntityName": "Fadel-Mueller",
  "TypicalSearchId": 191
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "ProviderName": "Auer LLC",
  "SelectionId": 878,
  "CanSaveAsSelection": false,
  "MainHeading": "tempora",
  "FilterScreenHeading": "maiores",
  "SelectionEntityHeading": "modi",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 782
    }
  }
}