POST Agents/CRMScript/ValidateScript

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

Validate a CRMScript.

This will check that the syntax is correct NsApiSlow threshold: 5000 ms.

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/ValidateScript?$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

CRMScriptId

Property Name Type Description
CRMScriptId Integer

Response:

OK

Response Description
200 OK

Response body: CRMScriptResult

Property Name Type Description
Valid bool True if the CRMScript was successfully validated. If false, see the error message for details
ErrorMessage string Deprecated, see ErrorInformation instead. Contains the error message for a non-valide CRMScript
LineNumber int32 Deprecated, see ErrorInformation instead. The line number containing the incorrect syntax, if available
ErrorInformation CRMScriptErrorInfo Contains error information if the validation failed
Transpiled string This will contain transpiled code. In case of Typescript, this will then contain the executable JavaScript
Includes array The unique ids of all depencies of this script (all resolved includes)
SourceMaps array Array of source maps showing where in the original code a specific line originated from
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/ValidateScript
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *
Content-Type: application/json; charset=utf-8

{
  "CRMScriptId": 180
}

Sample response

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

{
  "Valid": false,
  "ErrorMessage": "vel",
  "LineNumber": 200,
  "ErrorInformation": null,
  "Transpiled": "ut",
  "Includes": [
    868,
    642
  ],
  "SourceMaps": [
    {
      "LineNumberFrom": 508,
      "LineNumberTo": 820,
      "Delta": 950,
      "IncludeId": "neque",
      "IncludedFrom": [
        "voluptatem",
        "est"
      ],
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 142
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 786
    }
  }
}