Scripts API

Note

The Scripts API is used to implement Socotra plugins. See the Plugins topic for information about how to use this API.

Endpoint Index

ActionEndpoint
Deploy scriptsPOST /scripts/upload
Query scripting logsPOST /scripts/queryLogs

Details

Deploy scripts
POST /scripts/upload
    Request:
    NamePositionTypeRequired
    fileformdatafilerequired
    tenantLocatorquerystringoptional
    Response: void

This endpoint takes a zip file with a hierarchical file structure containing folders and JavaScript files. This is the same structure that can be included in the /scripts folder in a full configuration file.

This operation replaces the entire script set, so be sure to include all files in the payload even if they are unchanged.

Query scripting logs
POST /scripts/queryLogs
QueryRequest
optional
maxTimestamp timestamp
minTimestamp timestamp
limit integer
oldestComeFirst boolean
position string
requestId string
searchPhrase string
QueryResponse
required
nextPosition string
QueryResponseLineItem
required
timestamp timestamp
message string
requestId string