通知对象
id integer
修订的主键。
timestamp string
创建通知时 ISO8601 中的时间戳。
status string
通知的当前状态。 “收件箱”、“已归档”之一。
recipient many-to-one
收到通知的用户。
sender many-to-one
发送通知的用户(如果有)。
subject string
邮件的主题行。
message string
通知的消息内容。 将在电子邮件中发送。
collection string
收集此通知引用。
item string
此通知引用的项目的主键。
json
{
"id": 2,
"timestamp": "2021-11-24T13:57:35Z",
"status": "inbox",
"recipient": "3EE34828-B43C-4FB2-A721-5151579B08EA",
"sender": "497a495e-5529-4e46-8feb-2f35e9b85601",
"subject": "You were mentioned in articles",
"message": "\nHello admin@例如.com,\n\rijk@directus.io has mentioned you in a comment:\n\n> Hello <em>admin@例如.com</em>!\n\n<a href=\"http://localhost:8080/admin/content/articles/1\">Click here to view.</a>\n",
"collection": "articles",
"item": "1"
}
列出通知
列出 Directus 中存在的所有通知。
查询参数
支持所有全局查询参数。
返回
最多包含 limit 通知对象 的数组。 如果没有项目 可用，数据将是一个空数组。
REST API
GET /notifications
SEARCH /notifications
GraphQL
POST /graphql/system
graphql
type Query {
notifications: [directus_notifications]
}
示例
graphql
query {
notifications {
id
recipient
subject
}
}
检索通知
按主键列出现有通知。
查询参数
支持所有全局查询参数。
返回
返回请求的 通知对象。
REST API
GET /notifications/:id
示例
GET /notifications/42
GraphQL
POST /graphql/system
graphql
type Query {
notifications_by_id(id: ID!): directus_notifications
}
示例
graphql
query {
notifications_by_id(id: 42) {
id
sender
recipient
message
subject
}
}
创建通知
创建一个新通知。
查询参数
支持所有全局查询参数。
请求正文
部分通知对象。
返回
返回已创建通知的 通知对象。
REST API
POST /notifications
示例
json
// POST /notifications
{
"recipient": "410b5772-e63f-4ae6-9ea2-39c3a31bd6ca",
"subject": "Hi there!"
}
GraphQL
POST /graphql/system
graphql
type Mutation {
create_notifications_item(data: create_directus_notifications_input!): directus_notifications
}
示例
graphql
mutation {
create_notifications_item(data: { recipient: "410b5772-e63f-4ae6-9ea2-39c3a31bd6ca", subject: "Hi there!" }) {
id
recipient
}
}
创建多个通知
创建多个新通知。
查询参数
支持所有全局查询参数。
请求正文
部分 通知对象 的数组。
返回
返回已创建通知的 通知对象。
REST API
POST /notifications
示例
json
// POST /notifications
[
{
"collection": "directus_files",
"recipient": "410b5772-e63f-4ae6-9ea2-39c3a31bd6ca",
"message": "Hi there! You should check out these files"
},
{
"collection": "articles",
"recipient": "410b5772-e63f-4ae6-9ea2-39c3a31bd6ca",
"message": "Hi there! You should check out these articles"
}
]
GraphQL
POST /graphql/system
graphql
type Mutation {
create_notifications_items(data: [create_directus_notifications_input!]!): [directus_notifications]
}
示例
graphql
mutation {
create_notifications_items(
data: [
{
collection: "directus_files"
recipient: "410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"
message: "Hi there! You should check out these files"
}
{
collection: "articles"
recipient: "410b5772-e63f-4ae6-9ea2-39c3a31bd6ca"
message: "Hi there! You should check out these articles"
}
]
) {
id
recipient
}
}
更新通知
更新现有通知。
电子邮件通知
仅在创建通知时发送电子邮件。 更新到现有通知不会触发新通知要发送的通知电子邮件。
查询参数
支持所有全局查询参数。
请求正文
部分通知对象。
返回
返回更新通知的 通知对象。
REST API
PATCH /notifications/:id
示例
json
// PATCH /notifications/34
{
"message": "This is my updated notification"
}
GraphQL
POST /graphql/system
graphql
type Mutation {
update_notifications_item(id: ID!, data: update_directus_notifications_input): directus_notifications
}
示例
graphql
mutation {
update_notifications_item(id: 32, data: { message: "This is my updated notification" }) {
id
message
}
}
更新多个通知
更新多个现有通知。
查询参数
支持所有全局查询参数。
请求正文
keys Required
您要更新的通知的主键数组。
data Required
通知对象 的任何属性。
返回
返回更新通知的 通知对象。
REST API
PATCH /notifications
示例
json
// PATCH /notifications
{
"keys": [15, 64],
"data": {
"message": "Updated message!"
}
}
GraphQL
POST /graphql/system
graphql
type Mutation {
update_notifications_items(ids: [ID!]!, data: update_directus_notifications_input): [directus_notifications]
}
示例
graphql
mutation {
update_notifications_items(ids: [15, 64], data: { message: "Updated message!" }) {
id
recipient
}
}
Delete a Notification
Delete an existing notification.
Returns
Empty body.
REST API
DELETE /notifications/:id
示例
DELETE /notifications/34
GraphQL
POST /graphql/system
graphql
type Mutation {
delete_notifications_item(id: ID!): delete_one
}
示例
graphql
mutation {
delete_notifications_item(id: 32) {
id
}
}
删除多个通知
删除多个现有通知。
请求正文
通知主键数组
返回
空正文
REST API
DELETE /notifications
示例
json
// DELETE /notifications
[15, 251, 810]
GraphQL
POST /graphql/system
graphql
type Mutation {
delete_notifications_items(ids: [ID!]!): delete_many
}
示例
graphql
mutation {
delete_notifications_items(ids: [15, 251, 810]) {
ids
}
}