Capture API
Operator-allowlisted watch folders, eSCL/AirScan, and scanner-job administration
Create a one-use capture-agent enrollment code
Requires connectors.manage and same-origin checks for cookie requests. The requested lifetime must be 60 seconds through 24 hours; the raw code is returned only in this 201 response and Jiandu stores only its digest.
List enrolled household capture agents
Requires connectors.manage. Returns each household agent's advertised devices, revocation state, last-seen time, and optimistic revision; narrow credentials are never returned.
Revoke a capture agent at an expected revision
Requires connectors.manage, same-origin checks for cookie requests, and the current expectedRevision. Revocation invalidates the device credential and cancels every nonterminal job assigned to that agent.
List household capture connectors
Requires connectors.manage. Returns each household-scoped connector's fixed source, enabled state, revision, and most recent success time or safe error code.
Create a watch-folder, cloud-drive, or eSCL capture connector
Requires connectors.manage and same-origin checks for cookie requests. The source must name an operator-configured cloud root or eSCL endpoint, or a safe existing directory within an allowlisted watch root. Cloud sources accept only the configured root ID; provider folders and credentials are controlled by the operator.
Delete a capture connector at an expected revision
Requires connectors.manage, same-origin checks for cookie requests, and the current expectedRevision; stale revisions return 409.
Update a capture connector's name and enabled state
Requires connectors.manage, same-origin checks for cookie requests, and the current expectedRevision. The connector's source cannot be changed by this operation.
Probe one configured eSCL scanner's capabilities
Requires connectors.manage. Jiandu resolves only the named operator-configured endpoint, returns 404 when it is unknown, and returns 503 when the capture service or scanner probe is unavailable.
List household capture jobs
Requires connectors.manage. Returns the household's bounded capture ledger, including target, state, cancellation flag, revision, durable upload/document/task identifiers, and safe terminal failure details.
Queue an eSCL or capture-agent scan job
Requires connectors.manage and same-origin checks for cookie requests. Jiandu validates the configured eSCL endpoint or active agent device and its advertised capabilities, then returns the durable queued job with 202.
Cancel a capture job optimistically
Requires connectors.manage, same-origin checks for cookie requests, and the current expectedRevision. Queued or leased work is canceled immediately; active scanning or uploading records a cooperative cancellation request, while a terminal job at the supplied revision is returned unchanged.
List configured capture source options
Requires connectors.manage. Returns identifiers and display names of operator-allowlisted watch roots, cloud roots, and fixed eSCL endpoints. Cloud options also include the provider name; credential paths and remote folder IDs are never exposed. This operation does not contact cloud providers or probe scanner capabilities.