POST v1/Locations/{locationID}/Policies/Signatures

Insert a signature

Request Information

URI Parameters

Name	Description	Type	Additional information
locationID	Id of the location	string	Required

Body Parameters

Signature to be inserted

BlobInfoDTO

Name	Description	Type	Additional information
Id	Id of the blob	integer	None.
BlobContainerInfoId	Blob container info id	integer	None.
BlobFileName	Points to the guid file name in the actual blob container.	string	None.
FileName	This is the display name in Catalyst.	string	None.
DisplayName	Display name	string	None.
FileType	This is typically the file extension, such as JPG or PDF.	string	None.
CreatedOn	Created on	string	None.
CreatedBy	Created by	string	None.
EntityId	Must be a valid ID for the File Relation Type.	integer	None.
FileRelation	File relation	integer	None.
CreatedById	Created by id	integer	None.
Active	Signifies whether the blob is active	boolean	None.
Description	Description	string	None.
ThumnbailBlobFileName	Thumnbail blob file name	string	None.
ThumbnailAvatarBlobFileName	Thumbnail avatar blob file name	string	None.
FileSize	File size	integer	None.
AppCreated	App created	string	None.
RelatedPolicyIDs	Related policy ids	Collection of integer	None.
CategoryDescriptor	Category descriptor	string	None.
File	File bytes	Collection of byte	None.
DownloadFileType	Download file type	string	None.
Readonly	Signifies whether the blob is readonly	boolean	None.
UsageCode	Usage code	string	None.
StorageLocationId	Storage location id	integer	None.
CreatedOnSearchable	Created on searchable	string	None.
FolderId	Folder id	integer	None.
ExcludeFromStorageCost	Signifies whether the blob is excluded from storage cost	boolean	None.
BlobUrl	Blob URL	string	None.
Tags	Tags	string	None.
BulkInsertId		globally unique identifier	None.
BulkInsertSessionId		globally unique identifier	None.
ShouldHaveThumbnail	Signifies whether the blob should have thumbnail	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": null,
  "StorageLocationId": null,
  "CreatedOnSearchable": "sample string 19",
  "FolderId": 1,
  "ExcludeFromStorageCost": true,
  "BlobUrl": "sample string 21",
  "Tags": null,
  "BulkInsertId": "7205f725-e773-4c17-a3c0-92630bde5735",
  "BulkInsertSessionId": "9550aa92-63d2-407f-b464-e458b877b31f",
  "ShouldHaveThumbnail": false
}

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'.

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 21</BlobUrl>
  <BulkInsertId>7205f725-e773-4c17-a3c0-92630bde5735</BulkInsertId>
  <BulkInsertSessionId>9550aa92-63d2-407f-b464-e458b877b31f</BulkInsertSessionId>
  <CategoryDescriptor>sample string 16</CategoryDescriptor>
  <CreatedBy>sample string 8</CreatedBy>
  <CreatedById>1</CreatedById>
  <CreatedOn>sample string 7</CreatedOn>
  <CreatedOnSearchable>sample string 19</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 i:nil="true" />
  <Tags i:nil="true" />
  <ThumbnailAvatarBlobFileName>sample string 14</ThumbnailAvatarBlobFileName>
  <ThumnbailBlobFileName>sample string 13</ThumnbailBlobFileName>
  <UsageCode i:nil="true" />
</BlobInfoDTO>

Response Information

Resource Description

Inserted signature

ActionResultDTOOfBlobInfoDTO

Name	Description	Type	Additional information
Result		BlobInfoDTO	None.
CreatedBy		string	None.
EntityID		integer	None.
RowSource		string	None.
PolicyID		integer	None.
IsSuccess	Signifies whether action is successful	boolean	None.
ErrorCode	Error code	string	None.
ErrorMessage	Error message	string	None.
InfoMessage	Information message	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": null,
    "StorageLocationId": null,
    "CreatedOnSearchable": "sample string 19",
    "FolderId": 1,
    "ExcludeFromStorageCost": true,
    "BlobUrl": "sample string 21",
    "Tags": null,
    "BulkInsertId": "f0e0122c-c290-4669-b3c8-e74ebf63ccb3",
    "BulkInsertSessionId": "8a2d116b-2f11-44a8-b40e-1c7cf93f7fc0",
    "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 21</d2p1:BlobUrl>
    <d2p1:BulkInsertId>f0e0122c-c290-4669-b3c8-e74ebf63ccb3</d2p1:BulkInsertId>
    <d2p1:BulkInsertSessionId>8a2d116b-2f11-44a8-b40e-1c7cf93f7fc0</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 19</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 i:nil="true" />
    <d2p1:Tags i:nil="true" />
    <d2p1:ThumbnailAvatarBlobFileName>sample string 14</d2p1:ThumbnailAvatarBlobFileName>
    <d2p1:ThumnbailBlobFileName>sample string 13</d2p1:ThumnbailBlobFileName>
    <d2p1:UsageCode i:nil="true" />
  </Result>
  <RowSource>sample string 3</RowSource>
</ActionResultOfBlobInfoDTO>