POST api/resources/rename
Changes the original filename of a resource.
Request Information
URI Parameters
None.
Body Parameters
Arguments describing which resource to modify and the new filename.
RenameResourceArgsName | Description | Type | Additional information |
---|---|---|---|
ResourceIdentifier |
The identifier for the resource |
globally unique identifier |
None. |
NewFilename |
The new original filename for the resource. |
string |
None. |
Request Formats
application/json, text/json
{ "ResourceIdentifier": "c1311491-235a-4b5a-acdf-e6f62e2c9978", "NewFilename": "sample string 2" }
application/xml, text/xml
<RenameResourceArgs xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ResourceIdentifier>c1311491-235a-4b5a-acdf-e6f62e2c9978</ResourceIdentifier> <NewFilename>sample string 2</NewFilename> </RenameResourceArgs>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
A structure describing the resource.
ResourceMetaDataName | Description | Type | Additional information |
---|---|---|---|
ResourceIdentifier |
The identifier for the resource |
globally unique identifier |
None. |
Application |
The application the resource belongs to |
string |
None. |
OriginalFilename |
Original filename of the resource |
string |
None. |
SizeInBytes |
Size in bytes of the resource |
integer |
None. |
CreatedUtc |
DateTime when the resource was added to the system. |
date |
None. |
LastAccessedUtc |
DateTime when the resource was last accessed. |
date |
None. |
TimeToLiveAfterLastAccess |
Timespan the resource will remain in the repository after the last access date. |
time interval |
None. |
Tags |
List of name/value pairs listing the tags associated with the resource. |
Collection of Pair of string [key] and string [value] |
None. |
Md5HashBase64 |
Md5Hash of the resource as a Base64Encoded string. |
string |
None. |
Md5HashHexString |
Md5Hash of the resource as a hex string. |
string |
None. |
Response Formats
application/json, text/json
{ "ResourceIdentifier": "688ca023-149f-4472-a312-ee58d7047cb6", "Application": "sample string 2", "OriginalFilename": "sample string 3", "SizeInBytes": 1, "CreatedUtc": "2024-05-19T00:51:44.5938138-04:00", "LastAccessedUtc": "2024-05-19T00:51:44.5938138-04:00", "TimeToLiveAfterLastAccess": "00:00:00.1234567", "Tags": [ { "Key": "sample string 1", "Value": "sample string 2" }, { "Key": "sample string 1", "Value": "sample string 2" } ], "Md5HashBase64": "sample string 6", "Md5HashHexString": "sample string 7" }
application/xml, text/xml
<ResourceMetaData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <ResourceIdentifier>688ca023-149f-4472-a312-ee58d7047cb6</ResourceIdentifier> <Application>sample string 2</Application> <OriginalFilename>sample string 3</OriginalFilename> <SizeInBytes>1</SizeInBytes> <CreatedUtc>2024-05-19T00:51:44.5938138-04:00</CreatedUtc> <LastAccessedUtc>2024-05-19T00:51:44.5938138-04:00</LastAccessedUtc> <TimeToLiveAfterLastAccess /> <Tags> <KeyValuePairOfStringString /> <KeyValuePairOfStringString /> </Tags> <Md5HashBase64>sample string 6</Md5HashBase64> <Md5HashHexString>sample string 7</Md5HashHexString> </ResourceMetaData>