POST api/Tool

Request Information

URI Parameters

None.

Body Parameters

Tool

Name	Type	Additional information
ToolName	string	Required
ToolVersion	integer	None.
DisplayName	string	Required
ToolCategory	string	Required
ExecutableFilePath	string	None.
ProgramTerminalPath	string	None.
RunOptions	Collection of RunOption	None.
Note	string	None.
TimeOut	integer	Range: inclusive between 0 and 2147483647
InternalOnly	string	None.
IsPremium	boolean	None.
ChargePerRun	decimal number	None.
OutputFormat	string	None.
Uuid	string	None.
OrganizationUuid	string	None.
CreatedBy	string	None.
ModifiedBy	string	None.
Hidden	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "ToolName": "sample string 1",
  "ToolVersion": 2,
  "DisplayName": "sample string 3",
  "ToolCategory": "sample string 4",
  "ExecutableFilePath": "sample string 5",
  "ProgramTerminalPath": "sample string 6",
  "RunOptions": [
    {
      "Index": 1,
      "Option": "sample string 2",
      "Arguments": "sample string 3"
    },
    {
      "Index": 1,
      "Option": "sample string 2",
      "Arguments": "sample string 3"
    }
  ],
  "Note": "sample string 7",
  "TimeOut": 8,
  "InternalOnly": "Y",
  "Internal": true,
  "IsPremium": true,
  "ChargePerRun": 12.0,
  "OutputFormat": "sample string 13",
  "Uuid": "sample string 14",
  "OrganizationUuid": "sample string 15",
  "CreatedOn": "2024-11-21T04:44:03.6892797-05:00",
  "CreatedBy": "sample string 18",
  "ModifiedOn": "2024-11-21T04:44:03.6892797-05:00",
  "ModifiedBy": "sample string 21",
  "Hidden": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Tool

Name	Type	Additional information
ToolName	string	Required
ToolVersion	integer	None.
DisplayName	string	Required
ToolCategory	string	Required
ExecutableFilePath	string	None.
ProgramTerminalPath	string	None.
RunOptions	Collection of RunOption	None.
Note	string	None.
TimeOut	integer	Range: inclusive between 0 and 2147483647
InternalOnly	string	None.
IsPremium	boolean	None.
ChargePerRun	decimal number	None.
OutputFormat	string	None.
Uuid	string	None.
OrganizationUuid	string	None.
CreatedBy	string	None.
ModifiedBy	string	None.
Hidden	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ToolName": "sample string 1",
  "ToolVersion": 2,
  "DisplayName": "sample string 3",
  "ToolCategory": "sample string 4",
  "ExecutableFilePath": "sample string 5",
  "ProgramTerminalPath": "sample string 6",
  "RunOptions": [
    {
      "Index": 1,
      "Option": "sample string 2",
      "Arguments": "sample string 3"
    },
    {
      "Index": 1,
      "Option": "sample string 2",
      "Arguments": "sample string 3"
    }
  ],
  "Note": "sample string 7",
  "TimeOut": 8,
  "InternalOnly": "Y",
  "Internal": true,
  "IsPremium": true,
  "ChargePerRun": 12.0,
  "OutputFormat": "sample string 13",
  "Uuid": "sample string 14",
  "OrganizationUuid": "sample string 15",
  "CreatedOn": "2024-11-21T04:44:03.6892797-05:00",
  "CreatedBy": "sample string 18",
  "ModifiedOn": "2024-11-21T04:44:03.6892797-05:00",
  "ModifiedBy": "sample string 21",
  "Hidden": true
}