Skip to content

Commit

Permalink
Added labs_included, excluded
Browse files Browse the repository at this point in the history
  • Loading branch information
TheMadBug committed Jun 17, 2019
1 parent d59754c commit 08d09f9
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/integration/api/classification_bulk.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Parameters
|level|editable|Will return records the current user has write access to and will be the latest version of those records including unshared changes.|
|level|public|Will only return records that have been published to be shared with 3rd party labs|
|level|loggd_in_users|Will only return records that have been published to be shared within Shariant|
|labs_include|comma sep list of lab ids|Only records associated to these labs will be included|
|labs_excluded|comma sep list of lab ids|Records associated with these labs will be excluded|
|output|json|(Default) Output will be an JSON object with a key "records' containing all the relevant records.|
|output|csv|Output will be a CSV file.|
|output|redcap|Output will be a CSV file structured for REDCap. Note that only records with a value in redcap_record_id will be included.|
Expand All @@ -31,4 +33,4 @@ Parameters
|group_by|none|Places each of the variant classification in a separate zip entry the entries named by lab identifier / lab record id|
|group_by|variant|Creates one zip entry per variant, the entry will have Shariant's internal ID|
|limit|_number_|Limits the number of rows returned. Warning, if grouping will limit the number of records randomly across different groups, so should be avoided in such a case|
|after|_unix timestamp_|If after has a value, only records that were last shared after will be returned. Be careful that this refers to the time the record was published, NOT the date of the last modification|
|after|_unix timestamp_|If after has a value, only records that were last shared after will be returned. Be careful that this refers to the time the record was published, NOT the date of the last modification|

0 comments on commit 08d09f9

Please sign in to comment.