---
title: Read
slug: rI7d-read
docTags: 
createdAt: 2022-01-05T08:13:03.000Z
---

Link Enterprise provides a web service endpoint that will allow you to retrieve a file metadata.

Included below are example of reading a files metadata.

:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "https://localhost:82/scrud/read",
  "name": "Read (metadata)",
  "method": "POST",
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [],
    "bodyDataParameters": [
      {
        "kind": "required",
        "name": "cmsName",
        "type": "string",
        "description": "Name of the s3 system configured in Link Enterprise ."
      },
      {
        "kind": "required",
        "name": "id",
        "type": "string",
        "description": "Unique id of s3 file or folder."
      },
      {
        "kind": "required",
        "name": "selectedCMS",
        "type": "string",
        "description": "Value should always be set to \"s3\" to let Link Enterprise know which configured content system to search."
      },
      {
        "name": "location",
        "kind": "optional",
        "type": "string",
        "description": " If no repository value is present middleware considers the location as bucket Name configured in ini File.",
        "children": []
      },
      {
        "name": "getContent",
        "kind": "optional",
        "type": "string",
        "description": "If true, Returns binary content of the Document. If false, returns metadata properties.",
        "children": []
      }
    ],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "ymgovs5m1fdI32-gkqqCH",
        "code": "\t{\n\t\t\"compid\": \"data24\",\n\t\t\"content-length\": \"3000\",\n\t\t\"contrep\": \"K2456\",\n\t\t\"docid\": \"1234\",\n\t\t\"scanperformed\": \"true\"\n\t}",
        "language": "200"
      },
      {
        "id": "guaZg_Kjaci06qaXI6hoD",
        "code": "",
        "language": "500"
      }
    ],
    "selectedLanguageId": "ymgovs5m1fdI32-gkqqCH"
  },
  "examples": {
    "languages": [
      {
        "id": "yA6PAHJgLMNa-NjR8XpmC",
        "code": "{\n   \"cmsName\":\"insertProductionSystemName (located in Link Enterprise gui)\",\n   \"id\":\"unique s3 id specfic to folder/id\",\n\t\"selectedCMS\":\"s3\",\n\t   \"location\":\"S3 Bucket Name\"\n\t\n}\n",
        "language": "json"
      }
    ],
    "selectedLanguageId": "yA6PAHJgLMNa-NjR8XpmC"
  },
  "description": "Retrieve a file metadata by using s3 unique Id.",
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  },
  "autoGeneratedAnchorSlug": "read-metadata",
  "legacyHash": "RTkIuAhig8f9DkChR6cM4"
}
```
:::

:::ApiMethodV2
```json
{
  "tab": "examples",
  "url": "https://localhost:82/scrud/read",
  "name": "Read (content)",
  "method": "POST",
  "request": {
    "pathParameters": [],
    "queryParameters": [],
    "headerParameters": [],
    "bodyDataParameters": [
      {
        "kind": "required",
        "name": "cmsName",
        "type": "string",
        "description": "Name of the s3 system configured in Link Enterprise ."
      },
      {
        "kind": "required",
        "name": "id",
        "type": "string",
        "description": "Unique id of s3 file or folder."
      },
      {
        "kind": "required",
        "name": "selectedCMS",
        "type": "string",
        "description": "Value should always be set to \"s3\" to let Link Enterprise know which configured content system to search."
      },
      {
        "name": "location",
        "kind": "optional",
        "type": "string",
        "description": "S3 Bucket name where you want to read the document. If no location value is present middleware considers the location as bucket Name configured in ini File.",
        "children": []
      },
      {
        "name": "getContent",
        "kind": "required",
        "type": "string",
        "description": "If true, Returns binary content of the Document. If false, returns metadata properties.",
        "children": []
      }
    ],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "ymgovs5m1fdI32-gkqqCH",
        "code": "\t{\n\t\t\"compid\": \"data24\",\n\t\t\"content-length\": \"3000\",\n\t\t\"contrep\": \"K2456\",\n\t\t\"docid\": \"1234\",\n\t\t\"scanperformed\": \"true\"\n\t}",
        "language": "200"
      },
      {
        "id": "guaZg_Kjaci06qaXI6hoD",
        "code": "",
        "language": "500"
      }
    ],
    "selectedLanguageId": "ymgovs5m1fdI32-gkqqCH"
  },
  "examples": {
    "languages": [
      {
        "id": "yA6PAHJgLMNa-NjR8XpmC",
        "code": "{\n   \"cmsName\":\"insertProductionSystemName (located in Link Enterprise gui)\",\n   \"id\":\"unique s3 id specfic to folder/id\",\n\t\"selectedCMS\":\"s3\",\n\t   \"location\":\"S3 Bucket Name\",\n\t   \"getContent\":true\n\t\n}\n",
        "language": "json"
      }
    ],
    "selectedLanguageId": "yA6PAHJgLMNa-NjR8XpmC"
  },
  "description": "Retrieve a file metadata by using s3 unique Id.",
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  },
  "autoGeneratedAnchorSlug": "read-content",
  "legacyHash": "M0geQ_vj6PJYXDeg9AgeG"
}
```
:::