POST Agents/Archive/GetArchiveListByColumnsWithHeaderWithContext2

• 5 minutes to read

POST /api/v1/Agents/Archive/GetArchiveListByColumnsWithHeaderWithContext2

Get a page of results for an archive list, with context parameter, explicitly specifying the restrictions as strings, orderby and chosen columns; as well as a name/value string formatted set of options.

The return value includes a header that has various extra information, in addition to the actual rows.

Archive Restriction strings are OData or SQL-ish. They are parsed and converted into ArchiveRestrictions.

For example:


"name begins 'Super'"
"category = 3"
"category in (2,3,4)"
"xstop set"
"registered after '2014.3.4'"
"registered dateBetween ('2014.11.29', '2014.12.25')"

Unary operators:

"updatedDate lastWeek", "assocId currentAssociate"

Brackets and or

AND and OR can be used to combine terms. AND has a higher priority than OR

"business = 2  AND name contains 'super'"

Brackets can be used for grouping.

"(business = 2 or category = 3) and name contains 'super'"

Aggregation operators

The column names can encode grouping and summarizing. You add functions and modifiers to the column name to trigger aggregation.

Example: group last names together, and inject a header row for each group.


GroupBy(lastName):Header

Example: count instances of middle names, and hide the individual rows, report just the totals for each group using a footer. Note how the modifiers stack.


Count(middleName):HideDetail:Footer

Example: the aggregator functions can nest, so you can say


GroupBy(DatePart(personUpdatedDate):YearMonth):Header

Strings

Use the begins or contains operators to do string searches. You can also use the normal = operator to do string exact match checks.

Use backslash to escape single quotes in strings (note that backslash needs to be doubled because c# also uses backslash escapes):

"department contains 'Bob\\'s'"

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/GetArchiveListByColumnsWithHeaderWithContext2?$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

ProviderName, Columns, SortOrder, Restriction, Entities, Page, PageSize, Options, Context

Property Name	Type	Description
ProviderName	String
Columns	String
SortOrder	String
Restriction	String
Entities	String
Page	Integer
PageSize	Integer
Options	String
Context	String

Response:

Response	Description
200	OK

Response body: ArchiveListResult

Property Name	Type	Description
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
Rows	array	The actual rows, according to the paging info, of the result. See RowCount for a paging-independent count estimate
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/Archive/GetArchiveListByColumnsWithHeaderWithContext2
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Content-Type: application/json; charset=utf-8

{
  "ProviderName": "Bayer-Bartoletti",
  "Columns": "modi",
  "SortOrder": "quisquam",
  "Restriction": "neque",
  "Entities": "voluptatibus",
  "Page": 609,
  "PageSize": 134,
  "Options": "rem",
  "Context": "sequi"
}

Sample response

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

{
  "RowCount": 437,
  "Rows": [
    {
      "EntityName": "Trantow LLC",
      "PrimaryKey": 498,
      "ColumnData": {
        "fieldName": {
          "DisplayValue": "et",
          "TooltipHint": "nulla",
          "LinkHint": "corporis"
        }
      },
      "LinkHint": "nam",
      "StyleHint": "expedita",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 867
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 853
    }
  }
}