POST api/resources/search

Searches for resources according to the arguments provided.

Request Information

URI Parameters

None.

Body Parameters

Arguments to restrict the list of resources by.

Name	Description	Type	Additional information
MaxResourcesToReturn	Max number of resources to return.	integer	None.
Filename	String for original filename to contain.	string	None.
MinFilesize	Smallest size of file to return in bytes.	integer	None.
MaxFilesize	Largest size of file to return in bytes.	integer	None.
Application	Application name (exact) to filter by.	string	None.
AccessedStartUtc	Earliest last accessed date to return.	date	None.
AccessedEndUtc	Latest last accessed date to return.	date	None.
CreatedStartUtc	Earliest created date to return.	date	None.
CreatedEndUtc	Latest created date to return.	date	None.
RequireAllTagsInListToMatch	Require all tags in tag list to match a particular resource before returning it. False will return a resource if at least 1 tag matches the resource. True, the tag values will have to be exact.	boolean	None.
TagList	List of tags to search for. Key is required and will have to match exactly. Value is optional and will match if the tag value contains the value.	Collection of Pair of string [key] and string [value]	None.
SearchForMultipartUploadResource	Should the search be for a MultipartUpload (true) or an active (false) resource.	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "MaxResourcesToReturn": 1,
  "Filename": "sample string 1",
  "MinFilesize": 1,
  "MaxFilesize": 1,
  "Application": "sample string 2",
  "AccessedStartUtc": "2024-12-25T09:21:46.8661024-05:00",
  "AccessedEndUtc": "2024-12-25T09:21:46.8661024-05:00",
  "CreatedStartUtc": "2024-12-25T09:21:46.8661024-05:00",
  "CreatedEndUtc": "2024-12-25T09:21:46.8661024-05:00",
  "RequireAllTagsInListToMatch": true,
  "TagList": [
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    },
    {
      "Key": "sample string 1",
      "Value": "sample string 2"
    }
  ],
  "SearchForMultipartUploadResource": true
}

application/xml, text/xml

Sample:

<ResourceListArgs xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <MaxResourcesToReturn>1</MaxResourcesToReturn>
  <Filename>sample string 1</Filename>
  <MinFilesize>1</MinFilesize>
  <MaxFilesize>1</MaxFilesize>
  <Application>sample string 2</Application>
  <AccessedStartUtc>2024-12-25T09:21:46.8661024-05:00</AccessedStartUtc>
  <AccessedEndUtc>2024-12-25T09:21:46.8661024-05:00</AccessedEndUtc>
  <CreatedStartUtc>2024-12-25T09:21:46.8661024-05:00</CreatedStartUtc>
  <CreatedEndUtc>2024-12-25T09:21:46.8661024-05:00</CreatedEndUtc>
  <RequireAllTagsInListToMatch>true</RequireAllTagsInListToMatch>
  <TagList>
    <KeyValuePairOfStringString />
    <KeyValuePairOfStringString />
  </TagList>
  <SearchForMultipartUploadResource>true</SearchForMultipartUploadResource>
</ResourceListArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An array of DTOs containing the metadata of the resources found.

Collection of ResourceMetaData

Name	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. 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": "226aa470-7970-49ec-a9be-90c31959babe",
    "Application": "sample string 2",
    "OriginalFilename": "sample string 3",
    "SizeInBytes": 1,
    "CreatedUtc": "2024-12-25T09:21:46.8758746-05:00",
    "LastAccessedUtc": "2024-12-25T09:21:46.8758746-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"
  },
  {
    "ResourceIdentifier": "226aa470-7970-49ec-a9be-90c31959babe",
    "Application": "sample string 2",
    "OriginalFilename": "sample string 3",
    "SizeInBytes": 1,
    "CreatedUtc": "2024-12-25T09:21:46.8758746-05:00",
    "LastAccessedUtc": "2024-12-25T09:21:46.8758746-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:

<ArrayOfResourceMetaData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ResourceMetaData>
    <ResourceIdentifier>226aa470-7970-49ec-a9be-90c31959babe</ResourceIdentifier>
    <Application>sample string 2</Application>
    <OriginalFilename>sample string 3</OriginalFilename>
    <SizeInBytes>1</SizeInBytes>
    <CreatedUtc>2024-12-25T09:21:46.8758746-05:00</CreatedUtc>
    <LastAccessedUtc>2024-12-25T09:21:46.8758746-05:00</LastAccessedUtc>
    <TimeToLiveAfterLastAccess />
    <Tags>
      <KeyValuePairOfStringString />
      <KeyValuePairOfStringString />
    </Tags>
    <Md5HashBase64>sample string 6</Md5HashBase64>
    <Md5HashHexString>sample string 7</Md5HashHexString>
  </ResourceMetaData>
  <ResourceMetaData>
    <ResourceIdentifier>226aa470-7970-49ec-a9be-90c31959babe</ResourceIdentifier>
    <Application>sample string 2</Application>
    <OriginalFilename>sample string 3</OriginalFilename>
    <SizeInBytes>1</SizeInBytes>
    <CreatedUtc>2024-12-25T09:21:46.8758746-05:00</CreatedUtc>
    <LastAccessedUtc>2024-12-25T09:21:46.8758746-05:00</LastAccessedUtc>
    <TimeToLiveAfterLastAccess />
    <Tags>
      <KeyValuePairOfStringString />
      <KeyValuePairOfStringString />
    </Tags>
    <Md5HashBase64>sample string 6</Md5HashBase64>
    <Md5HashHexString>sample string 7</Md5HashHexString>
  </ResourceMetaData>
</ArrayOfResourceMetaData>