Incontrol.INSPECT

Returns the metadata of one form: name, the language its documents are generated in, and timestamps.

get_form_details

Answers every alias of a form that an import can fill, with the type of element it belongs to, and a dynamic or repeater holding the aliases of its items as its children, so the values of add_draft can be built from what the form has instead of from a guess. An alias that holds a value only the form itself builds, such as a label or a calculation, is not listed. The aliases are those of the form's active version unless a formVersionId picks another. get_documentation('draftimport') describes the value each element type takes.

get_form_import_details

Returns the address of every kind of record this connection can link to, so a user can open one in Incontrol.INSPECT. Each address carries idPlaceholder where the record's own Id goes; swap it in, and compose no address of your own. The answer holds for the whole connection, so read it once and reuse it. Show the record's name as the link, not a bare address or an Id, and offer none for a record a tool reports as removed or out of the user's reach.

get_link_templates

Lists the files of one document, with their size: the images it shows in its images overview, and the files attached to it.

list_document_files

Lists the images one revision of a document showed in its images overview. Takes any revision, the current one included. Attachments are not kept per revision. Not for a document that is only shared with the user.

list_document_revision_images

Lists the revisions of one document, newest first, each with the note its author wrote. A document that was never revised returns just the original. Not for a document that is only shared with the user.

list_document_revisions

Lists every document the user has a relation to, newest first, with flags saying what that relation is. Removed documents, documents the user lost access to, and documents shared with one of their teams are included, each flagged with the reason.

list_my_document_activity

Lists the finished documents the user owns or had shared with them, newest first, with their id and name.

list_my_documents

Lists every draft the user has a relation to, newest first, with flags saying what that relation is. Removed drafts and drafts that can no longer be opened are included, each flagged with the reason.

list_my_draft_activity

Lists the drafts the user owns or had shared with them, newest first, with their id and name. Drafts without a finished version are included and flagged as incomplete.

list_my_drafts

Lists the forms the user can reach through their own teams, newest first, with their id, name and whether the form was only shared with them.

list_my_forms

Returns a single-use address for uploading an image over HTTP, for an image a draft is pre-filled with. The upload verifies the body is a readable image, stores it, and returns a blobId that add_draft takes as an image value. The token is spent by the first upload that succeeds and expires shortly after it was issued, so request one per upload.

request_image_upload

Fills values into a draft that already exists and returns its details. The draft stays on the version of the form it was started on, and a value the draft already holds is only replaced when the values name its alias. Nothing is saved when the values change nothing, so a call that is retried adds no second version. The draft has to be the user's own, and a draft that has no finished version yet cannot be filled.

update_draft