Populate Restriction Values

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/Find/PopulateRestrictionValues");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
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}", false);
var response = await client.PostAsync(request);

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

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', '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
      }
    ]
  })
};

fetch('http://localhost:53294/api/v1/Agents/Find/PopulateRestrictionValues', 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 => "53294",
  CURLOPT_URL => "http://localhost:53294/api/v1/Agents/Find/PopulateRestrictionValues",
  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
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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:53294/api/v1/Agents/Find/PopulateRestrictionValues"

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
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', '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
      }
    ]
  })
};

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

[
  {
    "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,
    "InterOperator": "None",
    "UniqueHash": 123
  }
]

Populate Restriction Values

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/Find/PopulateRestrictionValues");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
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}", false);
var response = await client.PostAsync(request);

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

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', '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
      }
    ]
  })
};

fetch('http://localhost:53294/api/v1/Agents/Find/PopulateRestrictionValues', 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 => "53294",
  CURLOPT_URL => "http://localhost:53294/api/v1/Agents/Find/PopulateRestrictionValues",
  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
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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:53294/api/v1/Agents/Find/PopulateRestrictionValues"

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
        }
    ] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', '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
      }
    ]
  })
};

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

[
  {
    "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,
    "InterOperator": "None",
    "UniqueHash": 123
  }
]

Authorizations

Authorization

string

header

required

SuperOffice username:password are passed in Base64-encoded.

You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.

Authorization

string

header

required

SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/

passing in the application id and redirect URL.

SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)

https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f

You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.

FlowImplicit

Authorization URL: https://online.superoffice.com/login/common/oauth/authorize

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

PopulateRestrictionValues: Take an incoming set of Restrictions (name + operator + any user-entered values), and populate/expand all values as specified by the operator's ValueHints, taking into account any values already there. Used for dynamic date periods; perhaps others in the future

Restrictions

object[]

Show child attributes

Response

Name

string

The programmatic column name, including any required prefixes

Operator

string

The operator, such as =, etc

Values

string[]

Value(s) to test against

DisplayValues

string[]

Display representation of value(s) - list ID's are decoded to display texts, other values are represented in a format suitable for decoding and display through the {SuperOffice.CRM.Globalization.CultureDataFormatter}.

ColumnInfo

object

This class carries information about the definition and properties of an archive display column. It is used by the archive MDO providers to construct column lists for the configuration dialogs, and by the archive control to know what type (and other properties) each column has. The class is serializable and used on both the application and Web server sides.

Show child attributes

IsActive

boolean

Is this restriction active? Inactive restrictions will not influence the generated query

SubRestrictions

array

Optional collection of sub criteria, usually null but set for Saint counter fields

InterParenthesis

integer<int32>

Get or set the parenthesis (if any) associated with this restriction. Positive values indicate a number of opening parentheses (deepening nesting level), while negative numbers indicate closing parentheses. Zero means no change in nesting level (no parentheses).

InterOperator

enum<string>

Get or set the inter-restriction operator that describes how this restriction is related to the next one in an array. Default for new ArchiveRestrictionInfo objects is And

Available options:

None,

And,

Or

UniqueHash

integer<int32>