POST Agents/Configuration/GetConfigurableScreenDelta

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Configuration/GetConfigurableScreenDelta

Gets a ConfigurableScreenDelta object.

NsApiSlow threshold: 5000 ms.

Query String Parameters

Parameter Name Type Description
configurableScreenDeltaId int32 Required The identifier of the ConfigurableScreenDelta object
$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/Configuration/GetConfigurableScreenDelta?configurableScreenDeltaId=861
POST /api/v1/Agents/Configuration/GetConfigurableScreenDelta?$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
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.

Response:

OK

Response Description
200 OK

Response body: TimeZoneData

Property Name Type Description
ConfigurableScreenDeltaId int32
Name string
Description string
DeltaJson string
DeltaType string
DeltaState string
RecipeId string
UpdatedDate date-time
CreatedDate date-time
UpdatedBy Associate Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
CreatedBy Associate Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.
AppliesToIds array
AppliesToKey string
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Configuration/GetConfigurableScreenDelta
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

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

{
  "ConfigurableScreenDeltaId": 456,
  "Name": "Contact Custom Fields",
  "Description": "Additional fields for contact management",
  "DeltaJson": "{\"fields\":[{\"name\":\"Industry\",\"type\":\"list\",\"required\":true},{\"name\":\"AnnualRevenue\",\"type\":\"decimal\",\"required\":false}]}",
  "DeltaType": "CustomFields",
  "DeltaState": "Published",
  "RecipeId": "contact-extra-fields-v2",
  "UpdatedDate": "2024-11-20T09:15:00+01:00",
  "CreatedDate": "2024-10-15T14:30:00+02:00",
  "UpdatedBy": null,
  "CreatedBy": null,
  "AppliesToIds": [
    1,
    2,
    3
  ],
  "AppliesToKey": "contact-card",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 492
    }
  }
}