Load Script

<< Click to Display Table of Contents >>

Navigation:  Managing Syncplify.me Server! > REST API > Admin API > Event Handling and Scripting >

Load Script

Loads a script from the database.

 

Request

Method

URL

POST

/smserver-default/sms.LoadScript

RAW

POST /smserver-default/sms.LoadScript HTTP/1.1

Cache-Control: no-cache

Connection: Keep-Alive

Pragma: no-cache

Content-Type: application/json; charset=UTF-8

Accept: */*

Authorization: Bearer XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX

 

[

{

           "Aid" : "4K4EMVZF2Q6U5GRPQIWCDFS5FA"

}

]

Explained

Loads one script from the database.

 

Payload:

A single element JSON array containing an object with a single property:

 Aid: ID of the script to be loaded

 

Response

Method

URL

RAW

Accept-Encoding: synlz,gzip

Content-Type: application/json; charset=UTF-8

 

 

{"result":[

[

  {

       "_id" : "4K4EMVZF2Q6U5GRPQIWCDFS5FA",

       "ScriptName" : "Pippo",

       "ScriptSource" : "begin\nend.",

       "ScriptLanguage" : "Pascal"

   }

],"id":772674711}

Explained

A one-element JSON array containing a single script object, which properties are as follows:

 

_id: unique ID of the script

ScriptName: Short friendly name of the script

ScriptSource: Actual source code

ScriptLanguage: Language ("Pascal", "CPP", "JavaScript", or "Basic")