Get information about the plugin

Return a JSON representation of the plugin

Request

GET https://{hostname}:{port}
  /build/rest2/plugins{id}

Table 1. URL parameters
Parameter	Type	Required	Description
id	string	true	The identifier to use when looking up plugin. This is the ID or name of the plugin

This command takes a JSON request string or file. Use the following template for the request:

{
  "apiVersion": "The API version of the plugin",
  "commands": [{
    "description": "The description of the command",
    "id": "The id of the command",
    "name": "The name of the command",
    "postProcessingScript": "The post processing script of 
  the command",
    "propSheetDefs": [{
      "description": "The description of the plugin",
      "id": "The id of the Property sheet",
      "name": "The name of the plugin",
      "properties": [{
        "allowedValuePropSheetDef": "The id of the 
  PropSheetDef containing the allowed values for the 
  property",
        "allowedValues": [{
          "id": "The id of the allowed value",
          "label": "The label of the allowed value",
          "value": "The value of the allowed value"
        }],
        "default-value": "The default value of the 
  property",
        "description": "The description of the property",
        "hidden": "Whether or not the property is hidden",
        "id": "The id of the property",
        "label": "A label for this property shown when 
  prompting users for a value",
        "name": "The name of the property",
        "required": "Whether or not the value of the 
  property is required",
        "secure": "Whether or not the value of the 
  property is secure",
        "type": "The type of the property",
        "value": "The value of the property. This is only 
  used for properties on non-template objects (project, but 
  not project template, etc)"
      }]
    }],
    "type": "The type of the command",
    "validationScript": "The validation script of the 
  command",
    "validationScriptLanguage": "The language of the 
  validation script"
  }],
  "description": "The description of the plugin",
  "hash": "The hash value of the plugin",
  "id": "The id of the plugin",
  "location": "The URL that can be used to get the JSON 
  representation of the plugin",
  "name": "The name of the plugin",
  "pluginId": "The Plug-in ID of the plugin",
  "pluginVersion": "The version of the plugin",
  "propSheetDefs": [{
    "description": "The description of the plugin",
    "id": "The id of the Property sheet",
    "name": "The name of the plugin",
    "properties": [{
      "allowedValuePropSheetDef": "The id of the 
  PropSheetDef containing the allowed values for the 
  property",
      "allowedValues": [{
        "id": "The id of the allowed value",
        "label": "The label of the allowed value",
        "value": "The value of the allowed value"
      }],
      "default-value": "The default value of the property",
      "description": "The description of the property",
      "hidden": "Whether or not the property is hidden",
      "id": "The id of the property",
      "label": "A label for this property shown when 
  prompting users for a value",
      "name": "The name of the property",
      "required": "Whether or not the value of the 
  property is required",
      "secure": "Whether or not the value of the property 
  is secure",
      "type": "The type of the property",
      "value": "The value of the property. This is only 
  used for properties on non-template objects (project, but 
  not project template, etc)"
    }]
  }],
  "tag": "The tag of the plugin",
  "type": "The type of the plugin"
}