Référence de l'API

Pièces jointes de l’application

Lister et compter les pièces jointes de l’application, fusionner les fragments téléversés et libérer les références aux pièces jointes.

Définitions de types

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
}

Opérations

mutation

mergeAppFileChunks

Démarrer la fusion des fragments téléversés en une pièce jointe gérée par l’application ; consulter mergeStatus pour vérifier la fin.

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

Libérer la référence indiquée à une pièce jointe gérée par l’application.

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

appFileCount

Compter les enregistrements de pièces jointes gérées par l’application correspondant à la requête.

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

appFiles

Lire une page d’enregistrements de pièces jointes gérées par l’application correspondant à la requête.

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