WebApi

<back to all web services

ChangeScriptState

Sets the state of this script. Allows controlling backend execution by flagging module as active/paused

The following routes are available for this service:
PUT, OPTIONS/Scripts/{ScriptId}/state
ChangeScriptState Parameters:
NameParameterData TypeRequiredDescription
AuthorizationheaderstringYesAuthorization token in the form "Bearer your_token_here"
ScriptIdpathstringYesScript ID
StatebodyScriptStateYesThe desired new state of the script

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /Scripts/{ScriptId}/state HTTP/1.1 
Host: burntrouter.info 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ChangeScriptState xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Algomate.API.ServiceModel">
  <Authorization>String</Authorization>
  <ScriptId>String</ScriptId>
  <State>Active</State>
</ChangeScriptState>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ScriptState xmlns="http://schemas.datacontract.org/2004/07/Algomate.Scripting">Active</ScriptState>