Return a field map for an AcroForm without modifying it.
Use describe("pdf.inspect.form-map") when your code needs the complete live JSON Schemas.
At a glance
| Property | Value |
|---|---|
| Package | @runstamp/forms |
| Domain / verb | pdf / inspect |
| Customer jobs | read, review |
| Deterministic | Yes |
| Side effects | none |
Availability
| Local | SDK | CLI | MCP | Managed API |
|---|---|---|---|---|
| public ga | public ga | public ga | public ga | public ga |
Managed API route: POST /api/v2/operations/pdf/inspect/form-map. Managed execution requires a free-trial workspace or an active Platform or Enterprise workspace, and an environment-bound API key.
Input and result
| Schema | Required fields | Optional fields |
|---|---|---|
| Input | artifactId, bytesBase64, sha256, tenantId, version | none |
| Options | none | operation, deterministic, deterministicSeed, timeoutMs, limits, locale, lossPolicy |
| Result value | output, artifacts | none |
Every success also carries losses, diagnostics, and a hash-bound receipt.
Defaults, limits, and format constraints
Defaults
| Path | Default |
|---|---|
$.deterministic | default=true |
$.lossPolicy | default="collect" |
Formats and profiles
| Path | Constraint |
|---|---|
$.version | minLength=1maxLength=16384 |
Other limits
| Path | Constraint |
|---|---|
$.artifactId | pattern="^[a-f0-9]{64}$" |
$.bytesBase64 | minLength=4maxLength=89478492pattern="^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" |
$.sha256 | pattern="^[a-f0-9]{64}$" |
$.tenantId | minLength=1maxLength=16384 |
$.deterministicSeed | minLength=1maxLength=1024 |
$.timeoutMs | minimum=1 |
$.limits.maxInputBytes | minimum=1 |
$.limits.maxOutputBytes | minimum=1 |
$.limits.maxPages | minimum=1 |
$.limits.maxElements | minimum=1 |
$.limits.maxArchiveEntries | minimum=1 |
$.limits.maxExpansionRatio | minimum=1 |
$.limits.maxDurationMs | exclusiveMinimum=0maximum=2147483647 |
$.locale | minLength=1maxLength=128 |
Invoke
const input = await fetch("https://runstamp.com/demo-evidence/operation-evidence/forms/pdf.inspect.form-map/input.json").then((response) => response.json());
const result = await runstamp.run("pdf.inspect.form-map", input);
if (!result.ok) throw new Error(`${result.error.code}: ${result.error.remediation}`);
console.log(result.value, result.losses, result.diagnostics, result.receipt);curl -fsS https://runstamp.com/demo-evidence/operation-evidence/forms/pdf.inspect.form-map/input.json -o input.json
npx -p @runstamp/sdk runstamp ops invoke pdf.inspect.form-map --input input.json{
"tool": "runstamp_invoke_operation",
"arguments": {
"operation": "pdf.inspect.form-map",
"input": "<JSON from https://runstamp.com/demo-evidence/operation-evidence/forms/pdf.inspect.form-map/input.json>",
"execution_mode": "local"
}
}Errors and losses
Declared errors (27)
pdf/A03_BINDING_MISMATCHpdf/ABORTEDpdf/ACTIVE_ACTIONpdf/BINDING_MISMATCHpdf/DUPLICATE_FIELD_NAMEpdf/FIELD_UNKNOWNpdf/FIELD_UNSUPPORTEDpdf/FLATTEN_FAILEDpdf/FORM_INVALIDpdf/INVALID_INPUTpdf/INVALID_VALUEpdf/MALFORMED_APPEARANCEpdf/MALFORMED_WIDGETpdf/OUTPUT_HASH_MISMATCHpdf/POST_MUTATION_CHECK_FAILEDpdf/PROTECTED_FORMpdf/RESOURCE_LIMITpdf/SIGNED_INPUTpdf/SIGNING_PROVIDER_REQUIREDpdf/TIMEOUTpdf/WIDGET_COUNT_MISMATCHpdf/SCHEMA_REJECTEDcommon/SCHEMA_REJECTEDcommon/OPERATION_CANCELLEDcommon/OPERATION_TIMEOUTcommon/CONTRACT_VIOLATIONpdf/LOSS_POLICY_VIOLATED
Declared losses (2)
pdf/FORM_INTERACTIVITY_REMOVEDpdf/FORM_APPEARANCE_DEFERRED
SDK AbortSignal, CLI exit 130, and MCP cancellation return the typed common/OPERATION_CANCELLED failure envelope.
Verified example and exact contract
- Fixture:
icp-workflow(Employee onboarding EMP-2027-00418). - Example input — SHA-256
84eb35381a2956daa37967acf24c0f8facbe3c25e52c4d68236ddab81760ae99. - Example result — SHA-256
8f771e990654eb7b18968774277cc3dab77c8c9b9e55039019b9bfcea3e040fb. - Verified result SHA-256:
c8f792cae94f5c82256314ab12767f4d31484291b7cbe76be1212ddc2dd46683. - Qualification lane:
12-approval-forms-review.
Contract fingerprints
- Descriptor:
898628ad91f86aa37660fdbcbd608bb082f9de7b83a816d44f63d3a5d2324175. - Input schema:
668d2f979605386f2ffd1fdc2f2e688b4833f9dcf1cb4d154fa7b2a4803804b3. - Options schema:
589287d5513225b5d31bb6d9b59a22a7ed38b300dcbe4e6e16f2011d49600236. - Result value schema:
1c35f7793a0b9141c1f1aedf70e448f26595eac812b7bc2b0fa5fd22c86f6fa2.
The machine-readable operation reference publishes the complete schemas, qualification results, and evidence bindings for every operation.