WebApi

<back to all web services

CompileScript

Compiles an existing script by ID

The following routes are available for this service:
POST, OPTIONS/Scripts/{ScriptId}/compile
CompileScript Parameters:
NameParameterData TypeRequiredDescription
AuthorizationheaderstringYesAuthorization token in the form "Bearer your_token_here"
ScriptIdpathstringYesScript ID
Script Parameters:
NameParameterData TypeRequiredDescription
ScriptIdformstringNo
NameformstringNo
TextformstringNo
StateformScriptStateNo
ResultformCompilationResultNo
CompilationResult Parameters:
NameParameterData TypeRequiredDescription
SuccessformboolNo
DiagnosticsformList<CompilationDiagnostic>No
CompilationDiagnostic Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
SeverityformCompilationDiagnosticSeverityNo
LocationformstringNo
MessageformstringNo
RawformstringNo

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.

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

<CompileScript 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>
</CompileScript>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<Script xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Algomate.Scripting">
  <Name>String</Name>
  <Result>
    <Diagnostics>
      <CompilationDiagnostic>
        <Id>String</Id>
        <Location>String</Location>
        <Message>String</Message>
        <Raw>String</Raw>
        <Severity>Hidden</Severity>
      </CompilationDiagnostic>
    </Diagnostics>
    <Success>false</Success>
  </Result>
  <ScriptId>String</ScriptId>
  <State>Active</State>
  <Text>String</Text>
</Script>