Get Archive List With Context

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Archive/GetArchiveListWithContext");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"GuiName\": \"<string>\",\n  \"ProviderName\": \"<string>\",\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  \"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({
    GuiName: '<string>',
    ProviderName: '<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,
    Context: '<string>'
  })
};

fetch('http://localhost:56350/api/v1/Agents/Archive/GetArchiveListWithContext', 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/GetArchiveListWithContext",
  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([
    'GuiName' => '<string>',
    'ProviderName' => '<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,
    '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/GetArchiveListWithContext"

payload = {
    "GuiName": "<string>",
    "ProviderName": "<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,
    "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({
    GuiName: '<string>',
    ProviderName: '<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,
    Context: '<string>'
  })
};

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

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

Get Archive List With Context

Get a page of data for an archive, with context parameter.

The columns returned will be those set as chosen columns, using either the SetChosenColumns service or the corresponding SelectableMDOList.SetSelected. 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 With Context

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Archive/GetArchiveListWithContext");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"GuiName\": \"<string>\",\n  \"ProviderName\": \"<string>\",\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  \"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({
    GuiName: '<string>',
    ProviderName: '<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,
    Context: '<string>'
  })
};

fetch('http://localhost:56350/api/v1/Agents/Archive/GetArchiveListWithContext', 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/GetArchiveListWithContext",
  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([
    'GuiName' => '<string>',
    'ProviderName' => '<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,
    '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/GetArchiveListWithContext"

payload = {
    "GuiName": "<string>",
    "ProviderName": "<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,
    "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({
    GuiName: '<string>',
    ProviderName: '<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,
    Context: '<string>'
  })
};

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

[
  {
    "EntityName": "<string>",
    "PrimaryKey": 123,
    "ColumnData": {},
    "LinkHint": "<string>",
    "StyleHint": "<string>",
    "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

GuiName, ProviderName, SortOrder, Restriction, Entities, Page, PageSize, Context

GetArchiveListWithContext: Get a page of data for an archive, with context parameter. The columns returned will be those set as chosen columns, using either the SetChosenColumns service or the corresponding SelectableMDOList.SetSelected.

GuiName

string

ProviderName

string

SortOrder

object[]

Show child attributes

Restriction

object[]

Show child attributes

Entities

string[]

Page

integer<int32>

PageSize

integer<int32>

Context

string

Response

EntityName

string

The entity name of the ArchiveListItem. An ArchiveList may contain rows from different entities.

PrimaryKey

integer<int32>

The primary key for the row

ColumnData

object

Dictionary of column name - column data items. Each column data item contains a display value, a tooltip hint, a link hint, and an orderby value. The display value is encoded by the CultureDataFormatter and can be decoded / localized by that class; all other values are optional. Tooltip hints can be passed to the TooltipProvider (Tooltip service) to be translated into an actual tootip.

Show child attributes

LinkHint

string

Link hint for the row, indicating things like navigation links that can be presented as clickable hyperlinks

StyleHint

string

Style hint for the row, for instance 'retired' for associates or 'private' for appointments. Presentation layers can interpret the style hints as they see fit.

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