Storage

Retrieve a document (meta-data only, no content)

get/api/v1/documents/{id4n}/{organizationId}/{fileName}/metadata

Request

Base URL
https://backend.id4i.de
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/id4i/apis/id4i-api/docs/api/v1/documents/:id4n/:organizationId/:fileName/metadata/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

organizationIdstring required

organizationId

id4nstring required

id4n

fileNamestring required

fileName

Response

filenamestring

File Name

mimeTypestring

Mime Type

ownerOrganizationIdstring

The organization's namespace which owns the document

Example response

{
  "filename": "publicInfo.pdf",
  "mimeType": "text/plain",
  "ownerOrganizationId": "de.bluerain",
  "visibility": {
    "public": true,
    "sharedOrganizationIds": [
      "de.acme",
      "com.porsche",
      "de.bluerain"
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.