PUT api - Tizra/Tizra-Customer-Tracker GitHub Wiki

(Server): Update Source contents (PDF files or attachments)

An HTTP PUT will create an attachment with a given name, or update its contents if it already exists. The Content-Type associated with that file can be set by the header on the put request. If one is not supplied, the filename will be used to guess an appropriate content-type. Note that the content-disposition is controlled by the is-attachment property of the Source.

The document to which the file will be attached must already exist.

For instance, if https://secure.agilepdf.com/admin-api/3h5u1u/objects/3no1u8 were the management URL for a document, PDF document content for processing would be accessed via URLs based at https://secure.agilepdf.com/admin-api/3h5u1u/objects/3no1u8/PdfSource.

A file called test.pdf could be created by a PUT to https://secure.agilepdf.com/admin-api/3h5u1u/objects/3no1u8/PdfSource/test.pdf. The contents of that file could later be accessed via a GET to the same URL.

Note that a URL consisting of a Source base url and a trailing slash is the URL of a file with an empty name.

As background, note that on a Tizra web site, Source files are accessed at URLs based at the URL of the object, but the name of the source is preceded by the string ~~. WebDAV also provides access to sources and files, but the source name is distinguished by a prefixing single ~.

(Server): Update or replace metadata for a document:

A PUT operation to an object management url like https://secure.agilepdf.com/admin-api/dfdfds/objects/3r3 will set all the included metadata fields for a particular object directly, without the kind of matching that POST operations perform on the operation field.

See the POST description details.