redcap_next_free_record_name {REDCapR} | R Documentation |
Determine free available record ID
Description
Determines the next available record ID.
Usage
redcap_next_free_record_name(
redcap_uri,
token,
verbose = TRUE,
config_options = NULL
)
Arguments
redcap_uri |
The URI (uniform resource identifier) of the REDCap project. Required. |
token |
The user-specific string that serves as the password for a project. Required. |
verbose |
A boolean value indicating if |
config_options |
A list of options to pass to |
Details
If the API call is unsuccessful, a value of character(0)
will
be returned (i.e., an empty vector). This ensures that a the function
will always return an object of class
base::character.
Value
a base::character vector of either length 1 (if successful) or length 0 (if not successful).
Note
Documentation in REDCap 8.4.0
To be used by projects with record auto-numbering enabled, this method exports the next potential record ID for a project. It generates the next record name by determining the current maximum numerical record ID and then incrementing it by one.
Note: This method does not create a new record, but merely determines what the next record name would be. If using Data Access Groups (DAGs) in the project, this method accounts for the special formatting of the record name for users in DAGs (e.g., DAG-ID); in this case, it only assigns the next value for ID for all numbers inside a DAG. For example, if a DAG has a corresponding DAG number of 223 wherein records 223-1 and 223-2 already exist, then the next record will be 223-3 if the API user belongs to the DAG that has DAG number 223. (The DAG number is auto-assigned by REDCap for each DAG when the DAG is first created.) When generating a new record name in a DAG, the method considers all records in the entire project when determining the maximum record ID, including those that might have been originally created in that DAG but then later reassigned to another DAG. Note: This method functions the same even for projects that do not have record auto-numbering enabled.
Examples
uri <- "https://bbmc.ouhsc.edu/redcap/api/"
token <- "9A81268476645C4E5F03428B8AC3AA7B"
# Returns 6
REDCapR::redcap_next_free_record_name(redcap_uri = uri, token = token)