Templates

This contains a list of APIs specific to the Templates Validations and Refresh

Create a Template

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

branch
string

Name of the branch.

repoIdentifier
string

Git Sync Config Id.

rootFolder
string

Path to the root folder of the Entity.

filePath
string

File Path of the Entity.

commitMsg
string

File Path of the Entity.

isNewBranch
boolean
Default: false

Checks the new branch

baseBranch
string

Name of the default branch.

connectorRef
string

Identifier of Connector needed for CRUD operations on the respective Entity

storeType
string

Tells whether the Entity is to be saved on Git or not

Enum: "INLINE" "REMOTE"
repoName
string

Name of the repository.

setDefaultTemplate
boolean
Default: false

Specify true if Default Template is to be set

comments
string

Comments

Request Body schema:

Template YAML

string
Responses
400

Bad Request

500

Internal Server Error

default

Returns the created Template

post/template/api/templates
Request samples
"string"
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Delete Template Version

SecurityApiKey
Request
path Parameters
templateIdentifier
required
string

Template Identifier for the entity

versionLabel
required
string

Version Label

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

branch
string

Name of the branch.

repoIdentifier
string

Git Sync Config Id.

rootFolder
string

Path to the root folder of the Entity.

filePath
string

File Path of the Entity.

commitMsg
string

Commit Message to use for the merge commit.

lastObjectId
string

Last Object Id

comments
string
header Parameters
If-Match
string
Responses
400

Bad Request

500

Internal Server Error

default

Returns true if the Template is deleted

delete/template/api/templates/{templateIdentifier}/{versionLabel}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get all the Variables which can be used as expression in the Template.

SecurityApiKey
Request
query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
required
string

Organization Identifier for the Entity.

projectIdentifier
required
string

Project Identifier for the Entity.

Request Body schema:

Template YAML

string
Responses
400

Bad Request

500

Internal Server Error

default

Returns all Variables used that are valid to be used as expression in template.

post/template/api/templates/v2/variables
Request samples
"string"
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Get Template

SecurityApiKey
Request
path Parameters
templateIdentifier
required
string

Template Identifier for the entity

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

versionLabel
string

Version Label

deleted
boolean
Default: false

Specifies whether Template is deleted or not

branch
string

Name of the branch.

repoIdentifier
string

Git Sync Config Id.

getDefaultFromOtherRepo
boolean

if true, return all the default entities

Responses
400

Bad Request

500

Internal Server Error

default

Returns the saved Template

get/template/api/templates/{templateIdentifier}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Update Stable Template Version

SecurityApiKey
Request
path Parameters
templateIdentifier
required
string

Template Identifier for the entity

versionLabel
required
string

Version Label

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

branch
string

Name of the branch.

repoIdentifier
string

Git Sync Config Id.

getDefaultFromOtherRepo
boolean

if true, return all the default entities

comments
string

Comments

Responses
400

Bad Request

500

Internal Server Error

default

Returns the updated Template Version

put/template/api/templates/updateStableTemplate/{templateIdentifier}/{versionLabel}
Request samples
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Update Template Version

SecurityApiKey
Request
path Parameters
templateIdentifier
required
string

Template Identifier for the entity

versionLabel
required
string

Version Label

query Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

orgIdentifier
string

Organization Identifier for the Entity.

projectIdentifier
string

Project Identifier for the Entity.

branch
string

Name of the branch.

repoIdentifier
string

Git Sync Config Id.

rootFolder
string

Path to the root folder of the Entity.

filePath
string

Path to the root folder of the Entity.

commitMsg
string

Commit Message to use for the merge commit.

lastObjectId
string

Last Object Id

resolvedConflictCommitId
string

If the entity is git-synced, this parameter represents the commit id against which file conflicts are resolved

baseBranch
string

Name of the default branch.

connectorRef
string

Identifier of Connector needed for CRUD operations on the respective Entity

setDefaultTemplate
boolean
Default: false

Specify true if Default Template is to be set

comments
string

Comments

header Parameters
If-Match
string
Request Body schema:

Template YAML

string
Responses
400

Bad Request

500

Internal Server Error

default

Returns the updated Template Version

put/template/api/templates/update/{templateIdentifier}/{versionLabel}
Request samples
"string"
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}