Type Alias TempContentsAPI

type TempContentsAPI = {
    clearCache: typeof clearCache;
    downloadTempFile: typeof downloadTempFile;
    getTempFileDetails: typeof getTempFileDetails;
    uploadTempFile: typeof uploadTempFile;
}
Index

Properties

clearCache: typeof clearCache

Clears the cache for temp-contents api requests.

downloadTempFile: typeof downloadTempFile

This endpoint is used to retrieve a temporary content file. It returns a valid (200 OK) in case the file exists and the user is authorized to view the contents. It returns a 410 Gone if the file has expired and 404 Not Found if the criteria is not met.

The temporary contents ID.

an object with query parameters

DownloadTempFileHttpError

getTempFileDetails: typeof getTempFileDetails

Retrieve a summary of the metadata associated with a temporary content resource. It returns a 200 OK with a model if the temporary resource is valid. It returns a 410 Gone if the file has expired and 404 Not Found if the criteria is not met.

The temporary contents ID.

GetTempFileDetailsHttpError

uploadTempFile: typeof uploadTempFile

Upload a file as a temporary content resource. It returns a 201 Created with a location header that contains the location of the created resource. If filename or TTL is not properly set, a 400 Bad request is returned. For internal issues, a 500 Internal Server Error is returned.

an object with query parameters

an object with the body content

UploadTempFileHttpError