API リファレンス

ドキュメント

機能の対応状況は app.capabilities、認可は app.access とホストの権限で確認してください。例は合成値を使用しています。呼び出す前にパス、ID、入力、フィルターを置き換えてください。

型定義

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!
}

操作

query

docCount

クエリに一致するドキュメント数を数えます。

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

docExtGroups

重複しないすべてのファイル拡張子と各件数を一覧表示します。「種類で絞り込む」UI の構築に役立ちます。

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

docs

ドキュメントを検索します。すべて表示するには query を空にします。

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 }
}