Static Documents API
Independent static documents are PDF files configured and deployed independently rather than by inclusion in
Config.zip. Use the following endpoints to create, update, or delete independent static PDF documents. All of the APIs mentioned below require you to be logged in as an administrator.
GroupStaticDocumentResponsewill contain a single
StaticDocumentResponseif a single document was deployed, or a list of
StaticDocumentResponseif a zip file uploaded multiple documents.
effectiveTimestampproperty specifies the effective date as a specific hour timestamp in unix epoch format. If minutes, seconds, and/or milliseconds are non-zero, the system will round to the next hour.
effectiveTimestampproperty is optional. The default
effectiveTimestampis the hour after the document was added to your configuration. For example, if the current date and time is
October 1st, 2022 11:30:15am PST, the
effectiveTimestampwill be set to
October 1st, 2022 noon PST(in unix epoch format).
effectiveTimestampprecisely match an existing static document with an effective date, and the content of the static document has changed, that static document will be replaced with the newly deployed document. The name match is case sensitive. The
effectiveTimestampmatch compares the two timestamps, both of which are scoped to the hour.
If you deploy a .zip file, the name of each PDF file included in the .zip file will be used for the static document name. Ensure file names match previous values if you intend to update existing static documents using a bulk upload.
StaticDocumentRequestincludes an exact duplicate of a previously deployed static document, the application will continue using the previously deployed static document, rather than redeploying it. A static document is considered a exact duplicate if all of the following are unchanged:
requiredfile stringoptionaleffectiveTimestamp timestampStaticDocumentName string
requiredlocator stringeffectiveTimestamp timestampurlExpirationTimestamp timestampStaticDocumentName stringurl string
requiredeffectiveTimestamp timestamperrorDetails stringStaticDocumentName string
|matchMode||formdata||string startsWith | contains | equals | all||optional|
Takes three optional parameters:
fileNameparameter is the name of the PDF document of interest.
matchModeparameter is a enum value, which specifies how the
fileNameparameter will be matched.
asOfTimestampparameter is a timestamp in millisecond format. The
asOfTimestampcan be any value within the effective time frame. If a static document is effective from January 1st to June 1st (inclusive), then date parameters of January 1st, June 1st, and March 1st would all retrieve the same static document.
Retrieves a list of documents (
StaticDocumentResponse) which, depending on the optional parameters, will include:
fileNameonly – returns a list of all independent static documents with a matching filename, with various effective dates.
effectiveTimestamponly – returns a list of all independent static documents in effect for the specified timestamp, with various file names.
Specify both the
effectiveTimestamp– returns the one independent static document matching the specified
Do not specify either
effectiveTimestamp– returns a list of all independent static documents.
If the last independent copy of a static document is deleted, the application will use the
Config.zipversion of the static document for liquid template results.