EMS API Help Page

ems/apiUser/{apiKey}

Gets the API User with the specified API key.

ems/attachments

Uploads a file attachment against an EMS entity.

ems/attachments?entityType={entityType}&entityId={entityId}

Retrieves a collection of attachments linked to an EMS entity.

ems/attachments/{identifier}

Retrieves the attachment from the EMS repository with the given identifier.

ems/experimentFactors?experimentId={experimentId}

Gets the formulation, substrate and condition factors for the Experiment with the specified ID.

ems/experimentFactors/substrates/values/{substrateValueId}/lotId?value={value}

Updates the Lot ID for the specified substrate factor value.

ems/experimentFactors/conditions

Adds a condition factor to an Experiment.

ems/experimentFactors/substrateLists

Adds a substrate list to an Experiment.

ems/experimentFactors/formulationLists

Adds a formulation list to an Experiment.

ems/experimentFactors/conditions/{experimentConditionId}/values

Adds a value to an Experiment condition.

ems/experimentFactors/substrateLists/{substrateListId}/substrates

Adds a substrate to an Experiment substrate list.

ems/experimentFactors/formulationLists/{formulationListId}/formulations

Adds a formulation to an Experiment formulation list.

ems/experiments/{id}

Gets the Experiment with the specified id. The Experiment returned contains a collection of Protocol Conditions applied to it.

ems/experiments

Adds a new standard Experiment to a study.

ems/factors/conditions

Gets all condition factors in the EMS. Each Condition object returns a collection of Units available for it.

ems/plates?experimentId={experimentId}

Gets the Plates for the Experiment with the specified ID.

ems/plates/{plateId}/barcode?value={value}

Updates the barcode for the Plate with the specified ID.

ems/plates/{plateId}/comment

Adds a Comment to the Plate with the specified ID.

ems/plates/nextBarcodeNumber

Gets the next barcode number for a Plate. This barcode number is used in generating the full Plate barcode.

ems/plates

Adds a Plate to an Experiment.

ems/protocolConditions/{conditionId}

Updates the Value and Units for the specified Protocol Condition on an Experiment.

ems/protocols

Gets a list of all of the currently active Protocols the current sessions's user has access to.

ems/protocols/{id}

Gets the Protocol with the specified id. The Protocol returned contains details on all the condition options.

ems/results

Submits an EMS Results Package for processing. The package is checked for errors and the result of this check is returned from the API call. If the package is valid, it is added to the processing queue.

ems/results?experimentId={experimentId}

Starts an experiment result search in EMS. Note that this is the V1 controller implementation of this endpoint.

ems/results?experimentId={experimentId}

Starts an experiment result search in EMS. Note that this is the V2 controller implementation of this endpoint.

ems/resultsExport/{datasetId}

Initiates a download of the export CSV.

ems/studies

Gets a list of all of the currently active Studies available to the session user.

ems/studies

Adds a Study to a Project.

ems/userTokens/publicKey

Gets the modulus and exponent of an RSA-generated public key as base64-encoded strings for encrypting passwords.

ems/userTokens/create

Creates a user access token for the EMS API, authenticating through Windows Authentication.

ems/userTokens/createExternal

Creates a user access token for the EMS API, authenticating through a users' domain credentials.

ems/validate?entityType={entityType}&entityId={entityId}

Gets the validation results for a specific Entity.

ems/version

Gets the version information for the API.

ems/wells?plateId={plateId}

Gets the Wells for a specific Plate. Each Well object returned contains a collection of factors (Formulations, Subtrates, Conditions and Condition Sets) applied to it.

ems/wells/{wellId}/barcode?value={value}

Updates the barcode for the Well with the specified ID.

ems/wells/{wellId}/conditionValue

Adds a condition factor value to a Well

ems/wells/conditionValue?plateId={plateId}

Adds a condition factor value to all Wells for the specified Plate.

ems/wells/{wellId}/substrate

Adds a substrate to a Well.

ems/wells/substrate?plateId={plateId}

Adds a Substrate to all Wells for the specified Plate.

ems/wells/{wellId}/formulation

Adds a formulation to a Well.

ems/wells/formulation?plateId={plateId}

Adds a Formulation to all Wells for the specified Plate.

fml/materialLots?materialId={materialId}

Gets the non-disposed Lots for the FReg Material with the specified ID.

fml/materials?materialName={materialName}

Gets the Material with the specified name. The Material details are retrieved from the Stain Lookup spreadsheet only.

stability/experiments

Creates a stability experiment based on the information given in the content body.

stability/measurements

Gets the details of all Stability Measurements defined in the EMS.

stability/plates/{id}

Gets the Stability Plate with the specified id.

stability/sampleDeletionReasons

Gets all of the reasons that can be used when deleting a Stability Sample.

stability/sampleDueDates?plateId={plateId}

Gets the dates when the samples on a Plate are due to be measured. Here, a Plate refers to a product at a particular temperature.

stability/samples/{id}

Gets the Stability Sample with the specified id.

stability/samples/{id}?deletionReasonId={deletionReasonId}&deleteFutureSamples={deleteFutureSamples}

Deletes the Stability Sample with the specified id. Optionally deletes all future samples for this product/temperature combination.