GET api/Plugins

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Plugin

Name	Type	Additional information
PluginId	integer	None.
Name	string	Required String length: inclusive between 0 and 100
ShortName	string	Required String length: inclusive between 0 and 50
Path	string	Required String length: inclusive between 0 and 500
IsLatestVersion	boolean	None.
AllowAutoUpdate	boolean	None.
IsExecutable	boolean	None.
PluginSettings	Collection of PluginSetting	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "PluginId": 1,
    "Name": "sample string 2",
    "ShortName": "sample string 3",
    "Path": "sample string 4",
    "IsLatestVersion": true,
    "AllowAutoUpdate": true,
    "IsExecutable": true,
    "PluginSettings": [
      {
        "PluginSettingId": 1,
        "PluginId": 2,
        "SettingId": 3,
        "IsRequired": true,
        "Setting": {
          "SettingId": 1,
          "Name": "sample string 2",
          "Key": "sample string 3",
          "Default": "sample string 4",
          "IsAdvanced": true
        }
      },
      {
        "PluginSettingId": 1,
        "PluginId": 2,
        "SettingId": 3,
        "IsRequired": true,
        "Setting": {
          "SettingId": 1,
          "Name": "sample string 2",
          "Key": "sample string 3",
          "Default": "sample string 4",
          "IsAdvanced": true
        }
      }
    ]
  },
  {
    "PluginId": 1,
    "Name": "sample string 2",
    "ShortName": "sample string 3",
    "Path": "sample string 4",
    "IsLatestVersion": true,
    "AllowAutoUpdate": true,
    "IsExecutable": true,
    "PluginSettings": [
      {
        "PluginSettingId": 1,
        "PluginId": 2,
        "SettingId": 3,
        "IsRequired": true,
        "Setting": {
          "SettingId": 1,
          "Name": "sample string 2",
          "Key": "sample string 3",
          "Default": "sample string 4",
          "IsAdvanced": true
        }
      },
      {
        "PluginSettingId": 1,
        "PluginId": 2,
        "SettingId": 3,
        "IsRequired": true,
        "Setting": {
          "SettingId": 1,
          "Name": "sample string 2",
          "Key": "sample string 3",
          "Default": "sample string 4",
          "IsAdvanced": true
        }
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfPlugin xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Starship.WebAPI.Models">
  <Plugin>
    <AllowAutoUpdate>true</AllowAutoUpdate>
    <IsExecutable>true</IsExecutable>
    <IsLatestVersion>true</IsLatestVersion>
    <Name>sample string 2</Name>
    <Path>sample string 4</Path>
    <PluginId>1</PluginId>
    <PluginSettings>
      <PluginSetting>
        <IsRequired>true</IsRequired>
        <PluginId>2</PluginId>
        <PluginSettingId>1</PluginSettingId>
        <Setting>
          <Default>sample string 4</Default>
          <IsAdvanced>true</IsAdvanced>
          <Key>sample string 3</Key>
          <Name>sample string 2</Name>
          <SettingId>1</SettingId>
        </Setting>
        <SettingId>3</SettingId>
      </PluginSetting>
      <PluginSetting>
        <IsRequired>true</IsRequired>
        <PluginId>2</PluginId>
        <PluginSettingId>1</PluginSettingId>
        <Setting>
          <Default>sample string 4</Default>
          <IsAdvanced>true</IsAdvanced>
          <Key>sample string 3</Key>
          <Name>sample string 2</Name>
          <SettingId>1</SettingId>
        </Setting>
        <SettingId>3</SettingId>
      </PluginSetting>
    </PluginSettings>
    <ShortName>sample string 3</ShortName>
  </Plugin>
  <Plugin>
    <AllowAutoUpdate>true</AllowAutoUpdate>
    <IsExecutable>true</IsExecutable>
    <IsLatestVersion>true</IsLatestVersion>
    <Name>sample string 2</Name>
    <Path>sample string 4</Path>
    <PluginId>1</PluginId>
    <PluginSettings>
      <PluginSetting>
        <IsRequired>true</IsRequired>
        <PluginId>2</PluginId>
        <PluginSettingId>1</PluginSettingId>
        <Setting>
          <Default>sample string 4</Default>
          <IsAdvanced>true</IsAdvanced>
          <Key>sample string 3</Key>
          <Name>sample string 2</Name>
          <SettingId>1</SettingId>
        </Setting>
        <SettingId>3</SettingId>
      </PluginSetting>
      <PluginSetting>
        <IsRequired>true</IsRequired>
        <PluginId>2</PluginId>
        <PluginSettingId>1</PluginSettingId>
        <Setting>
          <Default>sample string 4</Default>
          <IsAdvanced>true</IsAdvanced>
          <Key>sample string 3</Key>
          <Name>sample string 2</Name>
          <SettingId>1</SettingId>
        </Setting>
        <SettingId>3</SettingId>
      </PluginSetting>
    </PluginSettings>
    <ShortName>sample string 3</ShortName>
  </Plugin>
</ArrayOfPlugin>