Bottle Rocket API (v0.1.15.alpha)

Process uploaded images via this endpoint. Use the url-encoded multipart form schema to POST the image data.

The app will automatically provide matched template information as part of automated workflow triggering, but if you wish to simply upload a captured image to the system and trigger a manual workflow, the qr_code and qr_bounding_box parameters can be omitted.

Retrieves a subset of scans belonging to the authenticated user.

Provide a zero-based start index and record count to retrieve paged results and minimise server load.

A base64 thumbnail image string is also provided instead of the full image data in a multi-record payload.

Retrieves the full details of a users scan by its unique ID.

The full image data is provided as well as other capture and processing details.

Manually archives a scan by its unique ID.

To preserve drive space, the original image file is permanently deleted and will no longer be available for workflow processing. A stubbed record will remain with a small thumbnail image for reference.

This endpoint will provide a status of the authenticated connection.

Unauthorised or inactive accounts will return an error response.

Returns the current health of the server. Returns 'Status OK' via a HTTP 200 response, if healthy.

Gets the current startup phase of the system.

After a new server installation, it can be one of three phases:

0 = NoUserAccounts - unlikely, but possible if an operation to insert the admin account was aborted.

1 = AdminPendingDeactivation - the first operating state of the server. A new admin account must be added to replace the temporary admin account.

2 = AdminDeactivated - the phase after setup completion - a non-admin user account is managing the server and the admin account have been deactivated.

Returns the current version server API.

Retrieves a subset of connectors belonging to the authenticated user.

Provide a zero-based start index and record count to retrieve paged results and minimise server load.

If required, a connector code can be supplied as an additional filter.

Deletes a user's connector by its unique ID.

Note: deleting a connector will remove all references to it from all associated workflows.

Creates a new connector for the given user. Will return an error if the same named connector already exists for the given user.

Finalizes a Dropbox connector for the given user.

When this endpoint is called, it is assumed that the user has already supplied the app key and secret.

The Dropbox client will use these parameters to return a redirect URL, which, when opened in a browser, allows a user to grant permission to the app, and receive an access token, which will be supplied here.

Initiates a Google authentication request for the given user and client ID.

The API will return an authorization URL that can be supplied back to the user to complete the authentication process.

Finalizes a Google connector for the given user.

When this endpoint is called, it is assumed that the user has already navigated to the Google authorization URL, authenticated, approved permissions, and copied the access code into the form / API request. The access code will be sent back to Google

Initiates a Microsoft authentication request for the given user, client, and tenant ID.

The API will return a verification URL and user code that can be supplied back to the user to complete the authentication process.

Retrieves a set of (permitted) parent notes for the given Notion connector.

The notes that a Notion integration has access to are explicitly defined in the Notion integration.

Retrieves a set of (permitted) data sources for the given Notion connector.

The data sources that a Notion integration has access to are explicitly defined in the Notion integration.

Retrieves a subset of executions belonging to the authenticated user.

Provide a zero-based start index and record count to retrieve paged results and minimise server load.

Optionally, a workflow ID and scan ID can be supplied as additional filters.

Deletes a user's workflow execution by its unique ID.

Creates a new workflow execution for the given user, workflow ID, and captured scan ID.

Throws an error if the any of the related objects (user, scan, workflow) cannot be found for the given user.

If the run immediately flag is set to true, the execution will be scheduled to run immediately.

Attempts to cancel a running workflow execution by its unique identifier.

Attempts to start an inactive workflow execution by its unique identifier.

Returns a execution by its unique identifier.

Returns the current global system settings.

Updates the global system settings. Services that are driven by global system configuration will be restarted e.g. sweeping jobs.

Retrieves all page template currently configured in the system.

Typically this would not be called regularly as it is used by client apps to know which QR codes to look out for.

If you have added custom page templates to your system, they will be returned here.

Retrieves a subset of users belonging to the system.

Provide a zero-based start index and record count to retrieve paged results and minimise server load.

Returns a user by their unique identifier.

Creates a new system user. If this is the first user created by the admin account, then on success, the administrator account will be made inactive.

Updates one or more details of an existing system user. A value not supplied will not be updated.

If the update sets the IsAdmin flag to true, then the user calling the API will have their administrator status removed.

If a new password has been supplied (and only if so), the response will contain a QR code that the mobile app can scan to provide their credentials.

Sets the dark mode preference for a given user.

Retrieves a subset of workflows belonging to the authenticated user.

Provide a zero-based start index and record count to retrieve paged results and minimise server load.

Deletes a user's workflow by its unique ID.

Creates a new workflow for the given user. Will return an error if the same named workflow already exists for the given user.

Updates one or more details of an existing workflow. A value not supplied will not be updated. Where a matching page symbol is supplied, it will be checked against any existing workflow, and return an error if already in use.

Returns a workflow by its unique identifier.

Deletes a user's workflow step by its unique ID.

Note: this will also delete all of the child steps of the deleted step, if any exist.

Retrieves the specific workflow step details for the given workflow and step ID.

Creates a new workflow step for the given workflow. If a parent step ID is provided, the new step will be inserted as a child of the specified parent step; otherwise it will be inserted as a root-level child step.

The step parameter uses a type discriminator in order to correctly map the step-specific details to the correct data store object dictionary; see the related documentation for details.

Updates an existing workflow step for the given workflow.

The step parameter uses a type discriminator in order to correctly map the step-specific details to the correct data store object dictionary; see the related documentation for details.

Retrieves a set of (permitted) folders for the given Google connector.

Retrieves a set of (permitted) note sections for the given Microsoft connector.