GET api/Characterisation/List

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

CharacterisationViewModel
NameDescriptionTypeAdditional information
Tools

Collection of Tool

None.

Characterisations

Collection of Characterisation

None.

Response Formats

application/json, text/json

Sample:
{
  "Tools": [
    {
      "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": "2022-10-01T10:39:24.1820993-04:00",
      "CreatedBy": "sample string 18",
      "ModifiedOn": "2022-10-01T10:39:24.1820993-04:00",
      "ModifiedBy": "sample string 21",
      "Hidden": true
    },
    {
      "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": "2022-10-01T10:39:24.1820993-04:00",
      "CreatedBy": "sample string 18",
      "ModifiedOn": "2022-10-01T10:39:24.1820993-04:00",
      "ModifiedBy": "sample string 21",
      "Hidden": true
    }
  ],
  "Characterisations": [
    null,
    {
      "ToolUuid": "sample string 1",
      "ToolName": "sample string 2",
      "Active": true,
      "Arguments": "sample string 4",
      "OutputMapString": "null",
      "OutputMap": null,
      "OutputFormatString": "File",
      "OutputFormat": 0,
      "FilePath": null,
      "Note": null,
      "Internal": false,
      "Uuid": null,
      "OrganizationUuid": null,
      "CreatedOn": "0001-01-01T00:00:00",
      "CreatedBy": null,
      "ModifiedOn": "0001-01-01T00:00:00",
      "ModifiedBy": null,
      "Hidden": false
    }
  ]
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.