RightChain APIs

RightChain™ APIs | Copyright: RightChain Incorporated | All Rights Reserved

3.2 GET Method This endpoint method can retrieve a record, list the contents of a directory, or return a signed URL for downloading a file from the system. The record is identified using one of the previously listed methods. 3.2.1 Query Parameters Name Description contents (optional) If TRUE, returns the records contained within an identified directory. Returns an error if the identified object is of type “file”. If FALSE (default), returns only the record of the identified object.

recursive (optional)

Only applies when “contents” is TRUE. If TRUE, returns all records within the identified directory and all its children, computed recursively. If FALSE (default), returns only records within the identified directory. Ignored when “contents” is TRUE. If TRUE, returns a signed URL (10 minute expiration) for downloading an identified “file” from the storage system. Returns an error for an identified “directory”. If FALSE (default), returns only the record of the identified object. When included, narrows results to only objects with “record_type” of “file” or “directory”. Ignored otherwise.

download (optional)

record_type (optional)

3.2.2

Body Parameters

Name

Description

record_id

ID string of the record.

record_name record_path

User defined name of the record. The path string of the record. The “record_id” of the parent directory.

parent_id

5