POST Agents/Find/FindWithColumns

• 4 minutes to read
 • 4 minutes to read 
POST /api/v1/Agents/Find/FindWithColumns

Execute a Find operation and return a page of results.

The criteria for the Find are fetched from the restriction storage provider according to the given parameters.

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/Find/FindWithColumns?$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

StorageType, ProviderName, StorageKey, DesiredColumns, PageSize, PageNumber, OrderBy

Property Name Type Description
StorageType String
ProviderName String
StorageKey String
DesiredColumns Array
PageSize Integer
PageNumber Integer
OrderBy Array

Response:

OK

Response Description
200 OK

Response body: FindResults

Property Name Type Description
ArchiveColumns array Array of ColumnInfo column specifications
ArchiveRows array Array of archive list items, i.e., the service layer carrier for archive rows. These are the find results, represented as archive rows
RowCount int32 Count of rows, independent of paging. If you order up page 1 with page size 50, the row count may still be 279, that being the number of rows that would have been returned in a paging-off situation
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/Find/FindWithColumns
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "StorageType": "blanditiis",
  "ProviderName": "Krajcik-Lang",
  "StorageKey": "magni",
  "DesiredColumns": [
    "quo",
    "et"
  ],
  "PageSize": 204,
  "PageNumber": 226,
  "OrderBy": [
    {
      "Name": "Volkman, Wilkinson and Moore",
      "Direction": "ASC"
    },
    {
      "Name": "Volkman, Wilkinson and Moore",
      "Direction": "ASC"
    }
  ]
}

Sample response

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

{
  "ArchiveColumns": [
    {
      "DisplayName": "Wintheiser, Bergstrom and Bogisich",
      "DisplayTooltip": "amet",
      "DisplayType": "omnis",
      "CanOrderBy": false,
      "Name": "Weber LLC",
      "CanRestrictBy": true,
      "RestrictionType": "soluta",
      "RestrictionListName": "Macejkovic Group",
      "IsVisible": false,
      "ExtraInfo": "maiores",
      "Width": "commodi",
      "IconHint": "eaque",
      "HeadingIconHint": "cum"
    }
  ],
  "ArchiveRows": [
    {
      "EntityName": "Kilback, Bergnaum and Conroy",
      "PrimaryKey": 699,
      "ColumnData": {
        "fieldName": {
          "DisplayValue": "incidunt",
          "TooltipHint": "soluta",
          "LinkHint": "sed"
        }
      },
      "LinkHint": "porro",
      "StyleHint": "architecto",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 421
        }
      }
    }
  ],
  "RowCount": 942,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 132
    }
  }
}