PUT Script/{uniqueIdentifier}

Some tooltip text!

• 4 minutes to read

 • 4 minutes to read

PUT /api/v1/Script/{uniqueIdentifier}

Create or Update the CRMScript information

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

Path Part	Type	Description
uniqueIdentifier	string	Global unique reference to script (independent of installation) Required

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: crmscript

Information about the CRMScript

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	String	Registered when in UTC.
RegisteredBy	String	Who created this script
Updated	String	Last updated when in UTC.
UpdatedBy	String	Who updated this script
Path	String	Path to script in the hierarchy.

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

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

{
  "UniqueIdentifier": "tempora",
  "Name": "Sanford, Ratke and Kiehn",
  "Description": "Reverse-engineered leading edge implementation",
  "IncludeId": "consequuntur",
  "Source": "suscipit",
  "Registered": "2020-02-02T14:13:49.5242846+01:00",
  "RegisteredBy": "culpa",
  "Updated": "1997-11-13T14:13:49.5242846+01:00",
  "UpdatedBy": "excepturi",
  "Path": "est"
}

Sample response

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

{
  "UniqueIdentifier": "nostrum",
  "Name": "Smith, Reilly and Moore",
  "Description": "Open-source modular attitude",
  "IncludeId": "occaecati",
  "Source": "nulla",
  "Registered": "2003-12-27T14:13:49.5242846+01:00",
  "RegisteredBy": "consectetur",
  "Updated": "2022-12-15T14:13:49.5242846+01:00",
  "UpdatedBy": "odio",
  "Path": "asperiores",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 236
    }
  }
}