Cyan Web API - Version 1

GET api/files?{name}

            Gets a file resource by file Name.  Note that this is not the contents of the file, this is the file metadata, such as the FileId, Name and Description.
            Some properties such as BlobStorageUrl, Size, ContentType and IsShared are not populated.
            Use "api/files/{fileName}/blobContents" to get the contents of a file.

Request Information

Parameters

Name	Description	Additional information
name	The name of the file	Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "fileId": "30b0657e-5c0c-49b2-acca-ef204463ad09",
  "tenantId": "baeaeff8-5e65-4db3-b15b-ad6f00e3b083",
  "name": "sample string 3",
  "description": "sample string 4",
  "blobStorageUrl": "sample string 5",
  "size": 1,
  "contentType": "sample string 6",
  "isShared": true,
  "correlationId": "sample string 8",
  "createdBy": "sample string 9",
  "createdDateUtc": "2025-04-21T02:02:36.5122388+00:00",
  "updatedDateUtc": "2025-04-21T02:02:36.5122388+00:00"
}

application/xml, text/xml

Sample:

<FileRepresentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Rest.Version1">
  <CreatedDateUtc>2025-04-21T02:02:36.5122388+00:00</CreatedDateUtc>
  <UpdatedDateUtc>2025-04-21T02:02:36.5122388+00:00</UpdatedDateUtc>
  <BlobStorageUrl>sample string 5</BlobStorageUrl>
  <ContentType>sample string 6</ContentType>
  <CorrelationId>sample string 8</CorrelationId>
  <CreatedBy>sample string 9</CreatedBy>
  <Description>sample string 4</Description>
  <FileId>30b0657e-5c0c-49b2-acca-ef204463ad09</FileId>
  <IsShared>true</IsShared>
  <Name>sample string 3</Name>
  <Size>1</Size>
  <TenantId>baeaeff8-5e65-4db3-b15b-ad6f00e3b083</TenantId>
</FileRepresentation>