Get Specific Script Template
This request retrieves a specific script template according the database generated ID value (see references below).
HTTP Method
GET
URI
{{baseUrl}}/api/v2/scripttemplates/{scriptTemplateId}
Request Parameters
Parameter |
Type |
Description |
|||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
{scriptTemplateId} |
Integer |
See Get Script Templates to search for the relevant "id" and match to the script name. You can also see the following:
|
Example Response
{
"id": 5000,
"customerVariables": null,
"name": "sbc-add-oc-numbers",
"scriptTemplateType": 8,
"description": null,
"relatedScripts": [
{
"key": 5001,
"value": "sbc-remove-oc-numbers"
}
]
}
HTTP Responses
■ | 200 OK |
Attribute |
Type |
Description |
|||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
Integer |
The unique id of the script. See SBC Template Scenarios for references to IDs for default SBC script templates. See M365 Template Scenarios for references to IDs for default M365 script templates. |
|||||||||||||||||||||||||||
customerVariables |
String |
Customer defined variables, mandatory for the script execution. Corresponds to the "CustomerVariables" column in the database record. Its recommended not to define like variable1, variable2 and instead to use meaningful names e.g. localhostname. See SBC Template Scenarios for references to customer variables for default SBC script templates. See M365 Template Scenarios for references to customer variables for default M365 script templates. |
|||||||||||||||||||||||||||
name |
String |
Corresponds to the "Friendly Name" of the script column in the database record. For example, "sbc-scenario7". |
|||||||||||||||||||||||||||
scriptTemplateType |
Integer |
Specifies the UMP operation where the script can be applied. One of the following values:
See SBC Template Scenarios for references to customer variables for default SBC script templates. See M365 Template Scenarios for references to customer variables for default M365 script templates. |
|||||||||||||||||||||||||||
description |
String |
Corresponds to the "Description" column in the script record. |
|||||||||||||||||||||||||||
relatedScripts |
List array key: integer value: string
|
The database id (key) and name of the related script. For example, script id '5000' with value 'sbc-add-oc-numbershas the related script id '5001' with value 'sbc-remove-oc-numbers'. |