API-Referenz

App-Anhänge

App-Anhänge auflisten und zählen, hochgeladene Teile zusammenfügen und Anhangsreferenzen freigeben.

Typdefinitionen

graphql
type Mutation {
  mergeAppFileChunks(fileId: String!, totalChunks: Int!, fileName: String!, totalSize: Long!): MergeTask!
  releaseAppFile(fileId: String!): Boolean!
}

type Query {
  appFileCount(query: String!): Int!
  appFiles(query: String!, offset: Int!, limit: Int!): [AppFile!]!
}

type AppFile {
	id: String!
	size: Long!
	mimeType: String!
	fileName: String!
	realPath: String!
	createdAt: Instant!
	updatedAt: Instant!
}

scalar Instant

scalar Long

type MergeTask {
	status: MergeTaskStatus!
	value: String
	mergedSize: Long
	error: String
}

enum MergeTaskStatus {
	NONE
	STARTED
	MERGING
	DONE
	FAILED
}

Operationen

mutation

mergeAppFileChunks

Beginnt mit dem Zusammenführen hochgeladener Teile zu einem anwendungsverwalteten Anhang. Den Abschluss über mergeStatus prüfen.

graphql
mutation mergeAppFileChunks($fileId: String!, $totalChunks: Int!, $fileName: String!, $totalSize: Long!) {
  mergeAppFileChunks(fileId: $fileId, totalChunks: $totalChunks, fileName: $fileName, totalSize: $totalSize) { status value mergedSize error }
}
mutation

releaseAppFile

Gibt die angegebene Referenz auf einen anwendungsverwalteten Anhang frei.

graphql
mutation releaseAppFile($fileId: String!) {
  releaseAppFile(fileId: $fileId)
}
query

appFileCount

Zählt anwendungsverwaltete Anhangsdatensätze, die der Abfrage entsprechen.

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

appFiles

Liest eine Seite anwendungsverwalteter Anhangsdatensätze, die der Abfrage entsprechen.

graphql
query appFiles($query: String!, $offset: Int!, $limit: Int!) {
  appFiles(query: $query, offset: $offset, limit: $limit) { id size mimeType fileName realPath createdAt updatedAt }
}