Execute Script By String

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/CRMScript/ExecuteScriptByString");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"Script\": \"<string>\",\n  \"Parameters\": {},\n  \"EventData\": {\n    \"InputValues\": {},\n    \"BlockExecution\": true,\n    \"NavigateTo\": \"<string>\",\n    \"Message\": \"<string>\",\n    \"ShowDialog\": \"<string>\",\n    \"OutputValues\": {},\n    \"StateValues\": {},\n    \"Exception\": \"<string>\",\n    \"ParserValues\": {},\n    \"CgiVariables\": {},\n    \"CgiContent\": \"<string>\",\n    \"Headers\": {},\n    \"TraceExecution\": true,\n    \"TableRight\": {\n      \"Mask\": \"<string>\",\n      \"Reason\": \"<string>\"\n    },\n    \"FieldProperties\": {}\n  }\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Script: '<string>',
    Parameters: {},
    EventData: {
      InputValues: {},
      BlockExecution: true,
      NavigateTo: '<string>',
      Message: '<string>',
      ShowDialog: '<string>',
      OutputValues: {},
      StateValues: {},
      Exception: '<string>',
      ParserValues: {},
      CgiVariables: {},
      CgiContent: '<string>',
      Headers: {},
      TraceExecution: true,
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    }
  })
};

fetch('http://localhost:53294/api/v1/Agents/CRMScript/ExecuteScriptByString', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "53294",
  CURLOPT_URL => "http://localhost:53294/api/v1/Agents/CRMScript/ExecuteScriptByString",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Script' => '<string>',
    'Parameters' => [
        
    ],
    'EventData' => [
        'InputValues' => [
                
        ],
        'BlockExecution' => true,
        'NavigateTo' => '<string>',
        'Message' => '<string>',
        'ShowDialog' => '<string>',
        'OutputValues' => [
                
        ],
        'StateValues' => [
                
        ],
        'Exception' => '<string>',
        'ParserValues' => [
                
        ],
        'CgiVariables' => [
                
        ],
        'CgiContent' => '<string>',
        'Headers' => [
                
        ],
        'TraceExecution' => true,
        'TableRight' => [
                'Mask' => '<string>',
                'Reason' => '<string>'
        ],
        'FieldProperties' => [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:53294/api/v1/Agents/CRMScript/ExecuteScriptByString"

payload = {
    "Script": "<string>",
    "Parameters": {},
    "EventData": {
        "InputValues": {},
        "BlockExecution": True,
        "NavigateTo": "<string>",
        "Message": "<string>",
        "ShowDialog": "<string>",
        "OutputValues": {},
        "StateValues": {},
        "Exception": "<string>",
        "ParserValues": {},
        "CgiVariables": {},
        "CgiContent": "<string>",
        "Headers": {},
        "TraceExecution": True,
        "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
        },
        "FieldProperties": {}
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Script: '<string>',
    Parameters: {},
    EventData: {
      InputValues: {},
      BlockExecution: true,
      NavigateTo: '<string>',
      Message: '<string>',
      ShowDialog: '<string>',
      OutputValues: {},
      StateValues: {},
      Exception: '<string>',
      ParserValues: {},
      CgiVariables: {},
      CgiContent: '<string>',
      Headers: {},
      TraceExecution: true,
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    }
  })
};

fetch('http://localhost:53294/api/v1/Agents/CRMScript/ExecuteScriptByString', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Output": "<string>",
  "Parameters": {},
  "TraceRun": {
    "StartedAt": "2023-11-07T05:31:56Z",
    "EndedAt": "2023-11-07T05:31:56Z",
    "ExecutionTime": 123,
    "UserExecutionTime": 123,
    "PeakMemory": 123,
    "NumFrames": 123,
    "FileSize": 123,
    "AssociateId": 123,
    "Status": "<string>",
    "Frames": "<string>",
    "ForceSaveTrace": true,
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Eventdata": {
    "Type": "Unknown",
    "InputValues": {},
    "BlockExecution": true,
    "NavigateTo": "<string>",
    "Message": "<string>",
    "ShowDialog": "<string>",
    "OutputValues": {},
    "StateValues": {},
    "Exception": "<string>",
    "ParserValues": {},
    "CgiVariables": {},
    "CgiContent": "<string>",
    "Headers": {},
    "TraceExecution": true,
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Success": true,
  "ErrorInformation": {
    "ErrorMessage": "<string>",
    "IncludeId": "<string>",
    "LineNumber": 123,
    "CharacterPosition": 123,
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "StatusCode": 123,
  "StatusMessage": "<string>",
  "Headers": {},
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Execute Script By String

using RestSharp;


var options = new RestClientOptions("http://localhost:53294/api/v1/Agents/CRMScript/ExecuteScriptByString");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"Script\": \"<string>\",\n  \"Parameters\": {},\n  \"EventData\": {\n    \"InputValues\": {},\n    \"BlockExecution\": true,\n    \"NavigateTo\": \"<string>\",\n    \"Message\": \"<string>\",\n    \"ShowDialog\": \"<string>\",\n    \"OutputValues\": {},\n    \"StateValues\": {},\n    \"Exception\": \"<string>\",\n    \"ParserValues\": {},\n    \"CgiVariables\": {},\n    \"CgiContent\": \"<string>\",\n    \"Headers\": {},\n    \"TraceExecution\": true,\n    \"TableRight\": {\n      \"Mask\": \"<string>\",\n      \"Reason\": \"<string>\"\n    },\n    \"FieldProperties\": {}\n  }\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Script: '<string>',
    Parameters: {},
    EventData: {
      InputValues: {},
      BlockExecution: true,
      NavigateTo: '<string>',
      Message: '<string>',
      ShowDialog: '<string>',
      OutputValues: {},
      StateValues: {},
      Exception: '<string>',
      ParserValues: {},
      CgiVariables: {},
      CgiContent: '<string>',
      Headers: {},
      TraceExecution: true,
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    }
  })
};

fetch('http://localhost:53294/api/v1/Agents/CRMScript/ExecuteScriptByString', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "53294",
  CURLOPT_URL => "http://localhost:53294/api/v1/Agents/CRMScript/ExecuteScriptByString",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Script' => '<string>',
    'Parameters' => [
        
    ],
    'EventData' => [
        'InputValues' => [
                
        ],
        'BlockExecution' => true,
        'NavigateTo' => '<string>',
        'Message' => '<string>',
        'ShowDialog' => '<string>',
        'OutputValues' => [
                
        ],
        'StateValues' => [
                
        ],
        'Exception' => '<string>',
        'ParserValues' => [
                
        ],
        'CgiVariables' => [
                
        ],
        'CgiContent' => '<string>',
        'Headers' => [
                
        ],
        'TraceExecution' => true,
        'TableRight' => [
                'Mask' => '<string>',
                'Reason' => '<string>'
        ],
        'FieldProperties' => [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:53294/api/v1/Agents/CRMScript/ExecuteScriptByString"

payload = {
    "Script": "<string>",
    "Parameters": {},
    "EventData": {
        "InputValues": {},
        "BlockExecution": True,
        "NavigateTo": "<string>",
        "Message": "<string>",
        "ShowDialog": "<string>",
        "OutputValues": {},
        "StateValues": {},
        "Exception": "<string>",
        "ParserValues": {},
        "CgiVariables": {},
        "CgiContent": "<string>",
        "Headers": {},
        "TraceExecution": True,
        "TableRight": {
            "Mask": "<string>",
            "Reason": "<string>"
        },
        "FieldProperties": {}
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Script: '<string>',
    Parameters: {},
    EventData: {
      InputValues: {},
      BlockExecution: true,
      NavigateTo: '<string>',
      Message: '<string>',
      ShowDialog: '<string>',
      OutputValues: {},
      StateValues: {},
      Exception: '<string>',
      ParserValues: {},
      CgiVariables: {},
      CgiContent: '<string>',
      Headers: {},
      TraceExecution: true,
      TableRight: {Mask: '<string>', Reason: '<string>'},
      FieldProperties: {}
    }
  })
};

fetch('http://localhost:53294/api/v1/Agents/CRMScript/ExecuteScriptByString', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Output": "<string>",
  "Parameters": {},
  "TraceRun": {
    "StartedAt": "2023-11-07T05:31:56Z",
    "EndedAt": "2023-11-07T05:31:56Z",
    "ExecutionTime": 123,
    "UserExecutionTime": 123,
    "PeakMemory": 123,
    "NumFrames": 123,
    "FileSize": 123,
    "AssociateId": 123,
    "Status": "<string>",
    "Frames": "<string>",
    "ForceSaveTrace": true,
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Eventdata": {
    "Type": "Unknown",
    "InputValues": {},
    "BlockExecution": true,
    "NavigateTo": "<string>",
    "Message": "<string>",
    "ShowDialog": "<string>",
    "OutputValues": {},
    "StateValues": {},
    "Exception": "<string>",
    "ParserValues": {},
    "CgiVariables": {},
    "CgiContent": "<string>",
    "Headers": {},
    "TraceExecution": true,
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "Success": true,
  "ErrorInformation": {
    "ErrorMessage": "<string>",
    "IncludeId": "<string>",
    "LineNumber": 123,
    "CharacterPosition": 123,
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  },
  "StatusCode": 123,
  "StatusMessage": "<string>",
  "Headers": {},
  "TableRight": {
    "Mask": "<string>",
    "Reason": "<string>"
  },
  "FieldProperties": {}
}

Authorizations

Authorization

string

header

required

SuperOffice username:password are passed in Base64-encoded.

You can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.

Authorization

string

header

required

SuperOffice SuperId OAuth implicit flow. You need to issue a request to the SuperId authorization URL https://online.superoffice.com/login/common/oauth/authorize?response_type=token &client_id=670734e0-4c5a-11e3-be9e-a171392e81db &redirect_uri=https://example.com/spa/

passing in the application id and redirect URL.

SuperId will log the user in, and redirect to the requested redirect URL with a #payload containing the access token and claims. (The redirect URL must be registered with SuperId in advance)

https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb &token_type=bearer &state= &expires_in=3600 &ctx=Cust12227 &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f

You can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.

FlowImplicit

Authorization URL: https://online.superoffice.com/login/common/oauth/authorize

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select

string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

Script, Parameters, EventData

ExecuteScriptByString: Execute a CRMScript 2 (JavaScript), returning the printed output value.

Script

string

Parameters

object

Show child attributes

EventData

object

EventData containing data related to event handlers Carrier object for EventData. Services for the EventData Carrier is available from the CustomerService Agent.

Show child attributes

Response

Object for returning result from a CRMScript Carrier object for CRMScriptRunResult. Services for the CRMScriptRunResult Carrier is available from the CRMScript Agent.

Output

string

The output from the script, normally from a print or printLine statement

Parameters

object

The parameters/variables that might have been modified by the script

Show child attributes

TraceRun

object

Object for returning Trace run result from a CRMScript Carrier object for CRMScriptTraceRun. Services for the CRMScriptTraceRun Carrier is available from the CRMScript Agent.

Show child attributes

Eventdata

object

EventData containing data related to event handlers Carrier object for EventData. Services for the EventData Carrier is available from the CustomerService Agent.

Show child attributes

Success

boolean

Indicates if the script was executed successfully, or if it failed. In case of failing, the error members will contain more information

ErrorInformation

object

Object containing error information for a CRMScript Carrier object for CRMScriptErrorInfo. Services for the CRMScriptErrorInfo Carrier is available from the CRMScript Agent.

Show child attributes

StatusCode

integer<int32>

The status code which is available to be returned from Typescript scripts

StatusMessage

string

An additional status message that can be sent along with the status code

Headers

object

Optional result headers for context that supports it

Show child attributes

TableRight

object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

Show child attributes

FieldProperties

object

Field property dictionary mapping field names to field access rights.

Show child attributes