> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.CRMScriptEntity

# <a id="SuperOffice_WebApi_Data_CRMScriptEntity" /> Class CRMScriptEntity

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for CRMScriptEntity.
CRM Scripts - stored in the ejScript table, including source code.

```csharp theme={null}
public class CRMScriptEntity : Carrier
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[CRMScriptEntity](SuperOffice.WebApi.Data.CRMScriptEntity.md)

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Examples

Get CRMScriptEntity 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new CRMScriptAgent(configuration);
var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );</code></pre>

## Remarks

Use <xref href="SuperOffice.CRM.Services.ArchiveAgent?text=Archive+agent" data-throw-if-not-resolved="false" />:
All CRMScriptEntity: <pre><code class="lang-csharp">"Ejscripts"</code></pre>

## Constructors

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity__ctor" /> CRMScriptEntity()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public CRMScriptEntity()
```

## Properties

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_AccessKey" /> AccessKey

Access key used to run this script on the customer pages

```csharp theme={null}
public virtual string AccessKey { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_BlockedVerbs" /> BlockedVerbs

The verbs that are blocked when calling a ejscript over HTTP
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public EjScriptVerb? BlockedVerbs { get; set; }
```

#### Property Value

[EjScriptVerb](SuperOffice.WebApi.Data.EjScriptVerb.md)?

#### See Also

[CRMScriptEntity](SuperOffice.WebApi.Data.CRMScriptEntity.md).[BlockedVerbs\_String](SuperOffice.WebApi.Data.CRMScriptEntity.md#SuperOffice_WebApi_Data_CRMScriptEntity_BlockedVerbs_String)

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_BlockedVerbs_String" /> BlockedVerbs\_String

The verbs that are blocked when calling a ejscript over HTTP
Raw string enum value.

```csharp theme={null}
[JsonProperty("BlockedVerbs")]
public string BlockedVerbs_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[CRMScriptEntity](SuperOffice.WebApi.Data.CRMScriptEntity.md).[BlockedVerbs](SuperOffice.WebApi.Data.CRMScriptEntity.md#SuperOffice_WebApi_Data_CRMScriptEntity_BlockedVerbs)

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_Description" /> Description

Optional description of what this script is used for.

```csharp theme={null}
public virtual string Description { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_EjscriptId" /> EjscriptId

Primary key

```csharp theme={null}
public virtual int EjscriptId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_HierarchyId" /> HierarchyId

The script is inside this hierarchy folder

```csharp theme={null}
public virtual int HierarchyId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_HtmlOutput" /> HtmlOutput

True if this script will return HTML output

```csharp theme={null}
public virtual short HtmlOutput { get; set; }
```

#### Property Value

[short](https://learn.microsoft.com/dotnet/api/system.int16)

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_IncludeId" /> IncludeId

A unique name used for including this script in another

```csharp theme={null}
public virtual string IncludeId { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_Includes" /> Includes

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

```csharp theme={null}
public virtual int[] Includes { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)\[]

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_Name" /> Name

A description of this script

```csharp theme={null}
public virtual string Name { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_Registered" /> Registered

Registered when

```csharp theme={null}
public virtual DateTime Registered { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_RegisteredAssociateId" /> RegisteredAssociateId

Registered by whom

```csharp theme={null}
public virtual int RegisteredAssociateId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_ScriptType" /> ScriptType

The type/language of this script
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public ScriptType? ScriptType { get; set; }
```

#### Property Value

[ScriptType](SuperOffice.WebApi.Data.ScriptType.md)?

#### See Also

[CRMScriptEntity](SuperOffice.WebApi.Data.CRMScriptEntity.md).[ScriptType\_String](SuperOffice.WebApi.Data.CRMScriptEntity.md#SuperOffice_WebApi_Data_CRMScriptEntity_ScriptType_String)

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_ScriptType_String" /> ScriptType\_String

The type/language of this script
Raw string enum value.

```csharp theme={null}
[JsonProperty("ScriptType")]
public string ScriptType_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[CRMScriptEntity](SuperOffice.WebApi.Data.CRMScriptEntity.md).[ScriptType](SuperOffice.WebApi.Data.CRMScriptEntity.md#SuperOffice_WebApi_Data_CRMScriptEntity_ScriptType)

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_Source" /> Source

The script

```csharp theme={null}
public virtual string Source { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_SourceCode" /> SourceCode

Contains the source code of the script

```csharp theme={null}
public virtual string SourceCode { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_SourceMaps" /> SourceMaps

The source maps for this script

```csharp theme={null}
public virtual CRMScriptSourceMap[] SourceMaps { get; set; }
```

#### Property Value

[CRMScriptSourceMap](SuperOffice.WebApi.Data.CRMScriptSourceMap.md)\[]

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_UniqueIdentifier" /> UniqueIdentifier

Global unique identifier, accross customers/tenants

```csharp theme={null}
public virtual string UniqueIdentifier { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_Updated" /> Updated

Last updated when

```csharp theme={null}
public virtual DateTime Updated { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_UpdatedAssociateId" /> UpdatedAssociateId

Last updated by whom

```csharp theme={null}
public virtual int UpdatedAssociateId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_CRMScriptEntity_ValidationResult" /> ValidationResult

The result of a validation of a TypeScript when saving

```csharp theme={null}
public virtual CRMScriptResult ValidationResult { get; set; }
```

#### Property Value

[CRMScriptResult](SuperOffice.WebApi.Data.CRMScriptResult.md)

## See Also

[CRMScriptAgent](SuperOffice.WebApi.Agents.CRMScriptAgent.md),
[ArchiveAgent](SuperOffice.WebApi.Agents.ArchiveAgent.md),


## Related topics

- [SuperOffice.WebApi.Agents.ICRMScriptAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ICRMScriptAgent.md)
- [SuperOffice.WebApi.Agents.CRMScriptAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.CRMScriptAgent.md)
- [SuperOffice.WebApi.Data.CRMScript SaveCRMScriptEntityWithoutCompileRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.CRMScript_SaveCRMScriptEntityWithoutCompileRequest.md)
- [SuperOffice.WebApi.Data.Carrier](/en/api/reference/webapi/SuperOffice.WebApi.Data.Carrier.md)
- [SuperOffice.WebApi.Data.TriggerScriptEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.TriggerScriptEntity.md)
- [SuperOffice.WebApi.Agents.IListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IListAgent.md)