Status200
Ресурс

Workflow Log

Logs of the workflows executed

Модель Workflow Log

Свойства

  • Имя
    _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 logs belong to

  • Имя
    workflowId
    Тип
    Object IDОбязательно
    Описание

    ID of Workflow this logs belong to

  • Имя
    logs
    Тип
    Very Long Text
    Описание

    Logs

  • Имя
    workflowStatus
    Тип
    Workflow StatusОбязательно
    Описание

    Status of this workflow

  • Имя
    startedAt
    Тип
    Date
    Описание

    When did this workflow start

  • Имя
    completedAt
    Тип
    Date
    Описание

    When did this workflow complete

GETorPOST/api/workflow-log/get-list

Список

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

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

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

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

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

POST
/api/workflow-log/get-list?skip=0&limit=10
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "projectId": true,
    "workflowId": true,
    "workflowStatus": true,
    "_id": true,
    "completedAt": true
  },
  "query": {
    "logs": "Example logs"
  },
  "sort": {
    "createdAt": -1
  }
}

Ответ

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377fe990-28fe-11f1-b591-3fdcef396aba",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "workflowId": "550e8400-e29b-41d4-a716-446655440000",
      "workflowStatus": "Example workflow status",
      "completedAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "_id": "377fe991-28fe-11f1-b591-3fdcef396aba",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "workflowId": "550e8400-e29b-41d4-a716-446655440000",
      "workflowStatus": "Example workflow status",
      "completedAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "_id": "377fe992-28fe-11f1-b591-3fdcef396aba",
      "projectId": "550e8400-e29b-41d4-a716-446655440000",
      "workflowId": "550e8400-e29b-41d4-a716-446655440000",
      "workflowStatus": "Example workflow status",
      "completedAt": "2024-01-15T10:30:00.000Z"
    }
  ]
}
GETorPOST/api/workflow-log/:id/get-item

Получить по ID

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

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

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

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

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

POST
/api/workflow-log/:id/get-item
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "select": {
    "projectId": true,
    "workflowId": true,
    "workflowStatus": true,
    "_id": true,
    "completedAt": true
  }
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "workflowId": "550e8400-e29b-41d4-a716-446655440000",
  "workflowStatus": "Example workflow status",
  "completedAt": "2024-01-15T10:30:00.000Z"
}
POST/api/workflow-log/count

Количество

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

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

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

POST
/api/workflow-log/count
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "query": {
    "logs": "Example logs"
  }
}

Ответ

{
  "count": 107
}
POST/api/workflow-log

Создать Workflow Log

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

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

POST
/api/workflow-log
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {}
}

Ответ

{
  "_id": "550e8400-e29b-41d4-a716-446655440000",
  "projectId": "550e8400-e29b-41d4-a716-446655440000",
  "workflowId": "550e8400-e29b-41d4-a716-446655440000",
  "workflowStatus": "Example workflow status",
  "completedAt": "2024-01-15T10:30:00.000Z"
}
PUT/api/workflow-log/:id

Обновить по ID

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

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

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

POST/api/workflow-log/:id/update-item
GET/api/workflow-log/:id/update-item

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

PUT
/api/workflow-log/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY
Тело
{
  "data": {}
}

Ответ

{}
DELETE/api/workflow-log/:id

Удалить по ID

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

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

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

POST/api/workflow-log/:id/delete-item
GET/api/workflow-log/:id/delete-item

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

DELETE
/api/workflow-log/:id
Заголовки
Content-Type: application/json
ApiKey: YOUR_API_KEY

Ответ

{}

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

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

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

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

  • Project Owner
  • Project Admin
  • Project Member
  • Read Workflow Log
  • Read All Project Resources

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

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

  • Project Owner
  • Project Admin
  • Create Workflow Log

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

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

  • Project Owner
  • Project Admin
  • Edit Workflow Log

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

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

  • Project Owner
  • Project Admin
  • Delete Workflow Log