RightChain APIs

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

3 directory Endpoint This endpoint provides methods for creating (POST), retrieving (GET), updating (PUT), and deleting (DELETE) directories and files within the RightChain.ai infrastructure. Most of the functionality of the API is also provided within the GUI; however, the API calls act with admin rights by default. 3.1 Record Object Each record returned by the calls to the API has the following parameters: Name Description record_id ID string of the record. record_name User defined name of the record. record_path The path string of the record. record_type The type of the record: “directory” or “file”. record_desc If “record_type” is “directory”: Specifies who created the record: “API”, “RightChain” or a user email. last_modified_by Only applies when “record_type” is “file”. Specifies who last modified the file. modified_time Only applies when “record_type” is “file”. Timestamp of when the file was last modified. read_only Only applies when “record_type” is “file”. If TRUE, only the “last_modified_by” user, an admin, or the API can overwrite or delete the file. If FALSE, any user with access can overwrite or delete the file. users Only applies when “record_type” is “directory”. A vector of users with access to the directory within the GUI. modify_access Only applies when “record_type” is “directory”. A vector of users with permission to modify access to the directory. • “individual”: Only the user associated with the directory has access. • “shared”: Users listed within “users” have access to this directory. If “record_type” is “file”: • A descriptor of the file type or RightChain application. parent_id created_by The “record_id” of the parent directory. There are three ways to identify a record within a call to an endpoint, and all calls must contain one of the following parameters as named values within the body of the request: 1) “record_id”, 2)”record_path”, or 3)”record_name” and “parent_id”. Parent directories can be identified by either their “record_id” (“parent_id”) or “record_path” (“parent_path”) within most calls. An error will be thrown if a record cannot be identified by the given parameters.

4