Skip to main content
Put C R M Script Entity

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Path Parameters

id
integer<int32>
required

The CRMScriptEntity id to update.

Query Parameters

$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.

Body

The CRMScriptEntity to be saved.

CRM Scripts - stored in the ejScript table, including source code. Carrier object for CRMScriptEntity. Services for the CRMScriptEntity Carrier is available from the CRMScript Agent.

EjscriptId
integer<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
integer<int32>

The script is inside this hierarchy folder

Source
string

The script

SourceCode
string

Contains the source code of the script

ScriptType
enum<string>

The type/language of this script

Available options:
Unknown,
CRMScript,
JavaScript
HtmlOutput
integer<int32>

True if this script will return HTML output

Includes
integer<int32>[]

The unique ids of all depencies of this script (all resolved includes)

SourceMaps
object[]

The source maps for this script

ValidationResult
object

Object for returning information when validating a CRMScript Carrier object for CRMScriptResult. Services for the CRMScriptResult Carrier is available from the CRMScript Agent.

Registered
string<date-time>

Registered when in UTC.

RegisteredAssociateId
integer<int32>

Registered by whom

Updated
string<date-time>

Last updated when in UTC.

UpdatedAssociateId
integer<int32>

Last updated by whom

BlockedVerbs
enum<string>

The verbs that are blocked when calling a ejscript over HTTP

Available options:
BlockNone,
BlockGET,
BlockPOST,
BlockPUT,
BlockDELETE,
BlockPATCH,
BlockOPTIONS,
BlockHEAD,
BlockTRACE,
BlockCONNECT,
BlockOTHER,
BlockAll
TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.

Response

CRMScriptEntity updated.

CRM Scripts - stored in the ejScript table, including source code. CRMScriptEntity entity with API _Links added.

EjscriptId
integer<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
integer<int32>

The script is inside this hierarchy folder

Source
string

The script

SourceCode
string

Contains the source code of the script

ScriptType
enum<string>

The type/language of this script

Available options:
Unknown,
CRMScript,
JavaScript
HtmlOutput
integer<int32>

True if this script will return HTML output

Includes
integer<int32>[]

The unique ids of all depencies of this script (all resolved includes)

SourceMaps
object[]

The source maps for this script

ValidationResult
object

Object for returning information when validating a CRMScript Carrier object for CRMScriptResult. Services for the CRMScriptResult Carrier is available from the CRMScript Agent.

Registered
string<date-time>

Registered when in UTC.

RegisteredAssociateId
integer<int32>

Registered by whom

Updated
string<date-time>

Last updated when in UTC.

UpdatedAssociateId
integer<int32>

Last updated by whom

BlockedVerbs
enum<string>

The verbs that are blocked when calling a ejscript over HTTP

Available options:
BlockNone,
BlockGET,
BlockPOST,
BlockPUT,
BlockDELETE,
BlockPATCH,
BlockOPTIONS,
BlockHEAD,
BlockTRACE,
BlockCONNECT,
BlockOTHER,
BlockAll
TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.