Inhaltsverzeichnis

edm

EDM – Documents

Electronic document management — files, folders, versions and approval workflows. Store contracts, drawings, SOPs and certificates against a folder tree, route them for sign-off, and keep an auditable version history. Reference documents from any business object (an order, a work order, a supplier) via the reference field, and control access with per-document permissions.

GET/v1/edm/documentsScope: edm:read

List documents

Returns a cursor-paginated list of documents. Use updated_since for incremental sync.

Query parameters

limitoptional	integerPage size, 1–200 (default 50).
cursoroptional	stringPagination cursor from a previous response.
updated_sinceoptional	stringRFC 3339 timestamp; return items changed after it.
folder_idoptional	stringFilter by folder id.
referenceoptional	stringFilter by linked business object, e.g. order:so_1a2b.

Request

curl "https://api.apusplatform.com/v1/edm/documents" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "data": [
    {
      "id": "doc_7f21",
      "name": "Supply agreement 2026.pdf",
      "folder_id": "fld_contracts",
      "reference": "supplier:sup_44a1",
      "status": "approved",
      "version": 3,
      "mime_type": "application/pdf",
      "size": 284116,
      "updated_at": "2026-07-14T09:05:22Z"
    }
  ],
  "has_more": true,
  "next_cursor": "crsr_2b70"
}

POST/v1/edm/documentsScope: edm:write

Create a document

Registers a document and returns an upload_url. PUT the file bytes to upload_url to attach the first version.

Body

namerequired	stringFile name, e.g. Supply agreement 2026.pdf.
folder_idrequired	stringDestination folder id.
referenceoptional	stringLinked business object, e.g. order:so_1a2b.

Request

curl -X POST "https://api.apusplatform.com/v1/edm/documents" \
  -H "Authorization: Bearer $APUS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Supply agreement 2026.pdf",
    "folder_id": "fld_contracts",
    "reference": "supplier:sup_44a1"
  }'

Response

{
  "id": "doc_7f21",
  "name": "Supply agreement 2026.pdf",
  "folder_id": "fld_contracts",
  "status": "draft",
  "version": 0,
  "upload_url": "https://files.apusplatform.com/upload/doc_7f21?token=…",
  "created_at": "2026-07-20T02:10:00Z"
}

GET/v1/edm/documents/{id}Scope: edm:read

Retrieve a document

Returns a single document by its id, including a short-lived download_url for the current version.

Path parameters

idrequired

stringDocument id.

Request

curl "https://api.apusplatform.com/v1/edm/documents/doc_7f21" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "id": "doc_7f21",
  "name": "Supply agreement 2026.pdf",
  "folder_id": "fld_contracts",
  "reference": "supplier:sup_44a1",
  "status": "approved",
  "version": 3,
  "mime_type": "application/pdf",
  "size": 284116,
  "download_url": "https://files.apusplatform.com/doc_7f21?token=…",
  "updated_at": "2026-07-14T09:05:22Z"
}

PATCH/v1/edm/documents/{id}Scope: edm:write

Update a document

Updates mutable fields of a document. Only supplied fields change.

Path parameters

idrequired

stringDocument id.

Body

nameoptional	stringFile name.
folder_idoptional	stringMove the document to another folder.
referenceoptional	stringLinked business object.

Request

curl -X PATCH "https://api.apusplatform.com/v1/edm/documents/doc_7f21" \
  -H "Authorization: Bearer $APUS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "folder_id": "fld_archive"
  }'

Response

{
  "id": "doc_7f21",
  "folder_id": "fld_archive",
  "updated_at": "2026-07-20T02:12:00Z"
}

DELETE/v1/edm/documents/{id}Scope: edm:write

Delete a document

Moves a document to the recycle bin (soft delete). Its versions and audit trail are retained.

Path parameters

idrequired

stringDocument id.

Request

curl -X DELETE "https://api.apusplatform.com/v1/edm/documents/{id}" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

HTTP/1.1 204 No Content

GET/v1/edm/foldersScope: edm:read

List folders

Returns folders, optionally scoped to the children of a parent. Omit parent for the top level.

Query parameters

parentoptional

stringParent folder id; omit for root folders.

Request

curl "https://api.apusplatform.com/v1/edm/folders" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "data": [
    {
      "id": "fld_contracts",
      "name": "Contracts",
      "parent": "fld_root",
      "doc_count": 128
    },
    {
      "id": "fld_drawings",
      "name": "Engineering drawings",
      "parent": "fld_root",
      "doc_count": 512
    }
  ]
}

POST/v1/edm/foldersScope: edm:write

Create a folder

Creates a folder, optionally nested under a parent.

Body

namerequired	stringDisplay name.
parentoptional	stringParent folder id; omit for a root folder.

Request

curl -X POST "https://api.apusplatform.com/v1/edm/folders" \
  -H "Authorization: Bearer $APUS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Quality certificates",
    "parent": "fld_root"
  }'

Response

{
  "id": "fld_certs",
  "name": "Quality certificates",
  "parent": "fld_root",
  "created_at": "2026-07-20T02:14:00Z"
}

GET/v1/edm/folders/{id}Scope: edm:read

Retrieve a folder

Returns a single folder by its id.

Path parameters

idrequired

stringFolder id.

Request

curl "https://api.apusplatform.com/v1/edm/folders/fld_contracts" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "id": "fld_contracts",
  "name": "Contracts",
  "parent": "fld_root",
  "doc_count": 128,
  "created_at": "2026-01-08T03:40:00Z"
}

POST/v1/edm/documents/{id}/approvalsScope: edm:write

Record an approval decision

Records the current approver's decision on a document. Approving the final step sets the document status to approved.

Path parameters

idrequired

stringDocument id.

Body

decisionrequired	stringOne of approve, reject.
commentoptional	stringReviewer note, shown in the audit trail.

Request

curl -X POST "https://api.apusplatform.com/v1/edm/documents/apr_31c8/approvals" \
  -H "Authorization: Bearer $APUS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "decision": "approve",
    "comment": "Terms match the negotiated draft."
  }'

Response

{
  "id": "apr_31c8",
  "document_id": "doc_7f21",
  "decision": "approve",
  "actor": "usr_9a10",
  "document_status": "approved",
  "created_at": "2026-07-20T02:16:00Z"
}

GET/v1/edm/documents/{id}/approvalsScope: edm:read

List approvals

Returns the approval history for a document in chronological order.

Path parameters

idrequired

stringDocument id.

Request

curl "https://api.apusplatform.com/v1/edm/documents/{id}/approvals" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "data": [
    {
      "id": "apr_2b71",
      "step": 1,
      "decision": "approve",
      "actor": "usr_4c22",
      "created_at": "2026-07-19T08:30:00Z"
    },
    {
      "id": "apr_31c8",
      "step": 2,
      "decision": "approve",
      "actor": "usr_9a10",
      "created_at": "2026-07-20T02:16:00Z"
    }
  ]
}

GET/v1/edm/documents/{id}/versionsScope: edm:read

List versions

Returns the version history for a document, newest first. Each version carries its own download_url.

Path parameters

idrequired

stringDocument id.

Request

curl "https://api.apusplatform.com/v1/edm/documents/{id}/versions" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "data": [
    {
      "version": 3,
      "size": 284116,
      "author": "usr_9a10",
      "download_url": "https://files.apusplatform.com/doc_7f21/v3?token=…",
      "created_at": "2026-07-14T09:05:22Z"
    },
    {
      "version": 2,
      "size": 281044,
      "author": "usr_4c22",
      "download_url": "https://files.apusplatform.com/doc_7f21/v2?token=…",
      "created_at": "2026-06-30T11:20:00Z"
    }
  ]
}

GET/v1/edm/documents/searchScope: edm:read

Search documents

Full-text search across document names and extracted content. Optionally scope the search to one folder.

Query parameters

qrequired	stringSearch query.
folder_idoptional	stringRestrict results to this folder.

Request

curl "https://api.apusplatform.com/v1/edm/documents/search" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "data": [
    {
      "id": "doc_7f21",
      "name": "Supply agreement 2026.pdf",
      "folder_id": "fld_contracts",
      "score": 0.92,
      "highlight": "…annual <em>supply agreement</em> renewal…"
    }
  ],
  "has_more": false
}

GET/v1/edm/documents/{id}/permissionsScope: edm:read

List permissions

Returns the access-control entries granted on a document, resolved from direct grants and inherited folder rules.

Path parameters

idrequired

stringDocument id.

Request

curl "https://api.apusplatform.com/v1/edm/documents/{id}/permissions" \
  -H "Authorization: Bearer $APUS_TOKEN"

Response

{
  "data": [
    {
      "principal": "group:legal",
      "role": "editor",
      "inherited_from": "fld_contracts"
    },
    {
      "principal": "usr_9a10",
      "role": "approver",
      "inherited_from": null
    }
  ]
}

Bereit zur Integration?

Erstellen Sie einen API-Client in der Account-Konsole, um Ihre Zugangsdaten zu erhalten, oder sprechen Sie mit einem Integrationsingenieur über Ihren Anwendungsfall.

API-Zugangsdaten erhalten Mit einem Integrationsingenieur sprechen

← PrevMaintenance (EAM)Next →Webhooks