Get Default Desired Columns From Restrictions2

using RestSharp;


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

fetch('http://localhost:56350/api/v1/Agents/Find/GetDefaultDesiredColumnsFromRestrictions2', 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/Find/GetDefaultDesiredColumnsFromRestrictions2",
  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>',
    'Restrictions' => '<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/Find/GetDefaultDesiredColumnsFromRestrictions2"

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

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

[
  {
    "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>"
  }
]

Get Default Desired Columns From Restrictions2

Calculate the default desired columns, i. e., the result columns for a given search. The search is defined by a provider name and a set of restrictions. This is the algorithm that is used by the Find service method. 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 />

using RestSharp;


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

fetch('http://localhost:56350/api/v1/Agents/Find/GetDefaultDesiredColumnsFromRestrictions2', 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/Find/GetDefaultDesiredColumnsFromRestrictions2",
  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>',
    'Restrictions' => '<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/Find/GetDefaultDesiredColumnsFromRestrictions2"

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

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

[
  {
    "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>"
  }
]

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, Restrictions

GetDefaultDesiredColumnsFromRestrictions2: Calculate the default desired columns, i.e., the result columns for a given search. The search is defined by a provider name and a set of restrictions. This is the algorithm that is used by the Find service method.

ProviderName

string

Restrictions

string

Response

DisplayName

string

The column name to show, can be a resource identifier string

The column tooltip, used in the column list and in the column headings

DisplayType

string

Type of column, so that the archive knows how to display it (actual display values are always strings, invariant-culture formatted). This name can contain resource tags.

CanOrderBy

boolean

Can this column be used for sorting?

Name

string

Unique identity of this column (in this particular context); the name to be used when requesting the column from a provider, setting restrictions or order by criteria

CanRestrictBy

boolean

Can this column be used as a restriction

RestrictionType

string

The data type of the restriction; use this to retrieve the legal operators for the restriction

RestrictionListName

string

If the restriction data type is 'list', this property contains the name of the SoList so that choices can be shown

IsVisible

boolean

Is this column visible to the user in configuration dialogs etc

ExtraInfo

string

Example: "navigator" -> Should this column be mapped to a hyperlinked navigator text type?

Width

string

The width specification, if the column info has been extended with GUI-based information. It is either "n%" or "nc", where n is an integer. Percent-formatted fields grow and shrink; number-of-characters formatted fields have constant width when the whole archive width changes.

IconHint

string

Icon hint corresponding to the display name; this icon hint is used in the configuration dialog and other places where we 'talk about' the columns of the archive. The actual heading of the archive may also contain icons in lieu of textual names, the icon hint for that is specified in {SuperOffice.CRM.ArchiveLists.ArchiveColumnInfo.HeadingIconHint} and is a different one.

HeadingIconHint

string

Icon hint for the archive heading only. If this is a nonempty string, the archive header should use this icon and ignore the {SuperOffice.CRM.ArchiveLists.ArchiveColumnInfo.DisplayName}. Otherwise, the DisplayName should be used as the heading.