Read measurement viewports
GET
Read page measurement viewports in drawing order from the current layer.
Authentication#
Any one of these credentials is accepted.
API token
The deployment's static root credential (CLOUDPDF_API_AUTH_TOKENS), valid on every surface.
Document token
Doc-scoped JWT, valid only on the /v1/docs/{docId} subtree it names, gated by the capability scopes it carries (each operation's x-required-capability).
Document capabilitydoc.open
Parameters#
docIdpathstringrequiredlayerNamepathstringrequiredpageKeypathstringrequiredX-Document-PasswordheaderstringBase64-encoded password for an encrypted document. Valid only with the API token (403 anywhere else). An encrypted document answers 422 DocPasswordRequired when the header is absent. Viewer doc JWTs use the SDK password-session flow instead.
SDK examples#
The selected SDK is remembered across the API reference. Values are examples; replace them with identifiers and input from your application.
import { CloudPDFClient } from "@cloudpdf/sdk";
const client = new CloudPDFClient({
baseUrl: "https://yourhost.com/path/to/api",
token: "<token>",
});
await client.doc.pages.viewports({
docId: "docId",
layerName: "layerName",
pageKey: "pageKey"
});Responses#
200OK
application/jsonDocPagesViewports200Responseviewportsobject[]bboxobjectxnumberynumberwidthnumberheightnumbernamestringmeasure"rectilinear" | "geospatial" | "unknown"subtype"rectilinear"ratiostringoptionalxobject[]unitstringconversionnumberoptionalfraction"decimal" | "fraction" | "round" | "truncate"optionalprecisionintegeroptionalfixedbooleanoptionalthousandsstringoptionaldecimalstringoptionalprefixSpacingstringoptionalsuffixSpacingstringoptionallabelPosition"suffix" | "prefix"optionalyobject[]optionalunitstringconversionnumberoptionalfraction"decimal" | "fraction" | "round" | "truncate"optionalprecisionintegeroptionalfixedbooleanoptionalthousandsstringoptionaldecimalstringoptionalprefixSpacingstringoptionalsuffixSpacingstringoptionallabelPosition"suffix" | "prefix"optionaldistanceobject[]unitstringconversionnumberoptionalfraction"decimal" | "fraction" | "round" | "truncate"optionalprecisionintegeroptionalfixedbooleanoptionalthousandsstringoptionaldecimalstringoptionalprefixSpacingstringoptionalsuffixSpacingstringoptionallabelPosition"suffix" | "prefix"optionalareaobject[]unitstringconversionnumberoptionalfraction"decimal" | "fraction" | "round" | "truncate"optionalprecisionintegeroptionalfixedbooleanoptionalthousandsstringoptionaldecimalstringoptionalprefixSpacingstringoptionalsuffixSpacingstringoptionallabelPosition"suffix" | "prefix"optionalangleobject[]optionalunitstringconversionnumberoptionalfraction"decimal" | "fraction" | "round" | "truncate"optionalprecisionintegeroptionalfixedbooleanoptionalthousandsstringoptionaldecimalstringoptionalprefixSpacingstringoptionalsuffixSpacingstringoptionallabelPosition"suffix" | "prefix"optionalslopeobject[]optionalunitstringconversionnumberoptionalfraction"decimal" | "fraction" | "round" | "truncate"optionalprecisionintegeroptionalfixedbooleanoptionalthousandsstringoptionaldecimalstringoptionalprefixSpacingstringoptionalsuffixSpacingstringoptionallabelPosition"suffix" | "prefix"optionaloriginobjectoptionalxnumberynumbercyxnumberoptionalownedboolean404Not found
application/jsonDocPagesViewports404ResponsedefaultError
application/jsonEngineErrorPayloadname"EngineError"code"Unknown" | "InvalidArg" | "DocNotOpen" | "DocOpenFailed" | "DocPasswordRequired" | "DocPasswordIncorrect" | "SharePasswordRequired" | "Aborted" | "Network" | "Unauthenticated" | "Forbidden" | "NotFound" | "WireFormat" | "RuntimeUnavailable" | "LayerVersionConflict" | "NotImplemented" | "MalformedPdf" | "SigningPending" | "SigningExpired" | "SigningVersionMismatch" | "SignatureRefused" | "ProtectedDocument" | "StaleBase" | "PayloadTooLarge" | "ObjectNumberUnavailable" | "LayerFull" | "ChangeConflict" | "UndoUnavailable" | "IdempotencyKeyReused"messagestringdetailsobjectoptional