POST Agents/Archive/GetArchiveListByColumnsWithHeaderWithContext

• 4 minutes to read
 • 4 minutes to read 
POST /api/v1/Agents/Archive/GetArchiveListByColumnsWithHeaderWithContext

Get a page of results for an archive list, with context parameter, explicitly specifying the restrictions, 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. NsApiSlow threshold: 5000 ms. Archive Restriction Info objects represent search terms.

Column names and operator strings are defined elsewhere.

Values should be encoded using the CultureDataFormatter, so 10 is "[I:10]". Default string encodings should be handled ok, but beware of non-invariant cultures leading to incorrect date and float parsing.


var restriction1 = new ArchiveRestrictionInfo("category", "equals", "[I:10]");

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/GetArchiveListByColumnsWithHeaderWithContext?$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 Array
SortOrder Array
Restriction Array
Entities Array
Page Integer
PageSize Integer
Options String
Context String

Response:

OK

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/GetArchiveListByColumnsWithHeaderWithContext
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "ProviderName": "Okuneva, Bartell and Boyle",
  "Columns": [
    "perspiciatis",
    "voluptas"
  ],
  "SortOrder": [
    {
      "Name": "Sporer LLC",
      "Direction": "ASC"
    },
    {
      "Name": "Sporer LLC",
      "Direction": "ASC"
    }
  ],
  "Restriction": [
    {
      "Name": "Kling-Becker",
      "Operator": "sint",
      "Values": [
        "dolorem",
        "magni"
      ],
      "DisplayValues": [
        "et",
        "dolorem"
      ],
      "ColumnInfo": null,
      "IsActive": true,
      "SubRestrictions": [
        {},
        {}
      ],
      "InterParenthesis": 314,
      "InterOperator": "And",
      "UniqueHash": 284
    }
  ],
  "Entities": [
    "quidem",
    "sit"
  ],
  "Page": 986,
  "PageSize": 884,
  "Options": "autem",
  "Context": "ab"
}

Sample response

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

{
  "RowCount": 896,
  "Rows": [
    {
      "EntityName": "ticket",
      "PrimaryKey": 301,
      "ColumnData": {
        "title": {
          "DisplayValue": "Unable to login to customer portal",
          "TooltipHint": "Customer reports authentication error",
          "LinkHint": "ticket.main?ticket_id=301"
        }
      },
      "LinkHint": "view-ticket",
      "StyleHint": "ticket-open",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 651
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 443
    }
  }
}