Versions Compared

Old Version 29

changes.mady.by.user Stephan Böhmig

Saved on

compared with

New Version Current

changes.mady.by.user Stephan Böhmig

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PARAMETERS

The URL parameters are:

orderid

The order ID.

Tip:

See orders/list for enumerating or finding orders and getting an order’s numeric ID.

To find orders with reference starting with “abc”, use this BODY in orders/list:

Code Block
{ "query": "{reference}.Matches(\"abc\", \"prefix\")" }

int, Mandatory

The (optional) body is a JSON object with these properties:

excludeNames

Optional. Lets you define regular expressions to exclude files / folders from the ZIP archive.

Example:

Code Block
{
	"excludeNames": [
		"^Reference folder",
		"\\.zip$"
	]
}

The first pattern excludes any file paths starting with “Reference folder” (the ^ character is important here). This specifically excludes any files contained in the folder.

The second pattern excludes any .zip files in the order (at the root or in any subfolder). Note that in JSON you must escape the backslash character.

string[]?, Optional

includeNames

Optional. Lets you define regular expressions to only include files / folders that match at least one of the patterns.

Example:

Code Block
{
	"includeNames": [
        "\\.doc$",
		"\\.docx$",
	]
}

The ZIP archive will only contain Microsoft Word documents.

string[]?, Optional

callbackurl, callback

Optional

Specify a URL which will be called upon success or failure of operation. This makes polling for

results (see below) unnecessary.

URL is called as POST request with operation result included in the body, see "RESULTS" chapter below for the JSON format.

Suggestion: Include your own references in the URL, example: http://callmeback.mycompany.com?operationid=22222&mydata=abcde

string?,

operation status unnecessary. See Callbacks (with asynchronous operations)

Optional


RESULTS

The API method returns an Asynchronous operation result:

...


The custom property is a JSON object:

filetoken

The token to download the ZIP file.

Usemedia/get/{token} or media/get/{token}/stream

string

count

Total files in ZIP archive.

int

If the operation fails then status is “Failed” and statusText contains the error description.

...