Skip to main content
GET
/
library
/
{libraryId}
/
classId
/
{classId}
/
documentId
/
{documentId}
/
attachmentId
/
{attachmentId}
/
extension
/
{extensionType}
cURL
curl --request GET \
  --url https://aodocs.altirnao.com/api/library/{libraryId}/classId/{classId}/documentId/{documentId}/attachmentId/{attachmentId}/extension/{extensionType} \
  --header 'Authorization: Bearer <token>'
{
  "attributes": {
    "blocks": [
      {
        "attributes": [
          {
            "boundingBox": {
              "height": 123,
              "maxX": 123,
              "maxY": 123,
              "minX": 123,
              "minY": 123,
              "width": 123
            },
            "position": {
              "x": 123,
              "y": 123,
              "z": 123
            },
            "rotation": 123,
            "tag": "<string>",
            "textHeight": 123,
            "value": "<string>",
            "widthFactor": 123
          }
        ],
        "blockName": "<string>"
      }
    ],
    "classId": "<string>",
    "customProperties": {},
    "documentId": "<string>",
    "domainName": "<string>",
    "drawingExtents": {
      "height": 123,
      "maxX": 123,
      "maxY": 123,
      "maxZ": 123,
      "minX": 123,
      "minY": 123,
      "minZ": 123,
      "width": 123
    },
    "error": {
      "code": "<string>",
      "details": {},
      "message": "<string>"
    },
    "extractedAt": "<string>",
    "file": {
      "id": "<string>"
    },
    "libraryId": "<string>",
    "libraryType": "<string>",
    "status": "<string>",
    "version": "<string>"
  },
  "kind": "<string>",
  "xrefs": {
    "classId": "<string>",
    "documentId": "<string>",
    "domainName": "<string>",
    "error": {
      "code": "<string>",
      "details": {},
      "message": "<string>"
    },
    "extractedAt": "<string>",
    "file": {
      "id": "<string>"
    },
    "libraryId": "<string>",
    "libraryType": "<string>",
    "status": "<string>",
    "version": "<string>",
    "xrefs": [
      {
        "name": "<string>",
        "originalPath": "<string>",
        "resolved": true
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

libraryId
string
required

The ID of the library

classId
string
required

The ID of the document class

documentId
string
required

The ID of the document

attachmentId
string
required

The OSS object id of the attachment.

extensionType
string
required

The extension type to retrieve (e.g. ADXREF, ADATTR).

Query Parameters

domain
string

The G Suite domain

securityCode
string

The security code

Response

200 - application/json

A ApiOssExtension response

attributes
object
kind
string
xrefs
object