Tham chiếu API

Tài liệu

Kiểm tra app.capabilities để biết tính năng và app.access cùng quyền máy chủ để xác định quyền truy cập. Thay giá trị mẫu trước khi gọi.

Định nghĩa kiểu

graphql
type Query {
  docCount(query: String!): Int!
  docExtGroups(query: String! = ""): [DocExtGroup!]!
  docs(query: String!, offset: Int!, limit: Int!, sortBy: DocSortBy!): [Doc!]!
}

enum DataType {
	DEFAULT
	AUDIO
	VIDEO
	IMAGE
	SMS
	CONTACT
	NOTE
	FEED_ENTRY
	CALL
	PACKAGE
	FILE
	APP_FILE
	DOC
}

type Doc implements MediaItem {
	id: ID!
	title: String!
	path: String!
	extension: String!
	size: Long!
	bucketId: ID!
	createdAt: Instant!
	updatedAt: Instant!
	tags: [Tag!]!
}

type DocExtGroup {
	ext: String!
	count: Int!
}

enum DocSortBy {
	UPDATED_AT_ASC
	UPDATED_AT_DESC
	SIZE_ASC
	SIZE_DESC
	NAME_ASC
	NAME_DESC
}

scalar Instant

scalar Long

interface MediaItem {
	id: ID!
	title: String!
	path: String!
	size: Long!
	bucketId: ID!
	createdAt: Instant!
	updatedAt: Instant!
}

type Tag {
	id: ID!
	name: String!
	type: DataType!
	count: Int!
}

Thao tác

query

docCount

Đếm tài liệu khớp truy vấn.

graphql
query docCount($query: String!) {
  docCount(query: $query)
}
query

docExtGroups

Liệt kê mọi phần mở rộng tệp riêng biệt và số lượng. Hữu ích để xây dựng giao diện lọc theo loại.

graphql
query docExtGroups($query: String!) {
  docExtGroups(query: $query) { ext count }
}
query

docs

Tìm tài liệu. Để query rỗng để liệt kê tất cả.

graphql
query docs($query: String!, $offset: Int!, $limit: Int!, $sortBy: DocSortBy!) {
  docs(query: $query, offset: $offset, limit: $limit, sortBy: $sortBy) { id title path extension size bucketId createdAt updatedAt }
}