POST Agents/Archive/GetArchiveListByColumnsWithHeaderWithContext
Some tooltip text!
• 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. 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: *
Content-Type: application/json; charset=utf-8
{
"ProviderName": "Wisoky-Gleichner",
"Columns": [
"et",
"qui"
],
"SortOrder": [
{
"Name": "Williamson-Quigley",
"Direction": "ASC"
},
{
"Name": "Williamson-Quigley",
"Direction": "ASC"
}
],
"Restriction": [
{
"Name": "Littel-Lynch",
"Operator": "quia",
"Values": [
"libero",
"adipisci"
],
"DisplayValues": [
"aliquid",
"eius"
],
"ColumnInfo": null,
"IsActive": false,
"SubRestrictions": [
{},
{}
],
"InterParenthesis": 515,
"InterOperator": "And",
"UniqueHash": 487
}
],
"Entities": [
"placeat",
"pariatur"
],
"Page": 690,
"PageSize": 207,
"Options": "voluptas",
"Context": "a"
}
Sample response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"RowCount": 593,
"Rows": [
{
"EntityName": "Rohan LLC",
"PrimaryKey": 816,
"ColumnData": {
"fieldName": {
"DisplayValue": "corporis",
"TooltipHint": "culpa",
"LinkHint": "id"
}
},
"LinkHint": "harum",
"StyleHint": "cumque",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 337
}
}
}
],
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 748
}
}
}