TemplateVariablesApi

All URIs are relative to /api

Method	HTTP request	Description
create	POST /template-variables	Create a variable
destroy	DELETE /template-variables/{lookup}	Delete a variable
list	GET /template-variables	List template variables
replace	PUT /template-variables/{lookup}	Replace a variable
retrieve	GET /template-variables/{lookup}	Get a variable
update	PATCH /template-variables/{lookup}	Update a variable

create

TemplateVariable create(CreateTemplateVariableDto, limit, offset, order[], filter[], or[], expand[])

Create a variable

Create a new template variable (Admin only)

Parameters

Name	Type	Notes
CreateTemplateVariableDto	CreateTemplateVariableDto
limit	BigDecimal	[optional] [default to null]
offset	BigDecimal	[optional] [default to null]
order[]	List	[optional] [default to null]
filter[]	List	[optional] [default to null]
or[]	List	[optional] [default to null]
expand[]	List	[optional] [default to null]

Return type

TemplateVariable

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

destroy

destroy(lookup)

Delete a variable

Delete a template variable (Admin only)

Parameters

Name	Type	Description	Notes
lookup	BigDecimal		[default to null]

Return type

null (empty response body)

Authorization

api-key

HTTP request headers

Content-Type: Not defined
Accept: application/json

list

TemplateVariableListResponseDto list(limit, offset, order[], filter[], or[], expand[])

List template variables

List variables, optionally filter by template

Parameters

Name	Type	Notes
limit	BigDecimal	[optional] [default to null]
offset	BigDecimal	[optional] [default to null]
order[]	List	[optional] [default to null]
filter[]	List	[optional] [default to null]
or[]	List	[optional] [default to null]
expand[]	List	[optional] [default to null]

Return type

TemplateVariableListResponseDto

Authorization

api-key

HTTP request headers

Content-Type: Not defined
Accept: application/json

replace

TemplateVariable replace(lookup, CreateTemplateVariableDto, limit, offset, order[], filter[], or[], expand[])

Replace a variable

Full replace of a template variable (Admin only)

Parameters

Name	Type	Notes
lookup	BigDecimal	[default to null]
CreateTemplateVariableDto	CreateTemplateVariableDto
limit	BigDecimal	[optional] [default to null]
offset	BigDecimal	[optional] [default to null]
order[]	List	[optional] [default to null]
filter[]	List	[optional] [default to null]
or[]	List	[optional] [default to null]
expand[]	List	[optional] [default to null]

Return type

TemplateVariable

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json

retrieve

TemplateVariable retrieve(lookup, limit, offset, order[], filter[], or[], expand[])

Get a variable

Get a single template variable by ID

Parameters

Name	Type	Notes
lookup	BigDecimal	[default to null]
limit	BigDecimal	[optional] [default to null]
offset	BigDecimal	[optional] [default to null]
order[]	List	[optional] [default to null]
filter[]	List	[optional] [default to null]
or[]	List	[optional] [default to null]
expand[]	List	[optional] [default to null]

Return type

TemplateVariable

Authorization

api-key

HTTP request headers

Content-Type: Not defined
Accept: application/json

update

TemplateVariable update(lookup, UpdateTemplateVariableDto, limit, offset, order[], filter[], or[], expand[])

Update a variable

Update a template variable (Admin only)

Parameters

Name	Type	Notes
lookup	BigDecimal	[default to null]
UpdateTemplateVariableDto	UpdateTemplateVariableDto
limit	BigDecimal	[optional] [default to null]
offset	BigDecimal	[optional] [default to null]
order[]	List	[optional] [default to null]
filter[]	List	[optional] [default to null]
or[]	List	[optional] [default to null]
expand[]	List	[optional] [default to null]

Return type

TemplateVariable

Authorization

api-key

HTTP request headers

Content-Type: application/json
Accept: application/json