upload

Description

Uploads one or more files using a multipart request.

Administrators can upload on behalf of another member using the member parameter.

There are two modes of operation depending on whether the autoload parameter was used.

By default, the files are uploaded into the loading zone. When the autoload  parameter is true, the files are uploaded directly into the target folder of the specified group.

Some limitations are controlled by global properties:

• The maximum upload size is defined by the maxUploadSize global property.
• The maximum number of attachments to a comment are defined by the maxAttachmentNumber global property.
• The maximum number of workflow notifications is defined by the maxWorkflowNotifications global property.

Loading zone upload (default)

The loading zone is a temporary container for files on the server before they are loaded into PageSeeder.

There is a separate loading zone for each member on each group. Within a group, a member can have multiple loading zones by specifying a unique uploadid or xlinkid for each one. An xlinkid is used to upload attachments to a draft comment before it is submitted (the xlinkid is the same as the comment ID).

After files have been uploaded, the various load services can be used to modify, unzip them and start loading them into PageSeeder.

Direct upload (autoload)

When autoload parameter is true , the files are loaded directly into the target group and folder using a default configuration.

You can specify the target location using the url or the folder parameter. If neither is specified, the file is uploaded into the root folder of the group.

Use the overwrite-properties parameter if you want to update the title, description, labels or metadata of the target URI if it exists. This parameter has no effect if overwrite is not set to true.

Autoload is synchronous only if a single file is uploaded. When multiple files are uploaded, PageSeeder creates a thread and returns a HTTP 202 status code.

Parameters

Permission

The permission required depends on the target context.

When attaching a file to a comment, the user must be a member of the group. Otherwise, the user must have edit permissions on the target folder (contributor and higher).

An Anti-CSRF-Token token is required to use this service.

Response

The response depends on whether the autoload parameter was used and if multiple files were uploaded at once, in which case it starts an asynchronous process.

Loading zone upload (default)

By default, this service returns the details of files that were uploaded:

<upload member="[member ID]" [uploadid="[uploadid]"] max-workflow-notifications="20">
  <file name="[filename]" path="[path]" type="file" ... />
   ...
</upload> 

Direct upload (autoload)

If autoload is true and only one file is uploaded, this service returns the details of the URI created as a result of the upload in a <uri> element:

<upload member="[member ID]" [uploadid="[uploadid]" status="[failed|completed]"]
        max-workflow-notifications="20">
  <message>[explanation or error]<message>
  <uri id="[uri id]" ... />
</upload> 

If autoload is true and multiple files are uploaded, this service returns the details of the thread created in a <thread> element:

<upload member="[member ID]" [uploadid="[uploadid]"] max-workflow-notifications="20">
  <thread id="[thread ID]" ...>
    [thread XML]
  <thread>
</upload>

Error handling