Get Archive List By Columns With Header With Context

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Archive/GetArchiveListByColumnsWithHeaderWithContext");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"ProviderName\": \"<string>\",\n  \"Columns\": [\n    \"<string>\"\n  ],\n  \"SortOrder\": [\n    {\n      \"Name\": \"<string>\"\n    }\n  ],\n  \"Restriction\": [\n    {\n      \"Name\": \"<string>\",\n      \"Operator\": \"<string>\",\n      \"Values\": [\n        \"<string>\"\n      ],\n      \"DisplayValues\": [\n        \"<string>\"\n      ],\n      \"ColumnInfo\": {\n        \"DisplayName\": \"<string>\",\n        \"DisplayTooltip\": \"<string>\",\n        \"DisplayType\": \"<string>\",\n        \"CanOrderBy\": true,\n        \"Name\": \"<string>\",\n        \"CanRestrictBy\": true,\n        \"RestrictionType\": \"<string>\",\n        \"RestrictionListName\": \"<string>\",\n        \"IsVisible\": true,\n        \"ExtraInfo\": \"<string>\",\n        \"Width\": \"<string>\",\n        \"IconHint\": \"<string>\",\n        \"HeadingIconHint\": \"<string>\"\n      },\n      \"IsActive\": true,\n      \"SubRestrictions\": \"<array>\",\n      \"InterParenthesis\": 123,\n      \"UniqueHash\": 123\n    }\n  ],\n  \"Entities\": [\n    \"<string>\"\n  ],\n  \"Page\": 123,\n  \"PageSize\": 123,\n  \"Options\": \"<string>\",\n  \"Context\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    ProviderName: '<string>',
    Columns: ['<string>'],
    SortOrder: [{Name: '<string>'}],
    Restriction: [
      {
        Name: '<string>',
        Operator: '<string>',
        Values: ['<string>'],
        DisplayValues: ['<string>'],
        ColumnInfo: {
          DisplayName: '<string>',
          DisplayTooltip: '<string>',
          DisplayType: '<string>',
          CanOrderBy: true,
          Name: '<string>',
          CanRestrictBy: true,
          RestrictionType: '<string>',
          RestrictionListName: '<string>',
          IsVisible: true,
          ExtraInfo: '<string>',
          Width: '<string>',
          IconHint: '<string>',
          HeadingIconHint: '<string>'
        },
        IsActive: true,
        SubRestrictions: '<array>',
        InterParenthesis: 123,
        UniqueHash: 123
      }
    ],
    Entities: ['<string>'],
    Page: 123,
    PageSize: 123,
    Options: '<string>',
    Context: '<string>'
  })
};

fetch('http://localhost:56350/api/v1/Agents/Archive/GetArchiveListByColumnsWithHeaderWithContext', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Archive/GetArchiveListByColumnsWithHeaderWithContext",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ProviderName' => '<string>',
    'Columns' => [
        '<string>'
    ],
    'SortOrder' => [
        [
                'Name' => '<string>'
        ]
    ],
    'Restriction' => [
        [
                'Name' => '<string>',
                'Operator' => '<string>',
                'Values' => [
                                '<string>'
                ],
                'DisplayValues' => [
                                '<string>'
                ],
                'ColumnInfo' => [
                                'DisplayName' => '<string>',
                                'DisplayTooltip' => '<string>',
                                'DisplayType' => '<string>',
                                'CanOrderBy' => true,
                                'Name' => '<string>',
                                'CanRestrictBy' => true,
                                'RestrictionType' => '<string>',
                                'RestrictionListName' => '<string>',
                                'IsVisible' => true,
                                'ExtraInfo' => '<string>',
                                'Width' => '<string>',
                                'IconHint' => '<string>',
                                'HeadingIconHint' => '<string>'
                ],
                'IsActive' => true,
                'SubRestrictions' => '<array>',
                'InterParenthesis' => 123,
                'UniqueHash' => 123
        ]
    ],
    'Entities' => [
        '<string>'
    ],
    'Page' => 123,
    'PageSize' => 123,
    'Options' => '<string>',
    'Context' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/Agents/Archive/GetArchiveListByColumnsWithHeaderWithContext"

payload = {
    "ProviderName": "<string>",
    "Columns": ["<string>"],
    "SortOrder": [{ "Name": "<string>" }],
    "Restriction": [
        {
            "Name": "<string>",
            "Operator": "<string>",
            "Values": ["<string>"],
            "DisplayValues": ["<string>"],
            "ColumnInfo": {
                "DisplayName": "<string>",
                "DisplayTooltip": "<string>",
                "DisplayType": "<string>",
                "CanOrderBy": True,
                "Name": "<string>",
                "CanRestrictBy": True,
                "RestrictionType": "<string>",
                "RestrictionListName": "<string>",
                "IsVisible": True,
                "ExtraInfo": "<string>",
                "Width": "<string>",
                "IconHint": "<string>",
                "HeadingIconHint": "<string>"
            },
            "IsActive": True,
            "SubRestrictions": "<array>",
            "InterParenthesis": 123,
            "UniqueHash": 123
        }
    ],
    "Entities": ["<string>"],
    "Page": 123,
    "PageSize": 123,
    "Options": "<string>",
    "Context": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    ProviderName: '<string>',
    Columns: ['<string>'],
    SortOrder: [{Name: '<string>'}],
    Restriction: [
      {
        Name: '<string>',
        Operator: '<string>',
        Values: ['<string>'],
        DisplayValues: ['<string>'],
        ColumnInfo: {
          DisplayName: '<string>',
          DisplayTooltip: '<string>',
          DisplayType: '<string>',
          CanOrderBy: true,
          Name: '<string>',
          CanRestrictBy: true,
          RestrictionType: '<string>',
          RestrictionListName: '<string>',
          IsVisible: true,
          ExtraInfo: '<string>',
          Width: '<string>',
          IconHint: '<string>',
          HeadingIconHint: '<string>'
        },
        IsActive: true,
        SubRestrictions: '<array>',
        InterParenthesis: 123,
        UniqueHash: 123
      }
    ],
    Entities: ['<string>'],
    Page: 123,
    PageSize: 123,
    Options: '<string>',
    Context: '<string>'
  })
};

fetch('http://localhost:56350/api/v1/Agents/Archive/GetArchiveListByColumnsWithHeaderWithContext', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "RowCount": 123,
  "Rows": [
    {
      "EntityName": "<string>",
      "PrimaryKey": 123,
      "ColumnData": {},
      "LinkHint": "<string>",
      "StyleHint": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Get Archive List By Columns With Header With Context

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]”);

Get Archive List By Columns With Header With Context

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Archive/GetArchiveListByColumnsWithHeaderWithContext");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"ProviderName\": \"<string>\",\n  \"Columns\": [\n    \"<string>\"\n  ],\n  \"SortOrder\": [\n    {\n      \"Name\": \"<string>\"\n    }\n  ],\n  \"Restriction\": [\n    {\n      \"Name\": \"<string>\",\n      \"Operator\": \"<string>\",\n      \"Values\": [\n        \"<string>\"\n      ],\n      \"DisplayValues\": [\n        \"<string>\"\n      ],\n      \"ColumnInfo\": {\n        \"DisplayName\": \"<string>\",\n        \"DisplayTooltip\": \"<string>\",\n        \"DisplayType\": \"<string>\",\n        \"CanOrderBy\": true,\n        \"Name\": \"<string>\",\n        \"CanRestrictBy\": true,\n        \"RestrictionType\": \"<string>\",\n        \"RestrictionListName\": \"<string>\",\n        \"IsVisible\": true,\n        \"ExtraInfo\": \"<string>\",\n        \"Width\": \"<string>\",\n        \"IconHint\": \"<string>\",\n        \"HeadingIconHint\": \"<string>\"\n      },\n      \"IsActive\": true,\n      \"SubRestrictions\": \"<array>\",\n      \"InterParenthesis\": 123,\n      \"UniqueHash\": 123\n    }\n  ],\n  \"Entities\": [\n    \"<string>\"\n  ],\n  \"Page\": 123,\n  \"PageSize\": 123,\n  \"Options\": \"<string>\",\n  \"Context\": \"<string>\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    ProviderName: '<string>',
    Columns: ['<string>'],
    SortOrder: [{Name: '<string>'}],
    Restriction: [
      {
        Name: '<string>',
        Operator: '<string>',
        Values: ['<string>'],
        DisplayValues: ['<string>'],
        ColumnInfo: {
          DisplayName: '<string>',
          DisplayTooltip: '<string>',
          DisplayType: '<string>',
          CanOrderBy: true,
          Name: '<string>',
          CanRestrictBy: true,
          RestrictionType: '<string>',
          RestrictionListName: '<string>',
          IsVisible: true,
          ExtraInfo: '<string>',
          Width: '<string>',
          IconHint: '<string>',
          HeadingIconHint: '<string>'
        },
        IsActive: true,
        SubRestrictions: '<array>',
        InterParenthesis: 123,
        UniqueHash: 123
      }
    ],
    Entities: ['<string>'],
    Page: 123,
    PageSize: 123,
    Options: '<string>',
    Context: '<string>'
  })
};

fetch('http://localhost:56350/api/v1/Agents/Archive/GetArchiveListByColumnsWithHeaderWithContext', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Archive/GetArchiveListByColumnsWithHeaderWithContext",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ProviderName' => '<string>',
    'Columns' => [
        '<string>'
    ],
    'SortOrder' => [
        [
                'Name' => '<string>'
        ]
    ],
    'Restriction' => [
        [
                'Name' => '<string>',
                'Operator' => '<string>',
                'Values' => [
                                '<string>'
                ],
                'DisplayValues' => [
                                '<string>'
                ],
                'ColumnInfo' => [
                                'DisplayName' => '<string>',
                                'DisplayTooltip' => '<string>',
                                'DisplayType' => '<string>',
                                'CanOrderBy' => true,
                                'Name' => '<string>',
                                'CanRestrictBy' => true,
                                'RestrictionType' => '<string>',
                                'RestrictionListName' => '<string>',
                                'IsVisible' => true,
                                'ExtraInfo' => '<string>',
                                'Width' => '<string>',
                                'IconHint' => '<string>',
                                'HeadingIconHint' => '<string>'
                ],
                'IsActive' => true,
                'SubRestrictions' => '<array>',
                'InterParenthesis' => 123,
                'UniqueHash' => 123
        ]
    ],
    'Entities' => [
        '<string>'
    ],
    'Page' => 123,
    'PageSize' => 123,
    'Options' => '<string>',
    'Context' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/Agents/Archive/GetArchiveListByColumnsWithHeaderWithContext"

payload = {
    "ProviderName": "<string>",
    "Columns": ["<string>"],
    "SortOrder": [{ "Name": "<string>" }],
    "Restriction": [
        {
            "Name": "<string>",
            "Operator": "<string>",
            "Values": ["<string>"],
            "DisplayValues": ["<string>"],
            "ColumnInfo": {
                "DisplayName": "<string>",
                "DisplayTooltip": "<string>",
                "DisplayType": "<string>",
                "CanOrderBy": True,
                "Name": "<string>",
                "CanRestrictBy": True,
                "RestrictionType": "<string>",
                "RestrictionListName": "<string>",
                "IsVisible": True,
                "ExtraInfo": "<string>",
                "Width": "<string>",
                "IconHint": "<string>",
                "HeadingIconHint": "<string>"
            },
            "IsActive": True,
            "SubRestrictions": "<array>",
            "InterParenthesis": 123,
            "UniqueHash": 123
        }
    ],
    "Entities": ["<string>"],
    "Page": 123,
    "PageSize": 123,
    "Options": "<string>",
    "Context": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    ProviderName: '<string>',
    Columns: ['<string>'],
    SortOrder: [{Name: '<string>'}],
    Restriction: [
      {
        Name: '<string>',
        Operator: '<string>',
        Values: ['<string>'],
        DisplayValues: ['<string>'],
        ColumnInfo: {
          DisplayName: '<string>',
          DisplayTooltip: '<string>',
          DisplayType: '<string>',
          CanOrderBy: true,
          Name: '<string>',
          CanRestrictBy: true,
          RestrictionType: '<string>',
          RestrictionListName: '<string>',
          IsVisible: true,
          ExtraInfo: '<string>',
          Width: '<string>',
          IconHint: '<string>',
          HeadingIconHint: '<string>'
        },
        IsActive: true,
        SubRestrictions: '<array>',
        InterParenthesis: 123,
        UniqueHash: 123
      }
    ],
    Entities: ['<string>'],
    Page: 123,
    PageSize: 123,
    Options: '<string>',
    Context: '<string>'
  })
};

fetch('http://localhost:56350/api/v1/Agents/Archive/GetArchiveListByColumnsWithHeaderWithContext', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "RowCount": 123,
  "Rows": [
    {
      "EntityName": "<string>",
      "PrimaryKey": 123,
      "ColumnData": {},
      "LinkHint": "<string>",
      "StyleHint": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$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.

Body

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

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.

ProviderName

string

Columns

string[]

SortOrder

object[]

Show child attributes

Restriction

object[]

Show child attributes

Entities

string[]

Page

integer<int32>

PageSize

integer<int32>

Options

string

Context

string

Response

Header/Detail variant of archive result, with a Row Count plus the actual rows. Future extensions may include other header data on the same level as the RowCount Carrier object for ArchiveListResult. Services for the ArchiveListResult Carrier is available from the Archive Agent.

RowCount

integer<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

object[]

The actual rows, according to the paging info, of the result. See RowCount for a paging-independent count estimate

Show child attributes

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes