PATCH CRMScript/{id}

• 5 minutes to read

PATCH /api/v1/CRMScript/{id}

Update a CRMScriptEntity with changes, as described in a JSON Patch or a JSON Merge Patch document.

See RFC6902 and RFC 7396.

Online Restricted: ## The CRMScript agent is not available in Online by default. Access must be requested specifically when app is registered. Update the Department field to "foo" can be done either as a JSON PATCH:


[ { "op": "replace", "path": "/Department", "value": "foo" } ]

or as a JSON MERGE PATCH, which describes the change directly:


{ "Department": "foo" }

JSON PATCH supports operations 'add', 'replace', 'remove' and 'test'. The path is case insensitive, and the leading slash is optional, so the paths "/department", "Department" and "department" are all equivalent.

Calls the {SuperOffice.CRM.Services.ICRMScriptAgent} service SaveCRMScriptEntity.

Path Part	Type	Description
id	int32	The CRMScriptEntity id to update. Required

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.

PATCH /api/v1/CRMScript/{id}?$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:
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: changes

JSON-Patch array of operations+path+value, or a MERGE-PATCH object (which will be converted to a list of JSON-PATCH operations).

Property Name	Type	Description
op	String	"add", "replace", "remove", "test" "move" and "copy" not supported
path	String	The property names to modify. "/users/0/email", "/users/-",
value	Object	New/Replaced value - string or object.

Response:

CRMScriptEntity updated.

Response	Description
200	CRMScriptEntity updated.
404	CRMScriptEntity with given id does not exist in the db.
409	Update blocked because a 'test' operation has detected a conflict with the entity value.
412	Update aborted because CRMScriptEntity has changed since the requested If-Unmodified-Since timestamp.

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

PATCH /api/v1/CRMScript/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Content-Type: application/json; charset=utf-8

[
  {
    "op": "add",
    "path": "esse",
    "value": {}
  },
  {
    "op": "add",
    "path": "esse",
    "value": {}
  }
]

Sample response

HTTP/1.1 200 CRMScriptEntity  updated.
Content-Type: application/json; charset=utf-8

{
  "EjscriptId": 419,
  "UniqueIdentifier": "suscipit",
  "Name": "Stanton-Kessler",
  "Description": "Cloned transitional toolset",
  "IncludeId": "quae",
  "AccessKey": "reprehenderit",
  "HierarchyId": 504,
  "Source": "et",
  "SourceCode": "suscipit",
  "ScriptType": "CRMScript",
  "HtmlOutput": 97,
  "Includes": [
    306,
    421
  ],
  "SourceMaps": [
    {
      "LineNumberFrom": 789,
      "LineNumberTo": 65,
      "Delta": 773,
      "IncludeId": "ab",
      "IncludedFrom": [
        "ad",
        "cum"
      ],
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 701
        }
      }
    }
  ],
  "ValidationResult": null,
  "Registered": "2020-05-21T14:13:48.7587273+02:00",
  "RegisteredAssociateId": 899,
  "Updated": "1999-05-16T14:13:48.7587273+02:00",
  "UpdatedAssociateId": 44,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 329
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/project/321",
    "Archive": "https://www.example.com/api/v1/project"
  }
}