POST Agents/Find/PopulateRestrictions

• 4 minutes to read
 • 4 minutes to read 
POST /api/v1/Agents/Find/PopulateRestrictions

Take an incoming set of minimally populated restrictions (name + operator is required), and populate all the other parts of the ArchiveRestrictionInfo structure.

This includes column information, display values (including list value lookup), and calculated/default values where the value hints specify read-only (R). NsApiSlow threshold: 5000 ms.

Query String Parameters

Parameter Name Type Description
$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. 
POST /api/v1/Agents/Find/PopulateRestrictions?$select=name,department,category/id

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

ProviderName, Restrictions

Property Name Type Description
ProviderName String
Restrictions Array

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
Name string The programmatic column name, including any required prefixes
Operator string The operator, such as =, etc
Values array Value(s) to test against
DisplayValues array 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 ArchiveColumnInfo Optional complete ArchiveColumnInfo for this restriction; in that case, ColumnInfo.Name == this.Name will always be true
IsActive bool 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 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 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
UniqueHash int32

Sample request

POST /api/v1/Agents/Find/PopulateRestrictions
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *
Content-Type: application/json; charset=utf-8

{
  "ProviderName": "DuBuque LLC",
  "Restrictions": [
    {
      "Name": "Glover, Frami and Blick",
      "Operator": "est",
      "Values": [
        "voluptatibus",
        "dolor"
      ],
      "DisplayValues": [
        "qui",
        "maxime"
      ],
      "ColumnInfo": null,
      "IsActive": true,
      "SubRestrictions": [
        {},
        {}
      ],
      "InterParenthesis": 312,
      "InterOperator": "And",
      "UniqueHash": 142
    }
  ]
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "Name": "Lindgren-Friesen",
    "Operator": "praesentium",
    "Values": [
      "quaerat",
      "quae"
    ],
    "DisplayValues": [
      "numquam",
      "omnis"
    ],
    "ColumnInfo": null,
    "IsActive": false,
    "SubRestrictions": [
      {
        "Name": "McLaughlin-Metz",
        "Operator": "id",
        "Values": [
          "quo",
          "ut"
        ],
        "DisplayValues": [
          "nemo",
          "aut"
        ],
        "ColumnInfo": null,
        "IsActive": true,
        "SubRestrictions": [
          {},
          {}
        ],
        "InterParenthesis": 824,
        "InterOperator": "And",
        "UniqueHash": 253
      }
    ],
    "InterParenthesis": 783,
    "InterOperator": "And",
    "UniqueHash": 98
  }
]