> ## 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.
# Get Trigger Script Entity
> Gets a TriggerScriptEntity object.
Calls the CRMScript agent service GetTriggerScriptEntity.
NsApiSlow threshold: 5000 ms.
## Online Restricted: ## The CRMScript agent is not available in Online by default. Access must be requested specifically when app is registered.
## OpenAPI
````yaml /openapi/rest/openapi-v3-TriggerScript.json get /api/v1/TriggerScript/{id}
openapi: 3.0.0
info:
version: v1-REST
title: SuperOffice REST API v1
description: SuperOffice REST API - TriggerScript
contact:
name: SuperOffice DevNet
url: https://docs.superoffice.com/en/api/index.html
email: sdk@superoffice.com
servers:
- url: http://localhost:56350
- url: https://localhost:56350
security: []
tags: []
externalDocs:
description: >-
The SuperOffice DevNet Community has more documentation, examples, and
discussion forums.
url: https://community.superoffice.com/en/developer/
paths:
/api/v1/TriggerScript/{id}:
get:
tags:
- TriggerScript
summary: Get Trigger Script Entity
description: "Gets a TriggerScriptEntity object.\n\nCalls the CRMScript agent service GetTriggerScriptEntity.\r\nNsApiSlow threshold: 5000 ms.\r\n## Online Restricted: ## The CRMScript agent is not available in Online by default. Access must be requested specifically when app is registered."
operationId: v1TriggerScriptEntity_GetTriggerScriptEntity
parameters:
- name: id
in: path
description: The id of the TriggerScriptEntity to return.
required: true
schema:
format: int32
type: integer
- name: $select
in: query
description: >-
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.
required: false
schema:
type: string
- name: Accept-Language
in: header
description: >-
Convert string references and multi-language values into a specified
language (iso2) code.
required: false
schema:
type: string
- name: SO-Language
in: header
description: >-
Convert string references and multi-language values into a specified
language (iso2) code. Overrides Accept-Language value.
required: false
schema:
type: string
- name: SO-Culture
in: header
description: >-
Number, date formatting in a specified culture (iso2 language) code.
Partially overrides SO-Language/Accept-Language value. Ignored if no
Language set.
required: false
schema:
type: string
- name: SO-TimeZone
in: header
description: >-
Specify the timezone code that you would like date/time responses
converted to.
required: false
schema:
type: string
- name: SO-AppToken
in: header
description: >-
The application token that identifies the partner app. Used when
calling Online WebAPI from a server.
required: false
schema:
type: string
responses:
'200':
description: TriggerScriptEntity found.
content:
application/json:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.CRMScriptCarriers.TriggerScriptEntityWithLinks
text/json:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.CRMScriptCarriers.TriggerScriptEntityWithLinks
application/xml:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.CRMScriptCarriers.TriggerScriptEntityWithLinks
text/xml:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.CRMScriptCarriers.TriggerScriptEntityWithLinks
application/json-patch+json:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.CRMScriptCarriers.TriggerScriptEntityWithLinks
application/merge-patch+json:
schema:
$ref: >-
#/components/schemas/SuperOffice.WebApi.v1.Carriers.CRMScriptCarriers.TriggerScriptEntityWithLinks
'404':
description: Not Found.
security:
- SuperOffice_Password: []
SuperId_Authentication: []
components:
schemas:
SuperOffice.WebApi.v1.Carriers.CRMScriptCarriers.TriggerScriptEntityWithLinks:
description: "CRM Trigger Script - The script runs when a given event fires.\r\n\r\nTriggerScriptEntity entity with API _Links added."
type: object
properties:
ScreenChooserId:
format: int32
description: Primary key
type: integer
Name:
description: Optional description of what this script is used for.
type: string
ScreenType:
description: Event id that triggers script. See EventHandlerType enum.
enum:
- Unknown
- NewTicket
- NewTicketFromCustomerCenter
- NewTicketFromEmail
- NewTicketFromCustomerCenterBeforeSave
- NewTicketFromSpmLink
- NewNotifyTicketFromForm
- NewTicketFromForm
- TicketSave
- TicketClosed
- TicketPostponed
- TicketDeleted
- TicketActivated
- TicketReopened
- TicketReopenedFromCustomerCenter
- TicketReopenedFromEmail
- TicketChangedPriority
- TicketChangedCategory
- TicketChangedOwnedBy
- TicketChangedPrimaryCustomer
- TicketChangedTicketStatus
- TicketChangedSlevel
- TicketMessageAdded
- TicketInternalMessageAdded
- TicketExternalMessageAdded
- TicketMessageSentimentCalculated
- CompactModeInjection
- CustomerCenterAuthentication
- ScheduledTaskFailed
- DbiTaskFailed
- CustomerSetSubscriptions
- ImportMailBeforeProcessing
- ImportMailAfterProcessing
- MainMenu
- ChatNewSession
- ChatSessionChangedStatus
- ChatBeforeSaveNewMessage
- ChatAfterSaveNewMessage
- ServiceScreenNewTicketLoad
- ServiceScreenNewQuickTicketLoad
- ServiceScreenListTicketMessagesLoad
- ServiceScreenAddMessageLoad
- ServiceScreenEditTicketLoad
- ServiceScreenViewCustomerLoad
- ServiceScreenEditCustomerLoad
- ServiceScreenViewCompanyLoad
- ServiceScreenEditCompanyLoad
- ServiceScreenForwardLoad
- ServiceScreenEditExtraTableLoad
- ServiceScreenNewTicketBeforeSubmit
- ServiceScreenNewQuickTicketBeforeSubmit
- ServiceScreenListTicketMessagesBeforeSubmit
- ServiceScreenAddMessageBeforeSubmit
- ServiceScreenEditTicketBeforeSubmit
- ServiceScreenViewCustomerBeforeSubmit
- ServiceScreenEditCustomerBeforeSubmit
- ServiceScreenViewCompanyBeforeSubmit
- ServiceScreenEditCompanyBeforeSubmit
- ServiceScreenForwardBeforeSubmit
- ServiceScreenEditExtraTableBeforeSubmit
- ServiceScreenNewTicketAfterSubmit
- ServiceScreenNewQuickTicketAfterSubmit
- ServiceScreenListTicketMessagesAfterSubmit
- ServiceScreenAddMessageAfterSubmit
- ServiceScreenEditTicketAfterSubmit
- ServiceScreenViewCustomerAfterSubmit
- ServiceScreenEditCustomerAfterSubmit
- ServiceScreenViewCompanyAfterSubmit
- ServiceScreenEditCompanyAfterSubmit
- ServiceScreenForwardAfterSubmit
- ServiceScreenEditExtraTableAfterSubmit
- SalesBeforeSaveAppointment
- SalesBeforeSaveStakeholder
- SalesBeforeSaveQuote
- SalesBeforeSaveDocument
- SalesBeforeSaveContact
- SalesBeforeSavePerson
- SalesBeforeSaveRelation
- SalesBeforeSaveSale
- SalesBeforeSaveProject
- SalesBeforeSaveSelection
- SalesBeforeSaveProjectMember
- SalesBeforeSaveSelectionMember
- SalesBeforeSaveQuoteLine
- SalesBeforeSaveApproveQuote
- SalesBeforeSaveRejectQuote
- SalesBeforeSaveTicket
- SalesLoadCustomObject
- SalesBeforeSaveCustomObject
- SalesAfterSaveAppointment
- SalesAfterSaveStakeholder
- SalesAfterSaveQuote
- SalesAfterSaveDocument
- SalesAfterSaveContact
- SalesAfterSavePerson
- SalesAfterSaveRelation
- SalesAfterSaveSale
- SalesAfterSaveProject
- SalesAfterSaveSelection
- SalesAfterSaveProjectMember
- SalesAfterSaveSelectionMember
- SalesAfterSaveQuoteLine
- SalesAfterSaveApproveQuote
- SalesAfterSaveRejectQuote
- SalesAfterSaveTicket
- SalesAfterSaveCustomObject
- SalesSplitTicket
- SalesLoadTicket
- SalesLoadTicketMessage
type: string
Enabled:
description: Whether this screen chooser is enabled or not
type: boolean
UniqueIdentifier:
description: Global unique identifier, accross customers/tenants
type: string
Source:
description: The CRMscript code for this event handler
type: string
Registered:
format: date-time
description: Registered when in UTC.
type: string
RegisteredAssociateId:
format: int32
description: Registered by whom
type: integer
Updated:
format: date-time
description: Last updated when in UTC.
type: string
UpdatedAssociateId:
format: int32
description: Last updated by whom
type: integer
TableRight:
$ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
FieldProperties:
description: >-
Field property dictionary mapping field names to field access
rights.
type: object
additionalProperties:
$ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
_Links:
type: object
additionalProperties:
type: string
SuperOffice.CRM.Security.TableRight:
description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
type: object
properties:
Mask:
type: string
Reason:
type: string
SuperOffice.CRM.Security.FieldProperty:
description: >-
Class holding properties like field length, field type about a field in
the carrier.
type: object
properties:
FieldRight:
$ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
FieldType:
type: string
FieldLength:
format: int32
description: ''
type: integer
SuperOffice.CRM.Security.FieldRight:
description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
type: object
properties:
Mask:
type: string
Reason:
type: string
````
## Related topics
- [Get Trigger Script Entity](/en/api/reference/restful/agent/crmscript_agent/get-trigger-script-entity.md)
- [Delete Trigger Script Entity](/en/api/reference/restful/rest/triggerscript/delete-trigger-script-entity.md)
- [Post Trigger Script Entity](/en/api/reference/restful/rest/triggerscript/post-trigger-script-entity.md)
- [Default Trigger Script Entity](/en/api/reference/restful/rest/triggerscript/default-trigger-script-entity.md)
- [Put Trigger Script Entity](/en/api/reference/restful/rest/triggerscript/put-trigger-script-entity.md)