Move upload

moveUpload(input: MoveUploadInput!): MoveUploadPayload!

Requires project.uploads.write.

Arguments

ArgumentTypeRequired
inputMoveUploadInput!Yes

Input fields

input

MoveUploadInput

FieldTypeRequiredDescription
projectReferenceStringNoProject ID
uploadReferenceStringNoUpload UUID or project-relative path of the upload to move.
sourcePathStringNoAnother spelling of uploadReference. Send one of the two.
destinationPathString!YesDestination file path

Response

Returns MoveUploadPayload!. Open the type for its fields and nested types.

FieldTypeDescription
successBoolean!Whether move was successful
errorStringError message if move failed
fileMovedFileInfoMoved file info
idIDUpload UUID; null when the mutation failed.
pathStringProject-relative upload path.
fileNameStringFile name from the upload record.
contentTypeStringStored MIME type, or null when unspecified.
sizeBytesFloatFile size in bytes.

All fields of MoveUploadPayload.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation MoveUpload($input: MoveUploadInput!) {
  moveUpload(input: $input) {
    id
    status
    createdAt
    updatedAt
    contentType
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001",
    "destinationPath": "example"
  }
}