RightChain APIs

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

3.4 PUT Method This endpoint method can rename records, move records, or change controlling parameters such as “users”, “modify_access”, or “read_only”. The record is identified using one of the previously listed methods. Optional arguments are ignored when omitted. Methods for updating data within a file are currently under development and not available to users. RightChain recommends overwriting or creating a new file if data must be replaced.

3.4.1

Body Parameters

Name

Description

record_id

ID string of the record.

record_name record_path parent_id new_name (optional)

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

A new name for the record.

new_parent_id (optional) new_parent_path (optional)

The “record_id” of a new parent directory for this file.

The “record_path” of a new parent directory for this file.

read_only (optional) new_users (optional)

The “read_only” status of the file.

A new vector of user emails to replace the existing “users” value.

new_modify_access (optional)

A new vector of user emails to replace the existing “modify_access” value.

3.5 DELETE Method This endpoint method deletes the specified record. The record is identified using one of the previously listed methods. 3.5.1 Query Parameters Name Description delete_contents (optional) If TRUE, deletes the identified record and any children without warning. If FALSE (default), throws an error if the identified record has any children.

3.5.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

7