Get information about a process template

Return a JSON representation of a process template

Request

GET https://{hostname}:{port}
  /build/rest2/buildProcessTemplates/{id}
Table 1. URL parameters
Parameter Type Required Description
id string true The identifier to use when looking up a process template. This can be the name or ID of the process template
This command takes a JSON request string or file. Use the following template for the request:
{
  "active": "Whether or not the process template is 
  active.",
  "artifact-set-configuration": [{
    "artifactSet": "The name of the Artifact Sets",
    "baseDir": "The directory containing the artifact 
  files",
    "excludes": "The patterns used to determine which 
  files should be excluded from the artifact set even if 
  they match the include patterns",
    "includes": "The patterns used to determine which 
  files should be included in the artifact set"
  }],
  "description": "The process template description",
  "id": "The ID of the process template",
  "location": "The URL that can be used to get the JSON 
  representation of the process template",
  "name": "The name of the process template",
  "properties": [{
    "allowed-values": "The values users are allowed to 
  select for this property. Separate each value by entering 
  it on its own line",
    "default-value": "The default value of the property",
    "description": "The description of the property",
    "display-type": "The display type of the property 
  (Text, Select, Checkbox, Multi-Select, Text Area, Text 
  (secure), Integration Plugin, Agent Pool)",
    "label": "A label for this property shown when 
  prompting users for value. Leave blank to use the name as 
  the label",
    "name": "The name of the property",
    "required": "Whether or not the value of the property 
  is required.",
    "runtime": "Whether or not the value is entered at the 
  runtime of a build. When true, the property will appear by 
  the Build button. When false, the property will appear in 
  the Configuration tab",
    "saveToBuildConfig": "Whether or not to save the 
  property to build configurations. This is only used with 
  projects, processes, and their respective templates.",
    "scripted": "Whether or not the value type of the 
  property is scripted",
    "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 process template (Build or 
  Secondary)"
}