ToolsResponse Data Type

Response containing the custom tools to display in the UI

Properties
name data type constraints description
tools array of CustomTool   List of custom tools
messages array of Message   Messages contained in the response (which should be shown to the user)
responseInfo ResponseInfo  
inBackground boolean required boolean Whether the job was pushed into the background.

Example

{
  "tools" : [ {
    "id" : 12345,
    "key" : "...",
    "name" : {
      "property1" : "...",
      "property2" : "..."
    },
    "toolUrl" : "...",
    "iconUrl" : "...",
    "newtab" : true
  }, {
    "id" : 12345,
    "key" : "...",
    "name" : {
      "property1" : "...",
      "property2" : "..."
    },
    "toolUrl" : "...",
    "iconUrl" : "...",
    "newtab" : true
  } ],
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  },
  "inBackground" : true
}