POST Agents/CRMScript/GetCRMScriptByUniqueIdentifier

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/CRMScript/GetCRMScriptByUniqueIdentifier

Get information about a script from a unique identifier

Online Restricted: ## The CRMScript agent is not available in Online by default. Access must be requested specifically when app is registered.

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/CRMScript/GetCRMScriptByUniqueIdentifier?$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

UniqueIdentifier

Property Name Type Description
UniqueIdentifier String

Response:

OK

Response Description
200 OK

Response body: Script

Property Name Type Description
UniqueIdentifier string Global unique identifier, accross customers/tenants
Name string A description of this script
Description string Optional description of what this script is used for.
IncludeId string A unique name used for including this script in another
Source string The script
Registered date-time Registered when in UTC.
RegisteredBy string Who created this script
Updated date-time Last updated when in UTC.
UpdatedBy string Who updated this script
Path string Path to script in the hierarchy.
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/CRMScript/GetCRMScriptByUniqueIdentifier
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *
Content-Type: application/json; charset=utf-8

{
  "UniqueIdentifier": "perferendis"
}

Sample response

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

{
  "UniqueIdentifier": "sequi",
  "Name": "Steuber LLC",
  "Description": "Function-based uniform structure",
  "IncludeId": "inventore",
  "Source": "veritatis",
  "Registered": "2018-02-02T17:54:02.9139671+01:00",
  "RegisteredBy": "quia",
  "Updated": "2010-07-20T17:54:02.9139671+02:00",
  "UpdatedBy": "sed",
  "Path": "quia",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 724
    }
  }
}