GET api/File/{id}

Looks up for a file by name or ID.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The name or ID of the file as a string of 10 character.	string	Required

Body Parameters

None.

Response Information

Resource Description

The file (without data!) on success otherwise null

Files

Name	Type	Additional information
stream_id	globally unique identifier	None.
name	string	None.
last_write_time	date	None.
cached_file_size	integer	None.
is_directory	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "stream_id": "27d437b1-b4eb-4062-b39d-b06380a394cf",
  "name": "sample string 2",
  "last_write_time": "2026-03-13T14:57:58.6833766+00:00",
  "cached_file_size": 4,
  "is_directory": true
}

text/html

Sample:

{"stream_id":"27d437b1-b4eb-4062-b39d-b06380a394cf","name":"sample string 2","last_write_time":"2026-03-13T14:57:58.6833766+00:00","cached_file_size":4,"is_directory":true}

application/xml, text/xml

Sample:

<Files xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/LeaveAMessageAPI.Models.Entitys">
  <cached_file_size>4</cached_file_size>
  <is_directory>true</is_directory>
  <last_write_time xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2026-03-13T14:57:58.6833766Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </last_write_time>
  <name>sample string 2</name>
  <stream_id>27d437b1-b4eb-4062-b39d-b06380a394cf</stream_id>
</Files>