POST api/resources/ttlupdate

Sets a TimeToLive action on a pre-existing resource. It just ADDS an action, it does NOT remove previous actions.

Request Information

URI Parameters

None.

Body Parameters

Arguments describing which resource to modify and the TTL settings.

ResourceTimeToLiveUpdateArgs
NameDescriptionTypeAdditional information
ResourceIdentifier

The identifier for the resource

globally unique identifier

None.

StartCheckingTimeToLiveAtUtc

The date on which to start checking TTL.

date

None.

TimeToLiveAfterLastAccess

Timespan to set. Null, negative values, or 0 will cause an immediate deletion on ResourceExpiresOnUtc with no further checks.

time interval

None.

Request Formats

application/json, text/json

Sample:
{
  "ResourceIdentifier": "99019a32-4fc9-4690-a365-3e23bbce01e1",
  "StartCheckingTimeToLiveAtUtc": "2024-12-25T09:06:51.3569939-05:00",
  "TimeToLiveAfterLastAccess": "00:00:00.1234567"
}

application/xml, text/xml

Sample:
<ResourceTimeToLiveUpdateArgs xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ResourceIdentifier>99019a32-4fc9-4690-a365-3e23bbce01e1</ResourceIdentifier>
  <StartCheckingTimeToLiveAtUtc>2024-12-25T09:06:51.3569939-05:00</StartCheckingTimeToLiveAtUtc>
  <TimeToLiveAfterLastAccess />
</ResourceTimeToLiveUpdateArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A structure describing the resource.

ResourceMetaData
NameDescriptionTypeAdditional 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.
If the resource was a string:
"The quick brown fox jumps over the lazy dog" = nhB9nTcrtoJr2B01QqQZ1g==
"The quick brown fox jumps over the lazy dog." = 5NkJwpDQ+xygaP+t3yLL0A==
"" = 1B2M2Y8AsgTpgAmY7PhCfg==

string

None.

Md5HashHexString

Md5Hash of the resource as a hex string.
If the resource was a string:
"The quick brown fox jumps over the lazy dog" = 9e107d9d372bb6826bd81d3542a419d6
"The quick brown fox jumps over the lazy dog." = e4d909c290d0fb1ca068ffaddf22cbd0
"" = d41d8cd98f00b204e9800998ecf8427e

string

None.

Response Formats

application/json, text/json

Sample:
{
  "ResourceIdentifier": "05f0bd26-c51c-47c0-881e-c748790cfeb7",
  "Application": "sample string 2",
  "OriginalFilename": "sample string 3",
  "SizeInBytes": 1,
  "CreatedUtc": "2024-12-25T09:06:51.5220041-05:00",
  "LastAccessedUtc": "2024-12-25T09:06:51.5220041-05: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

Sample:
<ResourceMetaData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ResourceIdentifier>05f0bd26-c51c-47c0-881e-c748790cfeb7</ResourceIdentifier>
  <Application>sample string 2</Application>
  <OriginalFilename>sample string 3</OriginalFilename>
  <SizeInBytes>1</SizeInBytes>
  <CreatedUtc>2024-12-25T09:06:51.5220041-05:00</CreatedUtc>
  <LastAccessedUtc>2024-12-25T09:06:51.5220041-05:00</LastAccessedUtc>
  <TimeToLiveAfterLastAccess />
  <Tags>
    <KeyValuePairOfStringString />
    <KeyValuePairOfStringString />
  </Tags>
  <Md5HashBase64>sample string 6</Md5HashBase64>
  <Md5HashHexString>sample string 7</Md5HashHexString>
</ResourceMetaData>