The response to a templates.get request.
JSON representation | |
---|---|
{ "status": { object( |
Fields | |
---|---|
status |
The status of the get template request. Any problems with the request will be indicated in the error_details. |
metadata |
The template metadata describing the template name, available parameters, etc. |
TemplateMetadata
Metadata describing a template.
JSON representation | |
---|---|
{
"name": string,
"description": string,
"parameters": [
{
object( |
Fields | |
---|---|
name |
Required. The name of the template. |
description |
Optional. A description of the template. |
parameters[] |
The parameters for the template. |
ParameterMetadata
Metadata for a specific parameter.
JSON representation | |
---|---|
{ "name": string, "label": string, "helpText": string, "isOptional": boolean, "regexes": [ string ] } |
Fields | |
---|---|
name |
Required. The name of the parameter. |
label |
Required. The label to display for the parameter. |
helpText |
Required. The help text to display for the parameter. |
isOptional |
Optional. Whether the parameter is optional. Defaults to false. |
regexes[] |
Optional. Regexes that the parameter must match. |