RightChain APIs

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

3.3 POST Method This endpoint method creates a new record. Either the “parent_id” or the “parent_path” are required to identify the parent directory. This method returns the created record object. For a file, the method also returns a signed URL for uploading the data directly if tabular data was not uploaded in the data object of the body. The default application for files loaded with this method is “Uploaded Data”.

3.3.1

Query Parameters

Name

Description

overwrite (optional)

If TRUE, overwrites any existing records with the same name in the parent directory without warning. If FALSE (default), throws an error if a record with the same name already exists in the parent directory.

3.3.2

Body Parameters

Name

Description

new_name record_type parent_id parent_path

User defined name for the record.

The type of the record: “directory” or “file”. The “record_id” of the parent directory. The “record_path” of the parent directory.

users (optional)

Only applies when “record_type” is “directory”. A vector of users with access to this directory. If omitted, it will inherit the value from the parent directory. Only applies when “record_type” is “directory”. A vector of users with permission to modify user access. If omitted, it will inherit the value from the parent directory. Only applies when “record_type” is “file”. If TRUE, users will not be able to overwrite or delete this file. If FALSE (default), users will be able to overwrite or delete this file. Only applies when “record_type” is “file”. Data in a tabular format to be written into a data file and uploaded to the cloud. When omitted, the API call will return a signed URL (10 minute expiration) for uploading a file to the cloud.

modify_access (optional)

read_only (optional)

data (optional)

6