Find From Restrictions Columns

using RestSharp;


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

fetch('http://localhost:56350/api/v1/Agents/Find/FindFromRestrictionsColumns', 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/FindFromRestrictionsColumns",
  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([
    'Restrictions' => [
        [
                '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
        ]
    ],
    'ProviderName' => '<string>',
    'DesiredColumns' => [
        '<string>'
    ],
    'PageSize' => 123,
    'PageNumber' => 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/Find/FindFromRestrictionsColumns"

payload = {
    "Restrictions": [
        {
            "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
        }
    ],
    "ProviderName": "<string>",
    "DesiredColumns": ["<string>"],
    "PageSize": 123,
    "PageNumber": 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({
    Restrictions: [
      {
        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
      }
    ],
    ProviderName: '<string>',
    DesiredColumns: ['<string>'],
    PageSize: 123,
    PageNumber: 123
  })
};

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

{
  "ArchiveColumns": [
    {
      "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>"
    }
  ],
  "ArchiveRows": [
    {
      "EntityName": "<string>",
      "PrimaryKey": 123,
      "ColumnData": {},
      "LinkHint": "<string>",
      "StyleHint": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "RowCount": 123,
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Find From Restrictions Columns

Execute a Find operation and return a page of results.

The criteria for the Find are passed in directly, not fetched by a restriction storage provider. The desired columns of the result set are also passed in directly.The orderby information is calculated by the system.Use the GetCriteriaInformation and GetDefaultDesiredColumns service methods to let the system calculate these values, if you want to use or modify them. 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]”);

Find From Restrictions Columns

using RestSharp;


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

fetch('http://localhost:56350/api/v1/Agents/Find/FindFromRestrictionsColumns', 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/FindFromRestrictionsColumns",
  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([
    'Restrictions' => [
        [
                '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
        ]
    ],
    'ProviderName' => '<string>',
    'DesiredColumns' => [
        '<string>'
    ],
    'PageSize' => 123,
    'PageNumber' => 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/Find/FindFromRestrictionsColumns"

payload = {
    "Restrictions": [
        {
            "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
        }
    ],
    "ProviderName": "<string>",
    "DesiredColumns": ["<string>"],
    "PageSize": 123,
    "PageNumber": 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({
    Restrictions: [
      {
        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
      }
    ],
    ProviderName: '<string>',
    DesiredColumns: ['<string>'],
    PageSize: 123,
    PageNumber: 123
  })
};

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

{
  "ArchiveColumns": [
    {
      "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>"
    }
  ],
  "ArchiveRows": [
    {
      "EntityName": "<string>",
      "PrimaryKey": 123,
      "ColumnData": {},
      "LinkHint": "<string>",
      "StyleHint": "<string>",
      "TableRight": {
        "Mask": "<string>",
        "Reason": "<string>"
      },
      "FieldProperties": {}
    }
  ],
  "RowCount": 123,
  "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

Restrictions, ProviderName, DesiredColumns, PageSize, PageNumber

FindFromRestrictionsColumns: Execute a Find operation and return a page of results. The criteria for the Find are passed in directly, not fetched by a restriction storage provider. The desired columns of the result set are also passed in directly.The orderby information is calculated by the system.Use the GetCriteriaInformation and GetDefaultDesiredColumns service methods to let the system calculate these values, if you want to use or modify them.

Restrictions

object[]

Show child attributes

ProviderName

string

DesiredColumns

string[]

PageSize

integer<int32>

PageNumber

integer<int32>

Response

Result carrier for the Find operation. It contains a set of column specifications, and a set of row, where each row contains the columns. The row set is the result of carrying out some search operation. Carrier object for FindResults. Services for the FindResults Carrier is available from the Find Agent.

ArchiveColumns

object[]

Array of ColumnInfo column specifications

Show child attributes

ArchiveRows

object[]

Array of archive list items, i.e., the service layer carrier for archive rows. These are the find results, represented as archive rows

Show child attributes

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

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