• Share
    • Twitter
    • LinkedIn
    • Facebook
    • Email
  • Feedback
  • Edit
Show / Hide Table of Contents

POST Agents/Find/SaveRestrictionsWithContext

Some tooltip text!
• 2 minutes to read
 • 2 minutes to read
POST /api/v1/Agents/Find/SaveRestrictionsWithContext

Save an array of restrictions for later use as search criteria (including as dynamic selection and Find).

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/SaveRestrictionsWithContext?$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:
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Request Body: request

StorageType, ProviderName, StorageKey, Restrictions, Context

Property Name Type Description
StorageType String
ProviderName String
StorageKey String
Restrictions Array
Context String

Response:

No Content

Response Description
204 No Content

Response body: TimeZoneData

Sample request

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

{
  "StorageType": "iste",
  "ProviderName": "Fisher LLC",
  "StorageKey": "molestias",
  "Restrictions": [
    {
      "Name": "Parisian-Bailey",
      "Operator": "cumque",
      "Values": [
        "voluptatem",
        "soluta"
      ],
      "DisplayValues": [
        "magni",
        "et"
      ],
      "ColumnInfo": null,
      "IsActive": false,
      "SubRestrictions": [
        {},
        {}
      ],
      "InterParenthesis": 396,
      "InterOperator": "And",
      "UniqueHash": 262
    }
  ],
  "Context": "harum"
}

Sample response

HTTP/1.1 204 No Content
Content-Type: application/json; charset=utf-8

null
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top