ABC Resource Storage API

Summary

This API provides the ability for third party developers to manage documents without having to worry about where the files are actually stored.

Disclaimer

The information contained in this document pertains to the ABC Storage API. Use of this document, the contained information, and the API are restricted to authorized developers officially requested by ABC Imaging to interface with their system. Individual developers may or may not have access to all functionality of the API.

Communicating with the API

The API will understand requests in JSON or XML as specified by the “Content-Type” header setting. Likewise, it will return responses in either JSON or XML as dictated by the “Accept” header setting.

The API requires that each request contain the “ApiAuthentication” header with the value provided by the administrators.

Accounts

Resource for credential verification

API	Description
GET api/accounts/validate	Validates that the credentials provided have access to the system.

Resources

Resource for dealing with resources stored in the storage system.

API	Description
GET api/resources/{identifier}	Retrieves the bytes for a specific resource stored in the storage system.
GET api/resources/{identifier}/metadata	Retrieves the metadata for a specific resource stored in the storage system.
POST api/resources/search	Searches for resources according to the arguments provided.
DELETE api/resources/{identifier}	Deletes a specific resource stored in the storage system. This process cannot be reversed.
PUT api/resources	Adds a new resource to the repository. All bytes of the resource is expected to be in the request. ~50MB max resource size.
POST api/resources/copyresource	Adds a new resource to the repository. All bytes of the resource is expected to be in the request. ~50MB max resource size.
POST api/resources/multipart/initialize	Initializes a multipart upload to the repository. Uploads must be completed before the resource is available for use, or aborted if it is no longer needed.
POST api/resources/multipart/abort/{identifier}	Aborts a multipart upload that was started with <see cref="M:AbcStorage.Web.Api.Controllers.ResourcesController.InitiateNewMultipartResource(AbcStorage.Dto.Resources.InitiateNewMultipartResourceArgs)" />.
POST api/resources/multipart/upload	Uploads a portion of a resource to the repository. Part should be between 5MB and ~50MB.
POST api/resources/multipart/listparts/{identifier}	Returns basic information about which parts of a multipart resource upload has been uploaded.
POST api/resources/multipart/complete/{identifier}	Completes a multipart upload and make a resource available for usage.
POST api/resources/tagupdate	Replaces that tags associated with a resource.
POST api/resources/rename	Changes the original filename of a resource.
POST api/resources/ttlupdate	Sets a TimeToLive action on a pre-existing resource. It just ADDS an action, it does NOT remove previous actions.