POST v1/Files/Properties/{id}

Update the file properties for a specific file

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Id of the file

string

Required

Body Parameters

File properties

BlobInfoDTO
NameDescriptionTypeAdditional information
Id

integer

None.

BlobContainerInfoId

integer

None.

BlobFileName

string

None.

FileName

string

None.

DisplayName

string

None.

FileType

string

None.

CreatedOn

string

None.

CreatedBy

string

None.

EntityId

integer

None.

FileRelation

integer

None.

CreatedById

integer

None.

Active

boolean

None.

Description

string

None.

ThumnbailBlobFileName

string

None.

ThumbnailAvatarBlobFileName

string

None.

FileSize

integer

None.

AppCreated

string

None.

RelatedPolicyIDs

Collection of integer

None.

CategoryDescriptor

string

None.

File

Collection of byte

None.

DownloadFileType

string

None.

Readonly

boolean

None.

UsageCode

string

None.

StorageLocationId

integer

None.

CreatedOnSearchable

string

None.

FolderId

integer

None.

ExcludeFromStorageCost

boolean

None.

BlobUrl

string

None.

Tags

string

None.

BulkInsertId

globally unique identifier

None.

BulkInsertSessionId

globally unique identifier

None.

ShouldHaveThumbnail

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "BlobContainerInfoId": 2,
  "BlobFileName": "sample string 3",
  "FileName": "sample string 4",
  "DisplayName": "sample string 5",
  "FileType": "sample string 6",
  "CreatedOn": "sample string 7",
  "CreatedBy": "sample string 8",
  "EntityId": 9,
  "FileRelation": 10,
  "CreatedById": 1,
  "Active": true,
  "Description": "sample string 12",
  "ThumnbailBlobFileName": "sample string 13",
  "ThumbnailAvatarBlobFileName": "sample string 14",
  "FileSize": 1,
  "AppCreated": "sample string 15",
  "RelatedPolicyIDs": [
    1,
    2
  ],
  "CategoryDescriptor": "sample string 16",
  "File": "QEA=",
  "DownloadFileType": "sample string 17",
  "Readonly": true,
  "UsageCode": "sample string 19",
  "StorageLocationId": 1,
  "CreatedOnSearchable": "sample string 20",
  "FolderId": 1,
  "ExcludeFromStorageCost": true,
  "BlobUrl": "sample string 22",
  "Tags": "sample string 23",
  "BulkInsertId": "229664e2-729c-4294-8ee7-46336eeb2ac8",
  "BulkInsertSessionId": "cdf86bf0-7ca9-4e46-8dd6-6aed9d261486",
  "ShouldHaveThumbnail": false
}

application/xml, text/xml

Sample:
<BlobInfoDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Files">
  <Active>true</Active>
  <AppCreated>sample string 15</AppCreated>
  <BlobContainerInfoId>2</BlobContainerInfoId>
  <BlobFileName>sample string 3</BlobFileName>
  <BlobUrl>sample string 22</BlobUrl>
  <BulkInsertId>229664e2-729c-4294-8ee7-46336eeb2ac8</BulkInsertId>
  <BulkInsertSessionId>cdf86bf0-7ca9-4e46-8dd6-6aed9d261486</BulkInsertSessionId>
  <CategoryDescriptor>sample string 16</CategoryDescriptor>
  <CreatedBy>sample string 8</CreatedBy>
  <CreatedById>1</CreatedById>
  <CreatedOn>sample string 7</CreatedOn>
  <CreatedOnSearchable>sample string 20</CreatedOnSearchable>
  <Description>sample string 12</Description>
  <DisplayName>sample string 5</DisplayName>
  <DownloadFileType>sample string 17</DownloadFileType>
  <EntityId>9</EntityId>
  <ExcludeFromStorageCost>true</ExcludeFromStorageCost>
  <File>QEA=</File>
  <FileName>sample string 4</FileName>
  <FileRelation>10</FileRelation>
  <FileSize>1</FileSize>
  <FileType>sample string 6</FileType>
  <FolderId>1</FolderId>
  <Id>1</Id>
  <Readonly>true</Readonly>
  <RelatedPolicyIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </RelatedPolicyIDs>
  <StorageLocationId>1</StorageLocationId>
  <Tags>sample string 23</Tags>
  <ThumbnailAvatarBlobFileName>sample string 14</ThumbnailAvatarBlobFileName>
  <ThumnbailBlobFileName>sample string 13</ThumnbailBlobFileName>
  <UsageCode>sample string 19</UsageCode>
</BlobInfoDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BlobInfoDTO'.

Response Information

Resource Description

Updated file properties

ActionResultDTOOfBlobInfoDTO
NameDescriptionTypeAdditional information
Result

BlobInfoDTO

None.

CreatedBy

string

None.

EntityID

integer

None.

RowSource

string

None.

PolicyID

integer

None.

IsSuccess

boolean

None.

ErrorCode

string

None.

ErrorMessage

string

None.

InfoMessage

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": {
    "Id": 1,
    "BlobContainerInfoId": 2,
    "BlobFileName": "sample string 3",
    "FileName": "sample string 4",
    "DisplayName": "sample string 5",
    "FileType": "sample string 6",
    "CreatedOn": "sample string 7",
    "CreatedBy": "sample string 8",
    "EntityId": 9,
    "FileRelation": 10,
    "CreatedById": 1,
    "Active": true,
    "Description": "sample string 12",
    "ThumnbailBlobFileName": "sample string 13",
    "ThumbnailAvatarBlobFileName": "sample string 14",
    "FileSize": 1,
    "AppCreated": "sample string 15",
    "RelatedPolicyIDs": [
      1,
      2
    ],
    "CategoryDescriptor": "sample string 16",
    "File": "QEA=",
    "DownloadFileType": "sample string 17",
    "Readonly": true,
    "UsageCode": "sample string 19",
    "StorageLocationId": 1,
    "CreatedOnSearchable": "sample string 20",
    "FolderId": 1,
    "ExcludeFromStorageCost": true,
    "BlobUrl": "sample string 22",
    "Tags": "sample string 23",
    "BulkInsertId": "614ea59d-ed7a-4fc1-83d2-03499764e9ba",
    "BulkInsertSessionId": "9bc24ceb-4cf5-49c9-91a7-fb2dfee82cd8",
    "ShouldHaveThumbnail": false
  },
  "CreatedBy": "sample string 1",
  "EntityID": 2,
  "RowSource": "sample string 3",
  "PolicyID": 4,
  "IsSuccess": true,
  "ErrorCode": "sample string 6",
  "ErrorMessage": "sample string 7",
  "InfoMessage": "sample string 8"
}

application/xml, text/xml

Sample:
<ActionResultOfBlobInfoDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects">
  <ErrorCode>sample string 6</ErrorCode>
  <ErrorMessage>sample string 7</ErrorMessage>
  <InfoMessage>sample string 8</InfoMessage>
  <IsSuccess>true</IsSuccess>
  <CreatedBy>sample string 1</CreatedBy>
  <EntityID>2</EntityID>
  <PolicyID>4</PolicyID>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Files">
    <d2p1:Active>true</d2p1:Active>
    <d2p1:AppCreated>sample string 15</d2p1:AppCreated>
    <d2p1:BlobContainerInfoId>2</d2p1:BlobContainerInfoId>
    <d2p1:BlobFileName>sample string 3</d2p1:BlobFileName>
    <d2p1:BlobUrl>sample string 22</d2p1:BlobUrl>
    <d2p1:BulkInsertId>614ea59d-ed7a-4fc1-83d2-03499764e9ba</d2p1:BulkInsertId>
    <d2p1:BulkInsertSessionId>9bc24ceb-4cf5-49c9-91a7-fb2dfee82cd8</d2p1:BulkInsertSessionId>
    <d2p1:CategoryDescriptor>sample string 16</d2p1:CategoryDescriptor>
    <d2p1:CreatedBy>sample string 8</d2p1:CreatedBy>
    <d2p1:CreatedById>1</d2p1:CreatedById>
    <d2p1:CreatedOn>sample string 7</d2p1:CreatedOn>
    <d2p1:CreatedOnSearchable>sample string 20</d2p1:CreatedOnSearchable>
    <d2p1:Description>sample string 12</d2p1:Description>
    <d2p1:DisplayName>sample string 5</d2p1:DisplayName>
    <d2p1:DownloadFileType>sample string 17</d2p1:DownloadFileType>
    <d2p1:EntityId>9</d2p1:EntityId>
    <d2p1:ExcludeFromStorageCost>true</d2p1:ExcludeFromStorageCost>
    <d2p1:File>QEA=</d2p1:File>
    <d2p1:FileName>sample string 4</d2p1:FileName>
    <d2p1:FileRelation>10</d2p1:FileRelation>
    <d2p1:FileSize>1</d2p1:FileSize>
    <d2p1:FileType>sample string 6</d2p1:FileType>
    <d2p1:FolderId>1</d2p1:FolderId>
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Readonly>true</d2p1:Readonly>
    <d2p1:RelatedPolicyIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </d2p1:RelatedPolicyIDs>
    <d2p1:StorageLocationId>1</d2p1:StorageLocationId>
    <d2p1:Tags>sample string 23</d2p1:Tags>
    <d2p1:ThumbnailAvatarBlobFileName>sample string 14</d2p1:ThumbnailAvatarBlobFileName>
    <d2p1:ThumnbailBlobFileName>sample string 13</d2p1:ThumnbailBlobFileName>
    <d2p1:UsageCode>sample string 19</d2p1:UsageCode>
  </Result>
  <RowSource>sample string 3</RowSource>
</ActionResultOfBlobInfoDTO>