Template
This endpoint is used to create, update, search or delete teamplates inside an organization.
Entity fields:
data.type
string
Should be "template"
data.attributes.tcl
string
Terraform Configuration Language job template
data.attribute.name
string
Template name
data.attribute.description
string
Template description
data.attribute.version
string
Template version
Example:
{
"data": {
"type": "template",
"attributes": {
"name": "Some name",
"description": "Some description",
"version": "1.0.0",
"tcl": "{{templateSample}}"
}
}
}
Supported Operations
Creates an item of type template and adds it to template
organization Identifier
Successful response
POST /api/v1/organization/{organizationId}/template HTTP/1.1
Host:
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 305
{
"data": {
"type": "text",
"id": "text",
"attributes": {
"createdBy": null,
"createdDate": null,
"description": null,
"name": null,
"tcl": null,
"updatedBy": null,
"updatedDate": null,
"version": null
},
"relationships": {
"organization": {
"data": [
null
]
}
}
},
"included": [
{
"type": "text",
"id": "text",
"attributes": {},
"relationships": {}
}
]
}
Successful response
{
"data": {
"type": "text",
"id": "text",
"attributes": {
"createdBy": null,
"createdDate": null,
"description": null,
"name": null,
"tcl": null,
"updatedBy": null,
"updatedDate": null,
"version": null
},
"relationships": {
"organization": {
"data": [
null
]
}
}
},
"included": [
{
"type": "text",
"id": "text",
"attributes": {},
"relationships": {}
}
]
}
Returns an instance of type template
organization Identifier
template Identifier
Successful response
GET /api/v1/organization/{organizationId}/template/{templateId} HTTP/1.1
Host:
Accept: */*
Successful response
{
"data": {
"type": "text",
"id": "text",
"attributes": {
"createdBy": null,
"createdDate": null,
"description": null,
"name": null,
"tcl": null,
"updatedBy": null,
"updatedDate": null,
"version": null
},
"relationships": {
"organization": {
"data": [
null
]
}
}
},
"included": [
{
"type": "text",
"id": "text",
"attributes": {},
"relationships": {}
}
]
}
Deletes an instance of type template
organization Identifier
template Identifier
Successful response
DELETE /api/v1/organization/{organizationId}/template/{templateId} HTTP/1.1
Host:
Accept: */*
Successful response
No content
Modifies an instance of type template
organization Identifier
template Identifier
Successful response
PATCH /api/v1/organization/{organizationId}/template/{templateId} HTTP/1.1
Host:
Content-Type: application/vnd.api+json
Accept: */*
Content-Length: 305
{
"data": {
"type": "text",
"id": "text",
"attributes": {
"createdBy": null,
"createdDate": null,
"description": null,
"name": null,
"tcl": null,
"updatedBy": null,
"updatedDate": null,
"version": null
},
"relationships": {
"organization": {
"data": [
null
]
}
}
},
"included": [
{
"type": "text",
"id": "text",
"attributes": {},
"relationships": {}
}
]
}
Successful response
No content
Returns the relationship template
organization Identifier
Filters the collection of template using a 'disjoint' RSQL expression
Number of pages to return. Can be used with page[size]
Number of elements per page. Can be used with page[number]
Offset from 0 to start paginating. Can be used with page[limit]
Maximum number of items to return. Can be used with page[offset]
For requesting total pages/records be included in the response page meta data
Successful response
GET /api/v1/organization/{organizationId}/template HTTP/1.1
Host:
Accept: */*
Successful response
{
"data": [
{
"type": "text",
"id": "text",
"attributes": {
"createdBy": null,
"createdDate": null,
"description": null,
"name": null,
"tcl": null,
"updatedBy": null,
"updatedDate": null,
"version": null
},
"relationships": {
"organization": {
"data": [
null
]
}
}
}
],
"included": [
{
"type": "text",
"id": "text",
"attributes": {},
"relationships": {}
}
]
}
Last updated
Was this helpful?