WriteResponseObject

Description

A mechanism for the script to return arbitrary data, of any type, to the client.

Parameters

Parameter Name	Description	Type	Resolved Type	Required
Value	The data to be returned to the client	Value	Any	Yes

Examples

Example:

  {
    "WriteResponseObject": {
      "Value": "Make this available to the client"
    }
  },
  {
    "SetItem": {
      "Name": "ExampleArray",
      "Value": [ "And", "this", "too" ]
    }
  },
  {
    "WriteResponseObject": {
      "Value": "%{ExampleArray}%"
    }
  }

The data supplied by WriteResponseObject can be retrieved with a Get request to the Operations./Response endpoint. For example, Get request:

https://Address:Port/api/v1/Operations/c06bfeaa-0b79-4008-b002-7ce8b6aea26e/Response

Returns data set by the above example:

{
    "page": 1,
    "perPage": 25,
    "count": 2,
    "link": "https://127.0.0.1:20001/api/v1/operations/c06bfeaa-0b79-4008-b002-7ce8b6aea26e/response?page=1&perpage=25",
    "next": "https://127.0.0.1:20001/api/v1/operations/c06bfeaa-0b79-4008-b002-7ce8b6aea26e/response?page=2&perpage=25",
    "previous": null,
    "items": [
        "Make this available to the client",
        [
            "And",
            "this",
            "to"
        ]
    ]
}