Get Archive List2

using RestSharp;


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

fetch('http://localhost:56350/api/v1/Agents/Archive/GetArchiveList2', 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/GetArchiveList2",
  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' => '<string>',
    'Restriction' => '<string>',
    'Entities' => '<string>',
    'Page' => 123,
    'PageSize' => 123
  ]),
  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/GetArchiveList2"

payload = {
    "GuiName": "<string>",
    "ProviderName": "<string>",
    "SortOrder": "<string>",
    "Restriction": "<string>",
    "Entities": "<string>",
    "Page": 123,
    "PageSize": 123
}
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: '<string>',
    Restriction: '<string>',
    Entities: '<string>',
    Page: 123,
    PageSize: 123
  })
};

fetch('http://localhost:56350/api/v1/Agents/Archive/GetArchiveList2', 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 List2

Get a page of data for an archive using a restriction string. 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 strings are OData or SQL-ish. They are parsed and converted into ArchiveRestrictions. For example: <code> "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')" </code> Unary operators: <code>"updatedDate lastWeek", "assocId currentAssociate"</code><para /><h2>Brackets and or</h2> AND and OR can be used to combine terms. AND has a higher priority than OR <code>"business = 2 AND name contains 'super'"</code> Brackets can be used for grouping. <code>"(business = 2 or category = 3) and name contains 'super'"</code><para /><h2>Aggregation operators</h2> 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. <code> GroupBy(lastName):Header </code> 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. <code> Count(middleName):HideDetail:Footer </code> Example: the aggregator functions can nest, so you can say <code> GroupBy(DatePart(personUpdatedDate):YearMonth):Header </code><h2>Strings</h2> 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): <code>"department contains 'Bob\\'s'"</code><para />

Get Archive List2

using RestSharp;


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

fetch('http://localhost:56350/api/v1/Agents/Archive/GetArchiveList2', 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/GetArchiveList2",
  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' => '<string>',
    'Restriction' => '<string>',
    'Entities' => '<string>',
    'Page' => 123,
    'PageSize' => 123
  ]),
  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/GetArchiveList2"

payload = {
    "GuiName": "<string>",
    "ProviderName": "<string>",
    "SortOrder": "<string>",
    "Restriction": "<string>",
    "Entities": "<string>",
    "Page": 123,
    "PageSize": 123
}
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: '<string>',
    Restriction: '<string>',
    Entities: '<string>',
    Page: 123,
    PageSize: 123
  })
};

fetch('http://localhost:56350/api/v1/Agents/Archive/GetArchiveList2', 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

GetArchiveList2: Get a page of data for an archive using a restriction string. 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

string

Restriction

string

Entities

string

Page

integer<int32>

PageSize

integer<int32>

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