PlainApp
API-referentie

Uploads

Bestanden of blokken uploaden via HTTP, ontvangen blokken controleren, samenvoegen tot bestanden of bijlagen en uploadtaken volgen of opruimen.

Typedefinities

graphql
type Subscription {
  uploadMergeResult: UploadMergeResult!
}

type Mutation {
  deleteChunks(fileId: String!): Boolean!
  mergeChunks(fileId: String!, totalChunks: Int!, path: String!, replace: Boolean!, totalSize: Long!): MergeTask!
}

type Query {
  mergeStatus(fileId: String!): MergeTask!
  uploadedChunks(fileId: String!): [UploadedChunk!]!
}

scalar Long

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

enum MergeTaskStatus {
	NONE
	STARTED
	MERGING
	DONE
	FAILED
}

type UploadMergeResult {
	fileId: ID!
	ok: Boolean!
	value: String
	mergedSize: Long
	error: String
}

type UploadedChunk {
	index: Int!
	sizeBytes: Long!
}

Bewerkingen

http

POST /upload

info bevat de onbewerkte bytes van de versleutelde request-envelop voor POST /upload, geen tekst of Base64. Verstuur info vóór file. Bij succes bevat de tekstrespons HTTP 201 de naam waaronder het bestand is opgeslagen. De metadata moeten de opgegeven grootte in bytes bevatten; hergebruik wordt geweigerd.

bash
curl 'https://<device-host>:<https-port>/upload' \
  -H 'c-id: <client-id>' \
  -F 'info=<./encrypted-info.bin' -F 'file=@./example.txt'
# Send info before file. Metadata JSON: { dir, replace, isAppFile, size }
# info contains raw encrypted request-envelope bytes for POST /upload.
# A Bearer header alone does not authenticate multipart uploads.
http

POST /upload_chunk

Verstuur in info de onbewerkte bytes van de versleutelde request-envelop voor POST /upload_chunk vóór file. HTTP 201 retourneert tekst in het formaat index:size. Controleer uploadedChunks, roep mergeChunks of mergeAppFileChunks aan en volg mergeStatus. Samenvoegen gebeurt asynchroon.

bash
curl 'https://<device-host>:<https-port>/upload_chunk' \
  -H 'c-id: <client-id>' \
  -F 'info=<./encrypted-info.bin' -F 'file=@./chunk.bin'
# Metadata JSON: { fileId, index, size }; bind encryption to POST /upload_chunk.
# Inspect uploadedChunks; call mergeChunks with totalSize for normal files,
# or mergeAppFileChunks for app attachments. Poll mergeStatus for completion.
subscription

uploadMergeResult

Informatie ontvangen over voltooiing of mislukking van asynchrone samenvoeging van uploaddelen.

graphql
subscription uploadMergeResult {
  uploadMergeResult { fileId ok value mergedSize error }
}
mutation

deleteChunks

Alle opgeslagen delen voor een fileId van een opgedeelde upload verwijderen. Gebruik dit na annulering of mislukking van een upload om schijfruimte vrij te maken.

graphql
mutation deleteChunks($fileId: String!) {
  deleteChunks(fileId: $fileId)
}
mutation

mergeChunks

Geüploade delen gaan samenvoegen tot een doelbestand; controleer mergeStatus voor voltooiing.

graphql
# Starts the merge and returns immediately; completion arrives over the
# websocket, and `mergeStatus` is the polling fallback for a lost event.
mutation mergeChunks($fileId: String!, $totalChunks: Int!, $path: String!, $replace: Boolean!, $totalSize: Long!) {
  mergeChunks(fileId: $fileId, totalChunks: $totalChunks, path: $path, replace: $replace, totalSize: $totalSize) { status value mergedSize error }
}
query

mergeStatus

De voortgang of fout van het samenvoegen van een upload lezen; status NONE betekent dat voor deze bestands-ID geen samenvoeging is gestart.

graphql
# `NONE` when no merge was ever started for this id, which is what a
# client sees before it calls `mergeChunks`.
query mergeStatus($fileId: String!) {
  mergeStatus(fileId: $fileId) { status value mergedSize error }
}
query

uploadedChunks

De reeds ontvangen deelindexen voor een hervatbare opgedeelde upload weergeven. Gebruikt om onderbroken uploads te hervatten.

graphql
query uploadedChunks($fileId: String!) {
  uploadedChunks(fileId: $fileId) { index sizeBytes }
}