Get information about all source config templates
Return a JSON representation of all source config templates.
Request
GET https://{hostname}:{port}
/build/rest2/sourceTemplates?{parameters}
| Parameter | Type | Required | Description |
|---|---|---|---|
| rowsPerPage | int | false | The number of source config templates to return per page. |
| pageNumber | int | false | The page of source config templates that should be returned. |
| orderField | string | false | The field to use when sorting the source config templates. This would either be 'name' or 'id'. |
| sortType | string | false | The order to use when sorting the source config templates. This would either be 'asc' or 'desc'. |
| filterValue_name | string | false | The source config template name pattern to search for. |
This command takes a JSON request string or file. Use the following template for the request:
{
"description": "The source config template description",
"id": "The ID of the source config template",
"location": "The URL that can be used to get the JSON
representation of the source config template",
"name": "The name of thesource config template",
"plugin": "The Plug-in ID of Source Plug-in",
"plugin-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."
}],
"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."
}],
"work-dir-script": "The id of working directory script"
}
