WebApi

<back to all web services

UpdateScript

Updates an existing user script.

The following routes are available for this service:
PUT, OPTIONS/Scripts/{ScriptId}
UpdateScript Parameters:
NameParameterData TypeRequiredDescription
AuthorizationheaderstringYesAuthorization token in the form "Bearer your_token_here"
ScriptIdpathstringNoScript ID. If specified, tries to update existing script with new text.
NamebodystringYesA user supplied, arbitrary, name for the script
ScriptTextbodystringYesScript text
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.

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

<UpdateScript xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Algomate.API.ServiceModel">
  <Authorization>String</Authorization>
  <Name>String</Name>
  <ScriptId>String</ScriptId>
  <ScriptText>String</ScriptText>
</UpdateScript>
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>