Templates

Create backup Template

post

Creates a backup Template. You can configure record selection using declarative, SOQL, or SQL filters

Autorizações

AuthorizationstringObrigatório

Bearer <access_token>

Parâmetros de rota

connectionIdnumberObrigatório

Corpo

namestringObrigatórioExample: My new backup template

typestring · enumObrigatórioExample: backupValores possíveis:

descriptionstringOpcionalExample: This is my template

Respostas

201Sucesso

application/json

messagestringObrigatório

400

Incorrect request data is provided. For example, connectionId isn't a valid positive number

application/json

404

Connection not found

application/json

post/api/v1/connections/{connectionId}/templates/backup

POST /api/v1/connections/{connectionId}/templates/backup HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 547

{
  "name": "My new backup template",
  "type": "backup",
  "description": "This is my template",
  "templateSteps": [
    {
      "relationshipName": "text",
      "objectApiName": "Account",
      "label": "Account",
      "filterMode": "declarative",
      "fieldsDescribe": [
        {
          "name": "Name",
          "label": "Name",
          "type": "string",
          "isRequired": true,
          "isFilterable": true,
          "createable": true,
          "defaultedOnCreate": true,
          "nillable": true
        }
      ],
      "soqlFilter": "Name = 'TEST'",
      "customLogic": "",
      "declarativeFilter": [
        {
          "field": "Name",
          "label": "Account Name",
          "option": "equals",
          "value": "Test Account"
        }
      ],
      "skipRemove": false,
      "children": []
    }
  ]
}

{
  "message": "text"
}

Get list of Templates

get

Returns a paginated list of Templates with customizable page size

Autorizações

AuthorizationstringObrigatório

Bearer <access_token>

Parâmetros de rota

connectionIdnumberObrigatório

Parâmetros de consulta

searchstringOpcional

Search term (max 80)

pagenumberObrigatório

Number of page (min 1)

Example: 1

limitnumberObrigatório

Limit of entities per page (min 1, max 2000)

Example: 50

sortBystring · enumOpcionalExample: updatedAtValores possíveis:

orderstring · enumOpcionalExample: DESCValores possíveis:

Respostas

200

Returns a paginated list of Templates

application/json

totalnumberObrigatório

Total number of entities.

Example: 1

backupTemplatesCountnumberObrigatórioExample: 1

archiveTemplatesCountnumberObrigatórioExample: 1

400

Incorrect request data is provided. For example, page or limit parameters are missing

application/json

404

Connection not found

application/json

get/api/v1/connections/{connectionId}/templates

GET /api/v1/connections/{connectionId}/templates?page=1&limit=1&types=backup HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "total": 1,
  "items": [
    {
      "id": 1,
      "name": "My new backup template",
      "type": "backup",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    }
  ],
  "backupTemplatesCount": 1,
  "archiveTemplatesCount": 1
}

Get backup Template by Id

get

Returns the Template by Id

Autorizações

AuthorizationstringObrigatório

Bearer <access_token>

Parâmetros de rota

connectionIdnumberObrigatório

idnumberObrigatório

Respostas

200

Returns the Template by Id

application/json

idnumberObrigatórioExample: 1

namestringObrigatórioExample: My new backup template

typestring · enumObrigatórioExample: backupValores possíveis:

descriptionstringOpcionalExample: This is my template

400

Incorrect request data is provided. For example, templateId isn't a valid number

application/json

404

Template not found with the provided Id

application/json

get/api/v1/connections/{connectionId}/templates/backup/{id}

GET /api/v1/connections/{connectionId}/templates/backup/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "name": "My new backup template",
  "type": "backup",
  "description": "This is my template",
  "roots": [
    [
      {
        "relationshipName": "text",
        "objectApiName": "Account",
        "label": "Account",
        "soqlFilter": "Name = 'TEST'",
        "customLogic": "",
        "declarativeFilter": [
          {
            "field": "Name",
            "label": "Account Name",
            "option": "equals",
            "value": "Test Account"
          }
        ],
        "skipRemove": false,
        "id": 1,
        "level": 1,
        "filterMode": "declarative",
        "parentId": 1
      }
    ]
  ]
}