---
title: Read
slug: vTiM-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 filenet system configured in Link Enterprise ."
      },
      {
        "kind": "required",
        "name": "selectedCMS",
        "type": "string",
        "description": "Value should always be set to \"filenet\" to let Link Enterprise know which configured content system to search."
      },
      {
        "name": "location",
        "kind": "required",
        "type": "string",
        "description": "filenet folder where the document need to be read.",
        "children": []
      },
      {
        "name": "repository",
        "kind": "required",
        "type": "string",
        "description": "filenet repository Value",
        "children": []
      },
      {
        "name": "domain",
        "kind": "required",
        "type": "string",
        "description": "Filenet Domain name",
        "children": []
      },
      {
        "name": "checkout",
        "kind": "optional",
        "type": "string",
        "description": "If true, Does an Exclusive Checkout for filenet document.",
        "children": []
      },
      {
        "name": "id",
        "kind": "required",
        "type": "string",
        "description": "Filenet unique Document Id",
        "children": []
      },
      {
        "name": "selectClause",
        "kind": "optional",
        "type": "string",
        "description": "metadataField name which is required in response.",
        "children": []
      },
      {
        "name": "getContent",
        "kind": "optional",
        "type": "string",
        "description": "If true, Returns binary content of the Document. If false, returns metadata properties.",
        "children": []
      },
      {
        "name": "dateTimeFormat",
        "kind": "required",
        "type": "string",
        "description": "add datetime property in this provided format.",
        "children": []
      },
      {
        "name": "maxSize",
        "kind": "optional",
        "type": "string",
        "description": "Maximum number of entries in response.",
        "children": []
      }
    ],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "ymgovs5m1fdI32-gkqqCH",
        "code": "{\n\t\"someMetadataFieldName\": \"someMetadataFieldValue\"\n}",
        "language": "200"
      },
      {
        "id": "guaZg_Kjaci06qaXI6hoD",
        "code": "",
        "language": "500"
      }
    ],
    "selectedLanguageId": "ymgovs5m1fdI32-gkqqCH"
  },
  "examples": {
    "languages": [
      {
        "id": "yA6PAHJgLMNa-NjR8XpmC",
        "code": "{\n   \"cmsName\":\"Name of the filenet system configured in Link Enterpri.\",  \n    \"repository\":\"Filenet_Repository\",\n \"domain\":\"Domain_Name\",\n\t\"checkout\":false,\n\t\"id\":\"filenet document id\",\n\t\"dateTimeFormat\":\"MM/dd/yyyy hh:mm:ss a z\",\n\t\"selectClause\":\"someMetadataFieldName\",\n\t\"getContent\":false,\n\t\"maxSize\":100\n   \"selectedCMS\":\"filenet\",\n      \"location\":\"filenet folder name\"\n\t\n}",
        "language": "json"
      }
    ],
    "selectedLanguageId": "yA6PAHJgLMNa-NjR8XpmC"
  },
  "description": "Retrieve a file metadata by using filenet 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 filenet system configured in Link Enterprise ."
      },
      {
        "kind": "required",
        "name": "selectedCMS",
        "type": "string",
        "description": "Value should always be set to \"filenet\" to let Link Enterprise know which configured content system to search."
      },
      {
        "name": "location",
        "kind": "required",
        "type": "string",
        "description": "filenet folder where the document need to be read.",
        "children": []
      },
      {
        "name": "repository",
        "kind": "required",
        "type": "string",
        "description": "filenet repository Value",
        "children": []
      },
      {
        "name": "domain",
        "kind": "required",
        "type": "string",
        "description": "Filenet Domain name",
        "children": []
      },
      {
        "name": "checkout",
        "kind": "optional",
        "type": "string",
        "description": "If true, Does an Exclusive Checkout for filenet document.",
        "children": []
      },
      {
        "name": "id",
        "kind": "required",
        "type": "string",
        "description": "Filenet unique Document Id",
        "children": []
      },
      {
        "name": "selectClause",
        "kind": "optional",
        "type": "string",
        "description": "metadataField name. While retrieving content. add \"ContentElements\" as selectClause to get file information in response header.",
        "children": []
      },
      {
        "name": "getContent",
        "kind": "optional",
        "type": "string",
        "description": "If true, Returns binary content of the Document. If false, returns metadata properties.",
        "children": []
      },
      {
        "name": "dateTimeFormat",
        "kind": "required",
        "type": "string",
        "description": "add datetime property in this provided format.",
        "children": []
      },
      {
        "name": "maxSize",
        "kind": "optional",
        "type": "string",
        "description": "Maximum number of entries in response.",
        "children": []
      },
      {
        "name": "tmpDirectory",
        "kind": "optional",
        "type": "string",
        "description": "Temporary directory where the file content is stored in the local system. Required while getContent is set to true.",
        "children": []
      }
    ],
    "formDataParameters": []
  },
  "results": {
    "languages": [
      {
        "id": "ymgovs5m1fdI32-gkqqCH",
        "code": "file content",
        "language": "200"
      },
      {
        "id": "guaZg_Kjaci06qaXI6hoD",
        "code": "",
        "language": "500"
      }
    ],
    "selectedLanguageId": "ymgovs5m1fdI32-gkqqCH"
  },
  "examples": {
    "languages": [
      {
        "id": "yA6PAHJgLMNa-NjR8XpmC",
        "code": "{\n   \"cmsName\":\"Name of the filenet system configured in Link Enterpri.\",  \n    \"repository\":\"Filenet_Repository\",\n \"domain\":\"Domain_Name\",\n\t\"checkout\":false,\n\t\"id\":\"filenet document id\",\n\t\"dateTimeFormat\":\"MM/dd/yyyy hh:mm:ss a z\",\n\t\"selectClause\":\"someMetadataFieldName\",\n\t\"getContent\":true,\n\t\"maxSize\":100\n   \"selectedCMS\":\"filenet\",\n      \"location\":\"filenet folder name\",\n      \"tmpDirectory\":\"C:\\\\somefolderlocation\"\n\t\n}",
        "language": "json"
      }
    ],
    "selectedLanguageId": "yA6PAHJgLMNa-NjR8XpmC"
  },
  "description": "Retrieve a file metadata by using filenet unique Id.",
  "currentNewParameter": {
    "label": "Body Parameter",
    "value": "bodyDataParameters"
  },
  "autoGeneratedAnchorSlug": "read-content",
  "legacyHash": "vfL_H1ym3b69iCwb8tkz1"
}
```
:::