Read

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 { "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" } } { "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" } }