Return a list of available fields for the given vault.
GET /api/v1/vaults/$VAULT_ID/fields
Example:
curl -H "X-CDD-Token: $TOKEN" https://app.collaborativedrug.com/api/v1/vaults//fields
Returns:
{
"internal": [
{
"id": 1,
"type": "InternalFieldDefinition::MoleculeName",
"name": "Molecule Name or Synonym",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 2,
"type": "InternalFieldDefinition::MoleculeStructure",
"name": "Structure",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 3,
"type": "InternalFieldDefinition::MoleculeSynonym",
"name": "Molecule Name or Synonym",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 147,
"type": "InternalFieldDefinition::WellLocation",
"name": "Well Location",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 148,
"type": "InternalFieldDefinition::PlateName",
"name": "Plate Name",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 153,
"type": "InternalFieldDefinition::BatchName",
"name": "Batch Name",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 698,
"type": "InternalFieldDefinition::WellControlState",
"name": "Well control state",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 1041,
"type": "InternalFieldDefinition::MoleculeIdToMerge",
"name": "Molecule to merge",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 1910,
"type": "InternalFieldDefinition::BatchCoreCount",
"name": "Batch core count",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 1911,
"type": "InternalFieldDefinition::BatchSaltCount",
"name": "Batch salt count",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 2903,
"type": "InternalFieldDefinition::BatchSalt",
"name": "Salt",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 2937,
"type": "InternalFieldDefinition::BatchSolventOfCrystallizationCount",
"name": "Batch solvent of crystallization count",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 29145,
"type": "InternalFieldDefinition::OriginalMoleculeStructure",
"name": "Original molecule core structure",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 36237,
"type": "InternalFieldDefinition::BatchSolventOfCrystallization",
"name": "Batch solvent of crystallization",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 39278,
"type": "InternalFieldDefinition::InventoryDebitField",
"name": "Inventory Debit",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 39279,
"type": "InternalFieldDefinition::InventoryLocationField",
"name": "Inventory Location",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 65061,
"type": "InternalFieldDefinition::MoleculeBatchIdentifier",
"name": "Molecule-Batch ID",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 76937,
"type": "InternalFieldDefinition::AminoAcidSequence",
"name": "Sequence",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 76938,
"type": "InternalFieldDefinition::Mixture",
"name": "Mixture",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 76939,
"type": "InternalFieldDefinition::NucleotideSequence",
"name": "Sequence",
"data_type_name": null,
"unique_value": false,
"required_group_number": null,
"overwritable": false
}
],
"batch": [
{
"id": 67509,
"type": "BatchFieldDefinition",
"name": "External ID",
"data_type_name": "Text",
"unique_value": true,
"required_group_number": null,
"overwritable": false
},
{
"id": 74436,
"type": "BatchFieldDefinition",
"name": "CAS",
"data_type_name": "Text",
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 67138,
"type": "BatchFieldDefinition",
"name": "Date",
"data_type_name": "Date",
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 67139,
"type": "BatchFieldDefinition",
"name": "Person",
"data_type_name": "Text",
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 67141,
"type": "BatchFieldDefinition",
"name": "Vendor",
"data_type_name": "Text",
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 67142,
"type": "BatchFieldDefinition",
"name": "Note",
"data_type_name": "Text",
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 67143,
"type": "BatchFieldDefinition",
"name": "Initial Amount",
"data_type_name": "Number",
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 67144,
"type": "BatchFieldDefinition",
"name": "Current Amount",
"data_type_name": "Number",
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 67145,
"type": "BatchFieldDefinition",
"name": "Location",
"data_type_name": "Text",
"unique_value": false,
"required_group_number": null,
"overwritable": false
}
],
"molecule": [
{
"id": 90700,
"type": "MoleculeFieldDefinition",
"name": "Purity",
"data_type_name": "Number",
"unique_value": false,
"required_group_number": null,
"overwritable": false
}
],
"protocol": [
{
"id": 82356,
"type": "ProtocolFieldDefinition",
"name": "Category",
"data_type_name": "Text",
"unique_value": false,
"required_group_number": 1,
"overwritable": false
},
{
"id": 82357,
"type": "ProtocolFieldDefinition",
"name": "Description",
"data_type_name": "LongText",
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 84307,
"type": "ProtocolFieldDefinition",
"name": "Method",
"data_type_name": "Text",
"unique_value": false,
"required_group_number": null,
"overwritable": false
},
{
"id": 84308,
"type": "ProtocolFieldDefinition",
"name": "SOP",
"data_type_name": "File",
"unique_value": false,
"required_group_number": null,
"overwritable": false
}
]
}Notes on the GET Fields API call
This API call will provide you with the “type” and “name” values of all fields within a Vault. The JSON returned by this API call is organized into the following sections of fields:
- Internal
- Batch
- Molecule
- Protocol
If you are creating dynamic mappings for data files being imported via the POST Slurps API call, this GET Fields API call will be useful in discovering the details of how each field in your data file should be mapped. For example, when using the header_mappings parameter in a POST Slurps API call, you need to include the ID and type of data field being mapped to and this new GET Fields API call provides these details.