POST CRMScript

• 6 minutes to read
 • 6 minutes to read 
POST /api/v1/CRMScript

Creates a new CRMScriptEntity

Calls the CRMScript agent service SaveCRMScriptEntity.

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

The CRMScriptEntity to be saved.

Property Name Type Description
EjscriptId Integer Primary key
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
AccessKey String Access key used to run this script on the customer pages
HierarchyId Integer The script is inside this hierarchy folder
Source String The script
SourceCode String Contains the source code of the script
ScriptType String The type/language of this script
HtmlOutput Integer True if this script will return HTML output
Includes Array The unique ids of all depencies of this script (all resolved includes)
SourceMaps Array The source maps for this script
ValidationResult CRMScriptResult The result of a validation of a TypeScript when saving
Registered String Registered when in UTC.
RegisteredAssociateId Integer Registered by whom
Updated String Last updated when in UTC.
UpdatedAssociateId Integer Last updated by whom

Response:

OK

Response Description
200 OK

Response body: CRMScriptEntityWithLinks

Property Name Type Description
EjscriptId int32 Primary key
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
AccessKey string Access key used to run this script on the customer pages
HierarchyId int32 The script is inside this hierarchy folder
Source string The script
SourceCode string Contains the source code of the script
ScriptType string The type/language of this script
HtmlOutput int32 True if this script will return HTML output
Includes array The unique ids of all depencies of this script (all resolved includes)
SourceMaps array The source maps for this script
ValidationResult CRMScriptResult The result of a validation of a TypeScript when saving
Registered date-time Registered when in UTC.
RegisteredAssociateId int32 Registered by whom
Updated date-time Last updated when in UTC.
UpdatedAssociateId int32 Last updated by whom
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.
_Links object

Sample request

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

{
  "EjscriptId": 576,
  "UniqueIdentifier": "sint",
  "Name": "Ferry Inc and Sons",
  "Description": "Seamless grid-enabled matrices",
  "IncludeId": "et",
  "AccessKey": "iure",
  "HierarchyId": 991,
  "Source": "voluptatem",
  "SourceCode": "rerum",
  "ScriptType": "CRMScript",
  "HtmlOutput": 820,
  "Includes": [
    801,
    297
  ],
  "SourceMaps": [
    {
      "LineNumberFrom": 555,
      "LineNumberTo": 915,
      "Delta": 234,
      "IncludeId": "non",
      "IncludedFrom": [
        "inventore",
        "at"
      ]
    },
    {
      "LineNumberFrom": 555,
      "LineNumberTo": 915,
      "Delta": 234,
      "IncludeId": "non",
      "IncludedFrom": [
        "inventore",
        "at"
      ]
    }
  ],
  "ValidationResult": null,
  "Registered": "2018-12-14T16:32:47.4152322+01:00",
  "RegisteredAssociateId": 927,
  "Updated": "2010-07-30T16:32:47.4152322+02:00",
  "UpdatedAssociateId": 910
}

Sample response

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

{
  "EjscriptId": 709,
  "UniqueIdentifier": "maxime",
  "Name": "Jewess-Bins",
  "Description": "Customer-focused transitional ability",
  "IncludeId": "perspiciatis",
  "AccessKey": "neque",
  "HierarchyId": 226,
  "Source": "temporibus",
  "SourceCode": "quia",
  "ScriptType": "CRMScript",
  "HtmlOutput": 787,
  "Includes": [
    958,
    219
  ],
  "SourceMaps": [
    {
      "LineNumberFrom": 813,
      "LineNumberTo": 936,
      "Delta": 542,
      "IncludeId": "vero",
      "IncludedFrom": [
        "hic",
        "quae"
      ],
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 149
        }
      }
    }
  ],
  "ValidationResult": null,
  "Registered": "2022-04-23T16:32:47.4152322+02:00",
  "RegisteredAssociateId": 127,
  "Updated": "2001-06-16T16:32:47.4152322+02:00",
  "UpdatedAssociateId": 185,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 248
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/project/321",
    "Archive": "https://www.example.com/api/v1/project"
  }
}