{ "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/labguru-schemas.json", "title": "Labguru API Schemas", "description": "JSON Schema definitions for the Labguru REST API", "definitions": { "createSession": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createSession.json", "title": "createSession", "type": "object", "required": [ "login", "password" ], "properties": { "login": { "type": "string", "description": "E-mail", "example": "labuser@email.com" }, "password": { "type": "string", "description": "password" }, "account_id": { "type": "integer", "description": "(optional) The account id to generate the token for" } } }, "createAttachment": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createAttachment.json", "title": "createAttachment", "type": "object", "properties": { "token": { "type": "string" }, "item[attachment]": { "type": "string", "format": "binary", "description": "The file that will be uploaded." }, "item[title]": { "type": "string", "example": "Project_report.pdf", "description": "The title of the attachment. This should match the file name exactly, including the file extension (.xlsx, .csv, etc.)." }, "item[attach_to_uuid]": { "type": "string", "description": "The UUID of the object to which the attachment will be linked.
\n If this parameter is not provided, the uploaded file will be stored but not associated with any specific entity (unattached file)." }, "item[description]": { "type": "string", "example": "Detailed project report", "description": "A brief description of the attachment content." } }, "required": [ "token", "item[attachment]", "item[title]" ] }, "updateAttachment": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateAttachment.json", "title": "updateAttachment", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "element_id" ], "properties": { "element_id": { "type": "integer", "description": "The ID of the attachment element to which the attachment will be linked" } } } } }, "WormBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/WormBaseRequest.json", "title": "WormBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the worm" }, "alternative_name": { "type": "string", "description": "An alternative name for the worm" }, "gene_id": { "type": "integer", "description": "An ID reference to a gene from your labguru genes collection" }, "source": { "type": "string", "description": "Origin of the worm" }, "genotype": { "type": "string", "description": "Genetic constitution of the worm" }, "phenotype": { "type": "string", "description": "Observable physical or biochemical characteristics of the worm" }, "mutagen": { "type": "string", "description": "The agent used to induce mutations in the worm" }, "growth_conditions": { "type": "string", "description": "Specific conditions under which the worm is maintained" }, "outcrossed": { "type": "integer", "description": "Number of times the worm strain has been outcrossed with another" }, "made_by": { "type": "string", "description": "researcher name input" }, "dauer_defective": { "type": "boolean", "description": "Indicates whether the worm is defective in entering or exiting the dauer stage,\n with '1' for yes and '0' for no.", "example": 0 }, "description": { "type": "string", "description": "Description of the worm" } } } } }, "createWorm": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createWorm.json", "title": "createWorm", "allOf": [ { "$ref": "#/components/schemas/WormBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateWorm": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateWorm.json", "title": "updateWorm", "allOf": [ { "$ref": "#/components/schemas/WormBaseRequest" } ] }, "AntibodyBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/AntibodyBaseRequest.json", "title": "AntibodyBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "title": { "type": "string", "description": "The name of the antibody" }, "owner_id": { "type": "integer", "description": "The ID of the owner - by default it's your member id" }, "alternative_name": { "type": "string", "description": "An additional name for the antibody" }, "antigene": { "type": "string", "description": "Antigen / immunogen" }, "tags_fluorophores": { "type": "string", "description": "Tags / fluorophores" }, "clone_field": { "type": "string", "description": "The clone from which the antibody was derived." }, "isotype": { "type": "string", "description": "The class or type of the antibody (e.g., IgG, IgM)." }, "preparation_date": { "type": "string", "format": "date", "description": "The date on which the antibody was prepared, formatted as YYYY-MM-DD.", "example": "yyyy-mm-dd" }, "source": { "type": "string", "description": "The origin or source from which the antibody was obtained." }, "immune": { "type": "integer", "description": "Indicates the antibody's clonality: \"Monoclonal\" (immune = 1), \"Polyclonal\" (immune = 0), or \"None\" (Empty value).", "example": 1 }, "organism_id": { "type": "integer", "description": "The ID for the organism in which the antibody was raised. This ID corresponds to specific organisms (e.g., 5 for Mouse, 6 for Chicken, etc.)." }, "reacts_with": { "type": "string", "description": "Specifies the organism or group the antibody is reactive with, chosen from a predefined list of options such as \"Mouse\", \"Human\", \"Chicken\", and \"Zebrafish\", etc.", "example": "Mouse" }, "description": { "type": "string", "description": "A detailed description of the antibody" } } } } }, "createAntibody": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createAntibody.json", "title": "createAntibody", "allOf": [ { "$ref": "#/components/schemas/AntibodyBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "title" ] } } } ] }, "updateAntibody": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateAntibody.json", "title": "updateAntibody", "allOf": [ { "$ref": "#/components/schemas/AntibodyBaseRequest" } ] }, "ExperimentBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/ExperimentBaseRequest.json", "title": "ExperimentBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "title": { "type": "string", "description": "The experiment title" }, "project_id": { "type": "integer", "description": "The project id" }, "milestone_id": { "type": "integer", "description": "You can also provide a milestone_name(string) instead of milestone_id(integer)" }, "protocol_id": { "type": "integer", "description": "Start experiment from protocol by providing the protocol id " } } } } }, "addExperiment": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/addExperiment.json", "title": "addExperiment", "allOf": [ { "$ref": "#/components/schemas/ExperimentBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "title", "project_id", "milestone_id" ] } } } ] }, "updateExperiment": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateExperiment.json", "title": "updateExperiment", "allOf": [ { "$ref": "#/components/schemas/ExperimentBaseRequest" } ] }, "PlasmidBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/PlasmidBaseRequest.json", "title": "PlasmidBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "title": { "type": "string", "description": "The name of the plasmid" }, "alternative_name": { "type": "string", "description": "Any alternative name by which the plasmid may be known" }, "owner_id": { "type": "integer", "description": "id of the owner - by default it's your member id" }, "length": { "type": "integer", "description": "The total number of base pairs (bp) in the plasmid\u2019s DNA sequence." }, "usage": { "type": "string", "description": "Intended or common uses of the plasmid (cloning, gene expression, etc.)" }, "host": { "type": "string", "description": "Typical host organism for the plasmid" }, "resistance": { "type": "string", "description": "Antibiotic resistance markers present in the plasmid" }, "clone_number": { "type": "string", "description": "Unique identifier or clone number associated with the plasmid" }, "source": { "type": "string", "description": "Origin or provider of the plasmid" }, "sequence": { "type": "string", "description": "The nucleotide sequence of the plasmid" }, "description": { "type": "string", "description": "A detailed description of the plasmid" } } } } }, "createPlasmid": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createPlasmid.json", "title": "createPlasmid", "allOf": [ { "$ref": "#/components/schemas/PlasmidBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "title" ] } } } ] }, "updatePlasmid": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updatePlasmid.json", "title": "updatePlasmid", "allOf": [ { "$ref": "#/components/schemas/PlasmidBaseRequest" } ] }, "SOPBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/SOPBaseRequest.json", "title": "SOPBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "title": { "type": "string", "description": "The name of the SOP" } } } } }, "createSOP": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createSOP.json", "title": "createSOP", "allOf": [ { "$ref": "#/components/schemas/SOPBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "title" ] } } } ] }, "updateSOP": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateSOP.json", "title": "updateSOP", "allOf": [ { "$ref": "#/components/schemas/SOPBaseRequest" } ] }, "createComment": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createComment.json", "title": "createComment", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "comment", "commentable_id", "commentable_type" ], "properties": { "comment": { "type": "string", "description": "The text content of the comment" }, "commentable_id": { "type": "integer", "description": "The id of the item to which the comment is being added" }, "commentable_type": { "type": "string", "description": "Specifies the class name of the item to which the comment is attached, such as Biocollections::Plasmid" } } } } }, "LinkBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/LinkBaseRequest.json", "title": "LinkBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "source_id": { "type": "integer", "description": "The ID of the source item" }, "source_type": { "type": "string", "description": "Specifies the class name of the source item, such as Biocollections::Plasmid" }, "target_id": { "type": "integer", "description": "The ID of the target item" }, "target_type": { "type": "string", "description": "Specifies the class name of the target item, such as Biocollections::Antibody" }, "source_uuid": { "type": "string", "description": "The UUID of the source item" }, "target_uuid": { "type": "string", "description": "The UUID of the target item" } } } } }, "createLink": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createLink.json", "title": "createLink", "allOf": [ { "$ref": "#/components/schemas/LinkBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "source_id", "source_type", "target_id", "target_type", "source_uuid", "target_uuid" ] } } } ] }, "updateLink": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateLink.json", "title": "updateLink", "allOf": [ { "$ref": "#/components/schemas/LinkBaseRequest" } ] }, "CompoundBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/CompoundBaseRequest.json", "title": "CompoundBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "smiles": { "type": "string", "example": "C(=O)N1CCC(CCCC(=O)c2ccc(Cl)n(Cc3ncc(o3)-c3ccc(Cl)cc3)c2=O)CC1" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the compound" }, "description": { "type": "string", "description": "Updated description of the compound" }, "structure": { "type": "string", "description": "Compound structure", "example": "C(=O)N1CCC(CCCC(=O)c2ccc(Cl)n(Cc3ncc(o3)-c3ccc(Cl)cc3)c2=O)CC1" }, "cas": { "type": "string", "description": "Compound CAS" }, "formula": { "type": "string", "description": "Compound formula" }, "molar_mass": { "type": "string", "description": "Compound molar mass" }, "density": { "type": "string", "description": "Compound density" }, "boiling_point": { "type": "string", "description": "Compound boiling point" }, "melting_point": { "type": "string", "description": "Compound melting point" }, "hazards": { "type": "string", "description": "Compound hazards" } } } } }, "createCompound": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createCompound.json", "title": "createCompound", "allOf": [ { "$ref": "#/components/schemas/CompoundBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateCompound": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateCompound.json", "title": "updateCompound", "allOf": [ { "$ref": "#/components/schemas/CompoundBaseRequest" } ] }, "TaskBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/TaskBaseRequest.json", "title": "TaskBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "The name of the Task" }, "start_date": { "type": "string", "format": "date", "description": "Start Date (yyyy-mm-dd)" }, "assigned_to": { "type": "integer", "description": "id of assigner" }, "description": { "type": "string", "description": "Description of the task" }, "owner_id": { "type": "integer", "description": "id of the owner - by default it's your member id" }, "notify_at": { "type": "string", "format": "date", "description": "notification date & time (yyyy-mm-dd)" } } } } }, "createTask": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createTask.json", "title": "createTask", "allOf": [ { "$ref": "#/components/schemas/TaskBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateTask": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateTask.json", "title": "updateTask", "allOf": [ { "$ref": "#/components/schemas/TaskBaseRequest" } ] }, "RodentCageBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/RodentCageBaseRequest.json", "title": "RodentCageBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the Rodent cage" }, "breeding": { "type": "boolean", "description": "Breeding - by default it's true" }, "parent_id": { "type": "integer", "description": "The ID of the storage location" }, "description": { "type": "string", "description": "Detailed cage information" }, "owner_id": { "type": "integer", "description": "id of the owner - by default it's your member id" } } } } }, "createRodentCage": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createRodentCage.json", "title": "createRodentCage", "allOf": [ { "$ref": "#/components/schemas/RodentCageBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateRodentCage": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateRodentCage.json", "title": "updateRodentCage", "allOf": [ { "$ref": "#/components/schemas/RodentCageBaseRequest" } ] }, "GeneBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/GeneBaseRequest.json", "title": "GeneBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "title": { "type": "string", "description": "The name of the gene" }, "alternative_name": { "type": "string", "description": "Alternative gene name." }, "expression_location": { "type": "string", "description": "Location of gene expression." }, "pathway": { "type": "string", "description": "Involved metabolic pathway." }, "sequence": { "type": "string", "description": "Gene sequence.", "example": "ACTGACGACATGGTTCTGACCTGA" }, "owner_id": { "type": "integer", "description": "id of the owner - by default it's your member id" }, "source": { "type": "string", "description": "The origin or source from which the gene was obtained." }, "description": { "type": "string", "description": "Detailed gene information." } } } } }, "createGene": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createGene.json", "title": "createGene", "allOf": [ { "$ref": "#/components/schemas/GeneBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "title" ] } } } ] }, "updateGene": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateGene.json", "title": "updateGene", "allOf": [ { "$ref": "#/components/schemas/GeneBaseRequest" } ] }, "VirusBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/VirusBaseRequest.json", "title": "VirusBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the virus" }, "alternative_name": { "type": "string", "description": "alternative name for the virus" }, "gene_insert": { "type": "string", "description": "Specific gene or genetic insert present in the virus" }, "virus_type": { "type": "string", "description": "The virus type" }, "plasmid": { "type": "string", "description": "The plasmid that is used in the creation or manipulation of the virus" }, "serotype_strain": { "type": "string", "description": "serotype or strain of the virus" }, "mutations_deletions": { "type": "string", "description": "genetic mutations or deletions within the virus details" }, "tag": { "type": "string", "description": "Tag" }, "selectable_marker": { "type": "string", "description": "Selectable marker" }, "producer_cell_type": { "type": "string", "description": "Producer cell type" }, "viral_coat": { "type": "string", "description": "Viral coat" }, "tropism": { "type": "string", "description": "Tropism" }, "species": { "type": "string", "description": "The species from which the virus was isolated or generated" }, "safety_information": { "type": "string", "description": "safety information details" }, "storage_conditions": { "type": "string", "description": "Conditions under which the virus should be stored" }, "owner_id": { "type": "integer", "description": "id of the owner - by default it's your member id" }, "source": { "type": "string", "description": "The origin of the virus" }, "description": { "type": "string", "description": "Description of the virus" } } } } }, "createVirus": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createVirus.json", "title": "createVirus", "allOf": [ { "$ref": "#/components/schemas/VirusBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateVirus": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateVirus.json", "title": "updateVirus", "allOf": [ { "$ref": "#/components/schemas/VirusBaseRequest" } ] }, "LipidBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/LipidBaseRequest.json", "title": "LipidBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the lipid" }, "owner_id": { "type": "integer", "description": "ID of the owner (default: your member id)" }, "alternative_name": { "type": "string", "description": "Any alternative name by which the lipid may be known" }, "molecular_formula": { "type": "string", "description": "The molecular formula of the lipid" }, "molecular_weight": { "type": "string", "description": "Molecular weight of the lipid" }, "cas_number": { "type": "string", "description": "The Chemical Abstracts Service number" }, "stock_solution_prep": { "type": "string", "description": "Media/solution" }, "solubility": { "type": "string", "description": "Solubility information" }, "conditions_for_use": { "type": "string", "description": "Recommended conditions under which the lipid should be used" }, "conditions_for_storage": { "type": "string", "description": "Guidelines for proper storage of the lipid" }, "safety_information": { "type": "string", "description": "Safety guidelines and hazard information related to the lipid" }, "impurities": { "type": "string", "description": "Details of known impurities found in the lipid sample" }, "source": { "type": "string", "description": "The origin of the lipid" }, "description": { "type": "string", "description": "Detailed description of the lipid" } } } } }, "createLipid": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createLipid.json", "title": "createLipid", "allOf": [ { "$ref": "#/components/schemas/LipidBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateLipid": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateLipid.json", "title": "updateLipid", "allOf": [ { "$ref": "#/components/schemas/LipidBaseRequest" } ] }, "YeastBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/YeastBaseRequest.json", "title": "YeastBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the yeast" }, "description": { "type": "string", "description": "Description of the yeast" }, "reproduction": { "type": "string", "description": "Details of the mode of reproduction for the yeast" }, "genetic_background": { "type": "string", "description": "yeast's genetic lineage or background" }, "transgenic_features": { "type": "string", "description": "Transgenic Features" }, "phenotype": { "type": "string", "description": "Observable characteristics of the yeast" }, "source": { "type": "string", "description": "Origin of the yeast strain" }, "owner_id": { "type": "integer", "description": "id of the owner - if omitted, will default to your member id" } } } } }, "createYeast": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createYeast.json", "title": "createYeast", "allOf": [ { "$ref": "#/components/schemas/YeastBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateYeast": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateYeast.json", "title": "updateYeast", "allOf": [ { "$ref": "#/components/schemas/YeastBaseRequest" } ] }, "ProjectBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/ProjectBaseRequest.json", "title": "ProjectBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "title": { "type": "string", "description": "The name of the project" }, "description": { "type": "string", "description": "Description of the project" }, "start_date": { "type": "string", "format": "date", "description": "Start Date (yyyy-mm-dd)" }, "closed": { "type": "boolean", "description": "Archived/Active project flag" }, "status": { "type": "string", "description": "Status" }, "owner_id": { "type": "integer", "description": "ID of the owner (default: your member id)" } } } } }, "createProject": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createProject.json", "title": "createProject", "allOf": [ { "$ref": "#/components/schemas/ProjectBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "title" ] } } } ] }, "updateProject": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateProject.json", "title": "updateProject", "allOf": [ { "$ref": "#/components/schemas/ProjectBaseRequest" } ] }, "BacteriumBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/BacteriumBaseRequest.json", "title": "BacteriumBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the bacterium" }, "sensitivity": { "type": "string", "description": "Details the bacterium\u2019s sensitivity to antibiotics or other agents." }, "strain": { "type": "string", "description": "The specific strain of the bacterium" }, "source": { "type": "string", "description": "The origin or isolation source of the bacterium (e.g., environmental, clinical)." }, "owner_id": { "type": "integer", "description": "The ID of the owner - by default it's your member id" }, "description": { "type": "string", "description": "A detailed description of the bacterium" } } } } }, "createBacterium": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createBacterium.json", "title": "createBacterium", "allOf": [ { "$ref": "#/components/schemas/BacteriumBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateBacterium": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateBacterium.json", "title": "updateBacterium", "allOf": [ { "$ref": "#/components/schemas/BacteriumBaseRequest" } ] }, "PrimerBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/PrimerBaseRequest.json", "title": "PrimerBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "title": { "type": "string", "description": "The name of the primer" }, "alternative_name": { "type": "string", "description": "Any alternative name by which the primer may be known" }, "owner_id": { "type": "integer", "description": "id of the owner - if omitted, will default to your member id" }, "sequence": { "type": "string", "description": "The nucleotide sequence of the primer" }, "tag": { "type": "string", "description": "A unique label or tag associated with the primer" }, "gene_id": { "type": "integer", "nullable": true, "description": "A reference ID linking the primer to a specific gene in your lab" }, "tm": { "type": "string", "description": "The melting temperature (Tm) of the primer", "example": 3 }, "orientation": { "type": "string", "description": "Indicates the orientation of the primer. Set \"1\" for forward and \"0\" for reverse. This field is optional and can be left null if orientation is not applicable", "nullable": true, "example": "1" }, "target_position": { "type": "string", "description": "The specific binding position of the primer on the target DNA" }, "fragment_size": { "type": "string", "description": "The size of the DNA fragment that the primer is designed to amplify" }, "organism": { "type": "string", "description": "The specific organism for which the primer is designed, such as \"Mouse\"" }, "used_for": { "type": "string", "description": "The specific applications for which the primer is used (pcr / RT / SDM / etc.)" }, "restriction_site": { "type": "string", "description": "Information about any restriction enzyme recognition sites incorporated into the primer design" }, "source": { "type": "string", "description": "The origin or source from which the primer was obtained" }, "description": { "type": "string", "description": "A detailed description of the primer" } } } } }, "createPrimer": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createPrimer.json", "title": "createPrimer", "allOf": [ { "$ref": "#/components/schemas/PrimerBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "title" ] } } } ] }, "updatePrimer": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updatePrimer.json", "title": "updatePrimer", "allOf": [ { "$ref": "#/components/schemas/PrimerBaseRequest" } ] }, "SeedBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/SeedBaseRequest.json", "title": "SeedBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the seed" }, "owner_id": { "type": "integer", "description": "id of the owner - if omitted, will default to your member id" }, "genotype": { "type": "string", "description": "Genetic makeup of the seed" }, "phenotype": { "type": "string", "description": "Observable physical or biochemical characteristics of the seed" }, "generation": { "type": "string", "description": "Generational stage of the seed", "example": "F0" }, "male_parent_id": { "type": "integer", "description": "The ID of the male parent plant from your Labguru plants collection, if applicable." }, "female_parent_id": { "type": "integer", "description": "The ID of the female parent plant from your Labguru plants collection, if applicable." }, "source": { "type": "string", "description": "Origin of the seed" }, "description": { "type": "string", "description": "Description of the seed" } } } } }, "createSeed": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createSeed.json", "title": "createSeed", "allOf": [ { "$ref": "#/components/schemas/SeedBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateSeed": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateSeed.json", "title": "updateSeed", "allOf": [ { "$ref": "#/components/schemas/SeedBaseRequest" } ] }, "CellLineBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/CellLineBaseRequest.json", "title": "CellLineBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the cell line" }, "owner_id": { "type": "integer", "description": "The ID of the owner - by default it's your member id" }, "organism": { "type": "string", "description": "The organism from which the cells were originated" }, "tissue": { "type": "string", "description": "The tissue from which the cells were extracted" }, "medium_and_serum": { "type": "string", "description": "A supplement used for cultivating cells" }, "source": { "type": "string", "description": "The location or environment from which the cells were originated" }, "description": { "type": "string", "description": "A detailed description of the cell line" } } } } }, "createCellLine": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createCellLine.json", "title": "createCellLine", "allOf": [ { "$ref": "#/components/schemas/CellLineBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateCellLine": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateCellLine.json", "title": "updateCellLine", "allOf": [ { "$ref": "#/components/schemas/CellLineBaseRequest" } ] }, "ProteinBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/ProteinBaseRequest.json", "title": "ProteinBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the protein" }, "owner_id": { "type": "integer", "description": "ID of the owner - if omitted, will default to your id" }, "alternative_name": { "type": "string", "description": "An additional name for the protein" }, "gene": { "type": "string", "description": " The gene from which the protein is derived" }, "species": { "type": "string", "description": "The species from which the protein originates" }, "lg_mutations": { "type": "string", "description": "List of mutations in the protein structure" }, "chemical_modifications": { "type": "string", "description": "Details any chemical modifications the protein has undergone" }, "tag": { "type": "string", "description": "A label or tag attached to the protein" }, "purification_method": { "type": "string", "description": "The method used to purify the protein from other biological components" }, "mw": { "type": "string", "description": "The molecular weight of the protein" }, "extinction_coefficient_280nm": { "type": "string", "description": "The extinction coefficient at 280 nm" }, "storage_buffer": { "type": "string", "description": "The buffer solution in which the protein is stored" }, "storage_temperature": { "type": "string", "description": "The temperature in which the protein is stored" }, "source": { "type": "string", "description": "The protein source" }, "sequence": { "type": "string", "description": "The amino acid sequence of the protein" }, "description": { "type": "string", "description": "A detailed description of the protein" } } } } }, "createProtein": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createProtein.json", "title": "createProtein", "allOf": [ { "$ref": "#/components/schemas/ProteinBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateProtein": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateProtein.json", "title": "updateProtein", "allOf": [ { "$ref": "#/components/schemas/ProteinBaseRequest" } ] }, "PlantBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/PlantBaseRequest.json", "title": "PlantBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The botanical name of the plant." }, "owner_id": { "type": "integer", "description": "ID of the owner - if omitted, will default to your id" }, "phenotype": { "type": "string", "description": "Observable physical or biochemical characteristics of the plant" }, "genotype": { "type": "string", "description": "The genetic makeup of the plant" }, "generation": { "type": "string", "description": "Generation of the plant" }, "harvest_date": { "type": "string", "format": "date", "description": "The date when the plant was harvested, formatted as YYYY-MM-DD", "example": "2021-03-11" }, "source": { "type": "string", "description": "The origin of the plant" }, "description": { "type": "string", "description": "Description of the plant" } } } } }, "createPlant": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createPlant.json", "title": "createPlant", "allOf": [ { "$ref": "#/components/schemas/PlantBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updatePlant": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updatePlant.json", "title": "updatePlant", "allOf": [ { "$ref": "#/components/schemas/PlantBaseRequest" } ] }, "FlyBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/FlyBaseRequest.json", "title": "FlyBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the fly" }, "owner_id": { "type": "integer", "description": "id of the owner - by default it's your member id" }, "source": { "type": "string", "description": "Origin of the fly." }, "genotype": { "type": "string", "description": "Genetic makeup." }, "phenotype": { "type": "string", "description": "Observable characteristics." }, "breakpoints_insertions": { "type": "string", "description": "Genetic insertion points." }, "ch_number": { "type": "string", "description": "Chromosome number." }, "ch_te": { "type": "string", "description": "Transposable element in chromosome." }, "description": { "type": "string", "description": "Description of the fly" } } } } }, "createFly": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createFly.json", "title": "createFly", "allOf": [ { "$ref": "#/components/schemas/FlyBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateFly": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateFly.json", "title": "updateFly", "allOf": [ { "$ref": "#/components/schemas/FlyBaseRequest" } ] }, "SequenceBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/SequenceBaseRequest.json", "title": "SequenceBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "title": { "type": "string", "description": "The name of the sequence" }, "owner_id": { "type": "integer", "description": "id of the owner - by default it's your member id" }, "seq": { "type": "string", "description": "The actual sequence data in characters" }, "kind": { "type": "integer", "description": "sequence type: DNA = 1, CDNA = 2, RNA = 3, PROBE = 4, PROTEIN = 5", "example": 2 }, "accsesion": { "type": "string", "description": "The unique accession number assigned to the sequence" }, "organism": { "type": "string", "description": "The organism from which the sequence is derived" }, "description": { "type": "string", "description": "Description of the sequence" } } } } }, "createSequence": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createSequence.json", "title": "createSequence", "allOf": [ { "$ref": "#/components/schemas/SequenceBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "title", "seq" ] } } } ] }, "updateSequence": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateSequence.json", "title": "updateSequence", "allOf": [ { "$ref": "#/components/schemas/SequenceBaseRequest" } ] }, "RodentSpecimenBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/RodentSpecimenBaseRequest.json", "title": "RodentSpecimenBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the rodent specimen" }, "status": { "type": "string", "description": "the status of the rodent: alive, dead, missing, sacrificed" }, "description": { "type": "string", "description": "Description of the rodent specimen" }, "alternative_name": { "type": "string", "description": "additional name for the rodent specimen" }, "owner_id": { "type": "integer", "description": "id of the owner - by default it's your member id" }, "genotype": { "type": "string", "description": "genotype" }, "phenotype": { "type": "string", "description": "phenotype" }, "ear_tag": { "type": "string", "description": "ear tag" }, "coat_tag": { "type": "string", "description": "coat tag" }, "sex": { "type": "string", "description": "sex of the rodent: male, female, unknown" }, "ethics": { "type": "string", "description": "ethics approval id" }, "dob": { "type": "string", "format": "date", "description": "Date of birth (yyyy-mm-dd)" }, "dod": { "type": "string", "format": "date", "description": "Date of death (yyyy-mm-dd)" }, "source": { "type": "string", "description": "source" } } } } }, "createRodentSpecimen": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createRodentSpecimen.json", "title": "createRodentSpecimen", "allOf": [ { "$ref": "#/components/schemas/RodentSpecimenBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name", "status" ] } } } ] }, "updateRodentSpecimen": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateRodentSpecimen.json", "title": "updateRodentSpecimen", "allOf": [ { "$ref": "#/components/schemas/RodentSpecimenBaseRequest" } ] }, "createMaintenanceType": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createMaintenanceType.json", "title": "createMaintenanceType", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "The name of the maintenance type" } } } } }, "updateMaintenanceType": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateMaintenanceType.json", "title": "updateMaintenanceType", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "The new name of the maintenance type" } } } } }, "FungusBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/FungusBaseRequest.json", "title": "FungusBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the fungus" }, "species": { "type": "string", "description": "Biological species." }, "phenotype": { "type": "string", "description": "Observable traits." }, "genotype": { "type": "string", "description": "Genetic composition." }, "host": { "type": "string", "description": "Associated host organism." }, "virulent": { "type": "string", "description": "Virulence factor." }, "sporulate": { "type": "string", "description": "Ability to form spores." }, "mycelia": { "type": "string", "description": "Mycelial growth." }, "fruiting_bodies": { "type": "string", "description": "Presence of sporocarps." }, "owner_id": { "type": "integer", "description": "id of the owner - by default it's your member id" }, "source": { "type": "string", "description": "The origin or source from which the fungus was obtained." }, "description": { "type": "string", "description": "Description of the fungus" } } } } }, "createFungus": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createFungus.json", "title": "createFungus", "allOf": [ { "$ref": "#/components/schemas/FungusBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateFungus": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateFungus.json", "title": "updateFungus", "allOf": [ { "$ref": "#/components/schemas/FungusBaseRequest" } ] }, "TissueBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/TissueBaseRequest.json", "title": "TissueBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the tissue" }, "alternative_name": { "type": "string", "description": "An alternative name for the tissue" }, "species": { "type": "string", "description": "The species from which the tissue is derived" }, "genotype_phenotype": { "type": "string", "description": "Genotype/phenotype" }, "animal_details": { "type": "string", "description": "Detailed information about the animal from which the tissue was harvested" }, "tissue_type": { "type": "string", "description": "The type of the tissue " }, "harvest_date": { "type": "string", "description": "Harvest date - in the following format (yyyy-mm-dd)", "example": "2021-06-21" }, "fixation_embedding_procedure": { "type": "string", "description": "Fixation/embedding procedure" }, "applications": { "type": "string", "description": "Applications" }, "storage_conditions": { "type": "string", "description": "Storage conditions" }, "owner_id": { "type": "integer", "description": "id of the owner - by default it's your member id" }, "source": { "type": "string", "description": "The origin of the tissue" }, "description": { "type": "string", "description": "Description of the tissue" } } } } }, "createTissue": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createTissue.json", "title": "createTissue", "allOf": [ { "$ref": "#/components/schemas/TissueBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateTissue": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateTissue.json", "title": "updateTissue", "allOf": [ { "$ref": "#/components/schemas/TissueBaseRequest" } ] }, "RodentStrainBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/RodentStrainBaseRequest.json", "title": "RodentStrainBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the strain" }, "alternative_name": { "type": "string", "description": "additional name for the strain" }, "transgene": { "type": "string", "description": "Transgene" }, "genotype": { "type": "string", "description": "Genotype" }, "phenotype": { "type": "string", "description": "Phenotype" }, "owner_id": { "type": "integer", "description": "id of the owner - by default it's your member id" }, "source": { "type": "string", "description": "Source" }, "description": { "type": "string", "description": "Description of the strain" } } } } }, "createRodentStrain": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createRodentStrain.json", "title": "createRodentStrain", "allOf": [ { "$ref": "#/components/schemas/RodentStrainBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateRodentStrain": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateRodentStrain.json", "title": "updateRodentStrain", "allOf": [ { "$ref": "#/components/schemas/RodentStrainBaseRequest" } ] }, "createProtocol": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createProtocol.json", "title": "createProtocol", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "string", "example": "{\"name\":\"A protocol name\",\"experiment_procedures\":[],\"elements\":[]}" } } }, "updateProtocol": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateProtocol.json", "title": "updateProtocol", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The protocol name" } } } } }, "createMaintenance": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createMaintenance.json", "title": "createMaintenance", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "item_id", "item_type", "maintenance_type_id", "frequency_period", "frequency_frame" ], "properties": { "item_id": { "type": "integer", "description": "the id of the equipment" }, "item_type": { "type": "string", "description": "the class of the item (System::Instrument)", "example": "System::Instrument" }, "maintenance_type_id": { "type": "integer", "description": "the id of the maintenance type" }, "frequency_period": { "type": "integer", "description": "the time period in numbers", "example": "1" }, "frequency_frame": { "type": "string", "description": "one of the following time frames - hour/day/week/month/year", "example": "year" } } } } }, "updateMaintenance": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateMaintenance.json", "title": "updateMaintenance", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "item_id" ], "properties": { "item_id": { "type": "integer", "description": "the id of the equipment" }, "frequency_period": { "type": "integer", "description": "the time period in numbers", "example": "15" }, "frequency_frame": { "type": "string", "description": "one of the following time frames - hour/day/week/month/year", "example": "day" } } } } }, "PaperBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/PaperBaseRequest.json", "title": "PaperBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "the papers title " }, "journal": { "type": "string", "description": "the time period in numbers" }, "authors": { "type": "string", "description": "" }, "publication_date": { "type": "string", "format": "date", "description": "in the following format yyyy-mm-dd " }, "volume": { "type": "string", "description": "volume" }, "pages": { "type": "string", "description": "pages" }, "url": { "type": "string", "description": "www.link.com" }, "doi": { "type": "string", "description": "digital object identifier", "example": "10.1002/aur21" }, "review": { "type": "string", "description": "Abstract" } } } } }, "createPaper": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createPaper.json", "title": "createPaper", "allOf": [ { "$ref": "#/components/schemas/PaperBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updatePaper": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updatePaper.json", "title": "updatePaper", "allOf": [ { "$ref": "#/components/schemas/PaperBaseRequest" } ] }, "DocumentBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/DocumentBaseRequest.json", "title": "DocumentBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "title": { "type": "string", "description": "the document title " }, "description": { "type": "string", "description": "the document description" } } } } }, "createDocument": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createDocument.json", "title": "createDocument", "allOf": [ { "$ref": "#/components/schemas/DocumentBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "title" ] } } } ] }, "updateDocument": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateDocument.json", "title": "updateDocument", "allOf": [ { "$ref": "#/components/schemas/DocumentBaseRequest" } ] }, "ReportBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/ReportBaseRequest.json", "title": "ReportBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "title": { "type": "string", "description": "the report title " } } } } }, "createReport": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createReport.json", "title": "createReport", "allOf": [ { "$ref": "#/components/schemas/ReportBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "title" ] } } } ] }, "updateReport": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateReport.json", "title": "updateReport", "allOf": [ { "$ref": "#/components/schemas/ReportBaseRequest" } ] }, "addAnExperimentSectionToReport": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/addAnExperimentSectionToReport.json", "title": "addAnExperimentSectionToReport", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "report_id", "section_id" ], "properties": { "report_id": { "type": "integer", "description": "the report id" }, "section_id": { "type": "string", "description": "the experiment procedure id to copy", "example": "32" } } } } }, "addCoverToReport": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/addCoverToReport.json", "title": "addCoverToReport", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "report_id", "data" ], "properties": { "report_id": { "type": "integer", "description": "the report id" }, "data": { "type": "string", "description": "cover page data in HTML format", "example": "

Cover Page Heading

" } } } } }, "NoteBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/NoteBaseRequest.json", "title": "NoteBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "title", "project_id" ], "properties": { "title": { "type": "string", "description": "the note title " }, "body": { "type": "string", "description": "body description of the note" }, "project_id": { "type": "integer", "description": "the project id to add note to" } } } } }, "createNote": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createNote.json", "title": "createNote", "allOf": [ { "$ref": "#/components/schemas/NoteBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "title", "project_id" ] } } } ] }, "updateNote": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateNote.json", "title": "updateNote", "allOf": [ { "$ref": "#/components/schemas/NoteBaseRequest" } ] }, "CompanyBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/CompanyBaseRequest.json", "title": "CompanyBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "the company name" }, "address": { "type": "string", "description": "address of the company" }, "web": { "type": "string", "description": "link to the company web page " }, "contact": { "type": "string", "description": "contacts " }, "email": { "type": "string", "description": "email " }, "fax": { "type": "string", "description": "fax number " }, "description": { "type": "string", "description": "general description " } } } } }, "createCompany": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createCompany.json", "title": "createCompany", "allOf": [ { "$ref": "#/components/schemas/CompanyBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateCompany": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateCompany.json", "title": "updateCompany", "allOf": [ { "$ref": "#/components/schemas/CompanyBaseRequest" } ] }, "EquipmentBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/EquipmentBaseRequest.json", "title": "EquipmentBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "the equipment name" }, "model_number": { "type": "string", "description": "model number of the equipment" }, "serial_number": { "type": "string", "description": "serial number of the equipment " }, "equipment_type": { "type": "string", "description": "equipment type " }, "manufacturer": { "type": "string", "description": "manufacturer name " }, "purchase_date": { "type": "string", "format": "date", "description": "purchase date " }, "warranty_expired": { "type": "string", "format": "date", "description": "warranty_expired " }, "maintenance_information": { "type": "string", "description": "maintenance information " }, "description": { "type": "string", "description": "general description " } } } } }, "createEquipment": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createEquipment.json", "title": "createEquipment", "allOf": [ { "$ref": "#/components/schemas/EquipmentBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateEquipment": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateEquipment.json", "title": "updateEquipment", "allOf": [ { "$ref": "#/components/schemas/EquipmentBaseRequest" } ] }, "MaintenanceTemplateBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/MaintenanceTemplateBaseRequest.json", "title": "MaintenanceTemplateBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "equipment_type": { "type": "string", "description": "the equipment type" }, "maintenance_type_id": { "type": "integer", "description": "maintenance type id" }, "data": { "type": "string", "description": "templates fields in the follwing json format", "example": "[{\"title\":\"Detergent\",\"value\":\"Wateriii:\"}]" } } } } }, "createMaintenanceTemplate": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createMaintenanceTemplate.json", "title": "createMaintenanceTemplate", "allOf": [ { "$ref": "#/components/schemas/MaintenanceTemplateBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "equipment_type", "maintenance_type_id", "data" ] } } } ] }, "updateMaintenanceTemplate": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateMaintenanceTemplate.json", "title": "updateMaintenanceTemplate", "allOf": [ { "$ref": "#/components/schemas/MaintenanceTemplateBaseRequest" } ] }, "MaintenanceEventBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/MaintenanceEventBaseRequest.json", "title": "MaintenanceEventBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "item_id": { "type": "integer", "description": "the equipment id" }, "item_type": { "type": "string", "description": "equipment class name", "example": "System::Instrument" }, "maintenance_id": { "type": "integer", "description": "maintenance id" }, "data": { "type": "string", "description": "templates fields in the follwing json format", "example": "[{\"title\":\"Detergent\",\"value\":\"Wateriii:\"}]" }, "performed_at": { "type": "string", "format": "date", "description": "performance data" }, "performed_by": { "type": "integer", "description": "member id" } } } } }, "createMaintenanceEvent": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createMaintenanceEvent.json", "title": "createMaintenanceEvent", "allOf": [ { "$ref": "#/components/schemas/MaintenanceEventBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "item_id", "item_type", "maintenance_id", "data", "performed_by", "performed_at" ] } } } ] }, "updateMaintenanceEvent": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateMaintenanceEvent.json", "title": "updateMaintenanceEvent", "allOf": [ { "$ref": "#/components/schemas/MaintenanceEventBaseRequest" } ] }, "createSection": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createSection.json", "title": "createSection", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "name", "container_id", "container_type" ], "properties": { "name": { "type": "string", "description": "the name of the section" }, "container_id": { "type": "integer", "description": "the id of the experiment/protocol/report the section belongs to" }, "container_type": { "type": "string", "description": "the type of the container - Projects::Experiment | Knowledgebase::Protocol | Knowledgebase::AbstractDocument", "example": "Projects::Experiment" }, "position": { "type": "integer", "description": "the section position" } } } } }, "updateSection": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateSection.json", "title": "updateSection", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "the name of the section" }, "container_id": { "type": "integer", "description": "the id of the experiment/protocol/report the section belongs to" }, "container_type": { "type": "string", "description": "the type of the container - Projects::Experiment\\Knowledgebase::Protocol\\Knowledgebase::Report", "example": "Projects::Experiment" }, "position": { "type": "integer", "description": "the section position" } } } } }, "moveSection": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/moveSection.json", "title": "moveSection", "type": "object", "required": [ "token", "container_id", "container_type", "list" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "container_id": { "type": "integer", "description": "The id of the container" }, "container_type": { "type": "string", "default": "Projects::Experiment", "description": "The container type of the section" }, "list": { "type": "array", "items": { "type": "integer" }, "description": "An array of section IDs.
\n The order of IDs in this list defines the new arrangement of sections on the page", "example": [ 110, 111 ] } } }, "createFolder": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createFolder.json", "title": "createFolder", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "project_id", "title" ], "properties": { "project_id": { "type": "integer", "description": "The ID of the project" }, "title": { "type": "string", "description": "The folder title" } } } } }, "updateFolder": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateFolder.json", "title": "updateFolder", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "project_id": { "type": "integer", "description": "The ID of the project" }, "title": { "type": "string", "description": "The folder title" } } } } }, "StorageBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/StorageBaseRequest.json", "title": "StorageBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "system_storage_storage": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the storage unit." }, "storage_type_id": { "type": "integer", "description": "The ID of the storage type.
Examples include: 1 (Room), 21 (Shelf), 61 (Closet), 81 (Drawer), 111 (Cage), 120 (Refrigerator), 121 (Freezer), 201 (Cryo container), 251 (Slide Rack), 322 (Rack), 321 (Other)." }, "description": { "type": "string", "description": "description of the storage unit" }, "temperature": { "type": "integer", "description": "temperature of the storage unit." } } } } }, "createStorage": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createStorage.json", "title": "createStorage", "allOf": [ { "$ref": "#/components/schemas/StorageBaseRequest" }, { "type": "object", "properties": { "system_storage_storage": { "type": "object", "required": [ "name", "storage_type_id" ] } } } ] }, "updateStorage": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateStorage.json", "title": "updateStorage", "allOf": [ { "$ref": "#/components/schemas/StorageBaseRequest" } ] }, "BoxBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/BoxBaseRequest.json", "title": "BoxBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "the box name " }, "rows": { "type": "integer", "description": "number of rows" }, "cols": { "type": "integer", "description": "number of columns" }, "box_type": { "type": "integer", "description": "one of the following: [[\"Primer\", 0], [\"General\", -1], [\"Tube\", -1], [\"Seed\", -2], [\"Fly\", -3], [\"Bacterium\", -4], [\"Cell Line\", -5], [\"Tissue\", -6], [\"Antibody\", -7], [\"Plasmid\", -8], [\"Glycerol\", -9], [\"Enzyme\", -10], [\"Consumable\", -11], [\"Yeast\", -12], [\"Fungus\", -13], [\"Virus\", -14], [\"Protein\", -15], [\"Lipid\", -16], [\"Worm\", -17], [\"Sequence\", -18], [\"Zebrafish\", -19], [\"Gene\", -20], [\"Compound\", -21]]", "example": 0 }, "color": { "type": "string", "description": "[\"pink\", \"red\", \"orange\", \"yellow\", \"beige\", \"white\", \"blue\", \"purple\", \"green\", \"brown\", \"gray\", \"black\"]" }, "shared": { "type": "boolean", "description": "Personal - false/ shared - true(default)" }, "barcode": { "type": "string", "description": "the barcode of the box" } } } } }, "createBox": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createBox.json", "title": "createBox", "allOf": [ { "$ref": "#/components/schemas/BoxBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateBox": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateBox.json", "title": "updateBox", "allOf": [ { "$ref": "#/components/schemas/BoxBaseRequest" } ] }, "createTag": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createTag.json", "title": "createTag", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "tag", "class_name", "item_id" ], "properties": { "tag": { "type": "string", "description": "the tag name " }, "class_name": { "type": "string", "description": "the item type to tag", "example": "Biocollections::Antibody" }, "item_id": { "type": "string", "description": "the id of the item to to tag" } } } } }, "deleteTag": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/deleteTag.json", "title": "deleteTag", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "tag", "class_name", "item_id" ], "properties": { "tag": { "type": "string", "description": "the tag name to remove " }, "class_name": { "type": "string", "description": "the item type to remove the tag from", "example": "Biocollections::Antibody" }, "item_id": { "type": "string", "description": "the id of the item to to remove the tag from" } } } } }, "EventBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/EventBaseRequest.json", "title": "EventBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "event title" }, "start_date": { "type": "string", "format": "date", "description": "the event start date" }, "end_date": { "type": "string", "format": "date", "description": "the event end date" }, "description": { "type": "string", "description": " text description for this event" }, "notify_members": { "type": "string", "description": "who should be notified regarding the event: notify only me =[1], notify all participants = [-1], none =[0]", "example": "[0]" }, "notify_at": { "type": "string", "format": "date", "description": "when to notify about the event" }, "is_fullday_event": { "type": "boolean", "description": "true/false" }, "repeats": { "type": "integer", "description": "1/0" }, "repeat_frame": { "type": "string", "description": "the time frame which the event will be repeated at - Never, days, weeks, months", "example": "Never" }, "eventable_id": { "type": "integer", "description": "the equipment id which the event is related to" }, "eventable_type": { "type": "string", "description": "the item class name - System::Instrument", "example": "System::Instrument" } } } } }, "createEvent": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createEvent.json", "title": "createEvent", "allOf": [ { "$ref": "#/components/schemas/EventBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name", "start_date", "end_date" ] } } } ] }, "updateEvent": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateEvent.json", "title": "updateEvent", "allOf": [ { "$ref": "#/components/schemas/EventBaseRequest" } ] }, "createWebhook": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createWebhook.json", "title": "createWebhook", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "trigger_key", "active", "url" ], "properties": { "trigger_key": { "type": "string", "description": "trigger key", "example": "knowledgebase_document.signed" }, "active": { "type": "boolean", "description": "by default it's false", "example": false }, "url": { "type": "string", "description": "url", "example": "https://prod-flow.labguru.com/flows/1234567/flow_runs.json" } } } } }, "updateWebhook": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateWebhook.json", "title": "updateWebhook", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "trigger_key": { "type": "string", "description": "trigger key", "example": "knowledgebase_document.signed" }, "active": { "type": "boolean", "description": "by default it's false", "example": false }, "url": { "type": "string", "description": "url", "example": "https://prod-flow.labguru.com/flows/1234567/flow_runs.json" } } } } }, "createDataset": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createDataset.json", "title": "createDataset", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "name", "data_attachment_id" ], "properties": { "name": { "type": "string", "description": "dataset name" }, "data_attachment_id": { "type": "integer", "description": "dataset attachment id" }, "sdf_attachment_id": { "type": "integer", "description": "SDF attachment id" }, "description": { "type": "string", "description": "dataset description" } } } } }, "assignItemToDataset": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/assignItemToDataset.json", "title": "assignItemToDataset", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "item_type", "item_id" ], "properties": { "item_type": { "type": "string", "description": "the item type to attach the dataset to" }, "item_id": { "type": "integer", "description": "the id of the item" } } } } }, "createVisualization": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createVisualization.json", "title": "createVisualization", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "name", "dataset_id", "attachment_id" ], "properties": { "name": { "type": "string", "description": "visualization name" }, "dataset_id": { "type": "integer", "description": "the dataset id" }, "attachment_id": { "type": "integer", "description": "the attachment id" } } } } }, "createVector": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createVector.json", "title": "createVector", "type": "object", "required": [ "token", "dataset_id", "vector_data" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "dataset_id": { "type": "integer", "description": "the dataset id" }, "vector_data": { "type": "string", "description": "fields must be same as column headers in the dataset {\"data_header\": \"item_name\"}", "example": { "column1": "value1", "column2": "value2" } } } }, "updateVector": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateVector.json", "title": "updateVector", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "dataset_id": { "type": "integer", "description": "the dataset id" }, "vector_data": { "type": "string", "description": "fields must be same as column headers in the dataset - {\"data_header\": \"item_name\"}", "example": { "column1": "value1", "column2": "value2" } } } }, "GenericItemBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/GenericItemBaseRequest.json", "title": "GenericItemBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "generic item name" }, "description": { "type": "string", "description": "Text description for this generic item" } } } } }, "createGenericItem": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createGenericItem.json", "title": "createGenericItem", "allOf": [ { "$ref": "#/components/schemas/GenericItemBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateGenericItem": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateGenericItem.json", "title": "updateGenericItem", "allOf": [ { "$ref": "#/components/schemas/GenericItemBaseRequest" } ] }, "addItem": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/addItem.json", "title": "Add item", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "collection_type", "item_id", "quantity" ], "properties": { "collection_type": { "type": "string", "description": "The type of collection, specified in singular form, such as - Biocollections::Antibody" }, "item_id": { "type": "integer", "description": "The id of the item to be added to the shopping list" }, "price": { "type": "number", "format": "float", "description": "The price of the item" }, "currency": { "type": "integer" }, "quantity": { "type": "integer", "description": "The number of units of the item to be added to the shopping list." }, "remarks": { "type": "string", "description": "Additional comments or special instructions related to the item." } } } } }, "addCustomItem": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/addCustomItem.json", "title": "Add custom item", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "collection_type", "collection_id", "item_id", "quantity" ], "properties": { "collection_type": { "type": "string", "description": "The name of the custom collection to which the item belongs." }, "collection_id": { "type": "integer", "description": "The id of the custom collection within the system." }, "item_id": { "type": "integer", "description": "The id of the item to be added to the shopping list" }, "price": { "type": "number", "format": "float", "description": "The price of the item" }, "currency": { "type": "integer" }, "quantity": { "type": "integer", "description": "The number of units of the item to be added to the shopping list." }, "remarks": { "type": "string", "description": "Additional comments or special instructions related to the item." } } } } }, "updateOrder": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateOrder.json", "title": "updateOrder", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "price": { "type": "number", "format": "float", "description": "price" }, "budget": { "type": "string", "description": "budget" }, "currency": { "type": "integer", "description": "0 = NIS, 1 = DOLLAR, 2 = EURO, 3 = POUND, 4 = NOK " }, "quantity": { "type": "integer", "description": "quantity" }, "order_number": { "type": "integer", "description": "order number" }, "description": { "type": "string", "description": "description" } } } } }, "MaterialBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/MaterialBaseRequest.json", "title": "MaterialBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "Material name" }, "company_id": { "type": "integer", "description": "[required] - in case material is commercial" }, "produce_by": { "type": "string", "description": "[required] - in case material is non commercial" }, "description": { "type": "string", "description": "description" }, "cas_number": { "type": "integer", "description": "CAS Registry Number" }, "mw": { "type": "string", "description": "mw" }, "web": { "type": "string", "description": "url" }, "materialtype_id": { "type": "integer", "description": "the material type id" }, "units": { "type": "string", "description": "units" }, "price": { "type": "number", "format": "float", "description": "price" }, "currency": { "type": "integer", "description": "0 = NIS, 1 = DOLLAR, 2 = EURO, 3 = POUND, 4 = NOK " } } } } }, "createMaterial": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createMaterial.json", "title": "createMaterial", "allOf": [ { "$ref": "#/components/schemas/MaterialBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name" ] } } } ] }, "updateMaterial": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateMaterial.json", "title": "updateMaterial", "allOf": [ { "$ref": "#/components/schemas/MaterialBaseRequest" } ] }, "StockBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/StockBaseRequest.json", "title": "StockBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "the stock name " }, "storage_id": { "type": "integer", "description": "type of storages: 1 - Room, 21 - Shelf, 61 - Closet, 81 - Drawer, 111 - Cage, 120 - Refrigerator ,121 - Freezer, 181 - Rack Cell , 201 - Cryo container, 251 - Slide Rack, 261 - Rack Cell, 322 - Rack, 323 - Rack Cell, 321 - Other" }, "storage_type": { "type": "string", "description": "storage class name - [Box - System::Storage::Box] [all other storages type - System::Storage::Storage] " }, "stockable_type": { "type": "string", "description": "class name of the stockable item type, such as: Biocollections::Antibody" }, "stockable_id": { "type": "integer", "description": "stockable item id" }, "location_in_box": { "type": "integer", "description": "if storage is grid box, indicates numerical location in box" }, "owner_id": { "type": "integer", "description": "id of the owner - by default it's your member id" }, "expiration_date": { "type": "string", "format": "date", "description": "in the following format: yyyy-mm-dd " }, "lot": { "type": "string", "description": "number of batch" }, "description": { "type": "string", "description": "general description" }, "barcode": { "type": "string", "description": "barcode " }, "stored_by": { "type": "integer", "description": "member id" }, "concentration": { "type": "string", "description": "concentration" }, "concentration_prefix": { "type": "string", "description": "x10^/E^", "example": "E^" }, "concentration_unit_id": { "type": "integer", "description": "9-mg/mL, 10-g/L, 11-M, 12-mM, 13-\u00b5M, 14-\u00b5g/mL, 15-ng/\u00b5L, 16-ratio, 17-%, 18-g/mL", "example": 9 }, "concentration_exponent": { "type": "integer", "description": "concentration exponent" }, "concentration_remarks": { "type": "string", "description": "concentration remarks" }, "volume": { "type": "string", "description": "volume" }, "volume_prefix": { "type": "string", "description": "x10^/E^", "example": "E^" }, "volume_unit_id": { "type": "integer", "description": "6-L, 7-mL, 8-\u00b5L", "example": 7 }, "volume_exponent": { "type": "integer", "description": "volume exponent" }, "volume_remarks": { "type": "string", "description": "volume remarks" }, "weight": { "type": "string", "description": "weight" }, "weight_prefix": { "type": "string", "description": "x10^/E^", "example": "E^" }, "weight_unit_id": { "type": "integer", "description": "1 -Kg, 2-g, 3-mg, 4-\u00b5g, 5-ng", "example": 3 }, "weight_exponent": { "type": "integer", "description": "weight exponent" }, "weight_remarks": { "type": "string", "description": "weight remarks" } } } } }, "createStock": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createStock.json", "title": "createStock", "allOf": [ { "$ref": "#/components/schemas/StockBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "name", "storage_id", "storage_type", "stockable_type", "stockable_id" ] } } } ] }, "updateStock": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateStock.json", "title": "updateStock", "allOf": [ { "$ref": "#/components/schemas/StockBaseRequest" } ] }, "updateStockAmountInSampleElement": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateStockAmountInSampleElement.json", "title": "updateStockAmountInSampleElement", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "unit_type": { "type": "string", "description": "weight/volume" }, "element_id": { "type": "integer", "description": "the samples element id" }, "amount_used": { "type": "string", "description": "amount_used", "example": 15 }, "unit_type_name": { "type": "string", "description": "unit_type_name", "example": "mg" }, "subtract": { "type": "string", "description": "true", "example": "true" }, "sample_id": { "type": "integer", "description": "the sample id" } } }, "createUnit": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createUnit.json", "title": "createUnit", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "name", "type_for" ], "properties": { "name": { "type": "string", "description": "unit name " }, "type_for": { "type": "string", "description": "weight/volume/concentration" } } } } }, "deleteUnit": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/deleteUnit.json", "title": "deleteUnit", "type": "object", "required": [ "token", "unit_type" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "unit_type": { "type": "string", "description": "weight/volume/concentration", "example": "weight" } } }, "createRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createRequest.json", "title": "createRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "request_template_id" ], "properties": { "name": { "type": "string", "description": "The name of the request" }, "request_template_id": { "type": "integer", "description": "The ID of the request template to start the request from" }, "priority": { "type": "string", "description": "Specifies the priority level of the request. By default - Low", "enum": [ "Low", "Medium", "High", "Urgent" ], "example": "Medium" } } } } }, "updateRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateRequest.json", "title": "updateRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the request" }, "team_id": { "type": "integer", "description": "The performing team ID" }, "status": { "type": "string", "description": "The request status, indicating the current state of the request.", "enum": [ "Draft", "Pending", "Approved", "Awaiting Assignment", "Assigned", "In Progress", "Completed" ], "example": "Draft" }, "priority": { "type": "string", "description": "Specifies the priority level of the request. By default - Low", "enum": [ "Low", "Medium", "High", "Urgent" ], "example": "Medium" }, "due_date": { "type": "string", "format": "date", "description": "Date in the following format - 'YYYY-MM-DD'", "example": "2024-03-11" } } } } }, "submitRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/submitRequest.json", "title": "submitRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the request" }, "team_id": { "type": "integer", "description": "The performing team ID" }, "due_date": { "type": "string", "format": "date", "description": "Date in the following format - 'YYYY-MM-DD'", "example": "2024-03-11" } } } } }, "approvedRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/approvedRequest.json", "title": "approvedRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "team_id": { "type": "integer", "description": "The performing team ID" }, "due_date": { "type": "string", "format": "date", "description": "Date in the following format - 'YYYY-MM-DD'", "example": "2024-03-11" }, "priority": { "type": "string", "description": "Specifies the priority level of the request. By default - Low", "enum": [ "Low", "Medium", "High", "Urgent" ], "example": "Medium" } } } } }, "acceptRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/acceptRequest.json", "title": "acceptRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "priority": { "type": "string", "description": "Specifies the priority level of the request. By default - Low", "enum": [ "Low", "Medium", "High", "Urgent" ], "example": "Medium" } } } } }, "selectPerformer": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/selectPerformer.json", "title": "selectPerformer", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "performed_by" ], "properties": { "performed_by": { "type": "integer", "description": "The ID of the member which will perform the request" } } } } }, "startRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/startRequest.json", "title": "startRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "performed_by": { "type": "integer", "description": "The ID of the member which will perform the request" } } } } }, "createRequestTemplate": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createRequestTemplate.json", "title": "createRequestTemplate", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "request_type" ], "properties": { "name": { "type": "string", "description": "The name of the request template" }, "request_type": { "type": "string", "description": "The type of request" } } } } }, "updateRequestTemplate": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateRequestTemplate.json", "title": "updateRequestTemplate", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the request template" }, "request_type": { "type": "string", "description": "The type of request" } } } } }, "indexFiltering": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/indexFiltering.json", "title": "indexFiltering", "type": "object", "required": [ "kendo" ], "properties": { "kendo": { "type": "string", "example": "true" }, "filter": { "type": "object", "properties": { "logic": { "type": "string", "example": "and", "description": "Filter logic (e.g., \"and\" or \"or\")" }, "filters": { "type": "object", "description": "Array of filter objects", "properties": { "0": { "type": "object", "description": "Filter object", "properties": { "field": { "type": "string", "example": "name", "description": "Field name to filter by" }, "operator": { "type": "string", "example": "contains", "description": "Filter operator (e.g., \"contains\")" }, "value": { "type": "string", "example": "myValue", "description": "Filter value" } } }, "1": { "type": "object", "description": "Filter object", "properties": { "field": { "type": "string", "example": "id", "description": "Field name to filter by" }, "operator": { "type": "string", "example": "_eq", "description": "Filter operator (e.g., \"_eq\")" }, "value": { "type": "integer", "example": "172", "description": "Filter value" } } }, "2": { "type": "object", "description": "Filter object", "properties": { "field": { "type": "string", "example": "stored_on", "description": "Field name to filter by" }, "operator": { "type": "string", "example": "_gt", "description": "Filter operator (e.g., \"_gt\")" }, "value": { "type": "string", "format": "date", "description": "Filter value - Date in the following format 'YYYY-MM-DD'", "example": "2023-01-11" } } }, "3": { "type": "object", "description": "Filter object", "properties": { "field": { "type": "string", "example": "content", "description": "Field name to filter by" }, "operator": { "type": "string", "example": "startswith", "description": "Filter operator (e.g., \"startswith\")" }, "value": { "type": "string", "example": "pla", "description": "Filter value" } } }, "4": { "type": "object", "description": "Filter object", "properties": { "field": { "type": "string", "example": "stored_by", "description": "Field name to filter by" }, "operator": { "type": "string", "example": "contains", "description": "Filter operator (e.g., \"contains\")" }, "value": { "properties": { "name": { "type": "string", "example": "User Name", "description": "User name to filter by" }, "id": { "type": "string", "example": "[1]", "description": "User id in the following format \"[1]\"" } } } } } } } } } } }, "addVisualization": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/addVisualization.json", "title": "addVisualization", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "name", "dataset_id", "attachment_id" ], "properties": { "name": { "type": "string", "description": "The name of the visualization" }, "dataset_id": { "type": "integer", "description": "The ID of the dataset to which the visualization will be linked to" }, "attachment_id": { "type": "integer", "description": "The ID of the attachment (image) that will appear under the 'Visualization' tab of the dataset" } } } } }, "addElement": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/addElement.json", "title": "Add element", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "container_id", "container_type", "element_type", "data" ], "description": "Valid element types are:
\u2022 samples
\u2022 equipment
\u2022 code
\u2022 compound
\u2022 reaction
\u2022 text
\u2022 steps
\u2022 excel
\u2022 plate
", "properties": { "name": { "type": "string", "description": "Specifies the name of the element. If not provided, the element will be assigned a default name" }, "container_id": { "type": "integer", "description": "The ID of the section to which the element will be added" }, "container_type": { "type": "string", "description": "The type of container in which the element will be placed", "example": "ExperimentProcedure" }, "element_type": { "type": "string", "description": "The type of element to be added" }, "data": { "type": "string", "nullable": true } } } } }, "updateTextElement": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateTextElement.json", "title": "Update text element", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "data": { "type": "string", "example": "The updated text" } } }, "updateFormElement": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateFormElement.json", "title": "Update form element", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "form_json": { "type": "string", "description": "A JSON string containing key-value pairs that specify updates to the form fields.\n Each key corresponds to a form field name and the value specifies the new content for that field.", "example": { "Field Name": "Field Content" } } } }, "addPlateElement": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/addPlateElement.json", "title": "Add plate element", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "container_id", "container_type", "element_type", "data", "rows", "cols" ], "description": "Valid plate dimensions are:
\u2022 3x2 (6 wells)
\u2022 4x3 (12 wells)
\u2022 6x4 (24 wells)
\u2022 8x6 (48 wells)
\u2022 12x6 (72 wells)
\u2022 12x8 (96 wells)
\u2022 24x16 (384 wells)
", "properties": { "name": { "type": "string", "description": "Specifies the name of the element. If not provided, the element will be assigned a default name" }, "container_id": { "type": "integer", "description": "The ID of the section to which the element will be added" }, "container_type": { "type": "string", "description": "The type of container in which the plate element will be placed", "example": "ExperimentProcedure" }, "element_type": { "type": "string", "description": "The type of element to be added", "example": "plate" }, "cols": { "type": "integer", "description": "the number of columns in the plate layout" }, "rows": { "type": "integer", "description": "The number of rows in the plate layout" }, "data": { "type": "string", "nullable": true } } } } }, "createFixedSamplePoolingEvent": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createFixedSamplePoolingEvent.json", "title": "Create fixed sample pooling event", "type": "object", "description": "draw a fixed amount from all stocks.", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "name", "pool_type", "unit", "unit_type", "fixed_amount", "stocks_list", "pooled_stock_info" ], "properties": { "name": { "type": "string", "description": "The description of pool purpose" }, "unit_type": { "type": "string", "description": "volume/weight" }, "pool_type": { "type": "string", "example": "fixed" }, "unit": { "type": "string", "description": "Valid units of measurement are:\n\n- For 'volume': 'nL', '\u00b5L', 'mL', 'L'\n- For 'weight': 'ng', '\u00b5g', 'mg', 'g', 'Kg'", "example": "\u00b5L" }, "fixed_amount": { "type": "integer", "description": "Specifies the exact amount to draw" }, "stocks_list": { "type": "array", "description": "List of stock IDs from which to draw", "items": { "type": "integer" }, "example": [ 1291, 1293 ] }, "pooled_stock_info": { "type": "object", "required": [ "name", "stockable_type", "stockable_id", "storage_type", "storage_id" ], "description": "Contains all the necessary stock fields for creating a stock during the pooling event.\n This object may include all the relevant stock properties.", "properties": { "name": { "type": "string" }, "stockable_type": { "type": "string", "description": "Identifies the class name of the stock item, such as 'Biocollections::Bacterium'.\n This indicates the category of the entity and must match valid system-defined class names.", "example": "Biocollections::Bacterium" }, "stockable_id": { "type": "integer" }, "storage_type": { "type": "string", "description": "Specifies the storage classification, such as 'System::Storage::Storage',\n indicating the type of storage facility used for the item.", "example": "System::Storage::Storage" }, "storage_id": { "type": "integer" } } } } } } }, "createCustomSamplePoolingEvent": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createCustomSamplePoolingEvent.json", "title": "Create custom sample pooling event", "type": "object", "description": "draw a custom amount from each stock.", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "name", "unit_type", "pool_type", "unit", "stocks_usage", "pooled_stock_info" ], "properties": { "name": { "type": "string", "description": "The description of pool purpose" }, "unit_type": { "type": "string", "description": "volume/weight" }, "pool_type": { "type": "string", "example": "custom" }, "unit": { "type": "string", "description": "Valid units of measurement are:\n\n- For 'volume': 'nL', '\u00b5L', 'mL', 'L'\n- For 'weight': 'ng', '\u00b5g', 'mg', 'g', 'Kg'", "example": "\u00b5L" }, "stocks_usage": { "type": "object", "description": "Hash of stock IDs and the desired amount to pool.", "additionalProperties": { "type": "number", "description": "Amount to be pooled for the given stock ID." }, "example": { "300": 0.004, "834": 6, "45": 5 } }, "pooled_stock_info": { "type": "object", "description": "Contains all the necessary stock fields for creating a stock during the pooling event.\n This object may include all the relevant stock properties.", "required": [ "name", "stockable_type", "stockable_id", "storage_type", "storage_id" ], "properties": { "stockable_type": { "type": "string", "description": "Identifies the class name of the stock item, such as 'Biocollections::Bacterium'.\n This indicates the category of the entity and must match valid system-defined class names.", "example": "Biocollections::Bacterium" }, "stockable_id": { "type": "integer" }, "storage_type": { "type": "string", "description": "Specifies the storage classification, such as 'System::Storage::Storage',\n indicating the type of storage facility used for the item.", "example": "System::Storage::Storage" }, "storage_id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "createConsumeSamplePoolingEvent": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createConsumeSamplePoolingEvent.json", "title": "Create consume sample pooling event", "type": "object", "description": "draw the entire amount and consume.", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "required": [ "name", "unit_type", "pool_type", "unit", "stocks_list", "pooled_stock_info" ], "properties": { "name": { "type": "string", "description": "The description of pool purpose" }, "unit_type": { "type": "string", "description": "volume/weight" }, "pool_type": { "type": "string", "example": "consume" }, "unit": { "type": "string", "example": "\u00b5L", "description": "Valid units of measurement are:\n\n- For 'volume': 'nL', '\u00b5L', 'mL', 'L'\n- For 'weight': 'ng', '\u00b5g', 'mg', 'g', 'Kg'" }, "stocks_list": { "type": "array", "description": "List of stock IDs from which to draw", "items": { "type": "integer" }, "example": [ 1291, 1293 ] }, "pooled_stock_info": { "type": "object", "description": "Contains all the necessary stock fields for creating a stock during the pooling event.\n This object may include all the relevant stock properties.", "required": [ "name", "stockable_type", "stockable_id", "storage_type", "storage_id" ], "properties": { "stockable_type": { "type": "string", "description": "Identifies the class name of the stock item, such as 'Biocollections::Bacterium'.\n This indicates the category of the entity and must match valid system-defined class names.", "example": "Biocollections::Bacterium" }, "stockable_id": { "type": "integer" }, "storage_type": { "type": "string", "description": "Specifies the storage classification, such as 'System::Storage::Storage', indicating the type of storage facility used for the item.", "example": "System::Storage::Storage" }, "storage_id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "FlagBaseRequest": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/FlagBaseRequest.json", "title": "FlagBaseRequest", "type": "object", "required": [ "token" ], "properties": { "token": { "type": "string", "example": "YOUR TOKEN IS HERE" }, "item": { "type": "object", "properties": { "title": { "type": "string", "description": "Specifies the name of the flag" }, "icon": { "type": "string", "description": "The icon of the flag", "enum": [ "star", "bolt", "thumbs-up", "thumbs-down", "question", "exclamation", "bell", "bell-slash", "fire", "sun" ], "example": "star" }, "color": { "type": "string", "description": "The color of the flag", "enum": [ "green-light", "green", "green-dark", "red-light", "red", "red-dark", "blue-light", "blue", "blue-dark", "orange-light", "orange", "orange-dark", "grey-light", "grey", "grey-dark" ], "example": "green" }, "description": { "type": "string", "description": "General description of the flag" } } } } }, "createFlag": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/createFlag.json", "title": "createFlag", "allOf": [ { "$ref": "#/components/schemas/FlagBaseRequest" }, { "type": "object", "properties": { "item": { "type": "object", "required": [ "title" ] } } } ] }, "updateFlag": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/updateFlag.json", "title": "updateFlag", "allOf": [ { "$ref": "#/components/schemas/FlagBaseRequest" } ] }, "InvalidRequestError": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/InvalidRequestError.json", "title": "InvalidRequestError", "type": "object", "properties": { "error_message": { "type": "string" }, "type": { "type": "string", "example": "invalid_request_error" } } }, "UnprocessableEntity": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/UnprocessableEntity.json", "title": "UnprocessableEntity", "type": "object", "properties": { "error_message": { "type": "string" }, "type": { "type": "string", "example": "invalid_request_error" } } }, "InternalServerError": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/InternalServerError.json", "title": "InternalServerError", "type": "object", "properties": { "error_message": { "type": "string" }, "type": { "type": "string" } } }, "Unauthorized": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/Unauthorized.json", "title": "Unauthorized", "type": "object", "properties": { "message": { "type": "string", "example": "You are not authorized to perform this action" } } }, "OK": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/OK.json", "title": "OK", "type": "object", "properties": { "message": { "type": "string" }, "type": { "type": "string", "example": "Created" } } }, "NotFound": { "$schema": "http://json-schema.org/draft-07/schema#", "$id": "https://raw.githubusercontent.com/api-evangelist/labguru/main/json-schema/NotFound.json", "title": "NotFound", "type": "object", "properties": { "error": { "type": "string", "example": "Resource not found" } } } } }