Ресурс

Workflow Variable

Store environment variables or secrets for your workflows.

Модель Workflow Variable

Свойства

Имя
_id
Тип
Object ID
Описание
ID of this object
Имя
createdAt
Тип
Date
Описание
Date and Time when the object was created.
Имя
updatedAt
Тип
Date
Описание
Date and Time when the object was updated.
Имя
project
Тип
Project
Описание
Relation to Project Resource in which this object belongs
Имя
projectId
Тип
Object IDОбязательно
Описание
ID of your Project in which this object belongs
Имя
workflow
Тип
Workflow
Описание
Workflow this variable belong to. If this is null then this variable will be a global variable
Имя
workflowId
Тип
Object ID
Описание
ID of Workflow this variable belong to. If this is null then this variable will be a global variable
Имя
name
Тип
TextОбязательно
Описание
Variable Name
Имя
description
Тип
Long Text
Описание
Friendly description that will help you remember
Имя
content
Тип
Very Long TextОбязательно
Описание
Content of the variable
Имя
isSecret
Тип
BooleanОбязательно
Описание
Is this variable a secret. If true, then it'll not be in the logs
Имя
createdByUser
Тип
User
Описание
Relation to User who created this object (if this object was created by a User)
Имя
createdByUserId
Тип
Object ID
Описание
User ID who created this object (if this object was created by a User)

GETorPOST/api/workflow-variable/get-list

Список

Этот метод возвращает постраничный список ваших объектов «Workflow Variable». По умолчанию на странице до десяти записей.

Необязательные query-параметры

limit
число
Сколько объектов вернуть. По умолчанию 10, максимум 100
skip
число
Сколько объектов пропустить (для пагинации)

Необязательное тело запроса

query
Чтобы фильтровать Workflow Variable, укажите запрос здесь. Подробнее: написание запросов.
select
По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.
sort
По умолчанию сортировка по дате создания. Порядок можно изменить — см. раздел «Сортировка» в типах данных.

Запрос списка

POST

/api/workflow-variable/get-list?skip=0&limit=10

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "isSecret": true,
    "name": true,
    "projectId": true,
    "_id": true,
    "createdAt": true
  },
  "query": {
    "content": "Example content"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "378010a0-28fe-11f1-b591-3fdcef396aba",
      "isSecret": true,
      "name": "Example name",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "_id": "378010a1-28fe-11f1-b591-3fdcef396aba",
      "isSecret": true,
      "name": "Example name",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "_id": "378010a2-28fe-11f1-b591-3fdcef396aba",
      "isSecret": true,
      "name": "Example name",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "createdAt": "2024-01-15T10:30:00.000Z"
    }
  ]
}

GETorPOST/api/workflow-variable/:id/get-item

Получить по ID

Возвращает объект «Workflow Variable» по идентификатору.

id
строка
ID объекта

Необязательное тело запроса

select
По умолчанию возвращается только ID; для других полей используйте select. Подробнее: как выбирать поля.

Запрос одного объекта

POST

/api/workflow-variable/:id/get-item

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "select": {
    "isSecret": true,
    "name": true,
    "projectId": true,
    "_id": true,
    "createdAt": true
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "isSecret": true,
  "name": "Example name",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2024-01-15T10:30:00.000Z"
}

POST/api/workflow-variable/count

Количество

Возвращает количество ваших объектов «Workflow Variable».

Необязательное тело запроса

query
Чтобы фильтровать Workflow Variable, укажите запрос здесь. Подробнее: написание запросов.

Запрос количества

POST

/api/workflow-variable/count

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "query": {
    "content": "Example content"
  }
}

Ответ

{
  "count": 107
}

POST/api/workflow-variable

Создать Workflow Variable

Создаёт новый объект.

Запрос создания

POST

/api/workflow-variable

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "content": "Example content",
    "isSecret": true,
    "name": "Example name",
    "projectId": "550e8400-e29b-41d4-a716-446655440000",
    "createdByUser": "Example created by user"
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "isSecret": true,
  "name": "Example name",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2024-01-15T10:30:00.000Z"
}

PUT/api/workflow-variable/:id

Обновить по ID

Обновляет объект по ID.

Альтернативные методы

Если клиент не поддерживает PUT, используйте POST или GET с теми же заголовками и телом:

POST/api/workflow-variable/:id/update-item

GET/api/workflow-variable/:id/update-item

Запрос обновления

PUT

/api/workflow-variable/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Тело

{
  "data": {
    "content": "Example content",
    "name": "Example name",
    "description": "Example description"
  }
}

Ответ

{}

DELETE/api/workflow-variable/:id

Удалить по ID

Удаляет объект по ID.

Альтернативные методы

Если клиент не поддерживает DELETE, используйте POST или GET с теми же заголовками и телом:

POST/api/workflow-variable/:id/delete-item

GET/api/workflow-variable/:id/delete-item

Запрос удаления

DELETE

/api/workflow-variable/:id

Заголовки

Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

Права доступа

Для операций с ресурсом у ключа API должны быть права. При их отсутствии вернётся ответ 4xx.

Права на чтение

Нужны для чтения Workflow Variable

Project Owner
Project Admin
Project Member
Read Workflow Variables
Read All Project Resources

Права на создание

Нужны для создания Workflow Variable

Project Owner
Project Admin
Create Workflow Variables

Права на обновление

Нужны для обновления Workflow Variable

Project Owner
Project Admin
Edit Workflow Variables

Права на удаление

Нужны для удаления Workflow Variable

Project Owner
Project Admin
Delete Workflow Variables