操作 Operations

Directus 中有关操作集合的 REST 和 GraphQL API 文档。操作是 Directus 中数据流的构建块。

操作对象

id uuid
操作的主键。

name string
操作的名称。

key string
操作的关键。在给定的流中必须是唯一的。

type string
操作类型。 logmailnotificationcreatereadrequestsleeptransformtriggercondition或任何类型的自定义操作扩展之一。

options json
选项取决于操作的类型。

position_x integer
流工作空间内 X 轴上操作的位置。

position_y integer
流工作空间内 Y 轴上操作的位置。

date_created timestamp
创建操作时 ISO8601 中的时间戳。

user_created many-to-one
创建操作的用户。多对一到 users

resolve uuid
当前操作成功时触发的操作(或条件操作的 then 逻辑)。 操作 的主键。

reject uuid
当前操作失败时触发的操作(或条件操作的“否则”逻辑)。 操作 的主键。

flow many-to-one
包含此操作的流。多对一到

json
{
  "id": "585b04cd-2821-4dcc-a563-ae5d29ecace2",
  "name": "Log a Message",
  "key": "log_message",
  "type": "log",
  "position_x": 12,
  "position_y": 24,
  "date_created": "2022-05-11T13:14:52Z",
  "user_created": "12e62fd0-29c7-4fd3-b3d3-c7a39933e8af",
  "resolve": "bf4099c0-c54c-4736-ab4e-95e2487595e4",
  "reject": null,
  "flow": "22544db5-93f7-48e2-a028-7ae02c8fe49a"
}

列表操作

列出 Directus 中存在的所有操作。

查询参数

支持所有全局查询参数

返回

最多包含 limit 操作对象 的数组。 如果没有可用的物品, data 将是一个空数组。

REST API

GET /operations
SEARCH /operations

Learn more about SEARCH ->

GraphQL

POST /graphql/system
graphql
type Query {
 operations: [directus_operations]
}
示例
graphql
query {
 operations {
  id
  name
  key
 }
}

检索操作

按主键列出现有操作。

查询参数

支持所有全局查询参数

返回

返回请求的 操作对象

REST API

GET /operations/:id
示例
GET /operations/3c636d1c-4eb2-49cd-8a6d-3ec571ab3390

GraphQL

POST /graphql/system
graphql
type Query {
 operations_by_id(id: ID!): directus_operations
}
示例
graphql
query {
 operations_by_id(id: 42) {
  id
  name
  key
 }
}

创建操作

创建一个新的操作。

查询参数

支持所有全局查询参数

请求正文

部分操作对象

返回

返回已创建操作的 操作对象

REST API

POST /operations
示例
json
// POST /operations

{
  "name": "My Log",
  "key": "my_log",
  "type": "log"
}

GraphQL

POST /graphql/system
graphql
type Mutation {
 create_operations_item(data: create_directus_operations_input!): directus_operations
}
示例
graphql
mutation {
 create_operations_item(data: { name: "My Log", key: "my_log", type: "log" }) {
  id
  name
  key
 }
}

创建多个操作

创建多个新操作。

查询参数

支持所有全局查询参数

请求正文

部分 操作对象 的数组。

返回

返回已创建操作的 操作对象

REST API

POST /operations
示例
json
// POST /operations

[
  {
    "name": "My Log",
    "key": "my_log",
    "type": "log"
  },
  {
    "name": "Send Notification",
    "key": "send_notification",
    "type": "notification"
  }
]

GraphQL

POST /graphql/system
graphql
type Mutation {
 create_operations_items(data: [create_directus_operations_input!]!): [directus_operations]
}
示例
graphql
mutation {
 create_operations_items(
  data: [
   {
    "name": "My Log",
    "key": "my_log",
    "type": "log"
   },
   {
    "name": "Send Notification",
    "key": "send_notification",
    "type": "notification"
   }
  ]
 ) {
  id
  name
  key
 }
}

更新操作

更新现有操作。

查询参数

支持所有全局查询参数

请求正文

部分操作对象

返回

返回更新操作的 操作对象

REST API

PATCH /operation/:id
示例
json
// PATCH /operation/7d62f1e9-a83f-407b-84f8-1c184f014501

{
  "name": "My Updated Operation"
}

GraphQL

POST /graphql/system
graphql
type Mutation {
 update_operations_item(id: ID!, data: update_directus_operations_input): directus_operations
}
示例
graphql
mutation {
 update_operations_item(id: "7d62f1e9-a83f-407b-84f8-1c184f014501", data: { name: "My Updated Operation" }) {
  id
  name
 }
}

更新多个操作

更新多个现有操作。

查询参数

支持所有全局查询参数

请求正文

keys Required
您要更新的操作的主键数组。

data Required
操作对象 的任何属性。

返回

返回更新操作的 操作对象

REST API

PATCH /operations
示例
json
// PATCH /operations

{
  "keys": ["6a25fb7c-26a4-4dcb-a474-d47b6a203a38", "07ac467e-1900-4c62-9637-8dac2ab97f71"],
  "data": {
    "name": "Updated Operations"
  }
}

GraphQL

POST /graphql/system
graphql
type Mutation {
 update_operations_items(ids: [ID!]!, data: update_directus_operations_input): [directus_operations]
}
示例
graphql
mutation {
 update_operations_items(
  ids: ["6a25fb7c-26a4-4dcb-a474-d47b6a203a38", "07ac467e-1900-4c62-9637-8dac2ab97f71"]
  data: { name: "Updated Operations" }
 ) {
  id
  name
  key
 }
}

删除操作

删除现有操作。

Returns

Empty body.

REST API

DELETE /operations/:id
示例
DELETE /operations/07ac467e-1900-4c62-9637-8dac2ab97f71

GraphQL

POST /graphql/system
graphql
type Mutation {
 delete_operations_item(id: ID!): delete_one
}
示例
graphql
mutation {
 delete_operations_item(id: "07ac467e-1900-4c62-9637-8dac2ab97f71") {
  id
 }
}

删除多个操作

删除多个现有操作。

请求正文

一组操作主键

Returns

Empty body.

REST API

DELETE /operations
示例
json
// DELETE /operations
["a791ce73-41a2-4fb7-8f67-c7ba176cc719", "4e57ab0e-f4ec-47b5-9dad-e36f08a25642", "5fe0a6f6-18ad-4bb3-94c6-2e033246c784"]

GraphQL

POST /graphql/system
graphql
type Mutation {
 delete_operations_items(ids: [ID!]!): delete_many
}
示例
graphql
mutation {
 delete_operations_items(
  ids: [
   "a791ce73-41a2-4fb7-8f67-c7ba176cc719"
   "4e57ab0e-f4ec-47b5-9dad-e36f08a25642"
   "5fe0a6f6-18ad-4bb3-94c6-2e033246c784"
  ]
 ) {
  ids
 }
}

触发操作

根据主键触发操作。

请求正文

操作的有效负载(如果需要)。

返回

操作的结果(如果有)。

REST API

POST /operations/trigger/:operation_uuid
示例
json
// POST /flows/trigger/202a940b-a00b-47df-b832-369c53f13122
// Payload here