reject_submission: Reject a submission

Description Usage Arguments Details Value

View source: R/accept-reject-submission.R

Description

Reject a submission and give a reason. This sets the submission status 'state' to 'REJECTED', and updates the review elements, 'reviewedOn', 'reviewedBy', and 'rejectionMessage'.' Note: this function will throw an error if the REST call to Synapse fails; this could happen if the user does not have needed permissions, or the 'form_data_id' specified does not exist.

Usage

1
reject_submission(syn, form_data_id, reason)

Arguments

syn

Synapse login object

form_data_id

The formDataId of the submission.

reason

The reason for the rejection as a string; limited to 500 characters.

Details

WARNING: Once a submission is rejected, the state can not be changed again.

See Synapse REST API. # nolint

Value

The response from the rejection call as a list containing the submission metadata.


Sage-Bionetworks/synapseforms documentation built on June 16, 2020, 8:35 a.m.