Introduction
The Benchling In Vivo API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
Authentication
The Benchling In Vivo API uses OAuth 2.0 access tokens to authenticate requests. These Bearer tokens are the predominant type of access token used with OAuth 2.0.
The Client Credentials grant type is used by clients to obtain an access token outside of the context of a user.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Errors
Benchling In Vivo uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a request failed, etc.). Codes in the 5xx range indicate an error with the In Vivo servers (these are rare).
Metadata
Benchling In Vivo entities—including Study, Cage, Group, Animal, Sample and Project have a metadata parameter. You can use this parameter to attach key-value data to these In Vivo entities.
Metadata filtering
You can perform filtering of List API responses on metadata that you’ve added to entities that support it.
You can use the metadata query param so the filter term only looks up metadata values. To filter for a specific metadata key-value pair, use the metadata key name as a query param, such as study-internal-id=STUDY-1234.
Metadata Glossary
Benchling In Vivo entities that can attach metadata—including Study, Cage, Group, Animal, Sample and Project can store a glossary field, used to design a schema. For example you can set metadata to be a select field, or a date field.
Pagination
All top-level API resources have support for bulk fetches via "list" API methods. For instance, you can list studies, list animals, and list cages. These list API methods share a common structure, taking at least these three parameters: limit, page, perPage.
Versioning
When backwards-incompatible changes are made to the API, a new, dated version is released.
The latest version is 2022-12-14.
All requests use your API key settings, unless you override the API version.
To set the API version on a specific request, send a X-Studies-Api-Version header.
Your API version controls the API and webhook behavior you see (for example, what properties you see in responses, what parameters you’re permitted to send in requests, and so on). Your version gets set when you create your API key. When a breaking change is introduced to the Benchling In Vivo API, a new dated version is released. To avoid breaking your code, we don’t change your version until you’re ready to upgrade.
Each webhooks listener is configured with a specific API version. If you wish to change the version of your webhook events contact support.
Breaking Changes
2022-12-14
-
Measurement response
variablesreplaced withcalculations.
Global Resources
OAuth Token
An OAuth Access Token is a string that the OAuth client uses to make requests to the resource server.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
Indicates the token type value. |
|
|
The amount of time that an access token is valid (in seconds). |
|
|
The requested access token. |
Create a token
Fields
| Path | Type | Description |
|---|---|---|
|
|
Denotes the flow you are using. |
|
|
Your application’s Client ID. |
|
|
Your application’s Client Secret. |
Request
POST /api/public/v1/oauth/token HTTP/1.1
Content-Type: application/json
Content-Length: 161
Host: localhost:8080
{
"grant_type" : "client_credentials",
"client_id" : "610451c8-b07a-4d1b-8c18-617161bed063",
"client_secret" : "y3Er7yQdg3pZNhlJmhCJV2GdF8ORLbhGcHIrEPdQ"
}Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1019
{
"token_type" : "Bearer",
"expires_in" : 86400,
"access_token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2MTA0NTFjOC1iMDdhLTRkMWItOGMxOC02MTcxNjFiZWQwNjMiLCJqdGkiOiI5ZjViYTJiYy0xNzUxLTQ5MWItYTY2ZS03M2NkNDIxMmRmMzMiLCJpYXQiOjE3MzIyNjg1MjgsIm5iZiI6MTczMjI2ODUyOCwiZXhwIjoxNzMyMzU0OTI4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.jzcpksT7hiNAq5B0ht220cvLEmJXCtRaShvWyEEhgFhSMwUHfsZEVqRUWFwsdRkkeoySgSdQPiuSIvwjWQbpk30U73l1WMW8IOBefE3vrlMPdb_XRSR2QQ-4ql791s1I50DP8hmQubmXi1CxpstGIjoy3kInPoHlFFZwYfHWz8hWLsp5sEHqDSyp7QRqzYXYqiecQuadWsCAbbGXB2q02mzEHmyMww7nGTC1WQ9Hf3lvapG7yrxd-O9-e7HZs5eDzl-FE4t8OLydqlbBr61VN5onWISoAqt-IY9yrVoD8VaJlI27KNH2PU5papW3w0oY0rCjKOvG5Bzv-2vZBIiEdHXEBjTAm3IBLrxTkidfPvHOztuaLqQ8MwV7Qp97kXlCNK8jyi7_T7icPvgIcWM1KCnd_iwubIbh2NjIfiM47zRjPqSXbwYF4AyrXlXMqCqTh5BDhzV-kHt7YcKh9BPlXb5ynr7TXRywAgluIU0hdnqQDeKm-paErBy_Gf9kDuSHv_rYNylABXLuzbOHsmijGC3n-kB4SwhVbJ2cSwhQwt5MZFRMuHb4MaUiKtYRwj7esXZwHOT7SeJfxWL3fxNtgsHEgjaUwNCSkMEIUnAY6AxXWGFrio-mIlX-Esjdr5V3-F-r-uGhb-jdM1xFpMft800XEqBhRGFIeaH908CiiU8"
}Glossary
Your team’s glossary and their configurations for entities that include—Samples, Observations and Euthanized reasons.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the glossary. |
|
|
The title the glossary. |
|
|
The group associated to the glossary. |
Retrieve a glossary item
Retrieves the details of an existing glossary.
Request
GET /api/public/v1/glossary/gly_7BBuhNhViWxOALm1G4xL9Y HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkYWU1ZDhlYS00NjdlLTQyNmMtODA2NS0yNjhlZGMyZTFmMDEiLCJqdGkiOiJmOTRmYjAyNC1jZDczLTQxY2EtOGNhNS02NDRiNDRhNzA2MjgiLCJpYXQiOjE3MzIyNjg1MTYsIm5iZiI6MTczMjI2ODUxNiwiZXhwIjoxNzMyMzU0OTE2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.UcqJCMy5E3qzclV9EyaoY3M58gRGyd3w9rsLQdr91yxTG62W915KVl6y8TnO_M1_a3jBLHhcm5tVrpRcfHJLsjRTuTM-pmXUDRYhwsmr2XLnlH__a9WblPqjQXDPv6NNy7-lzb32cNVxiErLrF1MqOEUabu6xNXNKtnYBmRRgXADHiwqGCPbko0RLZ9BqHrqufefuR9Yd3rqsn7CuMPGsejTyZVSrRYrkH6aTM2KetKqzxIyYaOWtzbC0firBmkdJjLR3mLe-3-ZEIIPx6ksW_5auIyEpVB_8TmnpQtdTjWi8DoyT4YWC6s94Cl6sjjiGk1zrKWzc5ZHxW_gVhaDYCuFI2ydmaa-LVOh0tdloyFMjjpp8WSaOMYa11b_XZEBXSyu4IvsK9gvGE_TeK8msTdIlm3x49UBP58KTx1sJLPKaYB_c8FidkF7l3RVOJ-R9cFmz3gKRMSjVWhx2yUQuCwl32Qwuxv1LAR2zzsQjKkfGRc3dvUnP-kufuiOQCE9ufSeXB0cQ8oruKSPYaI497t0sFTzmmfSRgFcwZNt7lhDHtNKsyokI-4uFXtSfGBxyoJd_805MpriAolkYezceRyuOvL_P3w5JrVmkAHxCbRPMS5ddZpkiwIno7Nyyy3HtEWMnA7O0BJcpdXOONYEd4NzlVk_Bw699629CkATeM8
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 100
{
"id" : "gly_7BBuhNhViWxOALm1G4xL9Y",
"title" : "Euthanised",
"group" : "euthanize_reasons"
}List all glossary items
Returns a list of your glossary.
Query parameters
| Parameter | Description |
|---|---|
|
The number of glossaries to return per page. |
|
The page of glossaries to return. |
|
Filter glossaries by type |
Request
GET /api/public/v1/glossary HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3ZjIzMDljYS1hOTEyLTQxYTAtYWU0ZS0wYmY5M2YyNmFjYzEiLCJqdGkiOiIwNWRiMmY3YS02MDE4LTRjZDEtOWRkNy0zMjY4ZmEzNTg1ODciLCJpYXQiOjE3MzIyNjg1MTUsIm5iZiI6MTczMjI2ODUxNSwiZXhwIjoxNzMyMzU0OTE1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.j1pPIXOqfEugGmCZPIWNP2Bpp6HyRWYsp5dqmjkuOkhwBejArsM9klpoIBIuvdgFfKBLxzHMNYABvRWyawzI9JWJRTe9bB1ysvfEaqNSenqrDmcFafuAZ8CTRhwpHSLDhbrVH8if6uwNaVMIwkV1I1avZY1mKDPpvoWZJ5bvtZaHq44_FytHCCVD-twTfXGMb7mT2AL7VPUYEH7EBQUT-JyA375i8hkqXmCYFxBuy45Dfr48mdDqfuzGhtQVqesj4OacFF93v0fJGqEAiwQgcPlYcdto5zAy-grIzklSZmUNoYL1x0gcD6NISTVB848DugXPfQzQYZDeBVE98q3KwwwHFKgJUrlT8hEBMVL9ubRhIoAelRZSPdULuZgmSn5L6Hs_3pi6Ea_ds3HwsCl5MhzGXWp1HlpmFVZjOEVqNsqLRO8iqUUM_RXCkChANrdZS8muCF_767jLAd6bnBfxtBAWTbbovy7zhj6YTegUqUJvMMzsqqzSZaVSNpzQcvKEjLRznc4auLY1ekDNqP92ZERC91d_x-J7ArUpOGL0pbkOikFtNjcgIbANeYqnhji18eXKOZY4X0ENtyXEcGZ0gNpjOQpJIbgfku5ai2agBcAfJxgCZFbdhgZO516up4pnTiROpvsz4MzIkNIc2XQfpSzQX7-ifyZyIE8v0ecVvwI
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 496
{
"data" : [ {
"id" : "gly_4kKajwjpGFn131r9E4dAxT",
"title" : "Brain",
"group" : "samples"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/glossary?page=1",
"last" : "http://localhost:8080/api/public/v1/glossary?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/glossary",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Animal Resources
Animal
This is an object representing an animal in your facility. You can retrieve it to see the status, date of birth, sex, species, strain, identifiers and treatment group of the animal.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the animal. |
|
|
Unique catalog number of the animal. |
|
|
The name of the animal. |
|
|
The number of the animal. |
|
|
The strain of the animal. |
|
|
The species of the animal. |
|
|
The sex of the animal. |
|
|
The date of birth for the animal. |
|
|
The identifier for the tail of the animal. |
|
|
The identifier for the ear of the animal. |
|
|
The identifier by tag of the animal. |
|
|
The identifier for the donor patient of the animal. |
|
|
The tracking date for the animal. |
|
|
The disease induction date for the animal. |
|
|
The terminated date of the animal. |
|
|
The user who terminated the animal. |
|
|
Specifies whether animal survived the study before being euthanized. |
|
|
The metadata associated to the animal. |
|
|
The study of the animal. |
|
|
The study of the animal. |
|
|
The cage of the animal. |
|
|
The created timestamp of the animal. |
|
|
The last updated timestamp of the animal. |
Create an animal
Fields
| Path | Type | Description |
|---|---|---|
|
|
The cage of the animal. |
|
|
The name of the animal. |
|
|
The strain of the animal. |
|
|
The sex of the animal. |
|
|
The date of birth of the animal. |
|
|
The metadata to be associated the cage. |
Request
POST /api/public/v1/animals HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5ODRjNGE5Zi1iZTQwLTRhMTktYTczNy0wNDVhZjRlM2IwNDMiLCJqdGkiOiI4MjEzNzM3My05MGExLTQ3OTYtYTU4YS03MWZlYmMyODkzOTciLCJpYXQiOjE3MzIyNjg0OTksIm5iZiI6MTczMjI2ODQ5OSwiZXhwIjoxNzMyMzU0ODk5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.RCTHUH1u1njSILj92C-YP1C3EVmIqxQnwTmNA-e4oO-xYmealcGgcTI373BEZK4phq9_ReKkDlNyJMiDOUUK4cBC-1Jlozl2tDienOvnCR3GXod5k431gZTDXowSCsrLxTkXMh4nBzOPFsqh2uaV74ieamRb-MVcNJvbqM-kFjys5KFXPHqegnGhU7M3QBRw3LrlReUX5FcUFwwmsarkR9G6Jjp2rPub2j79wHtQLairv1NudPlqymxfqKBRHf4rHWn1ckCQG3Za3kzicwGn5iNVnMxtKRmuswf2XC8Df2NESRuRgnngcygAJsj_Tgms36ygUjt3psmunPgTeO9p2FN6L4IvG7RIcnIK85xzXf4NDrw2T_zdU-yMdJwNsBSN0-YJvENGknrYK1RJ6WYe7REpnRx_PcCc4CQj3nsjsMPM-YT6cUZYmwL1S1598-gDuuWIp1B_nB0W9gpSL7BabEOAjHxJs0es-GEXUE1do2RljFUM5kn-v4U5fe2MIxGVAPp9ZBkH3ppG8DKs9S1wn3UiY6K1wAG1zXBk1aU2QtJPkhFerVLejZtePKNgf_2Tsbpn39DlmHHOhSQQ_-YSjg3NIkCI58Uc9Z8YAcVGBr2EhxcHzGjEg93y4ZAT1FiLsb-W8qPJg4UPPpWCyz-izX2pr-aLQyIqvcxTVvQH9W4
Content-Length: 198
Host: localhost:8080
{
"cage_id" : "cge_4clI9dKqMxl7ABdVb7I7z3",
"name" : "Animal 1",
"strain" : "gRS6SPmEiH",
"sex" : "m",
"dob" : "2024-11-22",
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
}
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1815
{
"id" : "aml_1XwiPCr7Tk0UXzoN3ATGFD",
"catalog" : "A0000001",
"name" : "Animal 1",
"number" : 1,
"strain" : "gRS6SPmEiH",
"species" : "YPLZptHiSg",
"sex" : "m",
"dob" : "2024-11-22",
"tail" : null,
"ear" : null,
"tag" : null,
"donor" : null,
"tracking_date" : null,
"disease_induction_date" : null,
"terminated_at" : null,
"terminated_by" : null,
"terminated_reason" : null,
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"study" : {
"id" : "sdy_4cf098TnRm7uDNi50ZoKrY",
"project_id" : "pjt_7jq7PhEKCsaHagFJveLKen",
"name" : "WggB8ufYRZ",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "AoChrL7vEf",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_1SJPMqQqUmIQu3rO5tagvH",
"name" : "0fpwQOFRXD",
"email" : "qdNg512F@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_1oq4WBaPFAegEjmUJhkFiq",
"name" : "Uy9Dv7r25g",
"email" : "1ihXfYUI@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:38.959418Z",
"updated_at" : "2024-11-22T09:41:38.959418Z"
},
"study_group" : null,
"cage" : {
"id" : "cge_4clI9dKqMxl7ABdVb7I7z3",
"study_id" : "sdy_4cf098TnRm7uDNi50ZoKrY",
"name" : "99A2rU0txz",
"catalog" : "C0000001",
"metadata" : {
"cage-internal-id" : "CAGE-1234"
},
"created_at" : "2024-11-22T09:41:39.152355Z",
"updated_at" : "2024-11-22T09:41:39.152355Z"
},
"created_at" : "2024-11-22T09:41:39.207368Z",
"updated_at" : "2024-11-22T09:41:39.207368Z"
}Retrieve an animal
Retrieves the details of an existing animal.
Path parameters ./api/public/v1/animals/{animalId}
| Parameter | Description |
|---|---|
|
The unique identifier of the animal. |
Request
GET /api/public/v1/animals/aml_2ouImOQ4J6qkQPKfxXtXvd HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkMTM2YTk2ZC04NmFlLTRhNmMtODM5Yy0wOWYzMWRmOTE1ZWQiLCJqdGkiOiI5NzA3NTUwYi01OTZmLTQ1ZTItOTZjOS1jMGI0ZmM5YTQwYzgiLCJpYXQiOjE3MzIyNjg0OTksIm5iZiI6MTczMjI2ODQ5OSwiZXhwIjoxNzMyMzU0ODk5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.aCxLqosJGNFcd4TWt7SovQJWkDZKBroh8fj8VnJkKcysi6r0GfyGbTyb9s7lCB0OMBoy_K7j3lVOyNXpU0KLrjE-9pClBU4DsUzpUfEtGTlKC3n5UHz4b8_IzDXwW0QSY5FJRzeqWoNbqP6nNr3hMpa58itHtklsLP1qO2vDNHXDyWm9Ir1r28Ys3dELg64-fyHDOVNVy3zx6Q5Ou0ld-j2UlqquNqxFi53bV2A6JiGeIKzJ3OXo-yEmoH-F0bPqLKR7v_7lioT2ZJ6RMYdGhTCFfi-itldiBDuJ_vritYc7GTcoHIPUiJsUD8hw6BT7s7dCkrWzo5yc7wTHVkIcj81uOEy4lEKLLsU8Xz_fVQhl-gGm1uGc2UnvgyYqxyJfcTMJCCtuA98hn5bJziSpBw7UieEzx5gHK9axxUdZLsO2ep8JRMOern-b_-0ej0-Jx3DvCfc1NY82j4JgxsEwSUNXTkGzceDppkwdO8Qccmtr5ojUaCSzfEW8-E_70vSSxM3bWXl87MAh3Az5g3tQZRxGxMiSaQ3mAU3mtOHTyV8460t3eXPM6wE6JBUrEbRwPWr7gfCsrmJLXWh_Qn_pyY9ji5NO94AaPTFEZEP_QCY3T9-LLZpv8zygF83iQyP-gIcwaBLb_phHqv6racF9RgtqTvC72O8kc8a9TTxJW34
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2495
{
"id" : "aml_2ouImOQ4J6qkQPKfxXtXvd",
"catalog" : "A0000001",
"name" : "YqYp9FStJB",
"number" : 1,
"strain" : "TmgBLVTkqW",
"species" : "qdovDpfWyT",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "NiAbpTDAYe",
"ear" : "tUqwM1pL7z",
"tag" : "DzpIClVKx3",
"donor" : "uw5w4Pl5hW",
"tracking_date" : "2024-11-22",
"disease_induction_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_8mz1sXfHjDfqI3JJzgGjS",
"name" : "6dPZPKeHdx",
"email" : "l0yG9Hy1@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_2TJY45JA0rEzcShCEk66SA",
"title" : "Found dead",
"comment" : "bIn9kCviX6"
},
"disease_survivor" : false,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"study" : {
"id" : "sdy_HIXFHN70u1OXNoKcvVPn7",
"project_id" : "pjt_4g4fnxEUmIAx2iOuZm5xog",
"name" : "QWxQC342yP",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "mk4yjPpdC0",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_7bJeHR5snGIEANYAuLnvOa",
"name" : "RK3AoVtrRW",
"email" : "1rfyAbhm@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_1ZQPZsCvhKzZ997kE7sBqO",
"name" : "Wa5JU3SHFD",
"email" : "et68gV1M@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:39.588940Z",
"updated_at" : "2024-11-22T09:41:39.588940Z"
},
"study_group" : {
"id" : "grp_SA0iDZXze6R7pZZPdK4ww",
"study_id" : "sdy_HIXFHN70u1OXNoKcvVPn7",
"name" : "MrNL7tw9Gw",
"no" : 1491926378,
"color" : "bNcJeg81fz",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-internal-id" : "GROUP-1234"
},
"created_at" : "2024-11-22T09:41:39.794257Z",
"updated_at" : "2024-11-22T09:41:39.794257Z"
},
"cage" : {
"id" : "cge_6KZ4R3KtWvy9JEUYfEljEq",
"study_id" : "sdy_HIXFHN70u1OXNoKcvVPn7",
"name" : "he1bBiROfL",
"catalog" : "C0000001",
"metadata" : {
"cage-internal-id" : "CAGE-1234"
},
"created_at" : "2024-11-22T09:41:39.774928Z",
"updated_at" : "2024-11-22T09:41:39.774928Z"
},
"created_at" : "2024-11-22T09:41:39.809373Z",
"updated_at" : "2024-11-22T09:41:39.809373Z"
}Update an animal
Updates the specified animal by setting the values of the parameters passed.
Path parameters ./api/public/v1/animals/{animalId}
| Parameter | Description |
|---|---|
|
The unique identifier of the animal. |
Fields
| Path | Type | Description |
|---|---|---|
|
|
The study group of the animal. |
|
|
The cage of the animal. |
|
|
The name of the animal. |
|
|
The strain of the animal. |
|
|
The sex of the animal. |
|
|
The date of birth of the animal. |
|
|
The metadata to be associated the animal. |
Request
PATCH /api/public/v1/animals/aml_fVukuuMn5dZryE95hVwzx HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmN2FlYjlkMi1iZWE0LTQ3ZWYtOTI2ZC0xM2Y5OTExNzUwOTYiLCJqdGkiOiJiOWMyODIwYy0xMmVlLTRiZmQtOTQyOS03OTRmYTFiYzFjNTIiLCJpYXQiOjE3MzIyNjg1MDEsIm5iZiI6MTczMjI2ODUwMSwiZXhwIjoxNzMyMzU0OTAxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.cXAhUCon9Bb4kg9-rnazNSMvu6BnQvOFaBSF6YmHK4EOG_DGQI7WmnkMNA0PlP-k8W0ydSSJmT5Xyf9Uw7pOd-0mIHeeZtEQx-pIOFslEyauvVaaSaYTJkKd5eMiYD1Mp_hV9FsyNuZwsaF_JobSPkl9xXTUUhtLLg_QL221mBGTIegkwCbeJ1hT1yK846aF-Od3z5k0zD9cGsA65yeMVOUxBn-na6LUNcqNtW0aKwHgnNjB02NGJ6BjI6EOHXAy50YZpXfN3da6scnwHTQPAQt8Gcx7rE64h3AwJSd11l9kBLVqrvXlWguKFpkyAvH_SUONcjShh_d-Pp-h4EM_Uob312esWkfs1LGE21lxGP-827ZIcAmInlL8HOP31vpmmNJP3xCq5WzCLw9n_NMUjn6BKSanrXJjdILcyu795RFTWPafL9fDIJPmNHGexXKR3HhIt4dvYcuVc8mnVgzirLqtiO0jZqfrIreJSVGwwfbYUBsSMKxfnbaruPDJ_LIhudgBT8HED2EG9-AjoaQEcK0lURdnfnOx62BfFDV9Ioc4Vzw1QBXvriRDX_K_3pEDyJzlU85ys5W1uDLNyWZQGlXVPg_WCU7G-S3vmW-rVXGdm_HXJBLoG5t_n7EIBK2TlN7rn5f35la2TGuhmds3F01OCX_wTqrYEbWf3YVCI3M
Content-Length: 264
Host: localhost:8080
{
"study_group_id" : "grp_6ZaLDy8G8sGshmrUCyoMmI",
"cage_id" : "cge_IDFv5KmKsywZhv1sPM5l0",
"name" : "Benchling In Vivo Animal",
"strain" : "RQPWIYHKH2",
"sex" : "f",
"dob" : "2024-11-20",
"metadata" : {
"animal-internal-id" : "ANIMAL-4321"
}
}Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2273
{
"id" : "aml_fVukuuMn5dZryE95hVwzx",
"catalog" : "A0000001",
"name" : "Benchling In Vivo Animal",
"number" : 1,
"strain" : "RQPWIYHKH2",
"species" : "SIEgFBvMZ8",
"sex" : "f",
"dob" : "2024-11-20",
"tail" : "NsjRzhcccA",
"ear" : "YjhifOCn0V",
"tag" : "onF7Gw9T20",
"donor" : "nyg9GZUlKl",
"tracking_date" : "2024-11-22",
"disease_induction_date" : "2024-11-22",
"terminated_at" : null,
"terminated_by" : null,
"terminated_reason" : null,
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-4321"
},
"study" : {
"id" : "sdy_79hHHnptFuPv3kzsMpChRX",
"project_id" : "pjt_2xOA81MgAsJYngTGmy2dIq",
"name" : "L5sZtEqTko",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "jKPgUxjzHu",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_MuMt8YNlRcmOHGzo15Ajb",
"name" : "XkNlpneJp7",
"email" : "o7LEwaBV@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_5RN4fY0skX17HmC9Viphsx",
"name" : "s3ZDH6YYQ4",
"email" : "128Ix5lW@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:41.013283Z",
"updated_at" : "2024-11-22T09:41:41.013283Z"
},
"study_group" : {
"id" : "grp_6ZaLDy8G8sGshmrUCyoMmI",
"study_id" : "sdy_79hHHnptFuPv3kzsMpChRX",
"name" : "JUDGEvCcUI",
"no" : 255262552,
"color" : "#929675",
"max_animals" : 10,
"control" : false,
"metadata" : {
"new-study-group-internal-id" : "NEW-GROUP-1234"
},
"created_at" : "2024-11-22T09:41:41.225834Z",
"updated_at" : "2024-11-22T09:41:41.225834Z"
},
"cage" : {
"id" : "cge_IDFv5KmKsywZhv1sPM5l0",
"study_id" : "sdy_79hHHnptFuPv3kzsMpChRX",
"name" : "xBefYXGy8u",
"catalog" : "C0000002",
"metadata" : {
"new-cage-internal-id" : "NEWCAGE-1234"
},
"created_at" : "2024-11-22T09:41:41.231743Z",
"updated_at" : "2024-11-22T09:41:41.231743Z"
},
"created_at" : "2024-11-22T09:41:38.235593Z",
"updated_at" : "2024-11-22T09:41:41.258699Z"
}List all animals
Returns a list of your animals.
Query parameters
| Parameter | Description |
|---|---|
|
The number of animals to return per page. |
|
The page of animals to return. |
|
Filter animals to return by name |
|
Filter animals to return by cage ID |
|
Filter animals to return by catalog |
|
Filter animals to return by sex |
|
Filter animals to return by metadata value |
Request
GET /api/public/v1/animals HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiMTAyYTc3YS03OGYxLTRiYWItYTRiZi1kYzk1MTBiNTc3M2YiLCJqdGkiOiI5MDVlMDQxYS05MzA2LTQ2MTYtOTBlNC04ZjA0YTRiYThlYWUiLCJpYXQiOjE3MzIyNjg0OTQsIm5iZiI6MTczMjI2ODQ5NCwiZXhwIjoxNzMyMzU0ODk0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.JrZqjHHnxc8yXO-cl3dR8FUeTdd8aMq8fcKddx0dCI8F9aNvVwkZJKJC2P5zGsEru9xGk_QRzyH4FVt7pcdKRi_ft-ZcQqTD600tNXaEpZTSya8jlzOHv7ZyEpmEJ68IJZEHzOlElsPoOge7nB8i2KGBjc2nC3RR7W2YyT6Q93eOFijmBot8sWGHXV9PM7gIj5-fApX1vlrL20VR4j2WCMJJczRyhkWOg3X32_P8RTY_Ljbpp21rOefGh0O2-UKVTD2Ve5B9uEko-i41t6rnYW-7BvetVb03unJQFhkqbRlTzwM1gNKNY9HvMKVCwpFPqm-LVh4eGag-_q0O3-6sIfBRGLiTRPqrdeSk210yKR2Lgj4Qelp6IgU9rV92r35wxdOR-JqzmUA81MqS24bLNJ0z8aSRaWJLi8xmQ9qzipgRzqx7Qe9EAJti-KM_eJECCpFP3qqKVVp7_8EgE1FK81SiVGXWlkYRJUlMK8onBJSJosUrn2TlvwQKCiw5l5jiOmH0S49Hlmn38jThQToCd1-R8tsFPuqkFmmZlLC-Ln_bw4IZ-oAGC475zBB6ykcnfXvhp6W8hkK6Mh1k7VK61hydM684GL2N-fp5JR9ezKSJvv2GR2MAqN7hUESCqolt-pRE-dJ24XI3HmmiWGl2kJ5g0-A--xbS-fW30nnt9Go
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3072
{
"data" : [ {
"id" : "aml_4hkL4CH5hE4N0B61ACtXDG",
"catalog" : "A0000001",
"name" : "MBJMYw2wPx",
"number" : 1,
"strain" : "1XmggBJq13",
"species" : "CzgyOpzFyV",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "W5Un5gXfer",
"ear" : "w4fEsy3iYr",
"tag" : "n2CrNJCnEv",
"donor" : "s1d4BrbutX",
"tracking_date" : "2024-11-22",
"disease_induction_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_4VRoxQfhRXCuTqfvjgtNZL",
"name" : "qyZuYqcz3K",
"email" : "4L4SOzWy@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_5F5UOYiX3rOgDxFvWW1SnV",
"title" : "Found dead",
"comment" : "uaohbjEk2q"
},
"disease_survivor" : false,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"study" : {
"id" : "sdy_xzFaYhsKKnDey27lhBuyi",
"project_id" : "pjt_68XxJAmp3GioKhkk3mkzzA",
"name" : "eYlzAZKlCh",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "qdSHSFsvXO",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_3zLkR9Vk7ZEU9KAPCLluyY",
"name" : "VFu6ZIMJix",
"email" : "5Gputg93@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_1OKsqnTu8d0z2jZTKtbSa9",
"name" : "BO3mHxy8zC",
"email" : "vdvdFArY@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:34.109436Z",
"updated_at" : "2024-11-22T09:41:34.109436Z"
},
"study_group" : {
"id" : "grp_6WihbStIa6VKQ9NXpp4Es1",
"study_id" : "sdy_xzFaYhsKKnDey27lhBuyi",
"name" : "jjTMSI3XNN",
"no" : 742113757,
"color" : "0iI01QmfLa",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-internal-id" : "GROUP-1234"
},
"created_at" : "2024-11-22T09:41:34.398883Z",
"updated_at" : "2024-11-22T09:41:34.398883Z"
},
"cage" : {
"id" : "cge_4HiYfPCW8tkAmozFtEdg9K",
"study_id" : "sdy_xzFaYhsKKnDey27lhBuyi",
"name" : "3J1IIQZ3qS",
"catalog" : "C0000001",
"metadata" : {
"cage-internal-id" : "CAGE-1234"
},
"created_at" : "2024-11-22T09:41:34.362744Z",
"updated_at" : "2024-11-22T09:41:34.362744Z"
},
"created_at" : "2024-11-22T09:41:34.413535Z",
"updated_at" : "2024-11-22T09:41:34.413535Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/animals?page=1",
"last" : "http://localhost:8080/api/public/v1/animals?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/animals",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Delete an animal
Removes an animal.
Path parameters ./api/public/v1/animals/{animalId}
| Parameter | Description |
|---|---|
|
The unique identifier of the animal. |
Request
DELETE /api/public/v1/animals/aml_3St2lMrcblbNpys19Nins5 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2Yjc2ZjYxMC0yMDk0LTQ3ZWQtOTQ5MS1jNWEyZTgzYWUwMDEiLCJqdGkiOiI3NmZjMGRjOS0wZDY2LTQ4YWEtOWM3NC0yMzU0NzNkN2U1YWEiLCJpYXQiOjE3MzIyNjg0OTksIm5iZiI6MTczMjI2ODQ5OSwiZXhwIjoxNzMyMzU0ODk5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.KF8UatDnwSbZk6k3KOEQnAUgjbXp59fqdT-rSxj3xliG4LDbbb6F93cVc0Q5QcB4P6_mZxzYD3g20yoVBwULeNYwR66f0Ro4XhR1kVfhOrcBIGdzxmnsNLDe3M0meFjfEhWetcgwk153Zg6oT8ywFA2gFJCw3QKkx2nR2O7Jm4JPUlezfnDj3LZoSdWY8PYg2W-gBRxHsT-jmVstpKbocX1ZfyLn8_yk4s8Kd8ZaS5BemI9K5HLyKxvzZQMkkPSwQY0LuRbj0tpC8-zHIou9aD1_ovs3Q4IW37CVUj5eqfAd1c6b_vAY6e8dGUiUQKagj7ZoJgLpV321CgYJiMRKHhzfcrlRBElw57X5hCfxPAW_NSvy0i1ruBdUG6Eob4JVGaYkn1VejwH_c9ZE3S2Vmt7QwNiDVLhoELcHTBJPMjZCn168nUawQUnwoxcljzt6akkxZtOy9ddQscxgqZoPOhN4dJrs1u5VKv7nFEpcjtdzzvRWBuRW--IJPORE_F0JTE9c2efADD3yN1WuX82CcSZCx8ccsjaiSJXpPATA2PuYEa_xmTAq4-g3ksOc-lkc7v9JMEh5AnFdNlTeZLjus7kQKc23C7lTA1YZ_VWUzer2K8ZW19TpVk-71sSCuAz8T1o4WZ8_waXcAfrsYKstiFcVwXYR4LUWMYW0Spf1OJ8
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22
{
"deleted" : true
}Animal Dosage
This is an object representing a dose of compound administered to an animal. You can retrieve it to see the dosing method, stock, volume, concentration, date administered, user administered and the treatment group of the animal it was administered to by of the dosage.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the dosage. |
|
|
The name of the treatment type. |
|
|
The created timestamp of the dosage. |
|
|
The dose concentration associated with the dosage. |
|
|
The dose volume associated with the dosage. |
|
|
The stock concentration associated with the dosage. |
|
|
The volume of the dosage. |
|
|
The study associated with the dosage. |
|
|
The animal associated with the dosage. |
|
|
The measurement associated with the dosage. |
|
|
The user associated with the dosage. |
|
|
The treatment associated with the dosage. |
|
|
The optional weight that’s taken during a dosage. |
|
|
The created timestamp of the dosage. |
|
|
The last updated timestamp of the dosage. |
Retrieve an animal dosage
Retrieve an animal dosage.
Path parameters ./api/public/v1/animals/{animalId}/dosages/{dosageId}
| Parameter | Description |
|---|---|
|
The unique identifier of the animal. |
|
The unique identifier of the dosage. |
Request
GET /api/public/v1/animals/aml_5vXgBYmQFHO4m2YLUOpQIe/dosages/dsg_5yrhtcwhgjQDaxiQ0xXpPD HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3ZTcwOWQ1NS01MzYyLTRjMGUtYTgzYS0zNjk0YzE2YjcxZmYiLCJqdGkiOiJkM2EyZDgzNi1iOGMxLTQ2YzQtOGIyMC1iYjhjNmYyNmM1YjEiLCJpYXQiOjE3MzIyNjg1MTAsIm5iZiI6MTczMjI2ODUxMCwiZXhwIjoxNzMyMzU0OTEwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.hWVNmS_ivhdphx7r4ggMgi-AQ4W7Aby06NUOevDXQvnuM2HmhtvwMc0QtHxNKdhQRXbDzKDAAswgOzi9fM5GvZ4L8dOyJO05vhEIaMqQ0PGMDXSIRuDUACL2OrBxqUQJgH2klzupZ1XWhx7AVbeus-8zDKT4AiRoZeONBTfsJhc0oZ5i5w73Wi0fh_oRq522xNNGS4gjYiloodfByOjiqaLsEX3FwBYn5ZUYkoed5KJda4ZCWtEduONBvLqV7glFHYostwK4CDIOAuBngR4W3JuO3fProZKQZTco521oZtKZvK9-Sw2JVStr92nBUOYvtgECC6EJwolNuAlrImq8ZFdux7FB_8sBdADC3fPnsv_rikijl7kG5i4jZKxlQG7wX3hvtdGFgHr2c1JUO7W9EfdDtfWM3YC8OpJggbupF6HOUNDoY4m_30Isz8iz8nBHIQBKIEdwDGdJ01OmkX-A4AGVdxfbDhiYBicRJvGPAxrldr41aMALfLGRxmi-A4XPeHoI4JZ94QkiB3nob5Yoq29fiPSVVszmIHCH10VN_9KN9UvtIuvGkzWcXjkBWLUo4Vi5P42fPonO9BckSeDkiO8mnxm6xGhIjmR6wXZM2NlsFJoBlQhH9oHoA-TfNvdC9ZnSR3F1qOksA0stLeXrnI8BN5UW2jOoxMfXNJWtw3w
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 4505
{
"id" : "dsg_5yrhtcwhgjQDaxiQ0xXpPD",
"name" : "Example dosage",
"dosed_at" : "2024-11-22T09:41:50.937249Z",
"weight_at_dosing" : null,
"dose" : {
"unit" : "mg/kg",
"value" : "8.65",
"display_unit" : "mg/kg",
"display_value" : "8.65"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "19.37",
"display_unit" : "ml/kg",
"display_value" : "19.37"
},
"stock" : {
"unit" : "mg/ml",
"value" : "21.28",
"display_unit" : "mg/ml",
"display_value" : "21.28"
},
"volume" : {
"unit" : "µl",
"value" : "39.63",
"display_unit" : "µl",
"display_value" : "39.63"
},
"study" : {
"id" : "sdy_7XEEgXTU3X0KBrFQGG9e4J",
"project_id" : "pjt_3Htd6KVPgqvEKjJ2YrjlRl",
"name" : "uq9Ip93Fv0",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "P392Ff05s5",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5VfrRUhh5PJk1hsTRlvl2r",
"name" : "4Gh9wG5vTI",
"email" : "lsWJqvxm@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_2Tek3fREcTUjThszlzHTrJ",
"name" : "TmIib2mtOs",
"email" : "5CQATMfY@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:50.607018Z",
"updated_at" : "2024-11-22T09:41:50.607018Z"
},
"animal" : {
"id" : "aml_5vXgBYmQFHO4m2YLUOpQIe",
"study_id" : "sdy_7XEEgXTU3X0KBrFQGG9e4J",
"study_group_id" : "grp_4qzUtfA5mfgVGhrQ3MR4Qn",
"cage_id" : "cge_3Mc6587qJl0qKqjXHW0ZoT",
"catalog" : "A0000001",
"name" : "RfxSVrT4eW",
"number" : 1,
"strain" : "GTJP9DuoZ3",
"species" : "ncSk2XawWH",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "QtDSH7OLeE",
"ear" : "VS8cJPeeQf",
"tag" : "hoW8z3HJrf",
"donor" : "ubZJKJj3jN",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_6HociOZ1IubKMakHgX8U3",
"name" : "x2tS3pD6QF",
"email" : "30NWZO4d@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_4aC6OwOwMBpZWrRfsnCTnn",
"title" : "Found dead",
"comment" : "JeSLgyyzTO"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:41:50.815601Z",
"updated_at" : "2024-11-22T09:41:50.815601Z",
"disease_induction_date" : "2024-11-22"
},
"measurement" : {
"id" : "mst_4OI8E7cyvsHAGbj4n1cPXl",
"study_id" : "sdy_7XEEgXTU3X0KBrFQGG9e4J",
"animal_id" : "aml_5vXgBYmQFHO4m2YLUOpQIe",
"measured_at" : "2024-11-22",
"calculations" : [ {
"id" : "vbl_6hL2IayvFbKsiwsx6aqmQ1",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "55",
"formula" : "weight",
"variables" : [ ]
} ],
"created_at" : "2024-11-22T09:41:50.909760Z",
"updated_at" : "2024-11-22T09:41:50.909760Z"
},
"user" : {
"id" : "usr_3UbI0NoYf4MAz0yJs2ZA3h",
"name" : "2vtJB Overwatch",
"email" : "8xq4kjSf@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:41:50.579227Z",
"updated_at" : "2024-11-22T09:41:50.579227Z"
},
"treatment" : {
"id" : "tmt_2bdPTilh7ZuvZ8d6dhAGVC",
"study_id" : "sdy_7XEEgXTU3X0KBrFQGG9e4J",
"type" : "custom",
"name" : "2E1ou92uwQ",
"dose" : {
"unit" : "mg/kg",
"value" : "5",
"display_unit" : "mg/kg",
"display_value" : "5"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "15",
"display_unit" : "ml/kg",
"display_value" : "15"
},
"stock" : {
"unit" : "mg/ml",
"value" : "10",
"display_unit" : "mg/ml",
"display_value" : "10"
},
"volume" : {
"unit" : "µl",
"value" : "8",
"display_unit" : "µl",
"display_value" : "8"
},
"metadata" : {
"treatment-internal-id" : "TREATMENT-1234"
},
"created_at" : "2024-11-22T09:41:50.929769Z",
"updated_at" : "2024-11-22T09:41:50.929769Z",
"external_entity_id" : "JGj3ZUaQuv"
},
"created_at" : "2024-11-22T09:41:50.937276Z",
"updated_at" : "2024-11-22T09:41:50.937276Z"
}List all animal dosages
Returns a list of your animal dosages.
Path parameters ./api/public/v1/animals/{animalId}/dosages
| Parameter | Description |
|---|---|
|
The unique identifier of the animal. |
Query parameters
| Parameter | Description |
|---|---|
|
The number of dosages to return per page. |
|
The page of dosages to return. |
Request
GET /api/public/v1/animals/aml_1eG5XsGiF9SryqtGLih5Kh/dosages HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3OThhMmIyMC0yNzQ4LTRjZjYtYTFhMC04MTcyMTIwYzM1YTkiLCJqdGkiOiJlY2VmNzkyOC01MGZjLTRhOTMtYTFkNC05YTgzYmNiZGZiZjgiLCJpYXQiOjE3MzIyNjg1MDgsIm5iZiI6MTczMjI2ODUwOCwiZXhwIjoxNzMyMzU0OTA4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.i97f34GeAlVAygftfcJ-FEHhUFd4BRRfnXFmn46ot8L7qEc_rmx8e4TI_gnw1fJOzyfiKqIrsyVWjqDtoSReY87dKw0Lw43aPo-HhzR48bWmcvpC_ybv5Sbj6KeT8H71Ipw3cy1_fFKhbrneRfhys-jqXE1UlFCjTrRKcdm44xOvdGQwe1OtqyTSD77Hr3mMZ_ofwSWG7dKmCFi5LDD7hCWmDZW6umovQpsbmwyCGY-zy8j7jzlEv071jhQ9VZozUpTraLlySFklJveSJgEThh-EQ5bFwb_BGIVpHFJLVu9zRd260MtD2HZugYwR1L3jHEDcWOYCWqvQAUbZGB7lHLgfnyavUVZEifhqgizSeRQg6yn3qT-mL4elxeG5l6Brxh71Z3trgS20xiEtxSUDBNOKdvgX6YVXMzS8HglN0-eTrTwDmSvYHJ_P9Dlwx4YZZlp-SUqB6dIne64InXpPgoGu96tOtr7yxXQOBfLVpqIl4nfSh9TElXelXCqyUBFHhL7FfXH2HaZBBdcORirYPaJv90LZ5uMGG6gpG-XnJZ8SBiHbISOG3Quw8mQ8os0lCgS-ms2Z9lgGonqMNbvunuJBKujXZTjdmCoXS_l5VCLMQ9d12uzvIHEvTEw4AnFPCKulzclqW3kN91JvSYLUoWmd4_dwChmtYLk9VdinrgU
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 5346
{
"data" : [ {
"id" : "dsg_1vPx44RWSmqMnzuC8QnSLG",
"name" : "Example dosage",
"dosed_at" : "2024-11-22T09:41:48.465589Z",
"weight_at_dosing" : null,
"dose" : {
"unit" : "mg/kg",
"value" : "2.35",
"display_unit" : "mg/kg",
"display_value" : "2.35"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "16.94",
"display_unit" : "ml/kg",
"display_value" : "16.94"
},
"stock" : {
"unit" : "mg/ml",
"value" : "22.44",
"display_unit" : "mg/ml",
"display_value" : "22.44"
},
"volume" : {
"unit" : "µl",
"value" : "35.67",
"display_unit" : "µl",
"display_value" : "35.67"
},
"study" : {
"id" : "sdy_6VL4CUefQRQxT2u7duFrOp",
"project_id" : "pjt_3JOJn1FXKLmVOPhzEEtsK1",
"name" : "utTBK1VOZZ",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "mvfd5dtbn0",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_6vIoDDdIYgaRHvfbltzzt4",
"name" : "qDb3RxhxPV",
"email" : "1LCgkAND@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_34CkCLaLBaXgcvNIcfKZhd",
"name" : "9edxKvK5c5",
"email" : "R2JtMM1R@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:48.129040Z",
"updated_at" : "2024-11-22T09:41:48.129040Z"
},
"animal" : {
"id" : "aml_1eG5XsGiF9SryqtGLih5Kh",
"study_id" : "sdy_6VL4CUefQRQxT2u7duFrOp",
"study_group_id" : "grp_60R2EEZnaECjK6Tl8W6QrT",
"cage_id" : "cge_5B2udm4fBASNLI1kjqe1U5",
"catalog" : "A0000001",
"name" : "1BmkHzs6V8",
"number" : 1,
"strain" : "ve6a7tVFlK",
"species" : "VrZyhybEPT",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "1wdptZ2y3Q",
"ear" : "FSOK5KbqMR",
"tag" : "v5YuQ6DjcL",
"donor" : "4M3qcTXa8W",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_7gMkuVspN1ZcyMgWfv3fro",
"name" : "LReqxDyXdm",
"email" : "RiRVbPPl@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_7RdhNNB8IwPe3CXcAcVeLe",
"title" : "Found dead",
"comment" : "m0xjbq97I1"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:41:48.340626Z",
"updated_at" : "2024-11-22T09:41:48.340626Z",
"disease_induction_date" : "2024-11-22"
},
"measurement" : {
"id" : "mst_2Bqaeiw6gQRZ7TOvPGgFcn",
"study_id" : "sdy_6VL4CUefQRQxT2u7duFrOp",
"animal_id" : "aml_1eG5XsGiF9SryqtGLih5Kh",
"measured_at" : "2024-11-22",
"calculations" : [ {
"id" : "vbl_4WPmwbA9crZ6JncpXtH0UW",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "55",
"formula" : "weight",
"variables" : [ ]
} ],
"created_at" : "2024-11-22T09:41:48.436774Z",
"updated_at" : "2024-11-22T09:41:48.436774Z"
},
"user" : {
"id" : "usr_5cq3XbyPXNOgNSDM7Z4q99",
"name" : "KUNDD Overwatch",
"email" : "FA4pCIkK@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:41:48.093683Z",
"updated_at" : "2024-11-22T09:41:48.093683Z"
},
"treatment" : {
"id" : "tmt_6gtv09ojZNh6aleOjr0SoL",
"study_id" : "sdy_6VL4CUefQRQxT2u7duFrOp",
"type" : "concentration",
"name" : "LnoDpKyXkF",
"dose" : {
"unit" : "mg/kg",
"value" : "5",
"display_unit" : "mg/kg",
"display_value" : "5"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "15",
"display_unit" : "ml/kg",
"display_value" : "15"
},
"stock" : {
"unit" : "mg/ml",
"value" : "10",
"display_unit" : "mg/ml",
"display_value" : "10"
},
"volume" : {
"unit" : "µl",
"value" : "8",
"display_unit" : "µl",
"display_value" : "8"
},
"metadata" : {
"treatment-internal-id" : "TREATMENT-1234"
},
"created_at" : "2024-11-22T09:41:48.454353Z",
"updated_at" : "2024-11-22T09:41:48.454353Z",
"external_entity_id" : "wl8obvw0tj"
},
"created_at" : "2024-11-22T09:41:48.465605Z",
"updated_at" : "2024-11-22T09:41:48.465605Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/animals/aml_1eG5XsGiF9SryqtGLih5Kh/dosages?page=1",
"last" : "http://localhost:8080/api/public/v1/animals/aml_1eG5XsGiF9SryqtGLih5Kh/dosages?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/animals/aml_1eG5XsGiF9SryqtGLih5Kh/dosages",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Animal Measurement
This is an object representing a measurement that has been recorded from an animal on a day. Measurements are created in studies which have a preset, typically for observable data like tumour volume or blood glucose.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the measurement. |
|
|
The measured at timestamp of the measurement. |
|
|
The calculations associated to the measurement. |
|
|
The study of the measurement. |
|
|
The animal of the measurement. |
|
|
The user that recorded measurement. |
|
|
The created timestamp of the measurement. |
|
|
The last updated timestamp of the measurement. |
|
|
The measurement calculation variables. |
Retrieve an animal measurement
Retrieves the details of an existing animal measurement.
Path parameters ./api/public/v1/animals/{animalId}/measurements/{measurementId}
| Parameter | Description |
|---|---|
|
The unique identifier of the animal. |
|
The unique identifier of the measurement. |
Request
GET /api/public/v1/animals/aml_22jAEsS7gU4MvyaFrq9GTo/measurements/mst_6VJM1fVXhgta1ojsPguMfo HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwMjMzNzhjZS0wN2FhLTQ5N2QtODA2ZS1jMmZhNjg2ZWU4ODkiLCJqdGkiOiI0NTM3N2EyNy00NGRhLTQ2YjYtYjA3ZC1iNzE2NWMzMTA1NGUiLCJpYXQiOjE3MzIyNjg1MTgsIm5iZiI6MTczMjI2ODUxOCwiZXhwIjoxNzMyMzU0OTE4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.muv6X9iVm1ktnHbC8LRfhZZTZzEz8ImFl1hapM8iJHIq0VLpq0ZwW5-JxUEDU8S_6ZSxwx6j8Er6_eVPQurVEetwrz0WNiE1YUa5ukoLHIZ4DoCf5HEp6ExbWlqQ2nDZXl93fS93l1L5GLzJhOSH2poYVU-69AkNXR_9PgMAekm2zUHdrr_LnHMwkz08oLaAKiSaN2Ulowz9mFNZi73j6ApaAaer6NIHUg8Whs-SCwzya9_GUfHAdO0JLcznmW3SbZyR_gNWLKnX4aYT7pYJgBM-Hr4CgeW0dlrAR1nwtd5qIr6FutEVk9yDu1OpvbsBs7qnlptkeqeStpZeaILdpxskTINMOzyc_gVrP4ntxAnvE0TfP-kqf_8UPi3yW1HGnCUc4IYwZYRGEGmsNbq9ULPiBccHFUfLzpcbWJ1_uZ-m76cK0R02leLadCArtHUTfyfxBUpPZTEGmbABiXDrDUJuFbXHJeJWpzPr0jVcuxNszlFxx1CAOK9NV0f6P4OTf5LymimhPxjy-VQlQlrDDo-B16Hut-gtZWxVt801UgV1LCT-Hwq4F9Q094B612hesEv6ZYuvl9Ob60pTN8Luun6I6bOBHDzXCPOdAryqTDgdNGSkRdOBWxSa6xuDzkEMQgZ-PT11o1Tv1B26dwVkC6x2bwCIW4V_w18q1M-HBRE
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3204
{
"id" : "mst_6VJM1fVXhgta1ojsPguMfo",
"measured_at" : "2024-11-22",
"calculations" : [ {
"id" : "vbl_1ZouLG9p2rHDsF8gkIkeqj",
"key" : "tumour_volume",
"name" : "Tumour Volume",
"unit" : "mm³",
"excluded" : false,
"value" : "75",
"formula" : "(width * width * length) / 2",
"variables" : [ {
"id" : "vbl_3k83QYyRBJ5CG7TJINicGo",
"key" : "width",
"value" : "5",
"unit" : "mm"
}, {
"id" : "vbl_4z0oSS2AvOmY0xE39M1xge",
"key" : "length",
"value" : "6",
"unit" : "mm"
} ]
}, {
"id" : "vbl_2r2IFJeXC8FaFstUc4UWna",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "55",
"formula" : "weight",
"variables" : [ ]
} ],
"study" : {
"id" : "sdy_5CQhyFD61rwnsMbAgSmTRo",
"project_id" : "pjt_4Xac3U9FVMMXQUHIPf89Sf",
"name" : "GAmKeqSunM",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "2zcaQJDkLt",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_1qPdxx8wPyoQz130srs6HC",
"name" : "ZynjGZbC6C",
"email" : "VyCWcUwy@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_3wWM4fa63235moYtpCLvci",
"name" : "pbjxjd0O5T",
"email" : "dU0z6dRb@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:58.655292Z",
"updated_at" : "2024-11-22T09:41:58.655292Z"
},
"animal" : {
"id" : "aml_22jAEsS7gU4MvyaFrq9GTo",
"study_id" : "sdy_5CQhyFD61rwnsMbAgSmTRo",
"study_group_id" : "grp_1Kcfxor4zG0Z1vDyDOioOk",
"cage_id" : "cge_3Q7AP4GJm75etuOtYMWCGQ",
"catalog" : "A0000001",
"name" : "M1Tr9vG2F3",
"number" : 1,
"strain" : "ryn7eHeYDr",
"species" : "8cUpSvagMy",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "d1Flfodi8T",
"ear" : "WHEkzMn3ZG",
"tag" : "voauZgT8Tb",
"donor" : "Mqz3qEwbXJ",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_2UQuT5Vq7elaUqLWxdKu6t",
"name" : "rrT1b1hQW1",
"email" : "VPImOzdP@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_4BRJgQcqxHG8GVk19HXeBT",
"title" : "Found dead",
"comment" : "ITnQLkXduI"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:41:58.872197Z",
"updated_at" : "2024-11-22T09:41:58.872197Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_5f7pUCV52noIJqmgMfWqM7",
"name" : "Jx7sa Overwatch",
"email" : "Q8FV5C2R@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:41:58.615107Z",
"updated_at" : "2024-11-22T09:41:58.615107Z"
},
"created_at" : "2024-11-22T09:41:58.976140Z",
"updated_at" : "2024-11-22T09:41:58.976140Z"
}List all animal measurements
Returns a list of your animal measurements.
Path parameters ./api/public/v1/animals/{animalId}/measurements
| Parameter | Description |
|---|---|
|
The unique identifier of the animal. |
Query parameters
| Parameter | Description |
|---|---|
|
The number of measurements to return per page. |
|
The page of measurements to return. |
|
Filter measurements to return by date (yyyy-mm-dd). |
Request
GET /api/public/v1/animals/aml_5zRLaUemDJt48OXYogvs63/measurements HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyYzg3OTk5Yi01MjQ0LTQ4NDEtODc5NS00ODgzYzlkYzQ5NTkiLCJqdGkiOiJmZTY3MmJkOS00NzNlLTQ5NGUtYjMzOS0xMzVhZTE5OTVlMTciLCJpYXQiOjE3MzIyNjg1MjAsIm5iZiI6MTczMjI2ODUyMCwiZXhwIjoxNzMyMzU0OTIwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.QGbExevnjSwgNyHJvdQAzWLplQjsnLDTZW8ZC7GnkzZcFHBR9D637drk9cdjH2VonRf5qlBI242Lg4ghfOnTyBrIE-ILlt6t8b18b8vOncdAz59qFJQ9n8ap1x1Rdb1UaVlXbNloZW_EP6Sk2_DDma1_DYRLKIGC-sNacdXVnvQb1gV_EkOqqX9I1OFKkvbbsdu0rZ3Qgo4hnZ6vV6sRQ1E4MHaFw4I8_wRfDex7ONQLJfphIfp4_Ca_zVAwFvaV-WW3D_0QJpcVylSkzeBQRimQZUJu1giRElaKnkpmxpjBijjD8xHSqBlU2GLyy0EjFv6ROq--E76rARn2VpJLfaGpd5a6ycwNl9WcK4WsojyGVSjyikNFGfqnPkRxCNTvz6eQlMcraIbXNQfdB5ENOhEzx57K2eC9ltUG6u6G3k-FeSWWIfNl61njhGVmgNgiy1nfiOYphrMUW3BOmbRwG30XTJ7cfvzXvQH2uuquz13E1Rpth4NQx8ZQaNQBlJJIsNzrMOY8344b1kWlllHNrLU-yp2reDUFt6EEPDLciRQ43feOanzj1UaUe7KyVWZ9a0FSclDOo3Mv2FV2DulcgFFxGTAmlndVHk1XL7S5QJVYbYlErskJHTsQWaex8VXeOENQlqRXqvPHYOAmxBLTf6xH9AJutRyiJnava96z7HQ
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 7378
{
"data" : [ {
"id" : "mst_z4DD81gBBYQd4FgwlzJj7",
"measured_at" : "2024-11-22",
"calculations" : [ {
"id" : "vbl_1kqSLmF15aS08PgMEso58F",
"key" : "tumour_volume",
"name" : "Tumour Volume",
"unit" : "mm³",
"excluded" : false,
"value" : "75",
"formula" : "(width * width * length) / 2",
"variables" : [ {
"id" : "vbl_25w6oPPLBqVs8XZT9BDb3I",
"key" : "width",
"value" : "5",
"unit" : "mm"
}, {
"id" : "vbl_6HO2AF8Mw1vzeDzUPbmTqu",
"key" : "length",
"value" : "6",
"unit" : "mm"
} ]
}, {
"id" : "vbl_7GlJeVF6MM8XS6Eh56VJbF",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "55",
"formula" : "weight",
"variables" : [ ]
} ],
"study" : {
"id" : "sdy_12zCiJOum1M1HbB0FxIoEa",
"project_id" : "pjt_1YNDVWzzBYJd26dVK0RNjb",
"name" : "VJkVS1tvar",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "8t85GcV1k7",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_iOTIKnuWfVWg3hSavcJB5",
"name" : "7MozTeFOPI",
"email" : "vfTgthAs@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_1tEXXBp2xj0aHl6amTRh3e",
"name" : "yyb6r4Jtfz",
"email" : "uU0JMOk6@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:00.667254Z",
"updated_at" : "2024-11-22T09:42:00.667254Z"
},
"animal" : {
"id" : "aml_5zRLaUemDJt48OXYogvs63",
"study_id" : "sdy_12zCiJOum1M1HbB0FxIoEa",
"study_group_id" : "grp_3deouaQIVnl1JLei5S85pe",
"cage_id" : "cge_va3tNjcyUqfA7IZkF6Baj",
"catalog" : "A0000001",
"name" : "gsHgLHSr43",
"number" : 1,
"strain" : "diHEkzcJUd",
"species" : "jgv2ZpXXtl",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "SxwdkB7ReZ",
"ear" : "bwDpTp8fad",
"tag" : "xLgnE4HZuV",
"donor" : "yZ8k0Ye6Ii",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_1K4MoxwOZvEussSBy5NDdG",
"name" : "9nvPXrVt9T",
"email" : "ckKtNshQ@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_2MaR4EsszKOsV1xPgCXczQ",
"title" : "Found dead",
"comment" : "iwV5JQV42r"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:00.861751Z",
"updated_at" : "2024-11-22T09:42:00.861751Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_60sZeNor8JBPue4Ei3VQ9N",
"name" : "Z8ywL Overwatch",
"email" : "dhjzLh2i@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:00.622714Z",
"updated_at" : "2024-11-22T09:42:00.622714Z"
},
"created_at" : "2024-11-22T09:42:00.952571Z",
"updated_at" : "2024-11-22T09:42:00.952571Z"
}, {
"id" : "mst_694049hqlTnKNJq2UvTuih",
"measured_at" : "2024-11-21",
"calculations" : [ {
"id" : "vbl_6ZVOhQDBo5LOoRtsYyVKXX",
"key" : "tumour_volume",
"name" : "Tumour Volume",
"unit" : "mm³",
"excluded" : false,
"value" : "196",
"formula" : "(width * width * length) / 2",
"variables" : [ {
"id" : "vbl_52zRXs7oO0ax8nNbHwcAo7",
"key" : "width",
"value" : "7",
"unit" : "mm"
}, {
"id" : "vbl_3BZjlZterpYsFpdcgWM7BN",
"key" : "length",
"value" : "8",
"unit" : "mm"
} ]
}, {
"id" : "vbl_11KufOnva1L7zXYNmN7OGa",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "56",
"formula" : "weight",
"variables" : [ ]
} ],
"study" : {
"id" : "sdy_12zCiJOum1M1HbB0FxIoEa",
"project_id" : "pjt_1YNDVWzzBYJd26dVK0RNjb",
"name" : "VJkVS1tvar",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "8t85GcV1k7",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_iOTIKnuWfVWg3hSavcJB5",
"name" : "7MozTeFOPI",
"email" : "vfTgthAs@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_1tEXXBp2xj0aHl6amTRh3e",
"name" : "yyb6r4Jtfz",
"email" : "uU0JMOk6@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:00.667254Z",
"updated_at" : "2024-11-22T09:42:00.667254Z"
},
"animal" : {
"id" : "aml_5zRLaUemDJt48OXYogvs63",
"study_id" : "sdy_12zCiJOum1M1HbB0FxIoEa",
"study_group_id" : "grp_3deouaQIVnl1JLei5S85pe",
"cage_id" : "cge_va3tNjcyUqfA7IZkF6Baj",
"catalog" : "A0000001",
"name" : "gsHgLHSr43",
"number" : 1,
"strain" : "diHEkzcJUd",
"species" : "jgv2ZpXXtl",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "SxwdkB7ReZ",
"ear" : "bwDpTp8fad",
"tag" : "xLgnE4HZuV",
"donor" : "yZ8k0Ye6Ii",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_1K4MoxwOZvEussSBy5NDdG",
"name" : "9nvPXrVt9T",
"email" : "ckKtNshQ@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_2MaR4EsszKOsV1xPgCXczQ",
"title" : "Found dead",
"comment" : "iwV5JQV42r"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:00.861751Z",
"updated_at" : "2024-11-22T09:42:00.861751Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_60sZeNor8JBPue4Ei3VQ9N",
"name" : "Z8ywL Overwatch",
"email" : "dhjzLh2i@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:00.622714Z",
"updated_at" : "2024-11-22T09:42:00.622714Z"
},
"created_at" : "2024-11-22T09:42:00.972793Z",
"updated_at" : "2024-11-22T09:42:00.972793Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/animals/aml_5zRLaUemDJt48OXYogvs63/measurements?page=1",
"last" : "http://localhost:8080/api/public/v1/animals/aml_5zRLaUemDJt48OXYogvs63/measurements?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/animals/aml_5zRLaUemDJt48OXYogvs63/measurements",
"to" : 2,
"total" : 2,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Animal Observation
Retrieves the details of an existing animal observation.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the observation. |
|
|
The unique identifier of the glossary item. |
|
|
The title of the glossary item. |
|
|
Text related to the observation. |
|
|
The type of observation recorded. |
|
|
The value of the observation taken. |
|
|
The timestamp of when the observation occurred. |
|
|
The study of the measurement. |
|
|
The animal of the measurement. |
|
|
The user that recorded measurement. |
|
|
The created timestamp of the project. |
|
|
The last updated timestamp of the project. |
Retrieve an animal observation
Retrieves the details of an existing animal observation.
Path parameters ./api/public/v1/animals/{animalId}/observations/{observationId}
| Parameter | Description |
|---|---|
|
The unique identifier of the animal. |
|
The unique identifier of the observation. |
Request
GET /api/public/v1/animals/aml_7hCre6vYaORFUONj6JnDuL/observations/obs_zgIrQk01wK2lFzchccdXD HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmNTc3ZWRhYi1mZTg1LTQ3YzEtODA0ZS0wN2JjZDA2ZDExMTkiLCJqdGkiOiIyZGU0ZjcyZi01YzEyLTQ4NmUtOTgxMi0yM2IwYjZkYzQ3ZTYiLCJpYXQiOjE3MzIyNjg1MjksIm5iZiI6MTczMjI2ODUyOSwiZXhwIjoxNzMyMzU0OTI5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.XFlypVTm_DCe6KCfU17wZPlPEX7WX3N3sqcMKL9DjwBQEs-M1IIQP88nBw4JJpwFf3mCVk40FjCYFvwI8IRJvSit0Qv0HIvnxmPqHRB-L9bn3B26UmcvpV1nFEys0BJz2pSNYRRrd8fNIdnd3PmO95MKcCMwvlyRwjw4v96vvHP-vfkejlQ4VE3T__hny82th4NI6LraQqPqbzdoO4w3shzuHve1Nq-uKEk4Rx-U3agkbpLUaRSExztxRdRjODaXWxUjimqu4EnxGjrxdTGIRRiAejVt_Ki4Fh_3rYqqmQ2bkWdFsCvwkgIxZFl6qYnchp4rpFzePPuWJxMuNRF2T4vZbxobKFAhyTTBYryTZ8she0_Q3KhQfQ_Y1PJ7s7dsMZ2QVx7PAQpWs1CCJG0W7Tg2_rzAHWs9Jo686qw7zrUWNNlZX5Bwo7zORUUh2hTxp2SRmuooQTMhXq6wpOOMLS-k0z1gH6Zs5FoSx2925onl8N6KRODxpFyKhmlyeSO2OD61wxeLGN1Kj9QipXfZbKyPFilEcm1zeHZ_hBDzep4WYMMuzn_CcoWnUBILz4cjgmMQb4ERxZIBpG63B9g2mINv9lNEjCuh2cmq96RcWYBeaJMZfvURlKrHkI8BVEEMcnQoiEIZMs2e_IVyW1IV0DicpFzFSj-d3rr07HMrlpA
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2673
{
"id" : "obs_zgIrQk01wK2lFzchccdXD",
"glossary_id" : "gly_70DhClgqwxcTTIegbYxInC",
"title" : "Observation Glossary",
"text" : "Example text",
"type" : "severity",
"value" : "Severe",
"observed_at" : "2024-11-22T09:42:09.420842Z",
"study" : {
"id" : "sdy_5C5xLLrDNpbYPAvghuw7Vg",
"project_id" : "pjt_5CUnMJkUXpQYzZDgLspIvl",
"name" : "2D7qB0kd9M",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "WEwqBdlSuw",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_7AGNeee8NZdKj4ZM5nOICb",
"name" : "wU1ErXjZK4",
"email" : "MIQoM5Lp@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_3QmEkcwXq5ZWs72wz0upxW",
"name" : "kgYD3sVw9T",
"email" : "t3G8keRI@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:09.109270Z",
"updated_at" : "2024-11-22T09:42:09.109270Z"
},
"animal" : {
"id" : "aml_7hCre6vYaORFUONj6JnDuL",
"study_id" : "sdy_5C5xLLrDNpbYPAvghuw7Vg",
"study_group_id" : "grp_2IQjXAqC6YlS9zdn7dKgw5",
"cage_id" : "cge_QOVtEGj13NT6IQk2JgHvt",
"catalog" : "A0000001",
"name" : "aB0E4DHkRD",
"number" : 1,
"strain" : "cfFlyoLplk",
"species" : "QD7EXLzhoA",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "ZHCdtTiD95",
"ear" : "RW0O6Di7Bq",
"tag" : "17pwPzRjio",
"donor" : "qoxRkKhKmL",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_2x2zjg5DRRVTuSKjeIf5Dv",
"name" : "AC8E3FY0PI",
"email" : "7e0iI4wq@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_jYxYQXkQOyEd0jLjjKtSF",
"title" : "Found dead",
"comment" : "5TpXLZWou7"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:09.320131Z",
"updated_at" : "2024-11-22T09:42:09.320131Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_iZP49KdJ4B61kDsWRTfs7",
"name" : "mA2oS Overwatch",
"email" : "gkIRJsBU@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:09.076140Z",
"updated_at" : "2024-11-22T09:42:09.076140Z"
},
"created_at" : "2024-11-22T09:42:09.420998Z",
"updated_at" : "2024-11-22T09:42:09.420998Z"
}List all animal observations
Returns a list of your animal observations.
Path parameters ./api/public/v1/animals/{animalId}/observations
| Parameter | Description |
|---|---|
|
The unique identifier of the animal. |
Query parameters
| Parameter | Description |
|---|---|
|
The number of observations to return per page. |
|
The page of observations to return. |
Request
GET /api/public/v1/animals/aml_7DzfJTC8GZrjBvfaeE42pR/observations HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3NzllMjcyZC05YmE0LTQ1OTItOTIwZC1iNWUzNjU2YzdhZGMiLCJqdGkiOiJmOGRjYmYwNi1hZDJiLTRlMTYtYTAyYS00ZjVkYTMwZTBhNWIiLCJpYXQiOjE3MzIyNjg1MzIsIm5iZiI6MTczMjI2ODUzMiwiZXhwIjoxNzMyMzU0OTMyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.OOkxpFhnzKwC0bYjbJsNPLoxUsMlet1Z2du0vVJ9UY4HjNjVAz7muQ4jXX61AfVYVIfB9tGQYMxGL3Q_AHXvKZQrWutH8Egcm2UjuuXxKrE3VabLQEuosYYplPoH3B7Bb6qXzdYHmbyQRL0vX3h4PU3eUilbRni3BBVmnbb8obsc_scHEmG0N5ZGa_qR30h5udKMrOaIVWNQ7R-U97lMFNCwtsTyRs3DoDzZ7iTmcHECspyDW2xXry8Wu70P-fIK2zxoEAZrUJy7mTphFNeYHqeyyFW3gAKKHy1gMoPRTLyIc3CF6npQ0VuiBtUWrMNR-MIxrJSIT8QXffdpflzm5EoW3glUREGclglRpRQg_CdP8s9kQZQO3IKCPtL1BlT_sDSBh97Ro0Y3ztMr4onIl-A3Ao6lOam7qUqQIEL_OeGxbWh0D_S3rljR9HxTG8e2NFbkL7Ek7QgOQAjyPx6AL4oIXTHg2f0r-cfGLAtD34V97_XP1ziff4qpIOnJ-pZL9fQECR5z2enlMPjKY8tnsl6gVoatSsmKJ6SNcO9-Y2Cni82qfUPtXmqBX63mbDOkXRo5m1qfjIHb-fLD7zKDgZWlcH1-1zG6i6A-wARHS6h4NZOwg-9ZINH6lqvFVSqiD83ZMaEk1BA3p-a5wfVhiiNyawoYoYjqGLKKAgKmp_k
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3372
{
"data" : [ {
"id" : "obs_59pZ5ZaWeTAxq8I8d57tF3",
"glossary_id" : "gly_1kj2HNkQlJ2rNtGWtgC147",
"title" : "Observation Glossary",
"text" : "Example text",
"type" : "severity",
"value" : "Severe",
"observed_at" : "2024-11-22T09:42:12.031694Z",
"study" : {
"id" : "sdy_6JkQl1BQgrxvqKB5z5wSi5",
"project_id" : "pjt_MdhppP6dwaLU5JWuAlO49",
"name" : "PikeBDtzAE",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "bmccB9AiBz",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_kRjwxVwNx3dH0VFAziitu",
"name" : "gzPPgwpcal",
"email" : "43Dm7pZN@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_1nhkSAXYSFDsfl4WlFmhcC",
"name" : "jJ0IjYXBbZ",
"email" : "Wed5uYmY@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:11.745418Z",
"updated_at" : "2024-11-22T09:42:11.745418Z"
},
"animal" : {
"id" : "aml_7DzfJTC8GZrjBvfaeE42pR",
"study_id" : "sdy_6JkQl1BQgrxvqKB5z5wSi5",
"study_group_id" : "grp_5fXtOxdT7PCD3ACDiJNWnM",
"cage_id" : "cge_26k5LSUYXMtqmqnjVwYWty",
"catalog" : "A0000001",
"name" : "eLq1bSnzF2",
"number" : 1,
"strain" : "cvAGNMMe8r",
"species" : "TK291QYY8c",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "zaq02SFSsT",
"ear" : "oQm7chUKGo",
"tag" : "jnYz3b4j1U",
"donor" : "Yo9b3DWUdk",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_4QLJs5oOrPFU5iujy8sZ12",
"name" : "PEjP0IM5Tw",
"email" : "MzwcBkUS@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_ooq9Vt3bLGd4TFHhHbjd1",
"title" : "Found dead",
"comment" : "MItNmxnK5Q"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:11.934666Z",
"updated_at" : "2024-11-22T09:42:11.934666Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_5eTesgxw6fdt4KkMzJVXtv",
"name" : "XA4aL Overwatch",
"email" : "Rx84O2FZ@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:11.720401Z",
"updated_at" : "2024-11-22T09:42:11.720401Z"
},
"created_at" : "2024-11-22T09:42:12.031703Z",
"updated_at" : "2024-11-22T09:42:12.031703Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/animals/aml_7DzfJTC8GZrjBvfaeE42pR/observations?page=1",
"last" : "http://localhost:8080/api/public/v1/animals/aml_7DzfJTC8GZrjBvfaeE42pR/observations?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/animals/aml_7DzfJTC8GZrjBvfaeE42pR/observations",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Animal Sample
This is an object representing a sample such as blood or tissue collected from an animal in your facility. You can retrieve it to see the sample identifier, type, details like volume or mass and any metadata assigned.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the sample. |
|
|
The sample ID of the sample. |
|
|
The type of the sample. |
|
|
The collected timestamp of the sample. |
|
|
The details of the sample. |
|
|
Comments of the sample. |
|
|
The metadata associated to the sample. |
|
|
The study of the sample. |
|
|
The animal of the sample. |
|
|
The user who collected the sample. |
|
|
The created timestamp of the sample. |
|
|
The last updated timestamp of the sample. |
Retrieve an animal sample
Retrieves the details of an existing animal sample.
Path parameters ./api/public/v1/animals/{animalId}/samples/{sampleId}
| Parameter | Description |
|---|---|
|
The unique identifier of the animal. |
|
The unique identifier of the sample. |
Request
GET /api/public/v1/animals/aml_7Wxtw6ztJoRPVrhop3ulF4/samples/spl_3nsl4mvTFS6kmCc9N0ygH5 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2NjdjN2U0Yi04NWU0LTRjOGUtYmRhZS02ZjYwNzIxZjA2NTEiLCJqdGkiOiJiOWMwOWQ2Ni01ZjFlLTQxNzMtYjJiOC0wNzVhOTc5YjFiMzYiLCJpYXQiOjE3MzIyNjg1NDUsIm5iZiI6MTczMjI2ODU0NSwiZXhwIjoxNzMyMzU0OTQ1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.PNs-JCISm0e_H10ikQgTJLdcL8_3xuCMAecoU9CrQGKg6QKzFxUECcchAqcU7DHVfpnSpujHZ9SrD3j2kSBDDCPURCKPZimOODbewGVzehsWhh0aEDpFu5ox4K4QewobRxIKy1YLI7_odDJXqUr3yXuJRkFp8osP0YZGzD0pmik8EBgEUd7Kn3bdnvdI3SzqUcd4S5CfR5KSqxIpQgIjmCRaGRaLswyEZd7lVnDgb4qL-Dy79DqHEe4zvN9F_4iA6iZxYsLAyfz4Vbyfq1a588ypi00vJtYMh1E3IAHAfukxHaSOk1oO5OXournwY9J0mW9By65ISS2ek9n94D0Qcsw5zhipHhmn2xXvd4kj8zV6Hnb3J6hkkqTTjwUUXhR44MW5UjwcyUzGCOjoyoBhk0y-L2WD9ZhNsIr2webi9FreTlDY8Btq45oPteVnxNvjrh_5ytKFdMguCToiW71uj6mXOLiFbotUr89R-YPVEs8t4Oq9CPr7b37qUsbw31kTM5pFlSgfXjLIdv0TXMj2tKP5nxivLchqEZVGVHEdvqrNOL0BlfF3qikGmIusemlOTJpOjwUBO1oVpj2dCZOsUs7la_pwwakX17JkgJwESrVnEm3ZCFfQTBBt_C3jnt_nitO2dQWbmQOfgCl6yeSPtal_TTMEULXFlkEF4uMl2W4
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2740
{
"id" : "spl_3nsl4mvTFS6kmCc9N0ygH5",
"sample_id" : "S1046490673",
"type" : "Blood",
"collected_at" : "2024-11-22T11:42:25.973351Z",
"details" : [ {
"key" : "volume",
"unit" : "ml",
"value" : "5"
} ],
"comments" : "A blood sample",
"metadata" : {
"sample-internal-id" : "SMPL-1234"
},
"study" : {
"id" : "sdy_3Q4xL1U0iT3fuRl8iVP2gZ",
"project_id" : "pjt_7EKp081FWGpPiZxbpGO9cp",
"name" : "M4KtvJ1lsv",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "jmY1nGCVgQ",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5k9HvtjmzjiXwDV49wRQPW",
"name" : "mIS0XV3wLZ",
"email" : "aBbNX1Kt@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_1EOWTMkn1aG57FWKkmmXPL",
"name" : "bZMaT0QWdb",
"email" : "5hmXHb5D@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:25.593949Z",
"updated_at" : "2024-11-22T09:42:25.593949Z"
},
"animal" : {
"id" : "aml_7Wxtw6ztJoRPVrhop3ulF4",
"study_id" : "sdy_3Q4xL1U0iT3fuRl8iVP2gZ",
"study_group_id" : "grp_4PLhO0xgImvX4QI2oUnao3",
"cage_id" : "cge_27N9as4jnCRn7tWJcbelIr",
"catalog" : "A0000001",
"name" : "q6pZF5DhrJ",
"number" : 1,
"strain" : "oHy9e1Ydql",
"species" : "6JQsjsaLIM",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "YChKMt9Hfm",
"ear" : "ORTTR1SbzL",
"tag" : "ZiPDFLC1I2",
"donor" : "hZ5owFj283",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_6M42gzLy84W9gzgBn8YkC0",
"name" : "kcSL152RGE",
"email" : "wTMADx3d@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_7Cf8NoWWqzGKRc3c1O8zZe",
"title" : "Found dead",
"comment" : "JuOUZr8ZlW"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:25.788590Z",
"updated_at" : "2024-11-22T09:42:25.788590Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_nPMj6gnPRuvhzv3oxMlyH",
"name" : "Kz2BaGr6Y0",
"email" : "zQHp7m5v@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"AFxLYb0tah" : "gkoxyV4D40"
},
"created_at" : "2024-11-22T09:42:25.952431Z",
"updated_at" : "2024-11-22T09:42:25.952431Z"
},
"created_at" : "2024-11-22T09:42:25.973365Z",
"updated_at" : "2024-11-22T09:42:25.973365Z"
}List all animal samples
Returns a list of your animal samples.
Path parameters ./api/public/v1/animals/{animalId}/samples
| Parameter | Description |
|---|---|
|
The unique identifier of the animal. |
Query parameters
| Parameter | Description |
|---|---|
|
The number of samples to return per page. |
|
The page of samples to return. |
|
Sort samples based on an attribute (animal, cage, date, group sample, study or type). |
|
The order in which the samples will be sorted (asc or desc). |
|
Filter samples to return by metadata value |
|
Filter samples to return based on sample type. |
Request
GET /api/public/v1/animals/aml_El94d8Tf4XnxQWjKDjWOf/samples HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkNTI1OGQ2YS0yOTBhLTRkZjgtYTIxNC00ZGVjODIxOTU5ZTciLCJqdGkiOiI3Y2E3ZWIyYy0xMGY2LTRhNGUtODNlZi0xZDYzYmZkODliMzIiLCJpYXQiOjE3MzIyNjg1NDUsIm5iZiI6MTczMjI2ODU0NSwiZXhwIjoxNzMyMzU0OTQ1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.gFLzRJ3_S_SK5pGgz8Tsvl1mDOSApr17m88oGiCv07K4LKhg4HFxISF4csoE7Usc-eUWs4GYiu_Hm6gLJEqXo511pDweLJ27qTkmpA2zMaJUwxi2o72AWsQg8f0YmNGebsPW58crMpO6zOFJlWkm91TTEk0C9tixFFMl99KlMG8tcDhChIdg-nwH6WWHwSqjxgSirH4MvXd01yp4PMa7TtIsRwfUH_aKR_thPCFggBs_J58DqkEYW0WblQ3DsoWRHDPueJNd3Ey3bo-VVldIOkLz3OQtsAP0SmAqoTcDLJBwCuKpD1-efE7hXho6zjcl60JPD1FPq30njT34JhrvgJ_0Wt6E9maeFUoIu00Ln86KZdsgEZuxnPQdj98VRN7lRr6WJ2GPnvb6ndmXaa0ppyPeXwCLINn5PnjvqCpSPLqYPild6k5JT3BEXER17ngRFbLmWJ2e1Iq2sjMe-BsANzQw7TIBsoya7YJ_LO4PkFMa_N_-AxA-8VIRTaXUgpIi2S_eqyLh0GXigF7ID032zvI3F-iyZ43eCTAGwuEYSg6QGS-bmyyt8VBkJ-j6XqO33kuvygH3XJih_GEvFI-BbDH7ZsKOfCXQMlyCvMS3MPWvk1tq1PNP3vZWIBNEx2G3vcLnwV708mDOJ1uvNx66l_eyS9OzbjbWc7YfJgfKgAI
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3429
{
"data" : [ {
"id" : "spl_GLcHyNbbiVktreawwgrjs",
"sample_id" : "S1159988414",
"type" : "Blood",
"collected_at" : "2024-11-22T11:42:25.074862Z",
"details" : [ {
"key" : "volume",
"unit" : "ml",
"value" : "5"
} ],
"comments" : "A blood sample",
"metadata" : {
"sample-internal-id" : "SMPL-1234"
},
"study" : {
"id" : "sdy_7aRdNJnC8cELg4LD4evV2h",
"project_id" : "pjt_1btMStEaMQ59LMlI23AZIN",
"name" : "kpXt7tgPF3",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "Euht1XTLG5",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_771iAqWPtaPny74JOIybcF",
"name" : "RiszKAUqjA",
"email" : "iG1sXmAu@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_5PystDF5c2wz4ZjCmzi1OV",
"name" : "EmkTXo1OBw",
"email" : "1xQB6iYA@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:24.669704Z",
"updated_at" : "2024-11-22T09:42:24.669704Z"
},
"animal" : {
"id" : "aml_El94d8Tf4XnxQWjKDjWOf",
"study_id" : "sdy_7aRdNJnC8cELg4LD4evV2h",
"study_group_id" : "grp_72f3ZEncluPVH4Vks8vd0U",
"cage_id" : "cge_MJr2fFys5MQ9AG6zpBYaK",
"catalog" : "A0000001",
"name" : "kt9B17y1lW",
"number" : 1,
"strain" : "m9BWP5neMM",
"species" : "r4RqaviiLu",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "aNu7KncvRC",
"ear" : "ZBPTuvOPs0",
"tag" : "2Yn6sZy35x",
"donor" : "uiwtsjfBMq",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_7dwAhFUl20x2UGVl9fVRZs",
"name" : "NF95BtmuYR",
"email" : "OuiaLq6W@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_5Dxb8dscVYKnc1kklQwnHJ",
"title" : "Found dead",
"comment" : "exbyHJ5sUB"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:24.874219Z",
"updated_at" : "2024-11-22T09:42:24.874219Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_IGxRfDublAqfOACCIK9y7",
"name" : "pnf2XamhAE",
"email" : "Uhn87iuv@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"Qlru8dC2Ju" : "ZTOoyPaNnf"
},
"created_at" : "2024-11-22T09:42:25.061694Z",
"updated_at" : "2024-11-22T09:42:25.061694Z"
},
"created_at" : "2024-11-22T09:42:25.074875Z",
"updated_at" : "2024-11-22T09:42:25.074875Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/animals/aml_El94d8Tf4XnxQWjKDjWOf/samples?page=1",
"last" : "http://localhost:8080/api/public/v1/animals/aml_El94d8Tf4XnxQWjKDjWOf/samples?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/animals/aml_El94d8Tf4XnxQWjKDjWOf/samples",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Cage Resources
Cage
This is an object representing a cage in your facility. You can retrieve it to see the catalog number, name and any metadata assigned.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the cage. |
|
|
The name of the cage. |
|
|
Unique catalog number of the cage. |
|
|
The metadata associated to the cage. |
|
|
The study of the cage. |
|
|
The created timestamp of the cage. |
|
|
The last updated timestamp of the cage. |
Create a cage
Fields
| Path | Type | Description |
|---|---|---|
|
|
The name of the cage. |
|
|
The study of the cage. |
|
|
The metadata to be associated the cage. |
Request
POST /api/public/v1/cages HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzYjdjNWVhNi01YjE4LTQyMzctYTRiNy1jMTM3MzAxZmJiNzYiLCJqdGkiOiJhMTg0OWRmMi1kMTk5LTQwYjgtOTM4OS05NWZlOTFiODQ2YmEiLCJpYXQiOjE3MzIyNjg1MDUsIm5iZiI6MTczMjI2ODUwNSwiZXhwIjoxNzMyMzU0OTA1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.FCwSSCdiaQWoy5sRnJGV3dSau0zg4U6oSLRZ0vehslGxzb0UkhTVlKfFW8ffa4zSkrahwa4GU2VefD7gM6Ci6GebLBnK-b3JN2BPpb3J8LYgozDkUpQoKTpw0lgRnCLccoMpTdEAbdxqtd-gPC0U4LhR6BVNfIyRGaaH3Bn1WA2MQR3L_sS3RTUvzvAf59YgM9A-WvlgJ4nOwzTRYfQFYmhW2y-nvGDn5mNF5Q9VuPntDSbQxEmUowmJIdsLUh5oPj3W9cbpj_XsFDNj3lyQFT4exG7CDhz5aTx-CEClAzRP-GwutaA_gXPP42ZNDh9a6sIAmFwrmkO8-iqKvmIqTFVViqKlNhJ2ckXoc9FH9W56tYi0C9jDodoPTz5J4iADciI4kLEGVxfYTjkPyyZrTsBNv766K0eGng8I1CM_vkbPOR7Jrs-AhhgduFIx2iGhC4P5xByWPeXcZe2h38YSSK_VHfuV3WZbTnBfpV0XabXuMuyj5AE_XYKvfCY_j2z7zRkzueF2ZPnXS3QzSh33RhfNV946pjMMXMk98bjkIXLNMLCXzMNRelnO5FtHyU9UhAYLuW_Vi9NJl1Uc2Xqf4E6JiohaUzTo048WdlXygTnVmk4HvnRZBSh_gjke1MBCT-8j2IvxI2u650-Mn387SdvMNoSnFo7X8ajHZ727lgg
Content-Length: 107
Host: localhost:8080
{
"study_id" : null,
"name" : "EEkEF4JHyB",
"metadata" : {
"cage-internal-id" : "CAGE-1234"
}
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 265
{
"id" : "cge_6Vmp8Ru3Zb71ntnu1nYOLr",
"name" : "EEkEF4JHyB",
"catalog" : "C0000001",
"metadata" : {
"cage-internal-id" : "CAGE-1234"
},
"study" : null,
"created_at" : "2024-11-22T09:41:45.507732Z",
"updated_at" : "2024-11-22T09:41:45.507732Z"
}Retrieve a cage
Retrieves the details of an existing cage.
Path parameters ./api/public/v1/cages/{cageId}
| Parameter | Description |
|---|---|
|
The unique identifier of the cage |
Request
GET /api/public/v1/cages/cge_19ZiYOvwTHMcaiMGT5Rfrb HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5ODkyYTRiMi05NjIyLTQxOGEtYjViZC01MzEzYTQ0MGI3NTgiLCJqdGkiOiIwZjRhYjIyNy1mMzA2LTQwOWYtOGYzNS02ZGNhMGNkNTdlYmUiLCJpYXQiOjE3MzIyNjg1MDMsIm5iZiI6MTczMjI2ODUwMywiZXhwIjoxNzMyMzU0OTAzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.jxvKexaaboTvlmqyiUjmbGieQaG8F1JvJuPXYeVquMb_jTDrPaI-9q-SQgbTATrIiNSg8XwS_GuKA99VFhhXbMpvZQfOn1mhzuF86rYZSJFCb2-JVYE6YtEkLtF2k2n5ENQDif9YeodfUKTi26fxMz6a6Ihl1yE9nWoTbebE7P4FbYRhqhjVMg8JGomAt5MUZNUmwuDY3LJI17a1nQSM4nPxf6U_sabmWnL_APg7TEHavOdrTCWdzmb3Gzlmj48lkmluNaUaaTXhDjEcOJ3SvatrzWVE48niH07AZt6ZrKElTgT4gVhywE7o3joCCwpWhXqreZwgSIi5i28E735rtyZt8eORK8ab23VnJ2jVsj3wffoUCQjiF11Nho55xkQHKJEHLvXhlyV1mqaeSeNeWmDzd5lPoHFiTR_-Dp_TPNpnvz5JzT92jywzHeskaWzUcLQp_ndkqZy8gCr0jThD-C5c_kXIT8Cd6mdGC5C64aDRDKoWJx5ZxUvg-gQeYRby3xRqBlU57zwG46rHF9DK4WZKX2UxRnX0k6iMfAh-sHlYhidxgO5VP4EuSHFjE2qx73vNIXdaw1_Hrd8-tHYV-TqVRo7gs04VJw8wMyC13DyMuDcOAT4swgIDYJaPZczCLb7ME4dyM0c6vxgu2Z_8748JMiypmiRNUfCP_22VASk
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1115
{
"id" : "cge_19ZiYOvwTHMcaiMGT5Rfrb",
"name" : "IuEMq1661A",
"catalog" : "C0000001",
"metadata" : {
"cage-internal-id" : "CAGE-1234"
},
"study" : {
"id" : "sdy_4Fl3XGc4HS0s7jpP1OBnuL",
"project_id" : "pjt_53Ygwxu8KHUQrdzWyAmsMD",
"name" : "2WSMa0xkN0",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "YEDOMMj6Zo",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_4JTpWYyeo4E4ZOofaXDRHz",
"name" : "o5eg3OKDNe",
"email" : "m4U15NmA@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_3WQBoTnxonnZADG4MKNS2k",
"name" : "L5czF0zxQw",
"email" : "n5pGArDW@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:43.656465Z",
"updated_at" : "2024-11-22T09:41:43.656465Z"
},
"created_at" : "2024-11-22T09:41:43.842614Z",
"updated_at" : "2024-11-22T09:41:43.842614Z"
}Update a cage
Updates the specified cage by setting the values of the parameters passed.
Path parameters ./api/public/v1/cages/{cageId}
| Parameter | Description |
|---|---|
|
The unique identifier of the cage. |
Fields
| Path | Type | Description |
|---|---|---|
|
|
The name of the cage. |
|
|
The study of the cage. |
|
|
The metadata to be associated the cage. |
Request
PATCH /api/public/v1/cages/cge_7BLJAAcve0y5EM4wA4JHE4 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlOTdkZDMxNC01NWQyLTRhZWUtOTA1YS04Nzk5NDVkZWIwZjQiLCJqdGkiOiJjYWJmZWJlOS1iZDJlLTQ2YWUtODVhNy0yZmIwNmEyZGZlYTYiLCJpYXQiOjE3MzIyNjg1MDYsIm5iZiI6MTczMjI2ODUwNiwiZXhwIjoxNzMyMzU0OTA2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.FJZXE2J2EYMB6IQL8ODd4TxTiox_BAYDtVXLorGKZ131-T6S2Zb8x95TWpe3DldXxhV-k7aTFRzt6qYK7m2fLIGqXDTr0Qb7HjmYOw3BbSTL-d9aGCDHIcWAlhbq70mc4EKd4Sr8l0HfVYib9aZPlF8JfHUYDK0TjJGBCitk47hc9UoK5L3uDn0Y6HLCcEp4xjg83vV4yOgzwfr3juoME3JfPCwLtXn94-jKt9qReXEDXd90wHF88sWzuGMYgZXjjHMdPSTk7wpC7nbq3GSQ38sGTETU6fUDLzt5Z2RK9iNeoTN_rC8zmVCoPGfUn1zPCrNJiXLVIQERZ9F4iiQxVG9JELFk0bHe2OBAKOrTUX85lMEDt_q3_V7lVrESWqK9aNJAGRMJV0uVsZSKkTDkB4cCZMOU074fecj4-eMsndbFHQJBGueBQCT9F1fhx8stcRbnwB9bV9UoP6_Pi_0vCI8kK_0A5SDdgnSNRTdrtuMhxA8T-usSFfWbnE_jLN60Gf5emuAnIbEaoaUuEjpcTF8TGB5VwxCmCKQyU9hK3VqOH0a_U8gxskZuaCYYmWtKdzrYbgyG9AXPZOGNRzP2Jqe6FuFZwGvmYPAXC-mSNhQ4E0S2NV9dGMsG61WUbQ8_udtU3vEpYithxsa433OIHMwI7wCBIi6bZrP-qqkNk_4
Content-Length: 143
Host: localhost:8080
{
"study_id" : "sdy_4RxfmeKTGEGUzijEAQsjQf",
"name" : "Benchling In Vivo Cage",
"metadata" : {
"cage-internal-id" : "CAGE-4321"
}
}Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1134
{
"id" : "cge_7BLJAAcve0y5EM4wA4JHE4",
"name" : "Benchling In Vivo Cage",
"catalog" : "C0000001",
"metadata" : {
"cage-internal-id" : "CAGE-4321"
},
"study" : {
"id" : "sdy_4RxfmeKTGEGUzijEAQsjQf",
"project_id" : "pjt_3iq3y8VCu6QXOBAGJzHEEL",
"name" : "QgaijwBRlB",
"code" : "CD-24-446",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "tFg7EzNV19",
"timezone" : "America/Los_Angeles",
"metadata" : {
"new-study-internal-id" : "NEW-STUDY-1234"
},
"author" : {
"id" : "usr_Ira6iT3jNpwiBOcUtDVvj",
"name" : "HPynxOBt3E",
"email" : "WzAOO2iO@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_1xiwGLgSB3Sf4XaWBLyYe0",
"name" : "5M78Fgedh5",
"email" : "4ZhzsRsF@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:46.336455Z",
"updated_at" : "2024-11-22T09:41:46.336455Z"
},
"created_at" : "2024-11-22T09:41:43.516695Z",
"updated_at" : "2024-11-22T09:41:46.545722Z"
}List all cages
Returns a list of your cages.
Query parameters
| Parameter | Description |
|---|---|
|
The number of cages to return per page. |
|
The page of cages to return. |
|
Filter cages to return by name |
|
Filter cages to return by study |
|
Filter cages to return by catalog |
|
Filter cages to return by metadata value |
Request
GET /api/public/v1/cages HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhYTc3MDEzMi1mOWYwLTRmYTgtYThhZC02ODI5NmI1YmQ4MDkiLCJqdGkiOiIwZGVkZTBhMC1lNzZmLTQxNmUtODcxNS01ZDE2MjYxMTdhMWIiLCJpYXQiOjE3MzIyNjg1MDQsIm5iZiI6MTczMjI2ODUwNCwiZXhwIjoxNzMyMzU0OTA0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.gbzB6LVo0HkDBBndoilb7tu7BiEPUCX21tPnfxU-YsUlsI3mwKKKES_VD5oHWzN9bVVsLVyNaTIzYFdsTMuFPsB3J9-4dcugUlGbO0cBIjeO5S79c-eoFrIriB8YlUVbc46kRiUM1gy2dU7FKOLStv73tjYku8fnl4-9k7P3jvyT5Nzl_5dvIUZxMjDZrQZMgo9aItRJ8la2HV86zLYokk794whADN0Gl237f_srpWlaY_FwIGv2G3mNBvfjKek7Z1CFj_XmcgRKmUcGv6BOubVchuQe5dsV8aMQiELreLmV90f7SQVf-airqhSgz9UszM5KXEAyRYli5W7vbUomkUAjYUauIntVe1fUu8TrS1STnnvPBPtXnori0alMlljyQiSToxGQkIhQMV1r6IwcKs1yV2AIFd-gnUTMz3t4OjqRa76c_aSRUzGg3Ksc2q4Bzgxhy9se9vWS10c5IOY8tzSKDBsKjtKdAQ659NdWWyYef8IzvtI_p7pqqgFlj8kSqRVAjGQGzEzzKoP65Vdaa7aRvRGQXCTPPuAmB5OyKUyW9VxNuklelt3g7mpUO1jZYTVxTKI_qWVKMadMf2e9ITLkJIbae1-vNyfesmFrsBbWoD-mm9mkwRqEgcDlXZb-fgq6zdll_1M9xHFTYPL12B0Xgtcw7o0_9bWkAJqM9UA
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1586
{
"data" : [ {
"id" : "cge_19QBg5FbP3gyuHWSLCSqAu",
"name" : "kG27ky0xek",
"catalog" : "C0000001",
"metadata" : {
"cage-internal-id" : "CAGE-1234"
},
"study" : {
"id" : "sdy_5DVtaJGnFU5lY3kxKKeu9n",
"project_id" : "pjt_50L3hhagSsNsXVgMWfxLl5",
"name" : "iuhiVyITNI",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "49jgAmguKu",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_YjOlnx5iNJWcrdtBDbkex",
"name" : "NfT0IIqFAD",
"email" : "LzEnk79F@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4cTmOO0sgh9iY3xI9YCJOD",
"name" : "yei8Mim07l",
"email" : "phaqG8IL@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:44.422012Z",
"updated_at" : "2024-11-22T09:41:44.422012Z"
},
"created_at" : "2024-11-22T09:41:44.598607Z",
"updated_at" : "2024-11-22T09:41:44.598607Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/cages?page=1",
"last" : "http://localhost:8080/api/public/v1/cages?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/cages",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Delete a cage
Removes a cage.
Path parameters ./api/public/v1/cages/{cageId}
| Parameter | Description |
|---|---|
|
The unique identifier of the cage. |
Request
DELETE /api/public/v1/cages/cge_4FKG3v1ggS8dd5kL7n2ZvO HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4Njc2ZTk3MC1jMDE3LTQ5MzYtYTMxNi04ZTkyZWU4ZWMyNWUiLCJqdGkiOiI1Y2M3ZTE0Yy1mYjZiLTQwODgtYWVlNS1lZTM2NGUyZDUyOTAiLCJpYXQiOjE3MzIyNjg1MDUsIm5iZiI6MTczMjI2ODUwNSwiZXhwIjoxNzMyMzU0OTA1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.dSuZkCiMNyf43a4rjfqPSgVyWra1BB8BCFGt9qt9P49tsSFYqibdgo2yB5Z3ABKEWzmr1NoYxhAkmsgzLuZwVMcH-aAkiu7XrOWwxWxIVHA9jfzrADSnVwDWpFGqni208ZMa0PsRXOLz38BRtTA-tlnXVtmLaRF70iXUyaMt7YsDij1HBIzoV003GtjEyjAphnVbFyIV9welWLxTH0ffCczaNAAFkEhQhZLgt_4W13-YUtaQ3k1lid22D3uyC33zSHzCMQd9NEndw57vgXjFjsyBEHDwyOMWsyBnjTwnJgAOu--LvoSM6uLodZUPlZXuuNO6oprlHw9kRh19VpG_HLs2hy9bkWKcJwKwyy-0QlN3W9DmfcnqATgERWgl7GeiUw9L8PyVHhmQvc5h46X7s2NuqdxR31ggFEn5b1bwySuJ6yqpbifO0RinTGpHH9ZokLhiGhi5OdY1zwozCwmdliAQbJEgaEZafyFfvxxUAWTYD6SQE8Hhl89-UdaejN8fyraSUwD6S-txxMWMj9A-9nSTc8H7S85MmjmUSrVmMCtilmsxborqjJDFudv8HNX12fXAU9gO-IAPfcrMKXttUuzRlOIH4oq7hkhgbDQf0SQOssx13jJ9LSokM2koVOeU_V11kH-bjGuEDSYTno0FuwDEXm3zr_BlIz2EW9YWgNY
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22
{
"deleted" : true
}Metadata Resources
Metadata
Benchling In Vivo entities—including Study, Cage, Group, Animal, Sample and Project have a metadata parameter. You can use this parameter to attach key-value data to these In Vivo entities.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the metadata glossary. |
|
|
The type of the metadata glossary. |
|
|
The title of the metadata glossary. |
|
|
The unique slug of the metadata glossary. |
|
|
The field type of the metadata glossary. |
|
|
The metadata options associated to the metadata glossary. |
|
|
The active status of the metadata glossary. |
|
|
The read only status of the metadata glossary. |
Create a metadata
Fields
| Path | Type | Description |
|---|---|---|
|
|
The title of the metadata glossary. |
|
|
The unique slug of the metadata glossary. |
|
|
The type of the metadata glossary. |
|
|
The field type of the metadata glossary. |
|
|
The active status of the metadata glossary. |
|
|
The read only status of the metadata glossary. |
|
|
The metadata options associated to the metadata glossary. |
Request
POST /api/public/v1/metadata HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0ZmNmY2Q3NC1hNTdhLTQ2NTAtYjlhNC0zMTcxNzJmZjQ4ZDEiLCJqdGkiOiJjMTg5NjU3Zi00MTE3LTRhMTUtYjUyMi05NDA4ZGY5ODE0ZTIiLCJpYXQiOjE3MzIyNjg1MjUsIm5iZiI6MTczMjI2ODUyNSwiZXhwIjoxNzMyMzU0OTI1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.oA_HLJLQScyKdpwAR0S4x1LKCuOGK_XZzpc7uUCIrCDwNBdxMtbYnHpNI5HX3LjM6uuraAv7NQCP5PSVdFZ1f-wPzF-paA4sVPW8set2Rb-G9AvWg1WeB_60t1MLx1pIhVgPkzTzsXcIndvrXrWti_e7Z2siGxqoELgb9nwQYwuDaDdApaGcnCzDQvqUiY4wwKHiPj6_S81-PVafX4XoLxA_OPvDYMvSLNXnkxu4HlnoDiTXslXX4f5UxlCy0laER3Nw-cA8hegeBJA_5R7qyehAms3FkL1sPgIohuYU7Yh58oDxZsmob8vBZj6aojxUE2fO8Rd9SsKh4GMg0HCFv6UBl0bUqIE5hK4oPvST4fnNYKzNsBTD9QebKiGq4kcQtAA8x6qexKblWZ9mMckMEYiT7N_N148Vg9UKTylCwqHW0817AEwidqI8ckEtHS0kKkOaaoLh6mAX70kEpOkOnpfd9qupkO7tHd0DY8_iIflISBTkZHdW5ZSrMmEyMMNTYj7SgELhAywGlnWn2V8Npqcdl95gIXk6UBXb2yhXl6w8FFFZaHuIa9br3sCGMLAkT8l7jU4Ym0wD-MEMX-6iz9sUaJNFLCGscwcaNSncK1-SEnT9PskELbdCwE_bhUHgqeZGanH5h9__5nDIxf-myUEno7fBQidNjfeK1jmGrv0
Content-Length: 174
Host: localhost:8080
{
"type" : "study",
"title" : "8eCVW4KQD2",
"slug" : "c8KeUs14ea",
"field_type" : "select",
"options" : [ "1", "2", "3" ],
"active" : true,
"read_only" : true
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 212
{
"id" : "mgl_hT40eLu2WBLd9qe3UjNcA",
"type" : "study",
"title" : "8eCVW4KQD2",
"slug" : "c8keus14ea",
"field_type" : "select",
"options" : [ "1", "2", "3" ],
"active" : true,
"read_only" : true
}Update a metadata
Updates the specified metadata by setting the values of the parameters passed.
Path parameters ./api/public/v1/metadata/{metadataId}
| Parameter | Description |
|---|---|
|
The unique identifier of the metadata. |
Fields
| Path | Type | Description |
|---|---|---|
|
|
The title of the metadata glossary. |
|
|
The unique slug of the metadata glossary. |
|
|
The active status of the metadata glossary. |
|
|
The read only status of the metadata glossary. |
|
|
The metadata options associated to the metadata glossary. |
Request
PATCH /api/public/v1/metadata/mgl_6RdIZWokJKDTix0oI4pIPj HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmMzNmMzg5ZC1hZjFkLTQ3ZGEtYWY2MS04NjhmZjIwZDBhN2MiLCJqdGkiOiI5MjE5ODhlMy01NGJiLTRiOTQtODM4Zi02NDA1ZGRhNjY4M2EiLCJpYXQiOjE3MzIyNjg1MjYsIm5iZiI6MTczMjI2ODUyNiwiZXhwIjoxNzMyMzU0OTI2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.aCurHx5fR0C8ItYUULitVour6vj_wFG43g62FUaHmbldkjUUJAdZMwpG0xDOz399WS2gmSMGqx-R_OUXDmRCGIJjMBRe46jQOFY5KBlwyi3pJlzRtwn2r9vnJkBIEZW7GLhuBxyn4LX_ZqjSzUrhXIYpAwircPPxtTf3Tbh2YY4MIpQa0467qwutXbC_LGDk-6EPD9II2FOARhDKF-4t8ULVNJ8qeeiCO9955Ttj9hBC6ln3MaC5V_c2XRsen6DIBKg6FxfP2PZGSYH-NidQKtbw9REgRhe7HvmjQs6c6nvAyDhBHIjmEkhs3pCq44y0bTMYKh2HDv2Bqe7UUUdCu41MOOgrQ8rycMbfvAfltxaPuOSmB99MHrGL_q9YOsNNqYAEWjtLcO9aoqkhNMWN2dtRVIewKf5h2-Ry3rWQpfFELl2ZTb1lyQ8Fb9N3dhCfN1TubcAEdco1ilr5rdmO867ShFlsTJnziv0zqKwLlePxSb-jZVg_9G7aas4nu_glWiw0zt9sn3wc2uzqG3ZOy1Cfrn2JWbr1xMcUd-Qdopguo0yk9rZVFlUsU5M3o2NwKKqVGdIFP5C2puRPJ9fUMpDn7CRCa3zBkm9XoUME6FTecR6WGEmWhc_I7dklx4oiK2xjUNrZi_-YYGeiN5jSjKrzIOEiRhXdgBV0q7jVTDw
Content-Length: 149
Host: localhost:8080
{
"title" : "New Internal Category Id",
"slug" : "internal-category",
"options" : [ "B", "C", "D" ],
"active" : true,
"read_only" : false
}Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 236
{
"id" : "mgl_6RdIZWokJKDTix0oI4pIPj",
"type" : "global",
"title" : "New Internal Category Id",
"slug" : "internal-category",
"field_type" : "select",
"options" : [ "B", "C", "D" ],
"active" : true,
"read_only" : false
}Retrieve a metadata
Retrieves the details of an existing metadata.
Path parameters ./api/public/v1/metadata/{metadataId}
| Parameter | Description |
|---|---|
|
The unique identifier of the metadata. |
Request
GET /api/public/v1/metadata/mgl_f1UGrAqqaj4jNDkuKGcaB HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0NDVhMWY2Zi1iOGVlLTQ2MTgtYTVjMy1kOGRiMTk4MTQ5N2EiLCJqdGkiOiIyNzQ1YzRjMC03NWI5LTRhNTEtYmU5Yi1lY2FjNDU0M2NkNmIiLCJpYXQiOjE3MzIyNjg1MjQsIm5iZiI6MTczMjI2ODUyNCwiZXhwIjoxNzMyMzU0OTI0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.h_LFolqFCKTFy_gL__pzGFMoI30DhNuIMRh4IagKXA2Oc6K12R2aXIOovQihSwEAo-TRDMtD_kx_q6LsKZsniXcaW7sh6XHbKua7AzHRLod5K3Kda2B14uEtkXFIZA77y3_2JxF4j4_Dg57T3PEo5iFm80-xf-JP-Z7KS8ZE2I9ZQ4b7qfi9fRT6XcMIfqmERbv-6BG8rrN_f6dieBZF2fNU4d9aqKhKYpaPJuDNoYWS9JpfmC0Xv_HBCnXh3olY3vBehK7ifmquchQ05pO0kFAcHvOZy4MrM-I9tzCrd8agzt3_pEh0nSTPDnbNlnh4Ge0n015zmkrJntG0WDng1_E1tKRkWu_cEnBrz-ElYqyeRL5ND9p-vAu6Y4yrV0xfQesl5u8Pwe_sD32rNUd-h_Uxwr3uqQUI06zYJ3kDH5EaWeX-qfZPzqpdfTLrtYZ5o_7Og-YwI2yXR-8Q4I3i2YkK6EroejL7A_QntI_RT1xkpY4cneWBipVdV_mmlH8ZM_SipJW5gGb_oQlLsJo_GFLl42Q-RkYAQ1JdgUBC4OGGsW8iPZBH4Dy7UTgIMRl2fDTxq1Aa2e15nBSGUrTpn-eZOUTy-vNMMNuxEAzal861Cr7PE6Ua9Larw6B-QUgouQliR5jeWTqOFIn-ugymOqhLIaWugnOTguhDeT91dVE
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 231
{
"id" : "mgl_f1UGrAqqaj4jNDkuKGcaB",
"type" : "global",
"title" : "Internal Category Id",
"slug" : "internal-category",
"field_type" : "select",
"options" : [ "A", "B", "C" ],
"active" : true,
"read_only" : false
}List all metadata
Returns a list of your metadata.
Query parameters
| Parameter | Description |
|---|---|
|
The number of metadata glossaries to return per page. |
|
The page of metadata glossaries to return. |
|
Filter metadata glossaries by title |
|
Filter metadata glossaries by type |
|
Filter metadata glossaries to also return inactive |
Request
GET /api/public/v1/metadata HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkYmE4ZWI4Zi0xNDhhLTQ0YzAtYjJiMS1kMDJjOWExNjNkMjQiLCJqdGkiOiI1OGEyNGI3Yi00NWMxLTQ0MGItODdlYy1hNDJhNDZiNGVlYTMiLCJpYXQiOjE3MzIyNjg1MjUsIm5iZiI6MTczMjI2ODUyNSwiZXhwIjoxNzMyMzU0OTI1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.l8Ni5gf5hXkmTW10aX1JP6AA6owa_FHK0vboe41u_lQqF4_eZNjsmVpbcO-sw-YWDJ14Zys1tle9v54J00a4V1tvZgKZMHF7XJkSKO04wWTiW2QPCE7Rn76WmVrgfwYXfcMh9PBDie75Ore7R7aJYOW2TSGOcp95zUjhoiJA8Sk_hG0YSQ-CBU56zI_E4q7YzPI5oMk7htkq3mHKNGrPjjLNIkhz1_oUFb70I8iOtA5nY2z3dw7uewqmMd786dJVx1DghivXdp-YdMZl-UNc-5a_rn1wB9yLe_TErc940NKSL-oaZ49sJkycRNCZ9AI6noAUUdrE8F2KILrANfzdxd0xVRTiUH0KSlKGZKxh3l7N1TxA44irDwMRB833qZDF_5Su4Gt2fYcgOkJA49NgpMK0YNrLgD7hJxX_smP9bA5msz9H6SZ98Dkrpfosr762FOtiNbF3I_pf25u2fPDqj7agGz9eT1VS7CoQcjZiRaTyOcodZwwbLjP-ldGdq1qyqOFSAcPnLUNYg8rt8LdqVlGo0mp-LU2OXuk334Yzu6Rk_Viz16WIv9Bfw6Jw97JY7Fz_nTAxT0gRX8y77zIpfmvDbE_GizYtBaohtbDuTAnbYTDfwUO0BXOZnwCpLEJ2vq2eeUL_GeJdtL5kY_aFw4cH_6towXnGz1d_9c2Pqu4
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 653
{
"data" : [ {
"id" : "mgl_63VTx5CPUDRPyMgr8xvZ2D",
"type" : "global",
"title" : "Internal Category Id",
"slug" : "internal-category",
"field_type" : "select",
"options" : [ "A", "B", "C" ],
"active" : true,
"read_only" : false
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/metadata?page=1",
"last" : "http://localhost:8080/api/public/v1/metadata?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/metadata",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Delete a metadata
Delete a specific metadata
Path parameters ./api/public/v1/metadata/{metadataId}
| Parameter | Description |
|---|---|
|
The unique identifier of the metadata. |
Request
DELETE /api/public/v1/metadata/mgl_6XP3Y48H2MtrPq5crV7bQh HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjYTU0MTZjMC1lNzEwLTQzOGQtOWQ0Yi00MmJkZDdmMmE2OWIiLCJqdGkiOiIyMzMzZTk5Ni1iMDU5LTRkMTEtODM5Ni02YWM3ZDdkZGMzODUiLCJpYXQiOjE3MzIyNjg1MjUsIm5iZiI6MTczMjI2ODUyNSwiZXhwIjoxNzMyMzU0OTI1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.hES7tJkm2pj4E0bBUp8LOhoqOrxN6W8SE9T8gDW2Qwcehr1Tg8c9LmjelzkXsegWG355NM9eVLZ7XDiYnk3rjxd9wSHodKUBRPi-V0zmv_nBEjcCAP3q33ENRmHAx9-_eoYB0cJ_Kx9pADIOdi9IWqUgLZJpS8E2mgFDC7vovrRcxVg5YS9Z9NDdQsuylndRnEfZ1AGNzEfwrmLBWmNv_AaY6fsqXdWN30eKOPnbMgFFYzchUX0hfaEYJOfPYaaWEvr-5Aw7bv-cO5SD5q5oC4zfqcOx9Z0e7eUfe1gq6I6QWe8RCC4u41SVdgD800HaqOWRRzoi5rl07Ixp3Lh47k4zODO4N1wAHjBHehNKEzackDJrv1-rurXeAvG7G_xtYrb2y6zFKaUD4otV21Ahxh-YqMe9c3ydBwjvJTse3masnkpSfckPW5o3L5IPNd7HukySm1cPQid6FQRvptpPEE17OPACd3_7NKIt40gW9TEotAEJhov2Y_qBHfevUyie4fH5b3_TExe1C9j83DiZ9f3bGiMA1I2yc_ffRza9ubC6ooAIZFnJ7njHQjVWCpXw_GGEMtwJW5M22v2orbT0g66NmDQxPC192NKQBWhsNkwj1FXZRqASGGW37xW1M3d_VMUWpqL97W3lXUb3mTQbGMH25Vzi1gBCnsIEPWtSml8
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22
{
"deleted" : true
}Metadata Option
For metadata glossary fields "Lookup select" and "Lookup mutli select" you can assign values that can be auto completed by users. Typically used for select option lists larger than 15 records.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The value of the metadata option |
Create a metadata option
Fields
| Path | Type | Description |
|---|---|---|
|
|
The options for the metadata. |
Request
POST /api/public/v1/metadata/mgl_5O1mkB9HLUAcotFgqteY4r/options HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzNDVjOTY3NC00N2JiLTRhM2EtYmZmNi04Y2UxNTg2MzQ2YzciLCJqdGkiOiJlZDJjMTc1ZS1iMzBjLTRiMmQtOGU2Zi0xNTM3ZWFjZjQxZWYiLCJpYXQiOjE3MzIyNjg1MjYsIm5iZiI6MTczMjI2ODUyNiwiZXhwIjoxNzMyMzU0OTI2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.EgcrxThct7hS5SWQWjKnWOphnHs8mhGoDct-GJ5Hh9Kg06wAAaFgp3A0e24uEhj_cpTtvrMdsvRNdXBDAfq60s4vNWS2Fwt1Sn2tUSAIRzQCsViPz0Y2EIkbbltm9qF0LO7SsK7lUJwA9ungfUJAndwNdwdmla6qYdplIOO-BcjI6QcOvb49fsWELj3dsK3ifOfbyiRiKV6c5k74PWUq2BKNChmazDksLUiIyo4SCXUggBV5ELB7Q5VJUYaCfE398Vs9fWcIqx4WuY9EWpFwbOdC0JfKRo5skJPr0ZrH5j8CXlww_6H7JZSdgpe5M3wn2mkWBRludQdbzj-dGvQ6cA6tnPc-6ekLBCU1NuBFZTTtrJxGNvC7PMZv8ek8ZNNlvo4-P5G9QAMEMqAU4Z6iH5Dyahymgxm2YDNbs9vPauUWhI0lzvpdhAQIVWyIPhFHOYinaLiKOFIrt_xIgbPXmjhk68tudj8Nt303M1tTXdo3kS2NJaDSnG2m-12W-sd3Gt-bmSjYYXGN0-K-2zE374xP1IXQYhvVSFso7NOMKVp4-1VgUEmFt7yugFXlXit3Z9p8IU-zmNejkqM0KY89BeiGWCk57V1G0501wk9cutHSpMWgyKrQxfMJgH3tX2mNe5pMG_bFpmPB3uZJgomW-q-NDK1ARU_I7Zv9DaL7_pY
Content-Length: 59
Host: localhost:8080
{
"options" : [ "B6129SF2/J", "B6C3F1/J", "B6CBAF1/J" ]
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22
{
"success" : true
}Update a metadata option
Updates the specific metadata option
Path parameters ./api/public/v1/metadata/{metadataId}/options
| Parameter | Description |
|---|---|
|
The unique identifier of the metadata. |
Fields
| Path | Type | Description |
|---|---|---|
|
|
The old value of the option. |
|
|
The new value of the option. |
Request
PATCH /api/public/v1/metadata/mgl_2fTBtvmvq2NOJLjb09mRyr/options HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2YmU5OTA4Mi0yY2FlLTRkNTQtOWE2YS05MjUyNDFhZTI2M2UiLCJqdGkiOiIyNmVhYTkxMi03N2NkLTRmZjAtOTZkNS1mOGQ4MTJhN2MwZGQiLCJpYXQiOjE3MzIyNjg1MjcsIm5iZiI6MTczMjI2ODUyNywiZXhwIjoxNzMyMzU0OTI3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.cvPAYkZ0Nmvkqjx9G5pEYX4mbfBhEBHn3KjEM4gG26COKV1fY1zQxqFtk5FN2pEzaZ532eIhabf24YGrIXkglrfg3F0nDrbq1bgaOKqPMe0oFDN_iloYgyFRm8eK3u_jgQea9tcbNtugwJd1jl7wwn_YJQsMgO51Dy0Gv0XXwvxcRUATQ_uJ_aep7f6TqfFwX_f3FR2Sy6QjIuIBDZNQpLLWPh5mycvyUqPDfXwlOqWR-zHOKo3EHxB8RwytvrgzPwuFpKAmEtOH4lcjvxLhmYbm_059MprrO9EE_JuMEa6MmFK2ciGL2P-tcnXjK63Ye6Z8qJQXq2H07_EqdDX_QzyyoBrLaN1OYXZgkYCNqwmdTJd7Qsf9xvjcse2OF0uS7ng_t1mP3_2CJUUTfLjY8IWEZlNX0Z2mdwXG5RUY16fI9P0R3eFM8No6P1Uz71uD9LDZhUpSjml82f4_Wh6AUE_A3kfUMijarqsTmz0YAWq_NNgrLzoxRdzOgNThs8MDn_-8cTq7gYChnnQMrVlktMlu4dZSMMC2ezSbxh6734dUtzGjmEB9KwjD-bq34DNl5kYMaHVPcNq72xCvDvMDYKYh5LFVMItCzjWTS9r4v04DwRZAItS9DoDvnZmW_VdYxYUUKibIzpgmqK82ymdzx2Zm6Ueda8BOi1kHSpZ1KoQ
Content-Length: 61
Host: localhost:8080
{
"old_value" : "B6129SF2/J",
"new_value" : "B999SF2/J"
}Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22
{
"success" : true
}List all metadata options
Returns a list of your metadata options.
Path parameters ./api/public/v1/metadata/{metadataId}/options
| Parameter | Description |
|---|---|
|
The unique identifier of the metadata. |
Query parameters
| Parameter | Description |
|---|---|
|
The number of metadata options to return per page. |
|
The page of metadata options to return. |
|
Filter metadata option by value |
Request
GET /api/public/v1/metadata/mgl_27uTh0lZBfZ3skRsIkEusb/options HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0ZjBkOGE2ZS03ZDQ5LTQwYWItYTFiMy0zNmY5NjY2MjAzMDMiLCJqdGkiOiI3Mzc4YWRiMi1mMDFmLTQxNDctYTczZi0wZjAwMzY2MTQ3NDMiLCJpYXQiOjE3MzIyNjg1MjgsIm5iZiI6MTczMjI2ODUyOCwiZXhwIjoxNzMyMzU0OTI4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.B5xTxNd3gIdkJTVYyVi3owrmFkpawOia6WaqoAzmimXp1iNwA3VnzwJ3fALA0U7ozl7ahGfeziCoDRP-6xtP8Z6nlghKvkOEW3fmmvE2RPagvoGHDbjj5iUPUcTR1FUJuWkqPmE_RyTfhG3L0aQX8dtY4nmNxUzYBk9-z2o6tP7oSVee_S0-QHkU4zmZhf9GyuYQrXZ71p4SLbzIaUCLynxuFGWRhscwS9-t4T4CSK72-Qdfqx8kWM5fL5DyAFRkEUdW3_RA4ve5zf2mOubWVu3t3g9o7TUoG6yZMA2AqUUGeBlJ0ApaAzIlGYJ_wD5wI7UsoIh358lfUjZmJz5i3JgfLXBSsKS1bABB9vSblZq6lFyNC6pVQefDezxzpjV4aWNFpw4SRNrq5EyhDmegvhRbszc3vTQ2x8_YmpJF6gr05bj7aHOBkGHdgW-_4TUVAyyjUmQto7aODiKC3hyJcriF7lRxOGXFTdC8prTSAhwjr2K9M76EpgPYxGBu7tvqAWXpMAKl1MdV3kttUbSdqsyshqkZF5qE8bWqduZmfA8-krWUZk6bKKJ1_GXmSKdHCCYEPSNnxPSnq__os9mg8GT4NAK06hJm5oVYMMEBx3IIwHgDB1J4DgEPfkKLF4I-srmND1kGSQM8I5VwjTOHdf6VSccOawS7jhoJwKHu7iU
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 605
{
"data" : [ {
"value" : "B6129SF2/J"
}, {
"value" : "B6C3F1/J"
}, {
"value" : "B6CBAF1/J"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/metadata/mgl_27uTh0lZBfZ3skRsIkEusb/options?page=1",
"last" : "http://localhost:8080/api/public/v1/metadata/mgl_27uTh0lZBfZ3skRsIkEusb/options?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/metadata/mgl_27uTh0lZBfZ3skRsIkEusb/options",
"to" : 3,
"total" : 3,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Delete a metadata option
Delete a specific metadata option
Path parameters ./api/public/v1/metadata/{metadataId}/options
| Parameter | Description |
|---|---|
|
The unique identifier of the metadata. |
Fields
| Path | Type | Description |
|---|---|---|
|
|
The value of the option to delete. |
Request
DELETE /api/public/v1/metadata/mgl_6V37QkL5pUsmJytAM2Gtfq/options HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2ZjgxZGI3ZC1iODEzLTQ2MjMtYWFlNy00MzI0ZDc1YmNjMTQiLCJqdGkiOiI3ZTFjMjZmZi1iNzhmLTQ3YjktODEzOC03YmExM2UzMTU3NmYiLCJpYXQiOjE3MzIyNjg1MjYsIm5iZiI6MTczMjI2ODUyNiwiZXhwIjoxNzMyMzU0OTI2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.VkkOraf9txHOgU8YyeLPN-HHNZf_5OPWRT_SAzzxFNZHqa0lMGLUryHECGR5pyWzMG-7bKtSFpmMsby-obUpK020jMyVBrVEVsjGokiTow7wvoz_3MviCGaDWXUIuYH25Q6XsBSa0Fuitae7_BxlzzWXpl6-M8jCkuXWCStT8Jw3rtxhDlGK4918BFGXnrk4Jrqfa2zu4lHh2CfKDVjoYac8-mu8FmoM_VSlmzXkfw_hH470irV0YZUprp9npsRJDHqUkRe4LFlTk18IBKgEdXd8PstD64AlckGyC0bE4O7bdIKp5Ej_y94OWFcvmVTmnb3oRyT4ZE3gRjfT3miE5nMW8KJd-wG7L8rc0TKHVvmq9QzottmH6EtE6rTPcVBXlCwQ2D1m4tsoIWJcPaMu0STFWHNFhcoj-3MFaVArZVr5gB9pcG_3FXNS1em7ec3Y0YXf-qPVpkKm3Bwnpj28Yyz6BPATtGcTybmssGRkMeV1nlEFCE8MIYnc9dgP5lvyaLDUOO4ApYj0wAfNzBYgM1xPmAUx3XrnXS0vLp0NZwLRdABWCpS1kUwQLcFsaIFmg7liwaCDAlU3mdErbPr6XmrlIE17kY39m2tcvXLwhk9MmGVWfaBOyPH1I5q1F81w4Lnd7w7o6fwNHWZW3Mpjw6xcRQvi77Sk1WxeuYNGN_k
Content-Length: 28
Host: localhost:8080
{
"value" : "B6129SF2/J"
}Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22
{
"deleted" : true
}Project Resources
Project
This is an object representing a project for your team. Projects are collections of studies that users are assigned roles to. You can retrieve a project to see it’s name and any metadata assigned.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the project. |
|
|
The name of the project. |
|
|
The metadata associated to the project. |
|
|
The created timestamp of the project. |
|
|
The last updated timestamp of the project. |
Create a project
Fields
| Path | Type | Description |
|---|---|---|
|
|
The name of the project. |
|
|
The metadata to be associated the project. |
Request
POST /api/public/v1/projects HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5ZmFjMDIxZC00YTIyLTRlZGItYmFhZS0yNjNmNjcyOGNiMzMiLCJqdGkiOiJkMWZjYWMwNS0yMDRlLTRmNWQtOGJjYS0zMWFiZTA2MmNlM2EiLCJpYXQiOjE3MzIyNjg1MzQsIm5iZiI6MTczMjI2ODUzNCwiZXhwIjoxNzMyMzU0OTM0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.SPNZqksGxTQ-NPKub_g1HeOsNZOolVatRndLl47ZE3Gfhu4xucP0d8Waw1TZ_BkoEWT1oET24hf_P4kzkRXVALHEuVY-7ChjqffrnwbOMeT2S_B4MaVrP1OKXrY0jCqnBJCZKJTE0xRCiJOQQ3Lb5rfDp0_JUygt-TaiFhWEakLhZ8DaebajoOdWR2r2BbKM1khB8tozuR3Vgsc_hKbXKt4UbWy2k9ujzUgbX_fGqO8fK6-YavwlSNcf-56sKVMT7viZDNhK7YU2T14_nFGW9eXzABKQThAM_ENRq0nIkv19ufNk2Sa1uxv4x6nEWJZ3JC9N_YQlWr4HALh3BwKyJ8gviZ0X21SrK5082mEg4imNoj-CwXLqmoY3f50cZoizZrUsnKLi6fzIqDqgrooNqZ3vio_NGlKy2cKLUcdMubZmrT4SHZ1YeAK7ZONCQ2gloaO8b56tJoWrnY8RJWNF7Yz22xHXhuMYZANkdVATf8wGtaXY0lJLQ1g8SqtP9O1RcG2KYhQ3EimGxHe3Iiz-hRFauqAFRXcgqIEi-QWipgWWHt-1b6N3KO5G21AH3alB6NrAjk45D25PZ9SDMfJ5ASgUeHFlT7alLt5w1v_Ubn_UCBAyWKYCcziZkM3VCJvUGrItHGAUi6xf-OBDRUQYHWtf66hqjRHbBZA8kGfZ-Fk
Content-Length: 89
Host: localhost:8080
{
"name" : "45UyyDDDnO",
"metadata" : {
"project-internal-id" : "PROJ-1234"
}
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 224
{
"id" : "pjt_7Rqve1MjIDYWNqMWeeiq1P",
"name" : "45UyyDDDnO",
"metadata" : {
"project-internal-id" : "PROJ-1234"
},
"created_at" : "2024-11-22T09:42:14.181725Z",
"updated_at" : "2024-11-22T09:42:14.181725Z"
}Retrieve a project
Retrieves the details of an existing project.
Path parameters ./api/public/v1/projects/{projectId}
| Parameter | Description |
|---|---|
|
The unique identifier of the project. |
Request
GET /api/public/v1/projects/pjt_2q9l4c5iC8C2VWA5zaEX0N HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1Mzk0M2YxYi0wMWFiLTQ3ZGItOTZlYy1lYTljODFkZmVjN2EiLCJqdGkiOiI1YmQzNzQ0Yi1lNjBjLTQ1ZmUtODVlYy0xZmZkZWQwZTNiYTciLCJpYXQiOjE3MzIyNjg1MzQsIm5iZiI6MTczMjI2ODUzNCwiZXhwIjoxNzMyMzU0OTM0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.EuuhQzPLTgdVqFgO9ARzIVWxBei1qdrEhhJ_RZ4lFYS0QEHMY_0fUgXAb3LyTdxIwMjSlVhQVIKEGNL5kRK2NH-HsaFdm2nmLATb3-d5_gzABk047N4SpTChE9N8XmopK2Cvuplxz6z-8VRwkmKtaLYgjwCyhgv07WR0Je_sQ7mN3PDmh1dJCs1N20aPWwBbDa_zkeeHNJfL9z3YUfq2sCd3wwygZSN7ehcV-Jf033z_S7dlaqYmpSUZzC5k-qqjJjdaNl8YZ61KQFb6xdbhmne6fs-Cm3ITCZQ_XrszwM2G67hwPUqT8EwYasDSrpIf53AROYTtVgswYXXfWGUJMC_Z-NJcQaBRewVE-ygJDbnGWnrSCIwlt9tym0U6_SioHrqcg-dFvVw8McXZnJrh3hYwyS8hVfUjL2Ltra7ROCFOofGhiBlEkbKUKGypCqKuA_X1OWIUg9aCPhSzei_VZ1iXFIGpg6HdO8UxdH30n0zAl126e7Je3f0F6lGu12X56aCCcSMlcBfG3D-xW-ITyoKQMoLJmVUEZhBEQo-3Zponb4EQDNJGlsbYUIVbxs2okFxi3akDVNOs38VW1Du9kgFFpGN_DpkXacqtoJxZW66Zl5kjOlSkatEwshdFEYk-d6EIhRWBetdm7daysv8Xx5boi078b6UVOIsFGZ1_Oko
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 224
{
"id" : "pjt_2q9l4c5iC8C2VWA5zaEX0N",
"name" : "ePkpNHZCoP",
"metadata" : {
"project-internal-id" : "PROJ-1234"
},
"created_at" : "2024-11-22T09:42:14.083179Z",
"updated_at" : "2024-11-22T09:42:14.083179Z"
}Update a project
Updates the specified project by setting the values of the parameters passed.
Path parameters ./api/public/v1/projects/{projectId}
| Parameter | Description |
|---|---|
|
The unique identifier of the project. |
Fields
| Path | Type | Description |
|---|---|---|
|
|
The name of the project. |
|
|
The metadata to be associated the project. |
Request
PATCH /api/public/v1/projects/pjt_6lyUhdEJPI4EaTG6driyxW HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4OTdmNjdiNy1kZGM4LTRlYjItYTM5OC04OTRlZTIzMWI4NzkiLCJqdGkiOiI0MjkzMmViNi1hZTViLTQ3MGMtYTBhNy04ZWJkZWEzY2ZhYjAiLCJpYXQiOjE3MzIyNjg1MzQsIm5iZiI6MTczMjI2ODUzNCwiZXhwIjoxNzMyMzU0OTM0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.W0GgUfCOZuU37iA_7e5_6EstqLo6PISqmIvMgp5ExgVrpkS00UvlgeHqvvAVRprjiCyEwwBeK0vCb9-i_Aa7SwAmVpro_PW7z9hlHxIB3AD0F8Lbv6BRkdL8Mu4S3CiGVGKCOqFUlV8bdfVShZDgLZWDBOz97sZ2Hp2d_Jmb4i9QZCCPIAR6pawSUYnorhASb9VNs8h4LhK3nisBGt7Rkm-D38Ld4l4v2FOCX25RH8lJHtmwE9Y14_fO_VIdYx5WhiR3HoH7BKfuH9gJ_G8n0G8vemtxoVH8goKhNWWuIhWYGzs8O7jWJ03Py_UYwq_DcQSUPxG3OMJwAyKUdp32Z8iPMs7JpWsuKrIxxljtk8s0ke3yXAbMIx0wfQuhrpFcWujK1GFv2YtqeqityqpYgjYQcMWngfBnV7fL7mqAMjxaeDA9QESo_iR1nqxx3mcA2UY8semFVy6haZT_PfD0lhf2-06Xv3_zbdoKAtg-6qLtS7VG9RwTyeluO0p96uHViLEStY6qYqNUdrTBQT9rbbETLcPiCuNkKkuYsGsJ-mQAuO6bEft79dtXNJmEYWHQky-iJW7D5e7mbXTBllp_b-kCIu0tfPwds1HJ95b5lr5SAIORG0t4vt8vIYzBgAcvD07_fON6GMa0NhyI8Zi3TWbrJcQvQywK8zi6pHhzZq4
Content-Length: 104
Host: localhost:8080
{
"name" : "Benchling In Vivo Project",
"metadata" : {
"project-internal-id" : "PROJ-4321"
}
}Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 239
{
"id" : "pjt_6lyUhdEJPI4EaTG6driyxW",
"name" : "Benchling In Vivo Project",
"metadata" : {
"project-internal-id" : "PROJ-4321"
},
"created_at" : "2024-11-22T09:42:11.285931Z",
"updated_at" : "2024-11-22T09:42:14.305389Z"
}List all projects
Returns a list of your projects.
Query parameters
| Parameter | Description |
|---|---|
|
The number of projects to return per page. |
|
The page of projects to return. |
|
Filter projects to return by name. |
|
Filter projects to return by metadata value |
Request
GET /api/public/v1/projects HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2ZTg2Y2I3Mi1iNjkyLTRhNmMtYjZjNi1jNzdjODhlM2ZiMDIiLCJqdGkiOiI3YWM0MTQxZS02MDA2LTRjNzAtODQyZi1lYmIxOTlmN2ViN2MiLCJpYXQiOjE3MzIyNjg1MzMsIm5iZiI6MTczMjI2ODUzMywiZXhwIjoxNzMyMzU0OTMzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.iXciqpbJ0HXIEuJAOHc47KRTEWbRH-iGB4mENLiNChuVpNT-xRzW8GWccUP9x8m5SBKyiXz3rgSGth5JNVg_xOdjZEBND_MQhKb94TJm92rpLHfiu1msiqFMXNd17gAz3_k25zbkMSKL25pbz55jQJpfUQp3EZntzWVlrwB5NLVDneNBk9Qaq1bcUJ7OPcSKeV1oYvBeK7-gsy7xhhRv6y3mFd2zKRBuNN7IOsUCGZBc-5op-DZTfvvlAk3AtUrAHxbgdrbGWe4ztIoVfrUa9zOL0uXAGNBTp8D4kq8K0JMQ0vIWMCgY5F3eftoqoryNRE0mFbU0J4uRmpBCmcobw1XII6urvTAQ-GKeoTR7aRRBnv8B35Yzq5if3Sw3vj4G1wJ0OD7VnNI9EQOPCQmu_kC5_P6Coq849eWtW4OSGRPxKFgnZT9ZyfBxUhqeH-bHG1qsvehGTuASI5Bw-TYd2Z6M0hF7ZROgoEWk2H55azjzpchR4oCQ8FZYw98VnMB2BjOhzUw5gW0Qf1a9Plt0V5shw2A7IqkBzEu9yuiN6LnsqWebMo6aaj6_uwYwNhZ95AOHy5gV5XQM21QpDpLDVmjib8ZwHAnXHlqdu8bdyDlIqzrSi_zxhMLSyOS6I1J9jc4NCzVir6NODFH3sTXpZq53Wyf7N4_v8M1611j-iBY
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 643
{
"data" : [ {
"id" : "pjt_5fG2U0NgWRPCvtEm8EuVJV",
"name" : "kypQzza15S",
"metadata" : {
"project-internal-id" : "PROJ-1234"
},
"created_at" : "2024-11-22T09:42:13.350948Z",
"updated_at" : "2024-11-22T09:42:13.350948Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/projects?page=1",
"last" : "http://localhost:8080/api/public/v1/projects?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/projects",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Delete a project
Removes a project.
Path parameters ./api/public/v1/projects/{projectId}
| Parameter | Description |
|---|---|
|
The unique identifier of the project. |
Request
DELETE /api/public/v1/projects/pjt_6pr6ydxHYUge48Omb8ICpM HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5MzM2N2Y3Yy0yMDg2LTQwMzQtYjM4OS1jMjc2ZGMxYjE0ZjAiLCJqdGkiOiI0NzIxMmQzYS0zZjY2LTRlODctODYzOS1kMGJjZDMyMTljZjYiLCJpYXQiOjE3MzIyNjg1MzQsIm5iZiI6MTczMjI2ODUzNCwiZXhwIjoxNzMyMzU0OTM0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.IRd1SJzh68JZ5lPe-wIuSepCKt-6MQBS8KYFFWKwyWiRGRl-l446r7TfHO6KwfWrsCTG6uAlNhf49m56MSIi7PjwPtzt6p1cKtyaar8oYOYOVENewo4DY9xeMdxss0A1QitzzCX-4Pobb5esqjEXe1Uv1WsiwskuEuPbieX4C5ZHQJcb_NLkurF7qxddZtczIMmc1Y_rF5Y750KGDv5D9fqzMeosmxtMGN8qPe7YxT-DHajAai_VTVj40hSYOPlqPJUJaLImFtg3LicqTto3_1pSHGU54dP4MRV9EMSckF3NK_ww5ml2q7W1TV6gEfB6NT9ZM2mR9uO_e2oyxUxf00M9jidjdX2BHGRu5008kl21p9lkESxiQ1pt2Wba4eEcV9YBJKN90IgDUXRgXmvYAspP2c6Ov8tBobMw9TLL2wOplwEjLhExXGsMCsY3SHpxFJDaOdjuRV4vkhVO57aKPseL9hBT9GS7bTsIxuAf_1RRX6CBOnGqBP9h1rniDQpFZVSiidCM1uaKZzJUvJQYk4Q7KWG9yuegeOHNYhwSc1E5HR_DajaDryD1svtjIRM-i0lqGhu5amNWadDRxE9STermW8Frc7WLF6TOcP6o-hxs1XTtoE9QuP1lnYUxM6IbuEkQkC7_NqqY25NYQ3sQdFCQJGJKPxVBPNp6f9vdP1Y
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22
{
"deleted" : true
}Project Role
This is an object representing a role in a project. You can retrieve it to see the name of the project role.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the project role. |
|
|
The name of the project role. |
|
|
The metadata associated to the project role. |
|
|
The created timestamp of the project role. |
|
|
The last updated timestamp of the project role. |
Create a project role
Fields
| Path | Type | Description |
|---|---|---|
|
|
The name of the project role. |
|
|
The metadata to be associated the project role. |
Request
POST /api/public/v1/project-roles HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiMDliYzZkMi1mYTExLTQ2M2MtODc2Ni04NjMxMzZlYzNhMjUiLCJqdGkiOiJkYmRjZWE2NC04NzcxLTRhNzktODI5Ny0yMTBiNmY3YmJkZTkiLCJpYXQiOjE3MzIyNjg1MzUsIm5iZiI6MTczMjI2ODUzNSwiZXhwIjoxNzMyMzU0OTM1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.dPGrRTxQgiCuhIMn1vcWNIDE5GDm_pkD9vYBv697jmOvFXmvP2NIeKy1fqe66Y9KcXm144S1bwIF6UtIhcPyUPlFyCMyjJM6jFbwxHoKHFSoJn8pWRrFrqKYSDlcxIw70h7rT7_Q9FjnfANf9R7lL9tuKV9JmQZcPyKUd3YxzrkR5bioXpeYNzqBZMKoY3pjiixCqzeK2ZQEj7dnoYur3EQGZXzyOBLQFAbuGuGnB5bMmJgPgrb7fvEsKyrI-AAZyZ_Q5ad2QuXKrXkR25og_Z0VvZdLN2txmFG-uMD626TYZ7YN8si8cVCtccH_ipjMlMd7ZAmzr-2OW74JOejA91KF7V0uM388ypVtK-0Kj_F7MAbEGzzvoE08zp5skcalSmGaiGZAyxGjEktkbleht4TZhdQV_TVnFdt4RP4oZBHQ6WdW0hSy1J9qKfk679E309RBAQ_LJtTZKcfD9VNWbWLKuwKy9WnZf2mIFIbClMil8qhZrFDgji8erB_L9JIohia3MQ0jhKoJb1gIbXte6qZgqDmyzeNqAggRXgVWXItvyedZE2Q9eQWkd4xU88xInkHkwcFeKT2PCF5sbG-mgcBViI0BmFl9MWyZsQoCq1NOY5cveFO9lIlp1sJgG2Nwe8qlzBaJga4DXrRxX5RZgHqtFEdzfb7Hx9bhetZRwag
Content-Length: 99
Host: localhost:8080
{
"name" : "QWFA66fo14",
"metadata" : {
"project-role-internal-id" : "PROJ-ROLE-1234"
}
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 234
{
"id" : "prl_7Ip07LPxCa68bSD4u8qAyx",
"name" : "QWFA66fo14",
"metadata" : {
"project-role-internal-id" : "PROJ-ROLE-1234"
},
"created_at" : "2024-11-22T09:42:15.862263Z",
"updated_at" : "2024-11-22T09:42:15.862263Z"
}Retrieve a project role
Retrieves the details of an existing project role.
Path parameters ./api/public/v1/project-roles/{projectRoleId}
| Parameter | Description |
|---|---|
|
The unique identifier of the project role. |
Request
GET /api/public/v1/project-roles/prl_2zmYELDdgHaYY8B1pUA3uE HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzNjI3MjllZi1hYTE4LTQ2MjEtODU0NC0wNzVmZGI1MDdhNGEiLCJqdGkiOiI3Yzc3NGY2Yi1jNTIyLTRlYWItYWI2ZC04OWMxNzIyNDA3MTUiLCJpYXQiOjE3MzIyNjg1MzcsIm5iZiI6MTczMjI2ODUzNywiZXhwIjoxNzMyMzU0OTM3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.RFIxggFgxinVdPM6YoceEbjzvngQLGb0NO5BAcBR5WUYvzKQhstySM1RVUsp5uEaGou9V_UYdB_NhWZ8HgtXp7tlVk2WeGebfYQ-pTPSP-WU1GkLlipOwtmHENwFskS1GMvd2ysvOO3hSTrYI6ztV6r63NwJ061e9jfsfzT_RfhdRwMrnXFD5LbHJSej4Lqrc3BgiJqS8K2FvmjmjKr9ODBZcxU9l_lAy8H5LGJ807-LSw8GVswBpmXcPZ85XMwun3sAjAHyz9DX0vASzqzK8nI3Y1DimU2G2gzK-prDo_9gPI6VvX--6jhAaTTTR3aFg8Pzq0rtEIM1l12HVDI6Ah1m0TETKSihLqH51ouaZSZ4cPivAw7XOXAQ4aOtU7mKZqKeg-Y-mfn6X9BCQ-gO7L7VdE8tA4N0ZBmW7zqCVrqfgEj0yl6varX9NjdLLY_RjZ_I8hPGMp5yP8uWrO5xwtT7rzVD1Ark_05GdnEvZ-k7v13s6h3MBgAeeeRGlhqvae3mpVIdBlqOJBsefVL-1Pa_ymIjbI5Ls9WlEl_-iDCrn7Vv-y0VFt2wzaT0Z6tS9JVnL7naJGbSYP7StMDdhsuhM2ganESyPcCtCQtNGtGSIumo7D996EiWSqzvIoenM8ZoMmiw8KWYPgQRAoPw2LD7lZ8-0YzsiiZx3qWkvrU
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 234
{
"id" : "prl_2zmYELDdgHaYY8B1pUA3uE",
"name" : "pkOExUCQbT",
"metadata" : {
"project-role-internal-id" : "PROJ-ROLE-1234"
},
"created_at" : "2024-11-22T09:42:17.888780Z",
"updated_at" : "2024-11-22T09:42:17.888780Z"
}Update a project role
Updates the specified project role by setting the values of the parameters passed.
Path parameters ./api/public/v1/project-roles/{projectRoleId}
| Parameter | Description |
|---|---|
|
The unique identifier of the project role. |
Fields
| Path | Type | Description |
|---|---|---|
|
|
The name of the project role. |
|
|
The metadata to be associated the project role. |
Request
PATCH /api/public/v1/project-roles/prl_1y1bPN9Imjb8kHZMmyXdm7 HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3OTZhY2Q4Mi1kYmJjLTRlODMtODYzNC1kMmZlZWMxN2RmNzQiLCJqdGkiOiIyZDQzNmFhYy0wMDY0LTQwOWQtODUxNi1kNTlkOTQxZDUwY2EiLCJpYXQiOjE3MzIyNjg1MzYsIm5iZiI6MTczMjI2ODUzNiwiZXhwIjoxNzMyMzU0OTM2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.fd3v5FOOEdu8NSThHFOq-ZVqSyOdmTdSh7HwlK-FE1hiBPJV9zdzp0TuTUt3jW4k2hwzF4IJ72u11xBaGki0pEjEyeocmlpnMGkKwKo0_HdvYPOmgdQqqV-3eS0UlpBtaCH7Hpngx43T2XHWkW_591bOZbyl_0MQDveF64Ch5qRwGLRwZhCbVYIKpLnhlSAbc6PIJ5wMR3a_Tr4F-Xjxdb68uiCJ5-go6CPsTmNFYK-GLy4e2LLDQa9ekrduICUvM3eleYcIr-BlFdXaYYvMxY6wuL68juz0V4Qf4DUPXQqi3hn6rTnsoH8iawb_mnGvMkLAJSh0OU2L7IAoHTepv-Ygqd_eqCWFFBX6nxBosNmSuLskyloYHpMM3baWuwLkrdP47Ng-8QcASegaZuuwb-sX9fdT00lJWLn5jb52AEzdfKs3mYfJ7xhjsH1sByX5CU4aMcTQkM5uMSBH5d2dEMx7AufmcCnuECk5_6Y4RKevpiVOaQ1ingUrOJZnLg7_5ppf09CPBelYHFvRRdimL61cxxM1S-1VKjWO7trZ53L_D371D1d5-6Os4OeS8Ua2ubqCjFnHr9n3SRiDPTwv8vpsMVeSMy-ELGv8PTmGCRErifnlv_G6Yc_APBgzI_GiXjW7auhMpGLcTeIIk8GVCWyYAkCZY0CMU4m7Toc-N4k
Content-Length: 111
Host: localhost:8080
{
"name" : "Benchling In Vivo Role",
"metadata" : {
"project-role-internal-id" : "PROJ-ROLE-4321"
}
}Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 246
{
"id" : "prl_1y1bPN9Imjb8kHZMmyXdm7",
"name" : "Benchling In Vivo Role",
"metadata" : {
"project-role-internal-id" : "PROJ-ROLE-4321"
},
"created_at" : "2024-11-22T09:42:16.940762Z",
"updated_at" : "2024-11-22T09:42:16.963694Z"
}List all project roles
Returns a list of your project roles.
Query parameters
| Parameter | Description |
|---|---|
|
The number of roles to return per page. |
|
The page of roles to return. |
|
Filter roles to return by metadata value |
Request
GET /api/public/v1/project-roles HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjODU5YzFhNC04OTgxLTQyYjgtYjA1NC0zOGVjNWMyYTM2NzQiLCJqdGkiOiIxNjRmNjIyNC0wOThmLTRjMjktODIzZi1mYTAyYjNkYzI1ZjUiLCJpYXQiOjE3MzIyNjg1MzUsIm5iZiI6MTczMjI2ODUzNSwiZXhwIjoxNzMyMzU0OTM1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.d85hPgnvGS8Ftmqwk-e4xhE-HeTnIadW0X-SRKF9A1t0N6rNNcOIxkZIzIrYEpMWzf46UPgIkH6EGIpqouevwev8TIUgmH1S3QkcjIWh-jfvXLzrumIKmwW7186-Dmf9T1M9HYMCAiGLOTHEYqesUQQE6K2rlkDeTDYa8Be5Y87HC4VLYpHhcvGuHownnIiFpmNyZ73wYA1DtRfZuq7YEmlkOIUOd16TK5yUTiAEZgNePi0v2RylThXHmldFYWYC6JJw_EM7qO7ZsB3QRh2Pq1sUZCpb8IsBklHNShKJtEzXjMJ5d9nYjCI41YMzzN9w1EM0xdCj9IaVF04WCnGAxmKCKgn4l6TUZwbralwg3-yLswzPRNmR-kHUSSSlPQn-NNsvfvW1EadqU0fdXIAjceHH2G0Nyj3FeEaObUf4kBQgICtbYd1Zlfh4KQQo1UaouqxaKaFFWiOdLizIdLxM32ej67Gm4wesxHIdJy8kJ96IlIdXCLN4MmWRdbWe-WOP6MnRFvRUnq00RovCi-WORve6n7aGNcZ-yWWp9bNuhBEETGFFqLOZ14TWTsOQeW53gy2tuNhakAVrvJJbMWrRRFbRt8d2wr9HfZyx_Sg9NdPXbiW0ziG1Va6nXdhfZwU-pOVLUvJIMeA71hbkPolz45zn5Rn9RyJWEYlkh_s13hg
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 668
{
"data" : [ {
"id" : "prl_5DDWnRl0ZjpyIU9XJYq7Fy",
"name" : "KnSaGQhHBP",
"metadata" : {
"project-role-internal-id" : "PROJ-ROLE-1234"
},
"created_at" : "2024-11-22T09:42:15.808461Z",
"updated_at" : "2024-11-22T09:42:15.808461Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/project-roles?page=1",
"last" : "http://localhost:8080/api/public/v1/project-roles?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/project-roles",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Delete a project role
Removes a project role.
Path parameters ./api/public/v1/project-roles/{projectRoleId}
| Parameter | Description |
|---|---|
|
The unique identifier of the project role. |
Request
DELETE /api/public/v1/project-roles/prl_5FE05xanBzLawZwke9dU8P HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiMjY5ZGY2Mi02Y2NkLTRlOWMtYjI2ZC0xZGM5MjRhYjJkYTYiLCJqdGkiOiI1ZmJkMDI0ZC02MDg4LTQzYjgtYTkwOC02ODI5NThkMjI0NTAiLCJpYXQiOjE3MzIyNjg1MzUsIm5iZiI6MTczMjI2ODUzNSwiZXhwIjoxNzMyMzU0OTM1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.h_Njnv6i303JtzJpJKWAgvhRFX1W7MjWqd8I1XJvDiLWqoLYFNCN0GT_A4Ny4k77_JhgaWX5NktW4lPQeYAs_08UcRRgQ3BZNzIxEBk9pidu0KT6U3VxEbDcEIaflJjzEgH2lwnrlADJ9S0ssa5ZoDPuMVMg1YOeEOa5R65-pLMk8rOYf01CPo68Q89JGM1fhK0KSPc1EfH3h7RL1HCAwWDPHtaZJJNQunShRO5otR2uVG1bviZJE-6-TmSzg0GJmQFU7vh3hcgYCOBx_EpFOcC_36q8DXr7PWC6-KO6RFa1zsdEoBZm_9vazeek1RE6I4r3JbSnguZDkITj6zD2lil5DvxxupPWhRirBS5o-uWw9h0ElsQw-c7BduEHfJ5Gva6plC6as3qq09cSwTSfXmpptVLZUEqIHqcxCH1ysoGqBkclAeaie3TPa0uI7BxELnsG6ELD6-vRI2Gi-Tn3fqosUPLAz6Y823vVUGTbXSkqRp5ciwIkQdqiBk4xUdlhuX-i_vfa9goP7Tg-FhohFIsP40L5sU1zcAME6HnC7YtOBPdVqVRXGafCcTT9WG_q2665YPBYjqJHiZGMlj5sILUCYawTIUYacGWd2e6YoShy2IhBSDP0h-idX_BqRpJjjTmA8tBQ-uilorLi-viYuwGUATkIHHtBbagS-w1cmfg
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22
{
"deleted" : true
}Project User Role
This is an object representing a user’s role in a project. For example you can set a specific user as the toxicologist for a project. You can retrieve it to see the user assigned the role and the role name.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the project user role. |
|
|
The project role associated to the project user role |
|
|
The user associated to the project user role. |
|
|
The project associated to the project user role. |
|
|
The created timestamp of the project user role. |
|
|
The last updated timestamp of the project user role. |
Create a project user role
Fields
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the project role. |
|
|
The unique identifier of the user. |
Request
POST /api/public/v1/projects/pjt_41aAkA5b73fdIWUHoIeG0I/roles HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhNDBlZDI1Ni1mOThjLTQxZGItYmMyMy01MzJjODliM2MwODgiLCJqdGkiOiJiYjZhMTQxMS01ZTI5LTQ0ODMtYjZhOC1jZjc3ZDUwNDE3ZGYiLCJpYXQiOjE3MzIyNjg1MzgsIm5iZiI6MTczMjI2ODUzOCwiZXhwIjoxNzMyMzU0OTM4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.Wb83Tbv4vAcd8RWKNqkgiSfofJ42TxkBFOX4PF4xox9ZSs_vVn6vibNEoUpHnttrMKEOEJvfsRWp157PZe4U6JbMU41TwSOrA8HIDYXJC0oSg0k5oqiBqC1yvauF6z7MDKZFB25RNCCuRVCaK9Fr82Ok4PUlb5nGRAXorciaBqs_JBO_2M1GeiNwQulvmMr9htfO-eSJgfK_sJd8LC3rulF6YD6SvQW4hHM5DKfDrMuPETajtZ4X_pRBYhy0P1TjJas9eaob9hMf441ta5q4LU_xj5lPBBWqHfDzSt9hGXJX0B8QHzDP6Z1Hk-Ei2g23MNAVj_F6rLq9XmYDIXz7omdAVWBVgYMM-auaqAxC1xeLV3Avn0nUS0i34mY7pbiZk5VIIz6k2Nec_Kf0DmQAmQFMeTyy6V9GUgNY3-KLWDiID5FKKMS6ls429ASN6AM6N-DHz4FcXkzFLNJPf98Y-LR2Fnpe7JeRawJgWPpR4HHT3VWCIQQFuxh5ZeE1WWrbctFpRjBnrB_4p1ZgrdMR6bFb4N_sIlcQf9Pe4TGMgZfQ24TgCq9zaTdBiJ3ud_BYRtrPlvHEEH4Dy_UxAIdL4uZ4afwRifMedCyewnCPzrn7SmJwrAeFf3IPH3562avAohKqFE8u_-30DPKzyAqDMdCgyPfAqB42JVMTbAJwPNQ
Content-Length: 98
Host: localhost:8080
{
"project_role_id" : "prl_5zYl2C6dgYI8ctWHXf2Wc6",
"user_id" : "usr_11w7Oh20vvNu1UE59Pgz4N"
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 603
{
"id" : "psl_4frkkFSrzC7T0VylhW6ysy",
"role" : {
"id" : "prl_5zYl2C6dgYI8ctWHXf2Wc6",
"name" : "wpHD567dDr"
},
"user" : {
"id" : "usr_11w7Oh20vvNu1UE59Pgz4N",
"name" : "wBDdOrhbnY",
"email" : "b4qz257r@benchling.com"
},
"project" : {
"id" : "pjt_41aAkA5b73fdIWUHoIeG0I",
"name" : "NDudgOJDtN",
"metadata" : {
"project-internal-id" : "PROJ-1234"
},
"created_at" : "2024-11-22T09:42:18.847786Z",
"updated_at" : "2024-11-22T09:42:18.847786Z"
},
"created_at" : "2024-11-22T09:42:18.977116Z",
"updated_at" : "2024-11-22T09:42:18.977116Z"
}Retrieve a project user role
Retrieves the details of an existing project user role.
Path parameters ./api/public/v1/projects/{projectId}/roles/{projectUserRoleId}
| Parameter | Description |
|---|---|
|
The unique identifier of the project. |
|
The unique identifier of the project user role. |
Request
GET /api/public/v1/projects/pjt_Sjg4rfe3VNYvXxhcMSHtj/roles/psl_6Awf7Gd9pWjdckQ94QqNvm HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyNjZjYWVlMS0zNmZlLTQxNjAtYTA2NC0yM2Y5ZmIzZTU2M2QiLCJqdGkiOiI1M2Q1ZmJlZC0wMjFkLTQwYmMtOWRjYy02ZjJhNGFjNmEyNjQiLCJpYXQiOjE3MzIyNjg1MzcsIm5iZiI6MTczMjI2ODUzNywiZXhwIjoxNzMyMzU0OTM3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.e_nQYdGuty_WIrgYbW41k89rFswSAiAwL6AOTJg9xDdtnVx5MnUGtPrGHWfkLvH3GTGfjOSGGXWSeHGU_4TuW_3pRktBHmm5KknsRrG95p00nniDlFcoZgq_OLyTSW06QOqmSuwi6SQndImwb3Ltgz7ayLxNTmy10ewrt7qK3U7-0Ht4JuhcwZI3JRsSUoJj0zL_cMzSEVO4tMcjQyu3IsaL9nJtyW1jT5lazYZBdltxMDxEXgiq1Jn8gOGDPahdtsaX2v7anArGT2H_nB5QGvGDhE9tTazj5BjFxXij4Zcwq47f_Ia_cQ6XP-m7xJNXMkSVqJoAuJmDQd05BwTD1Y-u-3oAzW6caB3PDsFkibVWz3EJtFVpatoldpUjMUctqdn9GcqnowV1Mtt0feDSCj_pAAabUgkwSyf0WP8W5DKnZti1i8oHTAlyelqtPDIg3GfrF7xJddAKDhfB1gS-Se62u9KrI0O3f_zWn-KHORcOvYqLBl5-LLjA3rhgVUCBMXr34PY7wfC4WffGTjHDX2loSDHSmQrABIr83hGGSGyT4kEQTrk1M-2uQEvIl2hZJA9OcoafRZtL-2YhtHllb49Iwxufw2owqsRP6WezB1M-QDWJsFVvIpGf7S0pmQYbREcsn5Gop6zk79NJ87w8HVDx5ppIGuMJos4qhcVtGrQ
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 601
{
"id" : "psl_6Awf7Gd9pWjdckQ94QqNvm",
"role" : {
"id" : "prl_nDzGUIOYNNCh6V7DyKId9",
"name" : "xWI78l2v93"
},
"user" : {
"id" : "usr_4uTelKXtQEQ3MD8BEd4l7y",
"name" : "iSoTv0NNhG",
"email" : "BtKfo5re@benchling.com"
},
"project" : {
"id" : "pjt_Sjg4rfe3VNYvXxhcMSHtj",
"name" : "ADuCtDpT5H",
"metadata" : {
"project-internal-id" : "PROJ-1234"
},
"created_at" : "2024-11-22T09:42:16.997228Z",
"updated_at" : "2024-11-22T09:42:16.997228Z"
},
"created_at" : "2024-11-22T09:42:17.093776Z",
"updated_at" : "2024-11-22T09:42:17.093776Z"
}List all project user roles
Returns a list of your project user roles.
Path parameters ./api/public/v1/projects/{projectId}/roles
| Parameter | Description |
|---|---|
|
The unique identifier of the project. |
Query parameters
| Parameter | Description |
|---|---|
|
The number of project user roles to return per page. |
|
The page of project user roles to return. |
|
Filter project user roles to return by role name. |
|
Filter project user roles to return by user name. |
|
Filter project user roles to return by user email. |
Request
GET /api/public/v1/projects/pjt_1CV39OGc3x3hb5RnsDvFGF/roles HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4N2VmNTZmOC0yNjUxLTRjYjItOTkxNy04MzM4YWZmNWMyYjUiLCJqdGkiOiJhYzMxZjNlZS05MDMxLTQ0MjAtYTIxOS1iMWYyYWNkNDA4MjEiLCJpYXQiOjE3MzIyNjg1MzcsIm5iZiI6MTczMjI2ODUzNywiZXhwIjoxNzMyMzU0OTM3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.TCd8it7R2N5Rsoca7ol_Q69b1typTornwU1rrnM9sQbOfal5VaVzoVuKhTLNlzgJD3ynZ3kXKVMgPCnpmwA4P1R28rWuKqng-leKu4J0tD0oCLpFg3n_olkyKSQWcOYoXHfMTUQ4Uzcyx86gS9fYsqj2VUW1PYgNhNBsIu8dcFvR1qIFEVcUF6ZeT-r-Oekj1zSLby_Y0Sv2NSYaP3PMW7bw-8yxHvpoOGocWjHjJM-wEitgF9Hpyv-X_xtwYt1kecLWvI_qzmNbCa_wXLMC2WUflYgzw2PYAG07ybctw-_aMcZvUQw75BQ1lDab6_yAVcoPHfvCdLV2JxJDYexP8peVWGnXp2PqLWaGarVDbPa82TwNrCclcEo4JeL8EY9IpoACzSzRCg4_6stZ5PZFVmO-nQlQxJ7g15XkyrtyNvCqEuznMGW711BGQz2c_oZ4l5I6KNhQsuieKnpMk6A3qPiV-6p9eXF8-pqKK_4bF_CmfL3_2hJjJXLntV8U9GHkNil6CzAit13-cQ__gyz-9UGdOKIhZf0B6hy62gdbY-Z-E-5PrGlY0JlFgu-2mHMcv-kaMkQ_aeDXxyYpyDa_aG7SYOJkMbtqOas4bVuJWfMqw4m9EoW_tMeXjn11_A-SbwgCIoSaba-81411woHYAtRvULqNWMBFKiIk4A_1bvI
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1147
{
"data" : [ {
"id" : "psl_1rLLeBNfkXBGaesJoWBY5J",
"role" : {
"id" : "prl_rmmbrTSNo35wYwU1NlTIy",
"name" : "oznJFVcyOJ"
},
"user" : {
"id" : "usr_WGGpwJtrYEJljGHJENf8z",
"name" : "0fDpGRXjWx",
"email" : "57VRAUQt@benchling.com"
},
"project" : {
"id" : "pjt_1CV39OGc3x3hb5RnsDvFGF",
"name" : "jFm1mZzMvJ",
"metadata" : {
"project-internal-id" : "PROJ-1234"
},
"created_at" : "2024-11-22T09:42:17.350954Z",
"updated_at" : "2024-11-22T09:42:17.350954Z"
},
"created_at" : "2024-11-22T09:42:17.448246Z",
"updated_at" : "2024-11-22T09:42:17.448246Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/projects/pjt_1CV39OGc3x3hb5RnsDvFGF/roles?page=1",
"last" : "http://localhost:8080/api/public/v1/projects/pjt_1CV39OGc3x3hb5RnsDvFGF/roles?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/projects/pjt_1CV39OGc3x3hb5RnsDvFGF/roles",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Delete a project user role
Removes a project user role.
Path parameters ./api/public/v1/projects/{projectId}/roles/{projectUserRoleId}
| Parameter | Description |
|---|---|
|
The unique identifier of the project. |
|
The unique identifier of the project user role. |
Request
DELETE /api/public/v1/projects/pjt_46Y8UzBupljR8mMVD3auHh/roles/psl_1ZA51def9hNleNynJXqJSx HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4OWY2NDU0MS0wMWI3LTQxMWItODdhYy0zNmU1OTNjODM3NWIiLCJqdGkiOiI4OGRiY2NmOC1mMjBjLTQxMGYtYTYwOC1mYzhiNTM4YWI0ZmMiLCJpYXQiOjE3MzIyNjg1MzksIm5iZiI6MTczMjI2ODUzOSwiZXhwIjoxNzMyMzU0OTM5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.VR9Lsqc1AF7-NVO0nzKpz1dd3FJQjw-j-OHLh3NywShVFSYzLg_RUrO_Nsw201Qyl-uknKLr1XSI6BeJTifeLJwL9lY3G72kpm4LKPTMCqYuBBaiIKUfaHxEM7_gn5EsHYV7L4jvzzt6hGSA3G9VCaculoqOIOpZrzq9BL_uGGPyCTeYMSof3JvV4npcMjnEUMBJnU5vLJGLLfYx2GIzjteRjblPjl_G9j6wbE9GEIEz7SN8w6ayMQnyWmUgvGygB8hqwLCgc6EKlzcZZHtRkzl1---12KhnTsD9QK_W7yOxQ4-J7-EKfvLkcCH4UnXYsjLUGV7v9mWZUQ1pOQ86lQPVK5Un3OVjDMwTjOmqLnH-hBgC2J9IdtXnF6OH8_s2yPOBR56IbJAw5buwvrsNismrKjFb2bvMggxT5jIHvnpguYax0hLWfTca_5ohz4IB6RVhGldqUu492ysle5QD5aw6Fi1XvijGq3erCw0Dts_SCsOl7hd5oBo8vQOJvG6klsoLgAoIbonuH7AtLgthMSzWAy8f_dA1lyIy5_UxTKqL7Y06z1jcHlGPolSSNZGDQlSIc29yDW_7t9D99DnsoVxp-d26kY3DB9FaaxpjOYMGjTAgArIgzbWqYRHJRtKOLnuenK4-CRLSBAwSskvyXUMwGUz_5rMFKqL2G2W0-GM
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22
{
"deleted" : true
}Sample Resources
Sample
This is an object representing a sample such as blood or tissue collected from an animal in your facility. You can retrieve it to see the sample identifier, type, details like volume or mass and any metadata assigned.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the sample. |
|
|
The sample ID of the sample. |
|
|
The type of the sample. |
|
|
The collected timestamp of the sample. |
|
|
The details of the sample. |
|
|
Comments of the sample. |
|
|
The metadata associated to the sample. |
|
|
The study of the sample. |
|
|
The animal of the sample. |
|
|
The user who collected the sample. |
|
|
The created timestamp of the sample. |
|
|
The last updated timestamp of the sample. |
Retrieve a sample
Retrieves the details of an existing sample.
Path parameters ./api/public/v1/samples/{sampleId}
| Parameter | Description |
|---|---|
|
The unique identifier of the sample. |
Request
GET /api/public/v1/samples/spl_1GaqIx5auuENYX103NkNzR HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwNGE0ODg2My0zNDc1LTRkMjYtYTU2Ny1kYWNjMGM3MjQyOGUiLCJqdGkiOiI1ZWI3MWM3ZS04ZWI3LTQyYjQtYjE0OC00NWRjMDk4MTdkYTEiLCJpYXQiOjE3MzIyNjg1NDIsIm5iZiI6MTczMjI2ODU0MiwiZXhwIjoxNzMyMzU0OTQyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.XA6ytjtn5mFlTgrYgVNgTjzwQ1lwqOcFmUE3V7mdIcznhxkHF2XdudKr0Jc2T2VbwTzP75r03EoZCOY-fsQ2JCLtVJvwWl6o45K5Q5cLBgR1lf5vSJDfRrZPD0ckrZp6lmE9HV_4dJk-gNreIW09CKD-uzUh-Kx0Myp-fy1FXKKluOZgtDxhPOwFcgpH8Dhn0wm23K0TBpaA9zlm1dPBUACG4-5l2YmPa2LOsIrOKC4P8EPOQHJkF5pRuRkwRUYhzSJ2nZbONEwFchcfVoY1vPE2weQfL4kaVrkkS_16fCdstEH4kni21sYv6IlXldUcTdY3zqx9Lowvtz9HjIUitS0kJlcma6ErNixHFkO0W0NYhSoK1lO5P7aaGV0J3Z_BLYYuQ393nfJO2m7oOHHX7cmj3nPcaGjTeC7kbUVkt2RGymMhEpqa7PrmYq3ESoSE1_wUm7Ce9lhO8pT7BON7aFRxYfxJxIBIofkGCq6XhiNIgA8eB7n0tF1X27XPn2JfDpMGuLiP_NlspfMwQo0gjeu_0thcwRh8oItFpZlCN1NhZ2NjmrRNkK_3r-j0j1c5vuCA1oVr6ZQhZKX4I0dIrdVDikhYUbJM8LZVVnAQmxz25MmO9lSPKJbUAgDDCxriVeoBouo4T3ylE7UgWx91ttgOo-b_dw-QY7b0_9VM1tA
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2734
{
"id" : "spl_1GaqIx5auuENYX103NkNzR",
"sample_id" : "S372968922",
"type" : "Blood",
"collected_at" : "2024-11-22T11:42:22.802365Z",
"details" : [ {
"key" : "volume",
"unit" : "ml",
"value" : "5"
} ],
"comments" : "A blood sample",
"metadata" : {
"sample-internal-id" : "SMPL-1234"
},
"study" : {
"id" : "sdy_RLubXA66PWraX2250iitc",
"project_id" : "pjt_6h9kvN92uwbJeXj5Plx7si",
"name" : "1d2Y0UvM3C",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "7h2twLduVR",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_1fWz2z4S07kZ8epxjCxIbR",
"name" : "wIbR9yQAW7",
"email" : "xRNFPtUA@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_1zjPDa4GAuvIyHTiXRGFTu",
"name" : "cEKDfycgpR",
"email" : "46fTfN6n@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:22.406635Z",
"updated_at" : "2024-11-22T09:42:22.406635Z"
},
"animal" : {
"id" : "aml_7Er5EtwXE06o6lR2GLafIy",
"study_id" : "sdy_RLubXA66PWraX2250iitc",
"study_group_id" : "grp_2FxFqEHbnuzHeYwtRqyds3",
"cage_id" : "cge_fY7lnlftU4Air2uS5f9jC",
"catalog" : "A0000001",
"name" : "OYoOoZTIhf",
"number" : 1,
"strain" : "3i7hdwCaQV",
"species" : "gmjxLGu8wq",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "Hxw5OTszWS",
"ear" : "GTZw11TtHe",
"tag" : "ikmnoLcpzq",
"donor" : "irBjKXNAGz",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_NL0vway4cQaCVkp1TB9SQ",
"name" : "vx4SboEPxk",
"email" : "YhfIpZpN@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_AH3eeKY1u6O89V8kuekQN",
"title" : "Found dead",
"comment" : "cssLgZ7fTc"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:22.606183Z",
"updated_at" : "2024-11-22T09:42:22.606183Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_i9CoFU1mkm4fLewhHFZ0Y",
"name" : "vyb9NEbfKT",
"email" : "Omd16ndD@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"s6Gc9E4JKB" : "NmK1Llj0pY"
},
"created_at" : "2024-11-22T09:42:22.787580Z",
"updated_at" : "2024-11-22T09:42:22.787580Z"
},
"created_at" : "2024-11-22T09:42:22.802376Z",
"updated_at" : "2024-11-22T09:42:22.802376Z"
}List all samples
Returns a list of your samples.
Query parameters
| Parameter | Description |
|---|---|
|
The number of samples to return per page. |
|
The page of samples to return. |
|
Sort samples based on an attribute (animal, cage, date, group sample, study or type). |
|
The order in which the samples will be sorted (asc or desc). |
|
Filter samples to return based on animal. |
|
Filter samples to return based on study. |
|
Filter samples to return by metadata value |
|
Filter samples to return based on sample type. |
Request
GET /api/public/v1/samples HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0MGU4MGMzOC03M2FkLTQ2M2MtOWY2Zi04M2FmYjJjMjc5ZjIiLCJqdGkiOiJiNjAwMzY4YS0wMDljLTQ4NDktYWJhNy1lZThmZTI2YWM0ZTYiLCJpYXQiOjE3MzIyNjg1NDEsIm5iZiI6MTczMjI2ODU0MSwiZXhwIjoxNzMyMzU0OTQxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.T2Kx2yDWg2k8edjjedtSyGWieLNkD16FepTMQ3tcf4FwNLrB7k1Kkw5l0ZUWboYsBC--Wy2KB8fnQFhlseAB7ywokRn0BolRqfHweC0DDha4nrhLMF0CI2n_2R7tTkevmMTq1pYyER9_j1NT_Cy9nnAGfem4824ujishPat8Ccrj3i3riUyy279MtLkA3VXmWm7Pv3D0CbHqM_KvuaMx7gF9GN_rSf-d27g_rki3ZS5375fN49rz6fJUXRqPp2mLvTYUVzjCOpFRchJo3y_VyS2C6ehJN4T_hcrjLL5c1dXnX4-N1PqdIoCo0wlpzIc_bFrf6hU8wpkeFvAKZS5xk4txlS-sPUe2IhlpKPP4OJG2HH_qufK4aFJ00IY-ttTS_tX1OQ8847TQ2gDjiw5a0X5drZMJHpBLvJAFAKS8CXkt3B5I9S4W7sK1NX4VNhUu0upQLUWfyebQmGsrtA740LKVElCXsC6wY1efBm4sIT7NRsPe5vD4h1e3saULn94K33XGh33E3CLK5WX3AhBKNZ0lFLNU0PF9NzkXAF1QCbFusuAGMyb4CtXLr_OgLz27eAoClm2L-Q2FEoiOhusACB4UJmsUiA5q0YKEgoJN19mWVjfgE4UH7xW18FIXgs3WjwmG4uGrqlfVLWRUK7K5DUBj4NYLyOg333CgaC1OrvI
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3329
{
"data" : [ {
"id" : "spl_kRlaEePsjrcav3oXwaVvU",
"sample_id" : "S562193464",
"type" : "Blood",
"collected_at" : "2024-11-22T11:42:21.386135Z",
"details" : [ {
"key" : "volume",
"unit" : "ml",
"value" : "5"
} ],
"comments" : "A blood sample",
"metadata" : {
"sample-internal-id" : "SMPL-1234"
},
"study" : {
"id" : "sdy_3gAjMpJxbNbEgqNWthBJ2j",
"project_id" : "pjt_1mq7gZpEmmeR2eaWDdocAI",
"name" : "vyMyhDQpbb",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "m0slfaYMtR",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_43khC1t05FvIhforwJ96B7",
"name" : "IoyNHNhRtX",
"email" : "jyIDZHKT@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_10b7Vgfo69XQc19uOHcHQb",
"name" : "TJXk3Opfc9",
"email" : "xjc1nMUF@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:20.998227Z",
"updated_at" : "2024-11-22T09:42:20.998227Z"
},
"animal" : {
"id" : "aml_3HIuacp5L1EKD8HCV7YWgo",
"study_id" : "sdy_3gAjMpJxbNbEgqNWthBJ2j",
"study_group_id" : "grp_3l9SmAl2j3N9HR2FvsXdvI",
"cage_id" : "cge_6dtzZFfrpVtB7i8f9fFvxO",
"catalog" : "A0000001",
"name" : "CBdZqZzQTU",
"number" : 1,
"strain" : "gUPkKqbFtN",
"species" : "5l1CLiW5Co",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "EaeEZbCe7z",
"ear" : "qpcl3mxJ28",
"tag" : "OVUaNeNfyt",
"donor" : "vhBFPaTH94",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_6VxgNPT0UOULuLhssCTknn",
"name" : "ndH6uomPEv",
"email" : "N3tL6bmu@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_41P6Obm52Z9pIN1s0uxX73",
"title" : "Found dead",
"comment" : "4HXfKo9abP"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:21.201914Z",
"updated_at" : "2024-11-22T09:42:21.201914Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_60KtQaWDtiQBMuaPrZs4le",
"name" : "Nz8PQRd3E8",
"email" : "4vaqxlB6@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"uegHvq1UhH" : "6TwJJGPZro"
},
"created_at" : "2024-11-22T09:42:21.370390Z",
"updated_at" : "2024-11-22T09:42:21.370390Z"
},
"created_at" : "2024-11-22T09:42:21.386146Z",
"updated_at" : "2024-11-22T09:42:21.386146Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/samples?page=1",
"last" : "http://localhost:8080/api/public/v1/samples?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/samples",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Species Resources
Species
This is an object representing a species. You can retrieve it to see the name.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the species. |
|
|
The name of the species. |
|
|
The created timestamp of the species. |
|
|
The last updated timestamp of the species. |
|
|
The active status of the species. |
Create a species
Fields
| Path | Type | Description |
|---|---|---|
|
|
The name of the species. |
|
|
The active status of the species. |
Request
POST /api/public/v1/species HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5YWUyMGFjYS1jOWUwLTRmYjMtYTFjYi02ZDA3ZDZkMGI0ZTYiLCJqdGkiOiI5OGNjM2VlZS1mMWQ1LTQ5NTItOTJmYi03ZDE5ZjJjMzQzZTciLCJpYXQiOjE3MzIyNjg1NDcsIm5iZiI6MTczMjI2ODU0NywiZXhwIjoxNzMyMzU0OTQ3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.hSswjiX1TCfAOk1LA6oape6SW1apaynzCc0mwJaNkWLLp5OG4UVDQvyu5RhaA4J5BMCIvUz5ahjKm_e8MPPfEFNNuhV_FKy7zn8KjIp97O2Jdp80st26siOhrIEcL30kXBUtA10KZqRJ0Zrz9ewAQPk2i3ZkILKjUdldx3bGk9u23Wr3N2D2D2CWoQXx0QmhPR60IIxQMOelm7os1y9ELZvXIG0IYWhkHCb3ucHES3p89l2IF6xkf4QwVQshP73cbVBFTM2SotsVwrPnaC3P2GwtGl6mTOVwKtHBgPS40XnLj8SOGoz5rP_FI3FsgOWqpAqhFi7vqrl9noPAH4CkCy_H7pTbF6NQr-F8nTaG3d55AZKlHljeRZC0SE0zV9avSJDzCxhb2dV81ghAWJYVySuFI9ZV9MLx6gVt4aAgqVhcVJpJYPwM2UzO1bZAmXWQZU2DBI1OIzLegt34yvmAhYFXuqfgA65-YMkevJq2PtvHrH8QUpf8_Y4l7WXb2MXpikoxBk66Dj7Pc9Q_EuwoyEhyMWnWGZbhOPDIV34r7d8kATsE0uMXS9IEfHw1t4dcw8BHV1SJIr5sEtA6gCed43vVzX1f2NxROMxJG30Gp1Vi1vP5pstF-wNrVD5FZRHsaoHH0zJ3w8YHs-_gJIAgX_BcUxboHQbUFwKIQoPZn_4
Content-Length: 46
Host: localhost:8080
{
"name" : "KIeq0333VT",
"active" : true
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 181
{
"id" : "spc_58lVhbo2GsuFO3kUl68Lhd",
"name" : "KIeq0333VT",
"active" : true,
"created_at" : "2024-11-22T09:42:27.083822Z",
"updated_at" : "2024-11-22T09:42:27.083822Z"
}Retrieve a species
Retrieves the details of an existing species.
Path parameters ./api/public/v1/species/{speciesId}
| Parameter | Description |
|---|---|
|
The unique identifier of the species. |
Request
GET /api/public/v1/species/spc_4vbkJrKerPdss4mvRoySYy HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiNjRkMzQzNC1iZTU4LTQ0YjUtOWM3NC04ODEyN2I4NzdkMWQiLCJqdGkiOiI5OGQzMGIyNC0wOGFlLTQwMDEtOTU2Zi1lODY3YjMzOWEyYTciLCJpYXQiOjE3MzIyNjg1NDcsIm5iZiI6MTczMjI2ODU0NywiZXhwIjoxNzMyMzU0OTQ3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.Xia5otmF0w23fd78tmkqCl2gQnS8Ij8ayrdmS-BSdNqz5DypSPPDZINMinmxb4BRjKdFoDL7o1bsaAyB848G86PicQ-oBLTI7ScRlbjRnn78ZxKsu3EGR6OiGKw2jipwKHYjam2cV6XeEsi2Da3cgp3Y5eOL6B_GVK4Qb3bU9yVt1ExeTX0s5uplQ5xalS5pPSiLFpcOg1Bq4u2Xntf0hEfsQhVfp92-dmL46ngLD4_jCMear6fx1p8x1fPeG815oLRcu8SUhNDq4zxoKthFs-gjyUr2Je0fxJZsQpO8vWCOSeHOOtEoljftDAjFnizz35XCk6ySzsfPsydy2AW2T0jJnikva2h6DeCgGGonCPHrGwnxj_cad4hmZ9QBzDOQSHtHbj8xpN7897hQPyGn2a6EoZkFYeZIdDMJN9aqy_d0SrcN0tVuUztmuK2Uv4wy3awLM24dq6UOG9UXWnsVfI9RuWjMDeSngKywL2ENUhGBzxBX0gkeiVlCEqrABJk6A0MdJcjeJzCkNc0Rh9c0sqlvN50YA4l6SrVDQTLXub_tRpgdFifba6vGT0gtW3T40pbImMDZhdRXfaPJoC6e0-WILYd1XhmOCxIyD-bVN2Qn8Wxkcbz8YjTvd2MNXE6Tmf59_KH4_7uTslw_uW7sRgnPS546Dm0ZcZbk3kp2czg
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 181
{
"id" : "spc_4vbkJrKerPdss4mvRoySYy",
"name" : "zlZaEMVPUh",
"active" : true,
"created_at" : "2024-11-22T09:42:27.104463Z",
"updated_at" : "2024-11-22T09:42:27.104463Z"
}Update a species
Updates the specified species by setting the values of the parameters passed.
Path parameters ./api/public/v1/species/{speciesId}
| Parameter | Description |
|---|---|
|
The unique identifier of the species. |
Fields
| Path | Type | Description |
|---|---|---|
|
|
The name of the species. |
|
|
The active status of the species. |
Request
PATCH /api/public/v1/species/spc_1GAZACMFClibXGNLEVBOcR HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiZGVkMmRiZi04MWYxLTRhNjMtODVhNS02ODI0NTM0MTBhNjUiLCJqdGkiOiJjOTcxMmYzNC1hNWNhLTQ5ODItYTdiOC0yYzkxN2JiMDkwZDkiLCJpYXQiOjE3MzIyNjg1NDcsIm5iZiI6MTczMjI2ODU0NywiZXhwIjoxNzMyMzU0OTQ3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.U-AR4n5fHZTzRa5k14EeMW_HxoPIPKE75Pnrxp3RAa8dj9HzDe_qPcLO15RBp6iS4fzG8irvAs89CFhKXnwcxd8COCoDiFMqowGo_-zhKall66WFT_JxPWDuXgckjIsNQSJLjI2jrUW1UQDd5zGyEAkC4hvcu3PAJ-97VNRjwbXkVznohC3jPFJOMnpxuC7bz7xZFeRx5_jPmQ-lRVp2PsIouhpB46B1UMJ4DJ3gMbgwX21ZqE51hBiJvik5BksdjEskh2oZkh-fUKSO2GP7D2jWE01nngiNb_cC6cbhTN8KNIX4DiXAB6C0sttAmvIe8fAP03LLhvtSaS7cDFMHBKYadhmYzKX9VlSKWboibvroYi46vd8b1_pU0v7iXrVsQkPAvAXpByZrkOpLvBZDGpfbLrUJPs1iQpcdq1ZIgXVSxSazVv4Tm5L9UV9YKl26edhp9lox0nbDC7RcBPOgnMEPJtjP-vw2Kv1gdm0AegUdBWN_fAPGfTJrvDa50kCxpPhIET1K8v6e7LTdl6X6t5sD-8MIgTBGQNC4H-UDzltSGZQfGKeOY4KxMnEn06neRJTPlvwyaiixjiMCnpwU68Q69XT1cwi-s8Ki0s5Y4XOw6HdJa4SUEx3Gxfvyb68sUv425E-gFmvDtCED_dywsxnNjpe5BSf5NJ4azhyVbCk
Content-Length: 61
Host: localhost:8080
{
"name" : "Benchling In Vivo Species",
"active" : true
}Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 196
{
"id" : "spc_1GAZACMFClibXGNLEVBOcR",
"name" : "Benchling In Vivo Species",
"active" : true,
"created_at" : "2024-11-22T09:42:24.191602Z",
"updated_at" : "2024-11-22T09:42:27.219433Z"
}List all species
Returns a list of your species.
Query parameters
| Parameter | Description |
|---|---|
|
The number of species to return per page. |
|
The page of species to return. |
|
Filter species to return by name. |
Request
GET /api/public/v1/species HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjMmZkMzE2Ny1jOTg3LTRkNWQtYWZiMy1lMTM1OTk0OGQzMmIiLCJqdGkiOiIwYjg4MDVmOC05ZGVhLTQ4ZmUtYTk0My03ZWE0NjhlMTRlNGQiLCJpYXQiOjE3MzIyNjg1NDYsIm5iZiI6MTczMjI2ODU0NiwiZXhwIjoxNzMyMzU0OTQ2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.A1Xo2i9eJf_6iyvtuJf2nMG4qD_YHidP31JFpfgEPOqhDGwZ0T71QDTi8gCTzkW8sVmnHLrEkTuTe6g2r0-CgHIvXHUtvmQX8UA6VEDtbvH9x3D8XFBDY6OIYPw3B-iOGjcxgaOeZcCTUYZq44Tv15LPD7UR9lbxG3wxbqntm6LFpsfzLzy82Qtv4cvjnsiZiS9f-U01FXKl6Vfv6y62_YfcIhCr6dNXxJeFA2Isponu_fNh5zWkGC5z107U9BYb9sk1AyJ945sIMLq_JEOB3SCXGR-tw3Ef-WA2X-sXEqqaTxBNiktQjrIcqooC8M5-vtSDx1kpz9UsZpWZR2WQH_FaVDxpaXt6tjEKBbEZqPLx86tat0v6zP5Efmt7HhBfilPIFGlAAVakPSd6gmhPAq4tCX2fM8QduFHtXQPR50RsRXztZLXuEZ6umkqXbrQlQFUHs3tJWeEHeiVmqQ3byQHo0PsqwpjNqLPWmFK7hGJbWCUdA87Tu1t4Fv-PYE_p5fMmd6Off_z3dGX0oa1fWfB3nY24uF4aTaR5yCtRjNgc96-uCGBwKCYuehKnanJqpZitSFqUgI_6h6Z27MKxFWaDbyfFxiDESQ3QZwIvsjug7eUB-pMvI-khQHBWwffL5P77zoIhpEA6aZc4BQh0k5msnE5_cKrGFBoQUNWyJ9s
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 593
{
"data" : [ {
"id" : "spc_1nYdZi1daKgQidgaSGMbmA",
"name" : "mdYOlXB9vm",
"active" : true,
"created_at" : "2024-11-22T09:42:26.817108Z",
"updated_at" : "2024-11-22T09:42:26.817108Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/species?page=1",
"last" : "http://localhost:8080/api/public/v1/species?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/species",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Strain Resources
Strain
This is an object representing a strain. You can retrieve it to see the name and species of the strain.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the strain. |
|
|
The name of the strain. |
|
|
The species of the strain. |
|
|
The created timestamp of the strain. |
|
|
The last updated timestamp of the strain. |
|
|
The active status of the strain. |
Create a strain
Fields
| Path | Type | Description |
|---|---|---|
|
|
The name of the strain. |
|
|
The unique identifier of the species the strain belongs to. |
|
|
The active status of the straom. |
Request
POST /api/public/v1/strains HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlOTJiMGQwYS1kYjZkLTQzNjEtYjNhZS0xNzljZTE2OTVjYTkiLCJqdGkiOiJlMmRhNjg0Yy1jZDRlLTQ2MWEtODM5Yy0wZWIwYjAwZTc2MmYiLCJpYXQiOjE3MzIyNjg1NDcsIm5iZiI6MTczMjI2ODU0NywiZXhwIjoxNzMyMzU0OTQ3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.NxWkOA2ArdRHkAcrRQZVx6J87pqJLTvTcn1sB19ta5uQVZ8drHkcQz0aJgSfAy5aihl_I63ahn2J6xVhU6JlnHSRa7ePqyu-ge0GlIx5-h0XE7NpX2XCj19zB75UlGbjLwllR9iOWGDbCZ3DVWZdFU61rYjdJuBfOxrlVlj3wVbJcAqibHx-G125zQNBfkS73wOMIqF4XxFXxt1zogdUauWmf0BYiS-zAhHRWzflPCGQ2vuape0W9lUA5MgaS43AXn3GBzUK-BVlzXpXXunzvKIy7QS-mJWrlCItmoQhN4W0nOCpNnM7GT0uqSbzgE1Z_J_bW8bDkNiHYnZ7pekWJGRup5-EP4MqxLRHg_lWAF01VB9Oqs-9JcJHJueWrz-P4FRNSCmfInuRJseYCIwINSIiUGB_2vCH0DvDxVtObOx1vKj8NR_8TShXYuFYM5E5Tg28cVpks1D1gSR8RfOQwzW14N1NyIjO5j3GRnjhQOjmN_L5_Vlci1AKGmRodBsDlHonKxk0UuKGmO8kM2zFgFfWvVQZiA35vLcB_ii2GNAgaIRCP1lqcoFz_JagcTxuD3WOhMFrdalYvODkiym2a-XYi4pM-1Z1sGljfFarG9ost4LEtNuufTCQznMBBXnp-56gja9jgFWLTXVXeO1fvREPUVN6FOHkYDh_LUjyJYo
Content-Length: 92
Host: localhost:8080
{
"name" : "0hREzzrxzE",
"speciesId" : "spc_6MmSiAEXlJs3IPVu1Qh1Ax",
"active" : true
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 390
{
"id" : "stn_40M5jjfhk3OuTEtAASgAhN",
"name" : "0hREzzrxzE",
"species" : {
"id" : "spc_6MmSiAEXlJs3IPVu1Qh1Ax",
"name" : "pXgWMcgTGM",
"active" : true,
"created_at" : "2024-11-22T09:42:27.788894Z",
"updated_at" : "2024-11-22T09:42:27.788894Z"
},
"active" : true,
"created_at" : "2024-11-22T09:42:27.796060Z",
"updated_at" : "2024-11-22T09:42:27.796060Z"
}Retrieve a strain
Retrieves the details of an existing strain.
Path parameters
| Parameter | Description |
|---|---|
|
The unique identifier of the strain. |
Request
GET /api/public/v1/strains/stn_1HXGgdOwq8K10oiyvhRwHe HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwOWMzZjhmYi03NjM1LTQ3YzktYmEyMC0yM2NhNjI4YzIzYTIiLCJqdGkiOiJkZGIwMDdlYS0wOWE1LTRiOTgtYmQyOC1lZjczYTEzYmZhODEiLCJpYXQiOjE3MzIyNjg1NDcsIm5iZiI6MTczMjI2ODU0NywiZXhwIjoxNzMyMzU0OTQ3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.Z3ioSWd3smth9KQ32MOWHei5_PLJpPXk3aeYaPmoRUHYc5_FIMs3nAwIAkCATHXDc_fBlgMHCTsO7UJqH_smUYWdzMa7saxp_umAK_qzJnol6kMscB7APIfR_-mDb7LoL5St_o4sPh9mkxvjg8slSerfIrQkXH-5xbgRYIBGqRsYP7DVs9eZzbD5sx0eEimD3AACfF5KbkzR21FS-taxtsoUe54BecJLpWlSO3aG9BgyZA_BBuRjxovhnbqOxvc9wXkh-IWTpkekCMVbA_1xhZ-DA3mGoQwoyVPevAJ9tEKJzu6-JD3OgOVlIL0OQ6KiWePNnztcxJ9GMemwMdT5HoNZNU6bS3tYb9YJeA3TQHQy65kLTFPafezm0ivJ3QfBBptTNvb6SmdWbaSI6oXdjnFgq1pBXhmkVtcdvYrdRwNnPISlOZDbJqNij8BED9tKylP07oiKnaJWmMlnUC7SKjHoyRTPwqGPvCLkYHJjp3DvYpTEBH_eF9Jmu40h-eSrW9ftm9AVQz_7xx_O53a5fDZl2PBmhPqVr8XX8iO9T6TavRypnp7P2eZwpTJ87QxnWOwD_-VfUojIUL1TO-6MWqIRCN1CnLIzHbF3NeieWJcPIdPX-rTlXFFwg5CT-qske31RlOI8jA1fA1Bs38yT5io5XHQQMbmRmloQZS6pYe0
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 390
{
"id" : "stn_1HXGgdOwq8K10oiyvhRwHe",
"name" : "yBWAwxit6D",
"species" : {
"id" : "spc_5fUohb0h7iEwcSMZs6DCE0",
"name" : "AvXNQLh4i4",
"active" : true,
"created_at" : "2024-11-22T09:42:27.398442Z",
"updated_at" : "2024-11-22T09:42:27.398442Z"
},
"active" : true,
"created_at" : "2024-11-22T09:42:27.400545Z",
"updated_at" : "2024-11-22T09:42:27.400545Z"
}Update a strain
Updates the specified strain by setting the values of the parameters passed.
Path parameters ./api/public/v1/strains/{strainId}
| Parameter | Description |
|---|---|
|
The unique identifier of the strain. |
Fields
| Path | Type | Description |
|---|---|---|
|
|
The name of the strain. |
|
|
The active status of the strain. |
Request
PATCH /api/public/v1/strains/stn_HpInPjsLH2D4fNlQeXNoc HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJkYzJlNjU0OC01MjQ3LTRlY2ItYmVlNS0zYmVmNWE2NGQ5ODAiLCJqdGkiOiJhYjA5NTBiOC0zMDlkLTRhMGItYWNhMC04Yjg5NTMwMGI3MDgiLCJpYXQiOjE3MzIyNjg1NDcsIm5iZiI6MTczMjI2ODU0NywiZXhwIjoxNzMyMzU0OTQ3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.INT5aLWeXqiEyHW7yipLLhavTqn3T9oIoSIirYuomxXNxQjJ5DeFEFiqmdSCl6puP50nySjcJnszXYsARz4PikMLiuQBEh5uFCQNoyUTwAN2mtB2383In5TwZXPXQc7T9ANCIy5AvGp87yfYc6VEEY3bP5BbvOZXAULG0gFBU_JI1_k9lPOZ7tOmtPe9qD37Sae1aWpKM_giFZF5vr9ns94puQFGvNUoFGi5ZD1PkPJqLfsHrPzyCEimA59AKUkP415RM0XQcAAykda127sLcuJQIsdMx1VJrLuZcUsmJAXLm0dZdL_InspYld4dyrNAcBa1IulSmJUH7QJcUTghNvizvRrf0DyWDtUdoU6L-5mq584y9936j2K5-94VwCAiq6EfmJVW63SeJPlgu2QcGnev5gnJQd8s1U1nuv3tlJp004poJdFqG4iX0TfXIGmrp0i7xRmej8QFZJanxEoH0xLRSpT-LYXarmMlw24q57h8ZwqgqwvQMZF2yO0CEddr1uGOMa6aOgThJKwV7UiaXLXYiJUJ1ABr3poU3taOkjXLzY1XmgP8vV_7YvqM7FrFwUopt7TrxC52F_dNDhvPqUT0uqUQwkQ7qzauo9KnpBaVRwPLITEq8bCqhexfbfXqiO7iY5vm3RBI21SxSjkbhogHbHcDJGq_k0tpoeqFA7M
Content-Length: 60
Host: localhost:8080
{
"name" : "Benchling In Vivo Strain",
"active" : true
}Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 403
{
"id" : "stn_HpInPjsLH2D4fNlQeXNoc",
"name" : "Benchling In Vivo Strain",
"species" : {
"id" : "spc_4LOeV2u84RXvpQdLRpH2WF",
"name" : "oFhvqZ9oPO",
"active" : true,
"created_at" : "2024-11-22T09:42:27.816064Z",
"updated_at" : "2024-11-22T09:42:27.816064Z"
},
"active" : true,
"created_at" : "2024-11-22T09:42:24.820416Z",
"updated_at" : "2024-11-22T09:42:27.854576Z"
}List all strains
Returns a list of your strains.
Query parameters
| Parameter | Description |
|---|---|
|
The number of strains to return per page. |
|
The page of strains to return. |
|
Filter strains to return by name. |
Request
GET /api/public/v1/strains HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlMzlhNzQ2OC1kNGVlLTQzMjMtOTFhNy1lZjQxZWE4NGJmNTMiLCJqdGkiOiI3MDA2OTUyNS1mMjg0LTRhNjMtOTI5OC1jNjhkMGFjMWVmY2MiLCJpYXQiOjE3MzIyNjg1NDcsIm5iZiI6MTczMjI2ODU0NywiZXhwIjoxNzMyMzU0OTQ3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.W-ecxDvHgEo2qRGOrVw8LhzZz_qFZj5sBoEpsfLOJhu4orGPwz7Zu2cdlEGmgZ5ZwTLvDWNwz6kf5Gh65vRvzX2DP30jx7QFyga0y78iDYIHMAxKLs7kmgGM8nY6OLZAS5OZGdTjHEWvEeHBZjY6GO1ogYsP9J5kRc9mbcYpz4BrSieVCQ_wAEfT9HKQ1da96x6pL16jkvHF0aeXCYN43oVNhpooQvTLWdfMXFzjysAJtnLzwjQJcEZPYFG6RVHUh-4cZozD5NrCMiEsKAIXZfq-rvkEL6ZXD9KMg13dte-B8AxOc1aYIjLmiNGrBKMQZhT0VYPFliB4d_hu1cdAx6_bSGwpPaCB7hsipMgsvTGPS4mhJ-d3G8CQcfs55MqdpdOy6dbmneVQjC8LBDa-jY9txSaKqyvHvHkVITMYjE-uYZCUILP7QIngGXnugU59IgQSYUxTQELWsjj-x9_W_owJrMkC9sbUAQUO1L_KJjNhzcr1sKR5zAouyFxV8b1f1cdcDJPn-K1KG_NMyawptTopo812GaXWj_rS4DA6M4whC52fy6xQsgEo9VB1In6W8x0kMZbZWPNknDrEQ94N6dLBr5aG-ZIKKGj8-d11xaRJ9RHNB7qb4olAq4pgaJNwx-VAAKVwFnNV63S6RNyiAOYss6ieR_JYPHMmaK6SL70
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 816
{
"data" : [ {
"id" : "stn_4xYilHh5OXt10N3JAbg7nT",
"name" : "NnazeKuQqz",
"species" : {
"id" : "spc_7fmW4etuA1yX7XtqaXpjVf",
"name" : "0w0wUSTeer",
"active" : true,
"created_at" : "2024-11-22T09:42:27.879614Z",
"updated_at" : "2024-11-22T09:42:27.879614Z"
},
"active" : true,
"created_at" : "2024-11-22T09:42:27.881733Z",
"updated_at" : "2024-11-22T09:42:27.881733Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/strains?page=1",
"last" : "http://localhost:8080/api/public/v1/strains?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/strains",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Study Resources
Study
This is an object representing a study conducted in your facility by your team. You can retrieve it to see the name, the study design, notes, average calculation for treatment groups, if it’s internal or externally conducted and any metadata assigned.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the study. |
|
|
The name of the study. |
|
|
The code of the study. |
|
|
The type of the study. |
|
|
The start date of the study. |
|
|
The status of the study. |
|
|
The description of the study. |
|
|
The timezone of the study. |
|
|
The metadata associated to the study. |
|
|
The author of the study. |
|
|
The owner of the study. |
|
|
The project of the study. |
|
|
The completed timestamp of the study. |
|
|
The canceled timestamp of the study. |
|
|
The created timestamp of the study. |
|
|
The last updated timestamp of the study. |
Create a study
Fields
| Path | Type | Description |
|---|---|---|
|
|
The name of the study. |
|
|
The type of the study. |
|
|
The start date of the study. |
|
|
The project of the study. |
|
|
The timezone of the study. |
|
|
The author of the study. |
|
|
The owner of the study. |
|
|
The team of the study. |
|
|
The metadata associated to the study. |
Request
POST /api/public/v1/studies HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4YWMyNzNkMS05MDgyLTQ5MDItYTM5My1hNDQyZTA1NDY1MzUiLCJqdGkiOiIzY2EyOTY0ZC00YjczLTQ1MjktOTZkOC0xNmYyMWViN2RiMTkiLCJpYXQiOjE3MzIyNjg1NTMsIm5iZiI6MTczMjI2ODU1MywiZXhwIjoxNzMyMzU0OTUzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.UegUnEMVnlVIcijUBY1-1vNDp58kr5_dSo9dh1rcOf9Y9SjLNk5h6yQTgWxFjropkKOXDzDn7F5cmapvk-9A-GY1Rzil9o-LbLVpW8YW1va_VB6j679LiYslNs-V-DNJ37vm2geA6cu1Ug-PqHc8prQw3qVdeLoKpJVbby2cy57TAtnjjBOwwiJXKAWWIg12kiNu1TLpbXA89GZUKPxvNHTJ07TV9j2ki3sPpvjNZmNiQmtGJrjiMdg0TdffS1-BrdaGTpS0xTxCOuwiVtnkYw0t4stM60e8tX57GuathCTPPhygnUvLGYkoyStnVNrco_zLQ9w-ed_COzLtPa5FWYmWhzAVu49NDCRm5qhF0O6kuyopriG_Dri3jAPlw1eFnHzgLReaKKGD4E9ilNpO_eaO1S4iqrEE5p5rBbi2UlKtrHrfJbpzhI47trcB9yWlOwAskKZYP4g6rQH9qzAvyVMxmBRx_5qspQhH-JvmkMV4FyavzS7ZpIe8_4aXGQ_jcT1faJfAu7Nhx7HFrtVqQVchwZzPaWZgpJdDF6WHAwShMM7a5s56SHOhQ2Qn19yLGRZQJaYXCAVHT-l1p-niYhwrJ0HN27QB3PJCewAMrMtYALXw7WQzV0OpLbb5G729BqwwGGYgDXlmmqr0-RdXXPKvvJe66m1m0KWk079UJJA
Content-Length: 408
Host: localhost:8080
{
"name" : "Le6UUvyKCR",
"type" : "internal",
"started_on" : "2024-11-22",
"project_id" : "pjt_3woDV7QsvoIjp8tto3Psum",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author_id" : "usr_3hEjlxUSkyd4gogKO90aQg",
"owner_id" : "usr_4ZLGklpzaCY6WGkJP3SasB",
"team" : [ {
"user_id" : "usr_7l1ZRtY8XVG6MnnzokI8aH",
"access" : "read"
} ],
"timezone" : "America/Los_Angeles"
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1196
{
"id" : "sdy_6mcPPKEeNc4KiPd5UYFJ3S",
"name" : "Le6UUvyKCR",
"code" : "OW-SQ1-24-F",
"type" : "internal",
"status" : "in_progress",
"description" : null,
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_3hEjlxUSkyd4gogKO90aQg",
"name" : "mu092bAjnt",
"email" : "n62DU3Cy@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4ZLGklpzaCY6WGkJP3SasB",
"name" : "vWDTsWpe1H",
"email" : "vfaZPhKh@benchling.com",
"timezone" : "UTC"
},
"project" : {
"id" : "pjt_3woDV7QsvoIjp8tto3Psum",
"name" : "miUTrT1OD6",
"metadata" : {
"project-internal-id" : "PROJ-1234"
},
"created_at" : "2024-11-22T09:42:33.319340Z",
"updated_at" : "2024-11-22T09:42:33.319340Z"
},
"timezone" : "America/Los_Angeles",
"team" : [ {
"id" : "usr_7l1ZRtY8XVG6MnnzokI8aH",
"name" : "YuBF3P7G4v",
"email" : "EVZTYjLZ@benchling.com",
"timezone" : "UTC",
"type" : "team",
"access" : "read"
} ],
"started_on" : "2024-11-22",
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:33.604776Z",
"updated_at" : "2024-11-22T09:42:33.604776Z"
}Retrieve a study
Retrieves the details of an existing study. You need only supply the unique user identifier that was returned upon study creation.
Path parameters ./api/public/v1/studies/{studyId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
Request
GET /api/public/v1/studies/sdy_19W91q29EInd6bk8eycZLX HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjOGMzMzcwZi1iN2YwLTQ3ZjQtODQ3Yi05YzFiNWM5YzMyOTgiLCJqdGkiOiJhNzNiOWMxYS1mOGYzLTRjODEtODY3Yi1hMTI2NjgxY2I0ZWEiLCJpYXQiOjE3MzIyNjg1NTIsIm5iZiI6MTczMjI2ODU1MiwiZXhwIjoxNzMyMzU0OTUyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.Szb83OJGMK14yFv4HBtk7-Tq7bO_H0rUpRaFid9W44PA3W8npKTYrVuWVOR65dRiK-cfmjIND6Xu6q0ghY955KoBRCYyws-JrAuZLJbsOX0dhCFb7LnF9sG-kKR_AEHqkUFLBlyCWgTJjzCMberKPqnMxm_IEHfyjPQNn3eANGW-qyvVxVxCIJ9WG-CoJgJ8_Z4Y0BLbUnX2EDcsQSmQ-pBPzhzCtzYC39WaOFgBwGhMWMad6o8dAKyRVeOpeCU-HHtM7K88tAtZ5VAtZQp60aIh8nQ2Wjo-B5kX-BCTgh1yoZ8ve7PG9u8Wbo4aGL1OpvvvcHn7_J4qtus22gjDJW0brW3v6TrD0FRf6VpvDmiNXKqRqAjFXcHmq0U7rrHahs60kw4rf1fRZG4NY2UJWMC1NRhQT-isntc8rxFnA92aau-k03g60D4SnBrpxwMVU1_2uvi4xi0Lf61E0j3XFiUT_aSBjj0X17cTpjLtPadQBi08OHQIEPj4eYVef33Q8RMnIB3gP6UIqbBOa7QEKSEE3cslW9MkPXUqndqZSUmFDm5qCAoYU5k4QiVFbRPnKQ_-QQY9o2Q80laZzAFFlaliEhZZLx9eG_3JLFNS2y3Mda8A2sNTvURMCUK2JPjI0hQ9A-PmnNclMKsx8bZ_gxCVIgZXtuBc0XsV-JSbc4I
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1005
{
"id" : "sdy_19W91q29EInd6bk8eycZLX",
"name" : "C18CweDUPy",
"code" : "CD-24-445",
"type" : "internal",
"status" : "in_progress",
"description" : "TT14z39QjE",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_50dGhqyDCY8QW8um1KTI9I",
"name" : "yyKZaCu6sJ",
"email" : "dmEf06TY@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_2UgBRbJdkj43VDHrHcrCv8",
"name" : "NhzoXBVk9P",
"email" : "wYbO6G0J@benchling.com",
"timezone" : "UTC"
},
"project" : {
"id" : "pjt_5DER8whVfjMb7PXI5hgnCo",
"name" : "QIr640ZE8B",
"metadata" : {
"project-internal-id" : "PROJ-1234"
},
"created_at" : "2024-11-22T09:42:32.686110Z",
"updated_at" : "2024-11-22T09:42:32.686110Z"
},
"started_on" : "2024-11-22",
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:32.692760Z",
"updated_at" : "2024-11-22T09:42:32.692760Z"
}Update a study
Updates the specified study by setting the values of the parameters passed.
Path parameters ./api/public/v1/studies/{studyId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
Fields
| Path | Type | Description |
|---|---|---|
|
|
The name of the study. |
|
|
The project of the study. |
|
|
The owner of the study. |
|
|
The team of the study. |
|
|
The metadata to be associated the study. |
Request
PATCH /api/public/v1/studies/sdy_4f8cmiqOP7LICqHHRwiidd HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2ZjM2NzllYS0zZTMwLTQ3NGMtOTBkNy00MGEyZTQ1YjlhNGUiLCJqdGkiOiI2NTg2ZTZiZS1mZGE0LTRiZjktYjg5Zi1hM2Y1NDc5YWNmMTAiLCJpYXQiOjE3MzIyNjg1NDgsIm5iZiI6MTczMjI2ODU0OCwiZXhwIjoxNzMyMzU0OTQ4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.Z0A6lTB3muruWGUWs1pnpAQV3tP1YnPAlStcaxCosqd24TRAnrriEGSaOGDm3Dh1dWaBZays_GB4yAYcPpR0LtSj5MMm5_gZMSmET6vwN9BFP3aqIit51hrZU-7RhfXjqQGLgWVRc1HQB5KBaNosMT0s1fS8b_QvWMrr3oitM8-hrjnfmf3Gb5VQUuHQ-abIb_yKRtM4TjdKvTtgULce29G3NkLXiRmvikdFADUnbgV-G9oCm16yl8zdEPl_n77BUWjsY2N9RWgwVdCAJFWKPNoCdk54kHp42clOvbkcr84Qo5glv8j_vEYkfOOoHUWHMxMiBM3JM2v80cExAnQ9-5OpeliECn7Ajt5J3LbgUDqw1lV-zYXRFh_7MCD0pexjldQcPfhnozgk5tYzu58kMQhsO5hOeIYnSgDvWpEWPJ_lQbiWVcWtcVnezdB5Ubzp4Vv7jVi29p8aawy_U190HBedr45kk4K18AuEpBeCsMWQllQ2EGVVc_NOOlvry9ioPxvoilZZXOCqtDUuFSlJKn5eUTC-fbHcOnpmGqifli7x4QVgPvr1bH4wZhy6es04QG2wXwDnG3j_3BnnakiK8mMVLFvJ2TCr7xoamujufJsQmzc5TgPqb0dqBZFfMq3rJHGS3R3gJMzCKfIyhoR7DqJNXx-HaaHjVc5hXWu1rU0
Content-Length: 277
Host: localhost:8080
{
"name" : "Benchling In Vivo",
"project_id" : "pjt_52US4RilPDVkHz0Ue31KEQ",
"metadata" : {
"study-internal-id" : "STUDY-4321"
},
"owner_id" : "usr_1erJfrWrF0hYj9iXu7P89K",
"team" : [ {
"user_id" : "usr_6gDUprcuKMPEg0CCgiomZs",
"access" : "read"
} ]
}Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1020
{
"id" : "sdy_4f8cmiqOP7LICqHHRwiidd",
"name" : "Benchling In Vivo",
"code" : "CD-24-445",
"type" : "internal",
"status" : "in_progress",
"description" : "DyYS8zlCLc",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-4321"
},
"author" : {
"id" : "usr_2NZLI6EsqLHIXFsoC7BI14",
"name" : "J9QHvvNNqF",
"email" : "C5oKT7HR@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_1erJfrWrF0hYj9iXu7P89K",
"name" : "h36YN6zFV6",
"email" : "QZHU0dh9@benchling.com",
"timezone" : "UTC"
},
"project" : {
"id" : "pjt_52US4RilPDVkHz0Ue31KEQ",
"name" : "9UfjpW9Rfr",
"metadata" : {
"project-internal-identifier" : "PROJ-1234"
},
"created_at" : "2024-11-22T09:42:28.629463Z",
"updated_at" : "2024-11-22T09:42:28.629463Z"
},
"started_on" : "2024-11-22",
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:25.801653Z",
"updated_at" : "2024-11-22T09:42:28.846582Z"
}List all studies
Returns a list of your studies.
Query parameters
| Parameter | Description |
|---|---|
|
The number of studies to return per page. |
|
The page of studies to return. |
|
Filter studies to return by code |
|
Filter studies to return by metadata value |
Request
GET /api/public/v1/studies HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjMDVhMmQ3OS03NDJjLTRmMDYtOWY0ZC0yMzdmZDA3NTY0MjgiLCJqdGkiOiJlZTBiZmU4ZC1jY2M3LTQ4YTEtOTU3NC0wM2NmNWZiYzE3OGYiLCJpYXQiOjE3MzIyNjg1NTMsIm5iZiI6MTczMjI2ODU1MywiZXhwIjoxNzMyMzU0OTUzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.DlktcuPHqKVF_qo1ed4c2VB3LIlAE3BJq2nYFgzzLswLPrFhFdwAayGpiR34Kzh3jPe3XdOpvK_0SS7jLFPXemjwLzk4v9eTMybrsQCd8kgJObsQh-i0MgHOUN4sf70wnC4GrQtB5jwYEP7NI-Wabko6Gl-eU7k02QhK9jFQvf2-KlDzV0TTix4ZkQqTZoUHAezZJQ2sUa9xq--tmkTsqyGnKTCgYkfHjV1u9fgw0zaHK4BXOD9Qjr938s0BzF8mrq-2PA7KwrQ6T625DA-fXT6dCtjSt6vBsoSgN4b9i1-mvW9rHt_9pHbCh_448E_4wlbBZmLaafQNFJELLNrr7K1svShmlBTjUQgPs1JylbKxRiphNmB0AvxpIMDmuAKkWOlvDd7sCf4SCgr2MVC7JFtLPtqaeg0f6ThOeahx_k2AEkZ51GI4qVtvphfv_DF0m6sD6VjmZkvlsO6-KYaf7rM6i6CVaKKJX6NxTinc7GaIqxf079DCbcibBJcx13hNQbU8im_Z_axtb4Ekd9XzxKX1S3iaKKfXfToMQhXzdY4tQvfDkoRN2I-IYQAqVQHhhm2eSJn1Y60HvgnB7dYaX4OqEu_rmFERNr05moqe02Ew5FCaaxd8y_tltUTXBPGExBDBTtISOcpiBv7LsmjYH9_dc5tBY350AarSMcN7Z4w
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1479
{
"data" : [ {
"id" : "sdy_1nTeXG7AtXcCZpViV1yh1s",
"name" : "L7u1vv7SpF",
"code" : "CD-24-445",
"type" : "internal",
"status" : "in_progress",
"description" : "9ilj3IfOPs",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_43BsCYni3jsV5M8jgBelBX",
"name" : "hs8ySmXEua",
"email" : "HDmthKNr@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_7FK9ChBIVJx16WKU1SND5F",
"name" : "kYBIHGr9ML",
"email" : "hhCukKyC@benchling.com",
"timezone" : "UTC"
},
"project" : {
"id" : "pjt_2Fh5fXoRfGh4YK7SjKOZVm",
"name" : "w5E07zELir",
"metadata" : {
"project-internal-id" : "PROJ-1234"
},
"created_at" : "2024-11-22T09:42:32.950850Z",
"updated_at" : "2024-11-22T09:42:32.950850Z"
},
"started_on" : "2024-11-22",
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:32.963360Z",
"updated_at" : "2024-11-22T09:42:32.963360Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/studies?page=1",
"last" : "http://localhost:8080/api/public/v1/studies?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/studies",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Study Animal
This is an object representing an animal that has been enlisted in a study. You can retrieve it to see the status, date of birth, sex, species, strain, identifiers and treatment group of the animal.
Retrieve a study animal
Retrieves the details of an existing study animal.
Path parameters ./api/public/v1/studies/{studyId}/animals/{animalId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the animal. |
Request
GET /api/public/v1/studies/sdy_7Jgt77tDlQ67UBl4lrrS0a/animals/aml_kNZYpNxlGj1EwZsfysUGy HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlNGEwMTliZS04ZGQyLTQ0ZGItODNkMi1jOTI4YjAxNDNkMjAiLCJqdGkiOiJiMTAyNzExNi03YmQyLTRkYWItYTMzNi01MWE3NDk3NjY0MTYiLCJpYXQiOjE3MzIyNjg1MDAsIm5iZiI6MTczMjI2ODUwMCwiZXhwIjoxNzMyMzU0OTAwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.H3HDil9LcKVAow3yyCjTOwFT1muA07zwERSB_suGe6gXonZJJcOBwmpujO2U1Y083HKyVUvcoJg3fOP-6hthgF_QsCUYiBMzTlYJCWYtPUsWrUijS8jhiTa4FEq0rMlkhmF04TvZAvx4lH91q-l1U0sLxGxRJGefkHaTVHugAH6BgA2I6mzDvf9n2RIumgDWayFcIISFCrTjcG0vzEf7FvHYhZTbyzMEkBkl1JDNwPxqoCXuqGofGVy7qooIRlZMoVUxYhKtmqVNiLlC9-ef4lb-ZceKWHZyz9QlP9GY3kC7LpGMUn3KGKuaDcTwjtLJkhmCPNQgUzHTB71bE8PUJ7yNomjRhqSLLIEl8wcg5dJgLRPecA-5qh4o8vOgg6yMHkikaaUkOrGjMwSbrZxu4Rxcpfy-F6Q09mjySUuDNrlQc4JD6vE-RXxl_1ZZzH1WI593t5vVhFxNpvN8c5Szm8EvpBoOPSyfW9tQF-ACjATHVKyzeSaGYFAv6FekrephMsQ4wO-0SPOZPj-QMxq7ChOT3sOQkOjwy2rSpRE1tnbUnysw-WopKwTwLZ9vb4Kfq-CZPhqIbC5LGyD0Ner-1LSzNxFhL5K9O1f6aQlA28NDhe0upW16tqHkOBuPi3WeiZ1uO-oILt--CD2c73I8Yf9rsM3SVGbtjVW0HkZ0hh8
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2498
{
"id" : "aml_kNZYpNxlGj1EwZsfysUGy",
"catalog" : "A0000001",
"name" : "ydXw5fFKxX",
"number" : 1,
"strain" : "CL650SFxUC",
"species" : "lckEnFvME8",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "JCawEPELtN",
"ear" : "FSADGdzqLW",
"tag" : "CZAgQPTnnC",
"donor" : "4hSWAhmaZy",
"tracking_date" : "2024-11-22",
"disease_induction_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_6bpEF4ihH2FWF2gp0B7RKa",
"name" : "kBcV1Fizly",
"email" : "8WBBhUXd@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_6ctoUg2FC74SaZt3uY59O5",
"title" : "Found dead",
"comment" : "nXCYCoewhW"
},
"disease_survivor" : false,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"study" : {
"id" : "sdy_7Jgt77tDlQ67UBl4lrrS0a",
"project_id" : "pjt_2BMRtJ0nw3aTTn4qUUw15w",
"name" : "pY9m8rY2gm",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "Xo4m5dg7BQ",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5LzemfBjrwO4n0nT5OdHyJ",
"name" : "281VdaQQtW",
"email" : "Wu4dSFT7@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_7XO1hIPiRSihsW1NKsuL2z",
"name" : "xQuzb7yoFl",
"email" : "S2MnNVsu@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:40.027843Z",
"updated_at" : "2024-11-22T09:41:40.027843Z"
},
"study_group" : {
"id" : "grp_1G8T734IcFLUdySrMGkkwl",
"study_id" : "sdy_7Jgt77tDlQ67UBl4lrrS0a",
"name" : "Eu9vB2V5pi",
"no" : 748334315,
"color" : "oXpPvUNgy3",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-internal-id" : "GROUP-1234"
},
"created_at" : "2024-11-22T09:41:40.228438Z",
"updated_at" : "2024-11-22T09:41:40.228438Z"
},
"cage" : {
"id" : "cge_15gk7QNWZM2TD7C1td3FQI",
"study_id" : "sdy_7Jgt77tDlQ67UBl4lrrS0a",
"name" : "EeFVMxL6tc",
"catalog" : "C0000001",
"metadata" : {
"cage-internal-id" : "CAGE-1234"
},
"created_at" : "2024-11-22T09:41:40.211676Z",
"updated_at" : "2024-11-22T09:41:40.211676Z"
},
"created_at" : "2024-11-22T09:41:40.232519Z",
"updated_at" : "2024-11-22T09:41:40.232519Z"
}List all study animals
Returns a list of your study animals.
Path parameters ./api/public/v1/studies/{studyId}/animals
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
Query parameters
| Parameter | Description |
|---|---|
|
The number of animals to return per page. |
|
The page of animals to return. |
|
Filter animals to return by name |
|
Filter animals to return by cage ID |
|
Filter animals to return by catalog |
|
Filter animals to return by sex |
|
Filter animals to return by metadata value |
Request
GET /api/public/v1/studies/sdy_4ttYWumJwFb2f12UtFI0pt/animals HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzM2I5ZjhkZi03ZjY3LTRhZGYtOWM2Yy02N2JlZjQ5N2YzY2EiLCJqdGkiOiJhYjUxMjA3Yy1iODFlLTQ0NjAtYTVmMy01M2QzMDE5N2UyMDAiLCJpYXQiOjE3MzIyNjg1MDMsIm5iZiI6MTczMjI2ODUwMywiZXhwIjoxNzMyMzU0OTAzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.HQfQm5AeWGK2KN7cSkhPupv79FB04self-62JevCFVUP-ly8cex7aQQRPV-4uNstAd7896Rupj7GYhOBV6mQQlElL7iQeQWIuG5jEfwiPYA0jAAEakZxbVtnfu_CjhBkv3mPm8R4oPPnq2ggDhmIomnq2KnMO5GcusneBdLmhxao4NSEyHvFnTyWGVLuv_jooNSXBWNLfASFCNjHF8xtWE9XnEmbH7HJuNjH3LEv7wfd1TMc_W5_GI_fhb65s608k9F3LHS82GsOsYw08NA60sAR23mRL_Pq_jtOSraXwAdk2Ki4gLOGxbD-WaGsR4Huz5K6kyeqtUiiqES9ReGY-a1U0F6aQ7AsKZVblxCCnlLaZsfKIZTbFkWe7AKMfNq8boqehMmqBJINb_3_MjBemJKvjoQ4OPtETW6mYu4qeBxmgAr0kY2WsTs0wrD_2RWKpfls8DsSzJQaj0wUmIXD0buvlroyHhg3poJiP3YUQGSTOyylVeATP6BGjFGKUff9f4_NKSTgt6Q-fPHCqSupuRz6ARyRouIE-tDspDmtbhdKzTFDNZx_uqegn0sRSOQiOe3H8osHTpa7w9dfUdsCBYPB2q5YflIo1Oi-9C9eUdaux1xb8epxqx377FdKvYST18V8RvNEsA6Hp2AFJC4xTog3vyUceMSuJ_fUSEhU1qY
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3179
{
"data" : [ {
"id" : "aml_1lsNky7OWOWZ5mCoSpnAwE",
"catalog" : "A0000001",
"name" : "jt29HkXxP0",
"number" : 1,
"strain" : "a5808XDlhT",
"species" : "JwF1mOGyo0",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "mvKVzqlOxw",
"ear" : "hJNws1A6XU",
"tag" : "pDR4J2awsh",
"donor" : "wuv8xHMyUw",
"tracking_date" : "2024-11-22",
"disease_induction_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_rf1NpW7BZQ56Blo00XqXm",
"name" : "a9rGn12mHo",
"email" : "V3Vny6YP@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_4TZocZo7MIp5jTUM7DCpJd",
"title" : "Found dead",
"comment" : "yxAdWIp9XR"
},
"disease_survivor" : false,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"study" : {
"id" : "sdy_4ttYWumJwFb2f12UtFI0pt",
"project_id" : "pjt_1j8Twb7IHxFtoVDbKvqN2j",
"name" : "C8NFXdMMn3",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "T3ktFDvRJ2",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_yOLHIrFMSHxAjplGYg8gj",
"name" : "7OrKfIrbWV",
"email" : "KNQmNdCY@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_6DM1LacCXzT3Q5Wv6FFbDQ",
"name" : "B8s7NDEptz",
"email" : "vZOlW1aa@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:43.041383Z",
"updated_at" : "2024-11-22T09:41:43.041383Z"
},
"study_group" : {
"id" : "grp_1vNCltuGDsLzJp7su1W3oy",
"study_id" : "sdy_4ttYWumJwFb2f12UtFI0pt",
"name" : "FaVIVyf6lN",
"no" : 2120454663,
"color" : "ODIkpff5rR",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-internal-id" : "GROUP-1234"
},
"created_at" : "2024-11-22T09:41:43.240728Z",
"updated_at" : "2024-11-22T09:41:43.240728Z"
},
"cage" : {
"id" : "cge_7MyDDkHi4mixcLBhgiicmR",
"study_id" : "sdy_4ttYWumJwFb2f12UtFI0pt",
"name" : "sX0DV5bcKU",
"catalog" : "C0000001",
"metadata" : {
"cage-internal-id" : "CAGE-1234"
},
"created_at" : "2024-11-22T09:41:43.227910Z",
"updated_at" : "2024-11-22T09:41:43.227910Z"
},
"created_at" : "2024-11-22T09:41:43.245170Z",
"updated_at" : "2024-11-22T09:41:43.245170Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/studies/sdy_4ttYWumJwFb2f12UtFI0pt/animals?page=1",
"last" : "http://localhost:8080/api/public/v1/studies/sdy_4ttYWumJwFb2f12UtFI0pt/animals?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/studies/sdy_4ttYWumJwFb2f12UtFI0pt/animals",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Study Animal Dosage
This is an object representing a dose of compound administered to an animal. You can retrieve it to see the dosing method, stock, volume, concentration, date administered, user administered and the treatment group of the animal it was administered to by of the dosage.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the dosage. |
|
|
The name of the treatment type. |
|
|
The created timestamp of the dosage. |
|
|
The dose concentration associated with the dosage. |
|
|
The dose volume associated with the dosage. |
|
|
The stock concentration associated with the dosage. |
|
|
The volume of the dosage. |
|
|
The study associated with the dosage. |
|
|
The animal associated with the dosage. |
|
|
The measurement associated with the dosage. |
|
|
The user associated with the dosage. |
|
|
The treatment associated with the dosage. |
|
|
The optional weight that’s taken during a dosage. |
|
|
The created timestamp of the dosage. |
|
|
The last updated timestamp of the dosage. |
Retrieve a study animal dosage
Retrieves the details of an existing study animal dosage.
Path parameters ./api/public/v1/studies/{studyId}/animals/{animalId}/dosages/{dosageId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the animal. |
|
The unique identifier of the dosage. |
Request
GET /api/public/v1/studies/sdy_PhCluRO8I5T4m85iuNxrw/animals/aml_2v2bfmOv57ZtvfjgwjFSEK/dosages/dsg_Y27ZKYeA0vJuI0eu8SCsC HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiMzZlZGY2NS1mM2VlLTRjNjgtYTQwZS0xMTFjMGZmMjdjNTYiLCJqdGkiOiJhNDU4NTQwMi1jNGUzLTQwOTQtOWEzOC1hZDI4ZWJjMTBiMmMiLCJpYXQiOjE3MzIyNjg1MDgsIm5iZiI6MTczMjI2ODUwOCwiZXhwIjoxNzMyMzU0OTA4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.EYXiNMivoL5wxD2hftcarX7TEQsQgxwQQJKrsHEwYS3YnWZQ9Cm-MvrEkOSDXj5VXMbuiJhRPTMx0x1XBxUAymWNUHryiPeOtDtWiaUj8JMTPy1CJt3czRh9j01Tt1Izlub_YZ6fQgyWOMAJdhazxq9jL0PxwXyKELl0Y19JM0yKVoebxgov1x_fgm_evxdZg04166l1Tr7SddAVqNnXjAoclspc3c_oPia_39pwvgfllG4pZ-ZFdnekjRcA3boya9pPn9nB46wHV6TBYjV4BbefN4fVe0UIgWl8rf6mvHmXYn5OTHJyGEMbxrfGgsK96XYF2AxS-MB-9RQgiWN9Y4yC_NtayQqdHwHAs0cE5-C4EdcCCKxGny0h5_g9XK_2tQsK27dHwqRuUcdNGnT1Xr6bqw0TKOjVFosC9Ixa4i5VDwGSXQ_bVRnpUILxfbJSbamu-Y6p7muGoj62Cgyr6XCca3LF8m5YArB2eb2oH-s94FOXSZgTDTw6xyLpRugYc2jFvX_WAUqB9HWM-3MZCuf4F8CtPv60GYOB7nzvtRPhv_G_MO3sSm1Yt_Ck65QZnKPjfDbhd1WblF0dMXw-mWAMKfjEO6mI4RUZb0WMP5-amCXki1JgnyoCCp8NOxO_W6l54iuuJw0y7bLe_KhFA8Jc2aJxnq_uPhmX-1gn3Go
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 4500
{
"id" : "dsg_Y27ZKYeA0vJuI0eu8SCsC",
"name" : "Example dosage",
"dosed_at" : "2024-11-22T09:41:48.962538Z",
"weight_at_dosing" : null,
"dose" : {
"unit" : "mg/kg",
"value" : "3.27",
"display_unit" : "mg/kg",
"display_value" : "3.27"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "17.10",
"display_unit" : "ml/kg",
"display_value" : "17.10"
},
"stock" : {
"unit" : "mg/ml",
"value" : "23.57",
"display_unit" : "mg/ml",
"display_value" : "23.57"
},
"volume" : {
"unit" : "µl",
"value" : "40.00",
"display_unit" : "µl",
"display_value" : "40.00"
},
"study" : {
"id" : "sdy_PhCluRO8I5T4m85iuNxrw",
"project_id" : "pjt_2Kii85snI62d4sZvbBcGKy",
"name" : "MWnABh9BOh",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "nl5z32Q4Wr",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_1zAN2hDraSuVGqMV3aWvHE",
"name" : "Ha58OGPhh1",
"email" : "qVug5GYH@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_2b6vzOjV4UFczxixDfSNAA",
"name" : "dD5Fqkack6",
"email" : "JLTJr5rY@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:48.637403Z",
"updated_at" : "2024-11-22T09:41:48.637403Z"
},
"animal" : {
"id" : "aml_2v2bfmOv57ZtvfjgwjFSEK",
"study_id" : "sdy_PhCluRO8I5T4m85iuNxrw",
"study_group_id" : "grp_5wUf7PuAe9QECA3jmjFp3e",
"cage_id" : "cge_WOUpvQClTIFy2bz3lYkrL",
"catalog" : "A0000001",
"name" : "pprLowziw0",
"number" : 1,
"strain" : "zd8UWsOSqe",
"species" : "brF3V7zq3w",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "LDp3mTgYpG",
"ear" : "nC5UX1P99j",
"tag" : "3yFAJmrLKA",
"donor" : "2JNj2rF8Ei",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_1YgyswNZkN9w83YiV7bkCc",
"name" : "iYQNc5XIe2",
"email" : "Rmgk3nxZ@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_4KZXb4TYBlFAfsGW2GwUAu",
"title" : "Found dead",
"comment" : "aGb2J838WY"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:41:48.841242Z",
"updated_at" : "2024-11-22T09:41:48.841242Z",
"disease_induction_date" : "2024-11-22"
},
"measurement" : {
"id" : "mst_6smR0owPneTLqiSQxduMtR",
"study_id" : "sdy_PhCluRO8I5T4m85iuNxrw",
"animal_id" : "aml_2v2bfmOv57ZtvfjgwjFSEK",
"measured_at" : "2024-11-22",
"calculations" : [ {
"id" : "vbl_1Ua3ZqZiFdy0CydKajFNB2",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "55",
"formula" : "weight",
"variables" : [ ]
} ],
"created_at" : "2024-11-22T09:41:48.937170Z",
"updated_at" : "2024-11-22T09:41:48.937170Z"
},
"user" : {
"id" : "usr_33JungZlhCV2JFua9lL1Yq",
"name" : "tepUz Overwatch",
"email" : "BLMBH4hP@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:41:48.603697Z",
"updated_at" : "2024-11-22T09:41:48.603697Z"
},
"treatment" : {
"id" : "tmt_3sjtaAZjigs5nRorLkg4xs",
"study_id" : "sdy_PhCluRO8I5T4m85iuNxrw",
"type" : "custom",
"name" : "1X8AcTNSnR",
"dose" : {
"unit" : "mg/kg",
"value" : "5",
"display_unit" : "mg/kg",
"display_value" : "5"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "15",
"display_unit" : "ml/kg",
"display_value" : "15"
},
"stock" : {
"unit" : "mg/ml",
"value" : "10",
"display_unit" : "mg/ml",
"display_value" : "10"
},
"volume" : {
"unit" : "µl",
"value" : "8",
"display_unit" : "µl",
"display_value" : "8"
},
"metadata" : {
"treatment-internal-id" : "TREATMENT-1234"
},
"created_at" : "2024-11-22T09:41:48.955888Z",
"updated_at" : "2024-11-22T09:41:48.955888Z",
"external_entity_id" : "IO2zVPMzqR"
},
"created_at" : "2024-11-22T09:41:48.962554Z",
"updated_at" : "2024-11-22T09:41:48.962554Z"
}List all study animal dosages
Returns a list of your study animal dosages.
Path parameters ./api/public/v1/studies/{studyId}/animals/{animalId}/dosages
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the animal. |
Query parameters
| Parameter | Description |
|---|---|
|
The number of dosages to return per page. |
|
The page of dosages to return. |
Request
GET /api/public/v1/studies/sdy_5H5HFVyIfQkKuXRqYTye9r/animals/aml_4LUHeQwaRKPbEOXFAE4KUW/dosages HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0NTQ0MDQwMy1jMTczLTQ2YzgtYjVjMC1hOGNiMmVlMmE0MDciLCJqdGkiOiJiNWE1MTNlYi1lYjVkLTRhZTUtOWIyMS01OGE0NzQ1NGE0OTMiLCJpYXQiOjE3MzIyNjg1MTAsIm5iZiI6MTczMjI2ODUxMCwiZXhwIjoxNzMyMzU0OTEwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.a59O3qtmO19kjhcKg5xVMKHT28zdHEnKSLk0BedpS_sr4xfBLeoOb-yLNaCw8_rIR_C1P9S_ZqedhWOBp6c_NAC9ncEv4dhgZ3BIhxk6Q-haCaCnoEZZZcol2xVCPVUpz0bD6juizqMh3QpGpp6a8n1QDvP6Nnn1ognsw3qRCpfw9PvULltbJTg1TcgnsHuHvOVK7vE8QHSnQTnWA8Yg3dOMyb8-NqR88IuVDFTc_LdvqKqf896W80UjP3U4gVw631eCNEyRbF0v61neCj5lx3fvUctLlF7Ju-5NxvfjeInD-Qw4ZKR9GWMDSQTaWx-N1UwQf7LIU8P8N3-4XcI2YtoPyx2SRLIAxhDPMT2wDn2wkUlfOU8rUF5q1754cAIRTfuni-JiwrhA92HXduCQcBblp4aqbF9l_cS1E2hAuxMiVnfK3HATBZKlabngQaTx7CM_ESofhpjuycAaSBeRt72_HQ1hC5fWZcftkPhKHI2thDv9KDYQ70T9IDgqNenhE1Pn4SSIsmjiCPRC7z76SUYZT94vRgZAQ_6Hpkm5Iq2EtHTZ7p_jyt1esoT-hNGnq8xDdz2tZzLGSMzgoMpLmmckmGvRMUNz8w8Sk-oMZBjJlxNBfqiCVGjYyBB0P-0n9XHker_PZ1djM8Wv8eHQtnffr_BpAPnxGSTFnjvpeCE
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 5449
{
"data" : [ {
"id" : "dsg_25CQ2rXjCulSDSu5urfqOm",
"name" : "Example dosage",
"dosed_at" : "2024-11-22T09:41:50.449764Z",
"weight_at_dosing" : null,
"dose" : {
"unit" : "mg/kg",
"value" : "2.34",
"display_unit" : "mg/kg",
"display_value" : "2.34"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "15.56",
"display_unit" : "ml/kg",
"display_value" : "15.56"
},
"stock" : {
"unit" : "mg/ml",
"value" : "24.54",
"display_unit" : "mg/ml",
"display_value" : "24.54"
},
"volume" : {
"unit" : "µl",
"value" : "32.33",
"display_unit" : "µl",
"display_value" : "32.33"
},
"study" : {
"id" : "sdy_5H5HFVyIfQkKuXRqYTye9r",
"project_id" : "pjt_7mQjpEc5oULRfaLRA4VMJn",
"name" : "d9FIQFpISE",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "bkRtGuddq5",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5hM8CJepAOXrWd92tlNHoF",
"name" : "3WxwG2xjnD",
"email" : "ayy8anXH@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_5jh110rCD7BxmKZ0hONhfW",
"name" : "FdV1HXI1wA",
"email" : "lwdMYhZM@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:50.128923Z",
"updated_at" : "2024-11-22T09:41:50.128923Z"
},
"animal" : {
"id" : "aml_4LUHeQwaRKPbEOXFAE4KUW",
"study_id" : "sdy_5H5HFVyIfQkKuXRqYTye9r",
"study_group_id" : "grp_Sp7odLhtRriM6xPNJGeS2",
"cage_id" : "cge_5DifTTeoulAok0xk2RB0fb",
"catalog" : "A0000001",
"name" : "K3Vjf44487",
"number" : 1,
"strain" : "LYjLeC31Ip",
"species" : "1PlH7sepEd",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "K8SiiYAguL",
"ear" : "616kmBECgm",
"tag" : "YZDG3Fieqj",
"donor" : "LN37f2AwQR",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_3MhJ49dMYoZF2lqlPfffRO",
"name" : "4oVb55U6UE",
"email" : "zffoHliW@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_5Ip42aBZhVwRvfV0yNV0lo",
"title" : "Found dead",
"comment" : "IvEfBVXNnu"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:41:50.327596Z",
"updated_at" : "2024-11-22T09:41:50.327596Z",
"disease_induction_date" : "2024-11-22"
},
"measurement" : {
"id" : "mst_5tSOq4bY2rTljWjRM2dl0c",
"study_id" : "sdy_5H5HFVyIfQkKuXRqYTye9r",
"animal_id" : "aml_4LUHeQwaRKPbEOXFAE4KUW",
"measured_at" : "2024-11-22",
"calculations" : [ {
"id" : "vbl_f3fPQg3H5zT1PbU0fo9Od",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "55",
"formula" : "weight",
"variables" : [ ]
} ],
"created_at" : "2024-11-22T09:41:50.420154Z",
"updated_at" : "2024-11-22T09:41:50.420154Z"
},
"user" : {
"id" : "usr_2j9zMMt2u6m8KFBfOKlCHW",
"name" : "eXsJH Overwatch",
"email" : "hyIC1EbX@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:41:50.100833Z",
"updated_at" : "2024-11-22T09:41:50.100833Z"
},
"treatment" : {
"id" : "tmt_4ZIu8VlG4iivMi5a7bL7r6",
"study_id" : "sdy_5H5HFVyIfQkKuXRqYTye9r",
"type" : "concentration",
"name" : "DNLLLAEP0J",
"dose" : {
"unit" : "mg/kg",
"value" : "5",
"display_unit" : "mg/kg",
"display_value" : "5"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "15",
"display_unit" : "ml/kg",
"display_value" : "15"
},
"stock" : {
"unit" : "mg/ml",
"value" : "10",
"display_unit" : "mg/ml",
"display_value" : "10"
},
"volume" : {
"unit" : "µl",
"value" : "8",
"display_unit" : "µl",
"display_value" : "8"
},
"metadata" : {
"treatment-internal-id" : "TREATMENT-1234"
},
"created_at" : "2024-11-22T09:41:50.440684Z",
"updated_at" : "2024-11-22T09:41:50.440684Z",
"external_entity_id" : "0ibcwsfYwv"
},
"created_at" : "2024-11-22T09:41:50.449781Z",
"updated_at" : "2024-11-22T09:41:50.449781Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/studies/sdy_5H5HFVyIfQkKuXRqYTye9r/animals/aml_4LUHeQwaRKPbEOXFAE4KUW/dosages?page=1",
"last" : "http://localhost:8080/api/public/v1/studies/sdy_5H5HFVyIfQkKuXRqYTye9r/animals/aml_4LUHeQwaRKPbEOXFAE4KUW/dosages?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/studies/sdy_5H5HFVyIfQkKuXRqYTye9r/animals/aml_4LUHeQwaRKPbEOXFAE4KUW/dosages",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Study Animal Measurement
This is an object representing a measurement that has been recorded from an animal on a day. Measurements are created in studies which have a preset, typically for observable data like tumour volume or blood glucose.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the measurement. |
|
|
The measured at timestamp of the measurement. |
|
|
The calculations associated to the measurement. |
|
|
The study of the measurement. |
|
|
The animal of the measurement. |
|
|
The user that recorded measurement. |
|
|
The created timestamp of the measurement. |
|
|
The last updated timestamp of the measurement. |
|
|
The measurement calculation variables. |
Retrieve a study animal measurement
Retrieves the details of an existing study animal measurement.
Path parameters ./api/public/v1/studies/{studyId}/animals/{animalId}/measurements/{measurementId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the animal. |
|
The unique identifier of the measurement. |
Request
GET /api/public/v1/studies/sdy_4KxLuElcdvKU0MYeBi6g38/animals/aml_sbq4ffjmkeIfwGB5rvhOZ/measurements/mst_4HjazZRCROJUrzkMtwqV0Y HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjMWZmMzdiMy0wMWE0LTRiM2EtYTUzMS1hOWZjNjA1OTNkMmIiLCJqdGkiOiIxYThiZWY1Yy0zYmRlLTRjYmUtYmFlMS1mOTY1M2JlOWU0YzkiLCJpYXQiOjE3MzIyNjg1MjAsIm5iZiI6MTczMjI2ODUyMCwiZXhwIjoxNzMyMzU0OTIwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.gbxLBSkHNrutbo2bHEHjNgdMRk_vCikiLxTCYrET96MKrKSSrjEAUJBX44ogf0M2VFsAbvf8ZbpanEPQfoGyr2AAFINBdwiN2wZSYxzri9ayKrO6xUclNOmTeKXuhQ8YHFLaIW0XHul7zVFHCOJv58dL_M_LliRgmZDCGreTRkJlouIJ90kPtQKZNTJdGxdtvhTsZywhCH6GuR3G3oYWdrQ13RGr0cwgfd-EMNK0Ahuy6oHL92c92949-erVl8-hvVf-SX5zFWguq3bd0lCyK45pOZUGlBpzwXb4d2UUf7Wy2EqtKfSvjAIhVl7IDSo5tSe01vrYXMVk7j1cChNSzyuZTYZ_7cPlkUU32Jmf2pGDwoBOZIIpibaoGgAB8Ie6JZbs5RKh36qda--RMXEAAW295aMbClUrAtIbYgfYkOC3Ojc-DJdq3Ird0QpPJ1mu602a-mUhrX1KRfUP7zL3mX6qhvzcHPu7tPAtQcL23EHyTKVOUSI-ckkJT1YpuXAR8KNeO4wF4yXqMXX1l7WTGr5kxABnCtVueiQLaHRXOgQK-uNxG_B_t1VFI5YHuxNuFk61KAZoVbv2uFZYZBsMoMi9SkSW89f23mPEuEcORDtcBJs33K2ksAfJcO7yclk6AfGa_vQm0jPQxrtZzXVtG-sHEw3-AS-ZyoZBltmDRn0
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3200
{
"id" : "mst_4HjazZRCROJUrzkMtwqV0Y",
"measured_at" : "2024-11-22",
"calculations" : [ {
"id" : "vbl_6Xk05wQfO2tJMy6vZbmwEP",
"key" : "tumour_volume",
"name" : "Tumour Volume",
"unit" : "mm³",
"excluded" : false,
"value" : "75",
"formula" : "(width * width * length) / 2",
"variables" : [ {
"id" : "vbl_INYdLyWyFua904Gx5FJBj",
"key" : "width",
"value" : "5",
"unit" : "mm"
}, {
"id" : "vbl_5k4EsBpDzwi05iMRX0Pgeq",
"key" : "length",
"value" : "6",
"unit" : "mm"
} ]
}, {
"id" : "vbl_5SVwE26KVHFeW8fWFv5Rys",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "55",
"formula" : "weight",
"variables" : [ ]
} ],
"study" : {
"id" : "sdy_4KxLuElcdvKU0MYeBi6g38",
"project_id" : "pjt_38Ggmiw0Bpdgt9cQOuRG9B",
"name" : "UCLvQnfRWe",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "48QLFDvqxL",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_1cKiLG4lgxuEZt0l9BVHfe",
"name" : "0qNw5q0flj",
"email" : "dPAVPe3j@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_kRWwEgqPUV4un3PWYaPML",
"name" : "rp6KSKQl15",
"email" : "5LIpcSli@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:00.152318Z",
"updated_at" : "2024-11-22T09:42:00.152318Z"
},
"animal" : {
"id" : "aml_sbq4ffjmkeIfwGB5rvhOZ",
"study_id" : "sdy_4KxLuElcdvKU0MYeBi6g38",
"study_group_id" : "grp_2hPrIT5wwvAnWIcc3jGBBZ",
"cage_id" : "cge_NXL9Ab3f9IANZiJhmq1tD",
"catalog" : "A0000001",
"name" : "qAUKPqC0yu",
"number" : 1,
"strain" : "sHm2cz274t",
"species" : "GNbmHA9tF1",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "DKJBLxW4JY",
"ear" : "9UAqJlodCT",
"tag" : "O7UfmHCl8k",
"donor" : "Lt44HBJ7U7",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_2LbBJKWYmCuMnw699hl43o",
"name" : "MP7t92uhk3",
"email" : "zqBJNhMA@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_5XLJPxy706HmOI8Eq7qXNA",
"title" : "Found dead",
"comment" : "uycnq4pUZk"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:00.355396Z",
"updated_at" : "2024-11-22T09:42:00.355396Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_4fj950ClmWg7DM3RdsjHcI",
"name" : "1oQG3 Overwatch",
"email" : "k8UbxWpx@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:00.113542Z",
"updated_at" : "2024-11-22T09:42:00.113542Z"
},
"created_at" : "2024-11-22T09:42:00.451335Z",
"updated_at" : "2024-11-22T09:42:00.451335Z"
}List all study animal measurements
Returns a list of your study animal measurements.
Path parameters ./api/public/v1/studies/{studyId}/animals/{animalId}/measurements
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the animal. |
Query parameters
| Parameter | Description |
|---|---|
|
The number of measurements to return per page. |
|
The page of measurements to return. |
|
Filter measurements to return by date (yyyy-mm-dd). |
Request
GET /api/public/v1/studies/sdy_4Q64TAiCqPpBjhV5qoRZsi/animals/aml_5zdQTpnzlDWbOFtLS1QJmI/measurements HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxM2VlN2JjYS01NWY0LTQ3MTItYjQzZS1mZjA2ODZjMjg4MmYiLCJqdGkiOiIwZDIwZGJkZi1iMGUzLTRmNzMtOWFlZS1mYTM4Yjc1OTBhMzEiLCJpYXQiOjE3MzIyNjg1MTcsIm5iZiI6MTczMjI2ODUxNywiZXhwIjoxNzMyMzU0OTE3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.dQjBVTbztxjtgLAMLqcIGJ_7u7FPRqQuIUpoV0sirs1_Eq6hRFns7ayi-C7uXd-F0T9G8cnIJkcVWKREd85V1xPATS_QvVY7lCZ3YMTUfNxX-TX3OHcqp1dBCyWfUo3S6is67JgSxfsbQlwO1-kuPYuvDMb_hES1Yc-jNOg9hRu0x4Z0eYxAhjZgPDoyzaPD-yG19uCE1bs5zQOH4GmKNo-XkXgyZx3Z4-_C9Put0jC5bM3ee-cyC96F_AnwI1Bj086qvBa3K2ikhfWiTfP09eYo--HxEwv5sZGB4Yn8NOm93_FQbTSkau5NB77rFhi2SMW_0lMSoLcR4FiA9TBMLhQyRCpcqVz522UeZpN54_5TSl0ykR-ULgRkHwiDYEjApA6k0uQ3ZyiwWnO8Zu2_GfZ-GJp6_4vQWE-2IAD7x6vzo8hrKIIxHGUzJsBh2wIEtHb5IX7tzvqfN_imxzQCf_JkxaBYQqQsMQpUnoE46POrZ5cuxJbJhbYRwRRyXLGVrQQTBz9gidDR9q5i9hMTrugvDJciifNGkMkmD2ff34r0btm_BLq02RVxxN-jETdflAFgukjxedfY-XFK_WNPqYtQAf5qpZN2gdlPEF_S-TyPH0RXga054ROkaYiZzBPrHQZZB-8j5r_pu8nd9HWXlASSiEnaY2Up52A3uDZ7Q0g
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 7487
{
"data" : [ {
"id" : "mst_4lquQkhPUtQJ6lOja0Pz4Z",
"measured_at" : "2024-11-22",
"calculations" : [ {
"id" : "vbl_uos0WJrtoWFbyOYC9kVfm",
"key" : "tumour_volume",
"name" : "Tumour Volume",
"unit" : "mm³",
"excluded" : false,
"value" : "75",
"formula" : "(width * width * length) / 2",
"variables" : [ {
"id" : "vbl_3oUrgVzMX6S9QMJGOHCHuh",
"key" : "width",
"value" : "5",
"unit" : "mm"
}, {
"id" : "vbl_4OSCzkKj4JFSDxOVwF9rmo",
"key" : "length",
"value" : "6",
"unit" : "mm"
} ]
}, {
"id" : "vbl_6ITbE4atQDmHq8HJWkGeis",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "55",
"formula" : "weight",
"variables" : [ ]
} ],
"study" : {
"id" : "sdy_4Q64TAiCqPpBjhV5qoRZsi",
"project_id" : "pjt_6kHbhpmC4rduOcTj67CsA0",
"name" : "gquOB1tmhn",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "uRr9b810el",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_2gqROdzimbKXgGITcpcEVf",
"name" : "NhudsQdtbV",
"email" : "cKRg2mwU@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_1L9J2GidOebSQv15ozEqjv",
"name" : "IaYtpOF0sM",
"email" : "5qUaUO7V@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:56.740196Z",
"updated_at" : "2024-11-22T09:41:56.740196Z"
},
"animal" : {
"id" : "aml_5zdQTpnzlDWbOFtLS1QJmI",
"study_id" : "sdy_4Q64TAiCqPpBjhV5qoRZsi",
"study_group_id" : "grp_3yl5sxMme5dBshvF7bY8SQ",
"cage_id" : "cge_3QdzBco8bqH1Hn4CExaFOp",
"catalog" : "A0000001",
"name" : "WAaCfqc9fw",
"number" : 1,
"strain" : "KJ7gGQ6pZe",
"species" : "w1qQlOKhT6",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "uDAHBs1Vo1",
"ear" : "9t7OmoMQZK",
"tag" : "ARFCHj5xz2",
"donor" : "tmQwlpbsNn",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_5ZAZY30GxZMNMsp8NQdMMJ",
"name" : "YixRBVTxyk",
"email" : "iE1Twd96@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_34TGeTgkCGNRwiqogUep6a",
"title" : "Found dead",
"comment" : "kWeqF7gTuD"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:41:56.937848Z",
"updated_at" : "2024-11-22T09:41:56.937848Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_1VrbuQtARStkY4FQz9FtO3",
"name" : "4naa4 Overwatch",
"email" : "vg9hU4Mu@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:41:56.705675Z",
"updated_at" : "2024-11-22T09:41:56.705675Z"
},
"created_at" : "2024-11-22T09:41:57.031811Z",
"updated_at" : "2024-11-22T09:41:57.031811Z"
}, {
"id" : "mst_3JcoQtzmnDYxlzZveJe8FE",
"measured_at" : "2024-11-21",
"calculations" : [ {
"id" : "vbl_1fJbE2aIoQC3L4DYSgVthM",
"key" : "tumour_volume",
"name" : "Tumour Volume",
"unit" : "mm³",
"excluded" : false,
"value" : "196",
"formula" : "(width * width * length) / 2",
"variables" : [ {
"id" : "vbl_6QvhIqNmDAgaWUfT4ZzRnU",
"key" : "width",
"value" : "7",
"unit" : "mm"
}, {
"id" : "vbl_3rRbxa2PVfc3zaho9rI8fY",
"key" : "length",
"value" : "8",
"unit" : "mm"
} ]
}, {
"id" : "vbl_6B3G9JP2oD9zG322RPB4SQ",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "56",
"formula" : "weight",
"variables" : [ ]
} ],
"study" : {
"id" : "sdy_4Q64TAiCqPpBjhV5qoRZsi",
"project_id" : "pjt_6kHbhpmC4rduOcTj67CsA0",
"name" : "gquOB1tmhn",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "uRr9b810el",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_2gqROdzimbKXgGITcpcEVf",
"name" : "NhudsQdtbV",
"email" : "cKRg2mwU@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_1L9J2GidOebSQv15ozEqjv",
"name" : "IaYtpOF0sM",
"email" : "5qUaUO7V@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:56.740196Z",
"updated_at" : "2024-11-22T09:41:56.740196Z"
},
"animal" : {
"id" : "aml_5zdQTpnzlDWbOFtLS1QJmI",
"study_id" : "sdy_4Q64TAiCqPpBjhV5qoRZsi",
"study_group_id" : "grp_3yl5sxMme5dBshvF7bY8SQ",
"cage_id" : "cge_3QdzBco8bqH1Hn4CExaFOp",
"catalog" : "A0000001",
"name" : "WAaCfqc9fw",
"number" : 1,
"strain" : "KJ7gGQ6pZe",
"species" : "w1qQlOKhT6",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "uDAHBs1Vo1",
"ear" : "9t7OmoMQZK",
"tag" : "ARFCHj5xz2",
"donor" : "tmQwlpbsNn",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_5ZAZY30GxZMNMsp8NQdMMJ",
"name" : "YixRBVTxyk",
"email" : "iE1Twd96@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_34TGeTgkCGNRwiqogUep6a",
"title" : "Found dead",
"comment" : "kWeqF7gTuD"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:41:56.937848Z",
"updated_at" : "2024-11-22T09:41:56.937848Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_1VrbuQtARStkY4FQz9FtO3",
"name" : "4naa4 Overwatch",
"email" : "vg9hU4Mu@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:41:56.705675Z",
"updated_at" : "2024-11-22T09:41:56.705675Z"
},
"created_at" : "2024-11-22T09:41:57.041263Z",
"updated_at" : "2024-11-22T09:41:57.041263Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/studies/sdy_4Q64TAiCqPpBjhV5qoRZsi/animals/aml_5zdQTpnzlDWbOFtLS1QJmI/measurements?page=1",
"last" : "http://localhost:8080/api/public/v1/studies/sdy_4Q64TAiCqPpBjhV5qoRZsi/animals/aml_5zdQTpnzlDWbOFtLS1QJmI/measurements?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/studies/sdy_4Q64TAiCqPpBjhV5qoRZsi/animals/aml_5zdQTpnzlDWbOFtLS1QJmI/measurements",
"to" : 2,
"total" : 2,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Study Animal Observation
Retrieves the details of an existing study animal observation.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the observation. |
|
|
The unique identifier of the glossary item. |
|
|
The title of the glossary item. |
|
|
Text related to the observation. |
|
|
The type of observation recorded. |
|
|
The value of the observation taken. |
|
|
The timestamp of when the observation occurred. |
|
|
The study of the measurement. |
|
|
The animal of the measurement. |
|
|
The user that recorded measurement. |
|
|
The created timestamp of the project. |
|
|
The last updated timestamp of the project. |
Retrieve a study animal observation
Retrieves the details of an existing study animal observation.
Path parameters ./api/public/v1/studies/{studyId}/animals/{animalId}/observations/{observationId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the animal. |
|
The unique identifier of the observation. |
Request
GET /api/public/v1/studies/sdy_3PskiKogTrWMsZ7a9nb2ct/animals/aml_1gBm6DVaQ551pEW5uWeohy/observations/obs_3lmgyfHM0mcg4ikRni56Cd HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1YmE5ZmQ2NS0yOWViLTQ1YjQtOTMwNS0yYmZmMDRhYjYzNjQiLCJqdGkiOiIwYjJmMmI0Yi0wNmVkLTRmNzctODdkMC0xN2JjMjNlYTFhMDAiLCJpYXQiOjE3MzIyNjg1MzEsIm5iZiI6MTczMjI2ODUzMSwiZXhwIjoxNzMyMzU0OTMxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.WdDI-4M_wUzDHw50Vda7nUna5anoQRjA5_0r8wqo-Av8IA3PuT0D_-LJkT6I3nLDtEhVmxow6um2ZTIwx2LqCR1y7sRfkXZoghBYsfKsKVsws_ZROjpasPLCuqETU7lDeIbKykZ6tcSjJaCsEqgSs0YpfHVVguKnpyoVj4aeafK-HE5b1nJP1TunjbB1UaG5kMkePdpIeQWf5Auf9d6MIPh2A0aOcLmO-MDkc8Tv5YZv3PAldGYBUtEJ6_q9PtwxVthrjHSOyEGQexlxf0HSLG00k4Yih7k1N_6S5MtjqNoEhvGLnSeWqozmgV0Kwc9ta-YTIfwAaOBx7o1AyLa0OK9mIsNc2WA7tbJ-5jgz5z6YNu6ylPNJtz5kPRmN_lIKGnZhTSwtzWyA-lNbIsp7zaDoPG6y8u5S3Pk_Ohsh6MKtQA3a4FF9rLSTrhNpYWFopyjiFToAn8EatPtNa0hgwYoya2qWIxIDmABPwLsdOMcrQEgGOrOxm8vSaXQSd65XoKJmRSzNk2zBawiyr_hveb6PlLNLjYCzbjDPrKk5YMgue1J2Mhd2DVX4abIvsoGe8SBdHGjAmvUYy-xcaBqKArj9P2jKGto-f8ptvSZtkiCps3FZZ8a5hHiWYSnulYwg3CMFo7SGjkYmW7I5DurG1O18VJes203UAL_BB28b8GY
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2676
{
"id" : "obs_3lmgyfHM0mcg4ikRni56Cd",
"glossary_id" : "gly_7984rIJ1Zlg6LvTZqT1w90",
"title" : "Observation Glossary",
"text" : "Example text",
"type" : "severity",
"value" : "Severe",
"observed_at" : "2024-11-22T09:42:11.525984Z",
"study" : {
"id" : "sdy_3PskiKogTrWMsZ7a9nb2ct",
"project_id" : "pjt_7HYegzR8BZrEszs3AI1G3k",
"name" : "07cEDfAcxI",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "CJaOpHeLVR",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_4IDWJZK3JmWxgxwit87vdf",
"name" : "UfJdKZCFwX",
"email" : "deoMJVTO@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4Y8mrQQXr6taqRbTejAhxS",
"name" : "7IM8Gh8ej8",
"email" : "oH9e8G9X@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:11.204857Z",
"updated_at" : "2024-11-22T09:42:11.204857Z"
},
"animal" : {
"id" : "aml_1gBm6DVaQ551pEW5uWeohy",
"study_id" : "sdy_3PskiKogTrWMsZ7a9nb2ct",
"study_group_id" : "grp_2UsueDm3JWVhzCyewVbjps",
"cage_id" : "cge_3KhckVgOk8AjTWm0JIne3e",
"catalog" : "A0000001",
"name" : "yt6mzcJSQT",
"number" : 1,
"strain" : "5nMfBcPkGE",
"species" : "TUGiA2ZyCI",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "VCArHuAi4w",
"ear" : "pes8MnD7Sb",
"tag" : "y12phumxf7",
"donor" : "myTTE2WRld",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_4eBbf6GcBEW2PmSdpIIbr",
"name" : "dWKLGzGCfE",
"email" : "ZUmrqYWS@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_3idKtFMhkZgnnRbHvpXsfF",
"title" : "Found dead",
"comment" : "DvAHkBTjat"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:11.423560Z",
"updated_at" : "2024-11-22T09:42:11.423560Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_437dMQw1rFCfjDW4LP4Uxm",
"name" : "e5Bb0 Overwatch",
"email" : "UpLioxx7@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:11.176163Z",
"updated_at" : "2024-11-22T09:42:11.176163Z"
},
"created_at" : "2024-11-22T09:42:11.526001Z",
"updated_at" : "2024-11-22T09:42:11.526001Z"
}List all study animal observations
Returns a list of your study animal observations.
Path parameters ./api/public/v1/studies/{studyId}/animals/{animalId}/observations
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the animal. |
Query parameters
| Parameter | Description |
|---|---|
|
The number of observations to return per page. |
|
The page of observations to return. |
Request
GET /api/public/v1/studies/sdy_2YEdyiitOLUmqctZiMIP3b/animals/aml_38ySD7kRkT5NqfHTLjCgSz/observations HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5MjkzODZmMC0xM2JjLTRmNzQtOTA5My0xNTc5OGNjYTU4MTgiLCJqdGkiOiJmNzBkYjgyNC0xMTEzLTQyYWEtOTFlMi0xOWZiNjVkYzRlNWYiLCJpYXQiOjE3MzIyNjg1MzIsIm5iZiI6MTczMjI2ODUzMiwiZXhwIjoxNzMyMzU0OTMyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.mF7iiefqsyhBtGc7dk1euBMDnPhyiWtyLTbg4Ro3PUjhLSMSlofyKt5LUfzvb-_G1m2SlCeFPsDJGzR3YoWMVwifxIYa06HIPZaKDRSGGJUJyWzvrvo1KGD0DebhlO0puK1AoLCwnb18bP-M8giOlb_gA0fqxPT9l7k8Y_KFnniVLjm_L51H8gNC52eLxgYmPqXbFa-Zmn0CUvLzzwTLlaW6vpHUDKPMfR3pfZRBxiwib4VnuhRUcVicbwJXDmX_RcHPKC_9L3e-1eKTanqCKlvSYrnmkiQa1-B_A_P4rMgFjYb0wTNlUcH9VIl2ENPZQdLcT8KDFs1EsWDgnMjSQcfA-0T8IUgzco02CU6KytkjGTuX-OXO-MKklUIRJOqWfwLmljT-8EWTlgrQ7KHlL1-EYwPvMtU50ETfyvnJt-8tSsXb0NGP37IUBS8AeHkIJmSsEiV0Agiyp19f23rk-oX_00vrBg7EKPGFuOLdVJEdkqetEaTT2KbFDG6V0Tk5WlEy9dxGiDmvKCQjVfTyMA9Gdx8LK3nLM96j_E-g61Z5482YHrAlsaBTH_EXm_G_ujzVvZiOO5CrLmV49m6sadl6OhU9P9g63DMt8kgJf2Lok4Q7F85Vop_vv1bkAfqRto992bmye__Dn5QlgD8b5qEyVNoTDDnj9M-0ZWPPxYg
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3480
{
"data" : [ {
"id" : "obs_2shtC9uF9Mbdg3Cy6aSFjK",
"glossary_id" : "gly_5j9WzUrABls5dVpRv0x8pc",
"title" : "Observation Glossary",
"text" : "Example text",
"type" : "severity",
"value" : "Severe",
"observed_at" : "2024-11-22T09:42:12.486573Z",
"study" : {
"id" : "sdy_2YEdyiitOLUmqctZiMIP3b",
"project_id" : "pjt_6wEfxXlLH6HL5LLd0v8fuc",
"name" : "cTLYXh8UY1",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "7nnYrI0JgZ",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_1QLYFL9vgVOg8AMtSj0Imv",
"name" : "Zyn0aOp7AJ",
"email" : "BiNedONk@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_2RuerEZvuHX2E1t7HnlHSy",
"name" : "Nu4uanss1o",
"email" : "suXARTpo@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:12.191698Z",
"updated_at" : "2024-11-22T09:42:12.191698Z"
},
"animal" : {
"id" : "aml_38ySD7kRkT5NqfHTLjCgSz",
"study_id" : "sdy_2YEdyiitOLUmqctZiMIP3b",
"study_group_id" : "grp_65tnhj5CayORmnSvoX8KD7",
"cage_id" : "cge_5Pq4zA69NgGsOnJ0TJ4KyS",
"catalog" : "A0000001",
"name" : "l2hgzQjC7A",
"number" : 1,
"strain" : "gq1BGAE5Wx",
"species" : "6mClZzpyNl",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "B7okWqse53",
"ear" : "pRrfBA82XN",
"tag" : "XDXAV1lNWv",
"donor" : "rikFzUue1T",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_1mW12h5V4cXSTtwl6L0DtE",
"name" : "Ni6dtN1KlB",
"email" : "K9KEPdga@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_7KaZtFjt9qkq2l23gXL8eT",
"title" : "Found dead",
"comment" : "TUr0t6q05m"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:12.394432Z",
"updated_at" : "2024-11-22T09:42:12.394432Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_5sbASISpX48OyEyCqgIJ9Z",
"name" : "GJiKq Overwatch",
"email" : "b1vjvyMj@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:12.157637Z",
"updated_at" : "2024-11-22T09:42:12.157637Z"
},
"created_at" : "2024-11-22T09:42:12.486605Z",
"updated_at" : "2024-11-22T09:42:12.486605Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/studies/sdy_2YEdyiitOLUmqctZiMIP3b/animals/aml_38ySD7kRkT5NqfHTLjCgSz/observations?page=1",
"last" : "http://localhost:8080/api/public/v1/studies/sdy_2YEdyiitOLUmqctZiMIP3b/animals/aml_38ySD7kRkT5NqfHTLjCgSz/observations?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/studies/sdy_2YEdyiitOLUmqctZiMIP3b/animals/aml_38ySD7kRkT5NqfHTLjCgSz/observations",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Study Animal Sample
This is an object representing a sample such as blood or tissue collected from an animal in your facility. You can retrieve it to see the sample identifier, type, details like volume or mass and any metadata assigned.
Retrieve a study animal sample
Retrieves the details of an existing study animal sample.
Path parameters ./api/public/v1/studies/{studyId}/animals/{animalId}/samples/{sampleId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the animal. |
|
The unique identifier of the sample. |
Request
GET /api/public/v1/studies/sdy_7AgXuJgNcHbI9Jg5YJjJsR/animals/aml_1sC0Hk6qntq9RiD1BcBULj/samples/spl_69OFElWvy4tEyPHBsGhSAW HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI5YTI3MmQwOS03MWQ1LTQxZDEtOTg3NS1hNWY1Y2U1MzY4YWIiLCJqdGkiOiI4NjM4OTg1Ni05NWFlLTQ0NzMtYjhlZi1lNGIwYWNhZWNlZmMiLCJpYXQiOjE3MzIyNjg1NDMsIm5iZiI6MTczMjI2ODU0MywiZXhwIjoxNzMyMzU0OTQzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.edaMo1dLA_c3PRT7kJYoZO058MebR6Dgh0ss_bSjnusIzsW2oR4E4Ww-KwcZVTagJqn5uHLU7RoA5I_hwQX8LtWegDMs1zLY5On1C-Yd0UXxvtrFEUsNVAAfZF-Ct79x8Ap2_XEkTwa8DRxntuWPb7qWxsebK10xuBeHp7P5r0qRa3X-7B9uM9zhckjkMgAXk8BjqowNHodIV-Xe0rUTqlv0RvdMTpK8Kauc6NPsrNPb4u45gbsmvOtbrYyFLYoWkazWG8yNRhtUy-cOclccviqqr745D9FmKOqNFfn7zytdSdtdW20PBMj_oAX6s1hY2uJ4aWZk9f75fI4g9G9pFftKKuj1WTJdeVfYWFDIS6FibDlzC1mIwPjhtQKzZ13A5FOTTBgCDamjAtFBlV22yPDz5ycc8Z2asTkfBv97n3YloHLpjLvEjKbt0YZ-KIxOkklC_RmCasnLXjfh312ipxvWhZhj6_ImSZS_6vEjlKntmEvzF3OD6ROQCBDvS7MJDV2NQywlBLpxHmlIcRL_r3gyC3YFaQktQkidJdBLBzJeG6mzW2ayF2PZDifjnhsw157jPCIZFxNBtwYlc3mAnml9Nqm1xZs4RecdqqOBMhqTfOLgy3Fwqfete-o5ELF5yu6Np2nfQWkxooXeuXYKL173bNUrwsSJYhXZsChwqvc
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2738
{
"id" : "spl_69OFElWvy4tEyPHBsGhSAW",
"sample_id" : "S941364565",
"type" : "Blood",
"collected_at" : "2024-11-22T11:42:23.302858Z",
"details" : [ {
"key" : "volume",
"unit" : "ml",
"value" : "5"
} ],
"comments" : "A blood sample",
"metadata" : {
"sample-internal-id" : "SMPL-1234"
},
"study" : {
"id" : "sdy_7AgXuJgNcHbI9Jg5YJjJsR",
"project_id" : "pjt_1MR1ACuL7z4q8ijb1iUuKS",
"name" : "0U9FJwcjDt",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "dZAzPxX0es",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_3YmQlHvPxT2zsneuZ2zCnE",
"name" : "ZRZ6Z7fgfL",
"email" : "nesTWsy8@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_1JJozZQxYM2K5rClg90xF0",
"name" : "CstyByOv1m",
"email" : "wb4XKpoW@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:22.912905Z",
"updated_at" : "2024-11-22T09:42:22.912905Z"
},
"animal" : {
"id" : "aml_1sC0Hk6qntq9RiD1BcBULj",
"study_id" : "sdy_7AgXuJgNcHbI9Jg5YJjJsR",
"study_group_id" : "grp_wHuN3SapBfOEQwiXmifeO",
"cage_id" : "cge_ETc2GH14U9fCZMxkJEprb",
"catalog" : "A0000001",
"name" : "TkRzeR3Rv6",
"number" : 1,
"strain" : "6Z1hpcZvx6",
"species" : "iGepJe7DFA",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "NeheaIgzeA",
"ear" : "26y8JQs7XM",
"tag" : "42Omq1GGuN",
"donor" : "UGpqCRGicj",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_3b7oboCMAlEuWJ2Akz4w9M",
"name" : "BUAAyUmfrF",
"email" : "jVUUrPT7@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_1a9GG0uA2sQUcx7BEuWASR",
"title" : "Found dead",
"comment" : "a7w6VLPyme"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:23.120964Z",
"updated_at" : "2024-11-22T09:42:23.120964Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_5SIf07ZI1jQunjrQC7LGDy",
"name" : "8yKdvXMhPU",
"email" : "gFp8W04E@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"RxOXJOPEcJ" : "ht6dqts5WZ"
},
"created_at" : "2024-11-22T09:42:23.288902Z",
"updated_at" : "2024-11-22T09:42:23.288902Z"
},
"created_at" : "2024-11-22T09:42:23.302868Z",
"updated_at" : "2024-11-22T09:42:23.302868Z"
}List all study animal samples
Returns a list of your study animal samples.
Path parameters ./api/public/v1/studies/{studyId}/animals/{animalId}/samples
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the animal. |
Query parameters
| Parameter | Description |
|---|---|
|
The number of samples to return per page. |
|
The page of samples to return. |
|
Sort samples based on an attribute (animal, cage, date, group sample, study or type). |
|
The order in which the samples will be sorted (asc or desc). |
|
Filter samples to return by metadata value |
|
Filter samples to return based on sample type. |
Request
GET /api/public/v1/studies/sdy_ciSXMnoIpycs8UGGC1Kt4/animals/aml_2DmZFjw7QJFuqkWh3zIhNG/samples HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0NWVjMmUwMi0yMjhjLTQ1MjEtOWRhNi0xMjRjZWQ5NDk2MDYiLCJqdGkiOiJhNjg5YjkzNy0zOWIwLTQ2MTUtYjUwMy1lZjE4NzI3NDQzYjMiLCJpYXQiOjE3MzIyNjg1NDUsIm5iZiI6MTczMjI2ODU0NSwiZXhwIjoxNzMyMzU0OTQ1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.Pxr_l0cYT0D9Z85yGIhc5tfONeLV6PwhP0R1myu-nEsIGpFsExherqIvDwO8UgWzEQpYoT5SF5ZyV6qqFr0hXOcx4mywMzGHkYawx-ts-NW4WAllAIGpv7O-mpbgNsBjFqoQVpHie-ez16asInn1fJXshwwAj7DkfcY10wTiIBer-_hKNqT1Z0T_cfEFW6IQsDzbL5ZGJ-jvjOSQpy0A2p50VMZZEp1qYc9R_owSaC_91zvCv-JG-pFQneoNgMKsT983ukUjOVslcdk4m9avarMave2cu1bGWen4_Lq1ET5duP4Xhih-Kin8Cbp--aT3_J9y7Zjn3978HS_AZ9-5opiGMGwAi1nUiaFnhx_XjzXCbC8MgDy5-4yc87xn0n-GJCO937ak5ix2QRZoqSGXltwiseTyQK3Q_4CSAhBRIHtC7AG6wggGnKksMoce_oMDPYfq_rc-U2ISF0zqim-Rrsy3cLIr3ZCsilvaRTGW981ANXQ-HyPNF_L56iIFUfLqRM2zIfhsFQLfIrkxzo9_7a0GzsKNpYfHz-efOSv0Bke9-5hjxOfJP0PRmdC9XiL9PFLgo5GNh-NIbh3dFjikUGykOIs9-jIUyvyV8Oaio8ggFLVmiF0vxXuSc2ldURguUsXhVd1-rDXLLKyzFz76N1YAmHbWYKaszIlHy4WyQ3s
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3534
{
"data" : [ {
"id" : "spl_5o2qc4kz6Q9Rjy25lb5314",
"sample_id" : "S1479526675",
"type" : "Blood",
"collected_at" : "2024-11-22T11:42:25.527806Z",
"details" : [ {
"key" : "volume",
"unit" : "ml",
"value" : "5"
} ],
"comments" : "A blood sample",
"metadata" : {
"sample-internal-id" : "SMPL-1234"
},
"study" : {
"id" : "sdy_ciSXMnoIpycs8UGGC1Kt4",
"project_id" : "pjt_1Lwbt8LN3CVU2MGREQLM8S",
"name" : "TCMIQeQfpt",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "NrN48qcGL7",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_1pc9YNuNVx5A66zEBPbkjb",
"name" : "ieb8173pUx",
"email" : "2kfQ1eSf@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_1Hn3Y9pKaiDCZJGXmwL0qN",
"name" : "frvHnH7gy3",
"email" : "KjqU6NFO@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:25.138115Z",
"updated_at" : "2024-11-22T09:42:25.138115Z"
},
"animal" : {
"id" : "aml_2DmZFjw7QJFuqkWh3zIhNG",
"study_id" : "sdy_ciSXMnoIpycs8UGGC1Kt4",
"study_group_id" : "grp_q03YS8m9i9knGmguIOT8L",
"cage_id" : "cge_tKrfhfyYvo8a9ommeYhzj",
"catalog" : "A0000001",
"name" : "SyyaZNwQXL",
"number" : 1,
"strain" : "2eujzidm5I",
"species" : "LlxHyYI1kB",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "CMNtHnNe1J",
"ear" : "7YLLpzdElr",
"tag" : "5XXllCIOGV",
"donor" : "uQnqwwBcwW",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_2eC2UKEkAHTo4QdWkUUKHm",
"name" : "GaogMzHrr6",
"email" : "zPTQhD7q@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_6oh9nHYVBvg7nhPb7CzYhN",
"title" : "Found dead",
"comment" : "qC5oCNeTV8"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:25.338065Z",
"updated_at" : "2024-11-22T09:42:25.338065Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_622sBWeKBoXlEJfU7lH3Dz",
"name" : "y7VWakFp24",
"email" : "XR30KF4Q@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"EZP94Z8tXh" : "jLE59g6uBc"
},
"created_at" : "2024-11-22T09:42:25.509213Z",
"updated_at" : "2024-11-22T09:42:25.509213Z"
},
"created_at" : "2024-11-22T09:42:25.527817Z",
"updated_at" : "2024-11-22T09:42:25.527817Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/studies/sdy_ciSXMnoIpycs8UGGC1Kt4/animals/aml_2DmZFjw7QJFuqkWh3zIhNG/samples?page=1",
"last" : "http://localhost:8080/api/public/v1/studies/sdy_ciSXMnoIpycs8UGGC1Kt4/animals/aml_2DmZFjw7QJFuqkWh3zIhNG/samples?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/studies/sdy_ciSXMnoIpycs8UGGC1Kt4/animals/aml_2DmZFjw7QJFuqkWh3zIhNG/samples",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Study Group
Study group blurb.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the study group. |
|
|
The name of the study group. |
|
|
The sequence number of the study group. |
|
|
The color of the study group. |
|
|
The maximum number of animals allowed in the study group. |
|
|
Indicates this group is a control. |
|
|
The metadata associated to the study group. |
|
|
The study of the study group. |
|
|
The created timestamp of the study group. |
|
|
The last updated timestamp of the study group. |
Retrieve a study group
Retrieves the details of an existing study group. You need only supply the unique user identifier that was returned upon study group creation.
Path parameters ./api/public/v1/studies/{studyId}/groups/{studyGroupId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the study group. |
Request
GET /api/public/v1/studies/sdy_yM2LZekNDyqVE4IHu5fCZ/groups/grp_6Nxbu6D1LlWJzD0gKX9pz1 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzOWYyNWU3MC1mYzk0LTRlNjUtYmQ0MC0wZWNjYzgyNWY2MzgiLCJqdGkiOiI5OWVhOTAxYi04OTJmLTQ3MTUtYTg1MS03ZDBkMjAzZTc5ZWYiLCJpYXQiOjE3MzIyNjg1NTQsIm5iZiI6MTczMjI2ODU1NCwiZXhwIjoxNzMyMzU0OTU0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.VkcunhkZaEXGOmuzPpncZHjX7O0U8GMZ099tWFCQKco734oV6dJsP9Yioj_wSwhHsMeTmRNS4GHWlhQdw-M-qM7q99Az4bq9pthYLS5P3kAqGhsMujBbiR6S1KSsGHOJWoH9-3f0SmZA3AQp2pNYK5uiUX5kNnlwMQRXLlsLOuT3_1SV8JSWAhElhwNgS9P_dsafqS9x68q-1B7_d_2NhvKZpljsjDie4Ibm0YzSabFHP_g8nJBBZmrvtbA10P3V0NzrCaOZj1G42JGy_HsCWSEGAeuExWogsSCebqDpkeuDxtcX8HgTgC8iIGp0WGv-Nt_hHOStrQ4_5tIheTf1kOq9wQcbAkxXh43PzYI0qW_b9yw0F8Rf0KqlNaK-VK5NpchDZE3gXpe7OaIIygsclcUn7WpVPx8peaCO9ToVhBsUIf3AiSh5sJyaoV28FtucE0XGJARTvxFJ8rt8lmjpQ4paA4k4fI4zvlxfWB82PftG0yRYo-JgN9m9uHKUKTFCkByo2tC6mYMIGzy_JtWBiU_3o-HFGa7zpdh-W5fonYSmLiDS-yMbgk6XhBCw5k9Rsehz_vzjKfQs8Jl7pFf-gj7r2FtkJF94IJez5AdDSN61eSewhonYiaHf9q7f6wMKWyUp8Jv2GrRw9PVSqZMtQq3DJNQi0SLWqIMzj9a31Kc
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1166
{
"id" : "grp_6Nxbu6D1LlWJzD0gKX9pz1",
"name" : "A",
"no" : 1,
"color" : "#34e8eb",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-internal-id" : "SYSGROUP-A1"
},
"study" : {
"id" : "sdy_yM2LZekNDyqVE4IHu5fCZ",
"project_id" : "pjt_1W2JCyfgNik5W8xNPuoRq4",
"name" : "xXZL2RE4My",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "aMKEKGoUXh",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_3uKoWrMOs6iQJAWjv5gxLe",
"name" : "Ge2GYY2CcV",
"email" : "toBqZl9d@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_23HofkQyBD4mfV1A6bXOqU",
"name" : "GKURaKnw8z",
"email" : "ylXl8xnd@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:33.977718Z",
"updated_at" : "2024-11-22T09:42:33.977718Z"
},
"created_at" : "2024-11-22T09:42:34.178652Z",
"updated_at" : "2024-11-22T09:42:34.178652Z"
}List all study groups
Returns a list of your study groups.
Query parameters
| Parameter | Description |
|---|---|
|
The number of study groups to return per page. |
|
The page of study groups to return. |
|
Filter study groups to return by metadata value |
|
Filter study groups to return if they have an associated treatment |
Request
GET /api/public/v1/studies/sdy_1KpDACSsH9v30YyDP3xqwO/groups HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3MmViN2MyZi02Y2E3LTRiNmQtOGRlMC1mZTVhZWZiNmNlYmUiLCJqdGkiOiJjNzM0MmMwYy02NmRiLTQxMTYtODNhMi0wMTc3Mzg2MzZiNDkiLCJpYXQiOjE3MzIyNjg1NTQsIm5iZiI6MTczMjI2ODU1NCwiZXhwIjoxNzMyMzU0OTU0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.Yz8M8SI10m0ZbDME_pMB3Vxiqj7IczVE6cF1MYYvI_LGf3ROrgIz91plARPoMA4r8don9Cg1QmgZfIxrGPu0U2O09BGEWCrDrFKQK4nDDZUDHDuwO9xAjs6chE7S3hEMFNJs4gWYl0ZbLEDzzidgGhKcevuy051prxktXJkp2fE7OPKhhaovlAHdqTxlh0cnss00KxOXsTlwsr---14LWLVzpZkWMytxfqwcS7x1xc_AYSvkG6BWPJNXsjGWNGgGDy-c9sjQpFnbrIXAicPn4YhRnNcxIh3lXrtWcEAIcsOoF3WDppy-oUbYsAXZbRfMtTdtxjlChmucumXxDuGrDlzvKPL68W6xuI3fQ3yEfnTwNg7GjzGEswCbTlYTNVlkaIFzI8mzW1zUS3hcJHTNxhkZhK30BKrnm_bSE8dRC2c35XoSIPkxE9Nv1-GCar6BqTDTBOd_4o-kvYabggtseSK9rAcR3mX6T1Y2K5aZ7eDFlf5ZOmpYZC-UpKZ8rpkhCfCGD7FWv7z6mzRLIdxoR9eqowjtCK5-O1bXl_uM9Jxzy-BAkbSJV4npJOhFpVUB8LSwAXhOzI7JGwq7_NCahBXe9Q6lkS3l8bxKy0iXctHMmIGn_uY8bFs6z4FKeEdro5MwwP_i1-1aK6FYGtOx-6eMze_4tbyzUAuY7kn60SY
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 4255
{
"data" : [ {
"id" : "grp_2B1BA571GeDr74tsLQkiJv",
"name" : "A",
"no" : 1,
"color" : "#34e8eb",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-internal-id" : "SYSGROUP-A1"
},
"study" : {
"id" : "sdy_1KpDACSsH9v30YyDP3xqwO",
"project_id" : "pjt_iOlqR0IVJP2A8woYkINxc",
"name" : "GAshG6m7FN",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "sBjWivdqjH",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_6Ptfptpc07JPM9UiVbD3zA",
"name" : "AOfPip1S6A",
"email" : "bWtxUn7w@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_3qaBYTiP35rflvp1qCol1l",
"name" : "niXZzUy3Es",
"email" : "EJEth4Tm@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:34.593637Z",
"updated_at" : "2024-11-22T09:42:34.593637Z"
},
"created_at" : "2024-11-22T09:42:34.777137Z",
"updated_at" : "2024-11-22T09:42:34.777137Z"
}, {
"id" : "grp_Ppy24Ehc2eijXNQtehF4t",
"name" : "B",
"no" : 2,
"color" : "#4a7d4b",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-internal-id" : "SYSGROUP-B3"
},
"study" : {
"id" : "sdy_1KpDACSsH9v30YyDP3xqwO",
"project_id" : "pjt_iOlqR0IVJP2A8woYkINxc",
"name" : "GAshG6m7FN",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "sBjWivdqjH",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_6Ptfptpc07JPM9UiVbD3zA",
"name" : "AOfPip1S6A",
"email" : "bWtxUn7w@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_3qaBYTiP35rflvp1qCol1l",
"name" : "niXZzUy3Es",
"email" : "EJEth4Tm@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:34.593637Z",
"updated_at" : "2024-11-22T09:42:34.593637Z"
},
"created_at" : "2024-11-22T09:42:34.782431Z",
"updated_at" : "2024-11-22T09:42:34.782431Z"
}, {
"id" : "grp_1AlcbmcDvbIj1mnf7sKH6A",
"name" : "C",
"no" : 3,
"color" : "#ad2f70",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-internal-id" : "SYSGROUP-C2"
},
"study" : {
"id" : "sdy_1KpDACSsH9v30YyDP3xqwO",
"project_id" : "pjt_iOlqR0IVJP2A8woYkINxc",
"name" : "GAshG6m7FN",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "sBjWivdqjH",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_6Ptfptpc07JPM9UiVbD3zA",
"name" : "AOfPip1S6A",
"email" : "bWtxUn7w@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_3qaBYTiP35rflvp1qCol1l",
"name" : "niXZzUy3Es",
"email" : "EJEth4Tm@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:34.593637Z",
"updated_at" : "2024-11-22T09:42:34.593637Z"
},
"created_at" : "2024-11-22T09:42:34.790661Z",
"updated_at" : "2024-11-22T09:42:34.790661Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/studies/sdy_1KpDACSsH9v30YyDP3xqwO/groups?page=1",
"last" : "http://localhost:8080/api/public/v1/studies/sdy_1KpDACSsH9v30YyDP3xqwO/groups?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/studies/sdy_1KpDACSsH9v30YyDP3xqwO/groups",
"to" : 3,
"total" : 3,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Study Group Treatment
Study group treatment blurb.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the treatment. |
|
|
The name of the treatment type. |
|
|
The name of the treatment. |
|
|
The external identifier of the treatment. |
|
|
The dose concentration associated with the treatment. |
|
|
The dose volume associated with the treatment. |
|
|
The stock concentration associated with the treatment. |
|
|
The volume of the treatment. |
|
|
The metadata associated to the treatment. |
|
|
The study associated with the treatment. |
|
|
The study group associated with the treatment. |
|
|
The created timestamp of the treatment. |
|
|
The last updated timestamp of the treatment. |
Retrieve a study group treatment
Retrieves the details of an existing study group treatment.
Path parameters ./api/public/v1/studies/{studyId}/groups/{studyGroupId}/treatments/{treatmentId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the study group. |
|
The unique identifier of the treatment. |
Request
GET /api/public/v1/studies/sdy_57bghPYwEAEQarfUOq5lXF/groups/grp_6s0S3mEaxuHdWQjMS5shs5/treatments/tmt_pnksGF5G0IdUQ4QAtueTm HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiOTM1MTc3MS05MjhiLTRjZGYtODQxZC0wNjI5NTRkYmYyOWUiLCJqdGkiOiIwMjYyYjg0NC1kMmE2LTRjNTktODk1Mi02OGM5YTI1OWU2ZTEiLCJpYXQiOjE3MzIyNjg1NjEsIm5iZiI6MTczMjI2ODU2MSwiZXhwIjoxNzMyMzU0OTYxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.JPCbFFb0FdxpmDO7ydcJ6GXefD6WGZByf4D9D3cDd2U1CIY0Dfpd0GF9WueLGl2gd58D6pr9KyEQsXbZMWy86LUvRPAm4nzEhGSeN-ps0qVuIuRFe_3JZ7meyiEuytJuyHUGUgygGxCb8N37aOBlJEwU8wDm2G87Fa5yF5LIFVilMzz_X20xeM2JKPmEzg_xQSGAij0iNmkgr-hF-0d7mVPu2rf_V646LZUwW3LqgjNNjhrxb47dTnIsKVWvUXDUJ1s9pC2HPri7vKjdFECOIRT3C6csuEkeYkLYjYzJLAvg1PChcv4sUDN7g5ItzL7wioiv9wIT7BZbQ9x2ileruMg777iSjAWp_o6NIqp8KJ1GOVZM1Y5tPU-AvVFeHdCW4JLc_c7qyHP5mGpHCeSCgNP7YZyhM8i5JLZPJtCIahrHSUuOGDKJrOU13s27sHuw5AfvZb4tAnvFcuEThFkgA61sElQlkg8rlklyWXiP_Fx9MbxKsQdC4V90SCVBIRjqnmCrQsFHgEpa6o_oFV6CH4WpWtUBZRVcBbDoOWbz59Kt6HA135O0VFzDedK6HZjCVINQ5Vfd0qNJ6GTbQ81AbRCUyYYrKRQIHyjNkE98y-wRxU-B6SKGrQGTwDGo8GowpKFFUW__JkN-DOG2LG9HFuniWzEhGcF0T-ancVDJwHc
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2042
{
"id" : "tmt_pnksGF5G0IdUQ4QAtueTm",
"type" : "dose_volume",
"name" : "Pps8Ox9sTG",
"external_entity_id" : "fOFPzxqiuG",
"dose" : {
"unit" : "mg/kg",
"value" : "5",
"display_unit" : "mg/kg",
"display_value" : "5"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "15",
"display_unit" : "ml/kg",
"display_value" : "15"
},
"stock" : {
"unit" : "mg/ml",
"value" : "10",
"display_unit" : "mg/ml",
"display_value" : "10"
},
"volume" : {
"unit" : "µl",
"value" : "8",
"display_unit" : "µl",
"display_value" : "8"
},
"metadata" : {
"treatment-internal-id" : "TREATMENT-1234"
},
"study" : {
"id" : "sdy_57bghPYwEAEQarfUOq5lXF",
"project_id" : "pjt_54jZgn7r91hEYrP1Q1gIT0",
"name" : "OlPaxMFKry",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "2u7acpLZnA",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_3pYJWv9scsyIvady8IsiHg",
"name" : "7LPnoTwj4n",
"email" : "q5DyTnnV@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_h5g58EPNtiRC0C9i30nr9",
"name" : "gV31GIITvw",
"email" : "KLK6fJqk@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:41.235526Z",
"updated_at" : "2024-11-22T09:42:41.235526Z"
},
"study_group" : {
"id" : "grp_6s0S3mEaxuHdWQjMS5shs5",
"study_id" : "sdy_57bghPYwEAEQarfUOq5lXF",
"name" : "bG1ODWnoSK",
"no" : 1389834343,
"color" : "w229UVQofJ",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-internal-id" : "GROUP-1234"
},
"created_at" : "2024-11-22T09:42:41.438272Z",
"updated_at" : "2024-11-22T09:42:41.438272Z"
},
"created_at" : "2024-11-22T09:42:41.558207Z",
"updated_at" : "2024-11-22T09:42:41.558207Z"
}List all study group treatments
Returns a list of your study group treatments.
Query parameters
| Parameter | Description |
|---|---|
|
The number of measurements to return per page. |
|
The page of measurements to return. |
|
Filter studies to return by metadata value |
Request
GET /api/public/v1/studies/sdy_4cNrKtnPIinT58Vyj5mP48/groups/grp_5r0u0Inw6dO369gqzEno0h/treatments HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyYjQxM2VhOC0zMDk2LTQ4M2MtYWZlMC05ODNkY2Q5YmMxZjAiLCJqdGkiOiIzYmIyNzZiNS0zZDhiLTRlZjYtYjY5Zi02MzYzYmQ3ZDg3ZDYiLCJpYXQiOjE3MzIyNjg1NjAsIm5iZiI6MTczMjI2ODU2MCwiZXhwIjoxNzMyMzU0OTYwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.SqkLu7AxjQUcEnWYWfl-8tHjSDFMVOKtyQ_0SUvaLU6LJg8VFEqmMWiMRjk_6i-YObv7ACDs0mIYwFku-PhdE02YBJkfkKGI1qV-x1t6siH7zemF_ga0kmCY4tS18BcYBeSgov7m0T5aCAC5QHayJmFVikTeGcU_QcwBU-F3_2r7Uwozsg04rJhyKIr6xRa_siwZ4hRhoxjYk3CF6SvD0vNtT75wuiC6tgJlWTOtb-D3M9Mvc1-eWQaQjdPKgnbZv2HQZvHiWoutUVxK8_mX9kMtLqtWHPlJ-VIdrLJ9gaEaaBOjx0pO8l7Voul9CCIS5UKPovqgQJVqcoW6BkYQcLjALmJcJ3wvDiwWFTKXnYK7_4z0h9WfkGXPZ2oVF5OCcf_OiIvGog7vmMi8MbSsfT9R9hs0-0gyA7-12sbUp1jWHzoHuYm8IS8W5rglK0qezvMmPCalxmM5UYcRJzwkjSEDGtRYobXHjaH-xDBEdcX_zTXJ-fNbOi-Czm_WA2M_S6j3-4Ebj7-Y-U3i733rLIKL3QCq9hduFJm989n4ojAVbD4NqSt7F-KM5XbK8pJdMA-vroXyRTfj0TpjpOHmYrAaNULHG9nIxuvqhTR4nGJJjJo63HQYoQeuqmoyoYNSfLxsmSx9rvhkslMfQyC0UbWiGTL96MF7nwueskOemzY
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2822
{
"data" : [ {
"id" : "tmt_3StiCVaOXBYSk9X3qJYZHc",
"type" : "concentration_vgkg",
"name" : "68a3jKWkBE",
"external_entity_id" : "OzamlywlRS",
"dose" : {
"unit" : "mg/kg",
"value" : "5",
"display_unit" : "mg/kg",
"display_value" : "5"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "15",
"display_unit" : "ml/kg",
"display_value" : "15"
},
"stock" : {
"unit" : "mg/ml",
"value" : "10",
"display_unit" : "mg/ml",
"display_value" : "10"
},
"volume" : {
"unit" : "µl",
"value" : "8",
"display_unit" : "µl",
"display_value" : "8"
},
"metadata" : {
"treatment-internal-id" : "TREATMENT-1234"
},
"study" : {
"id" : "sdy_4cNrKtnPIinT58Vyj5mP48",
"project_id" : "pjt_1EHHIsnYuYzASINaHlzxpi",
"name" : "FJtG3cZMXz",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "JnjoNgJGks",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_3oTrubjX84vBVnQ2cYecCw",
"name" : "YEU1Uv0EEh",
"email" : "zXMpRYzR@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_2Guh3XMJeMxVywBqdcepHd",
"name" : "V9nkeIY6Ea",
"email" : "l2OtW5vP@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:39.700446Z",
"updated_at" : "2024-11-22T09:42:39.700446Z"
},
"study_group" : {
"id" : "grp_5r0u0Inw6dO369gqzEno0h",
"study_id" : "sdy_4cNrKtnPIinT58Vyj5mP48",
"name" : "LhO4BYt1lE",
"no" : 790855683,
"color" : "uDjlx1ngQY",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-internal-id" : "GROUP-1234"
},
"created_at" : "2024-11-22T09:42:39.903494Z",
"updated_at" : "2024-11-22T09:42:39.903494Z"
},
"created_at" : "2024-11-22T09:42:40.014372Z",
"updated_at" : "2024-11-22T09:42:40.014372Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/studies/sdy_4cNrKtnPIinT58Vyj5mP48/groups/grp_5r0u0Inw6dO369gqzEno0h/treatments?page=1",
"last" : "http://localhost:8080/api/public/v1/studies/sdy_4cNrKtnPIinT58Vyj5mP48/groups/grp_5r0u0Inw6dO369gqzEno0h/treatments?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/studies/sdy_4cNrKtnPIinT58Vyj5mP48/groups/grp_5r0u0Inw6dO369gqzEno0h/treatments",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Study Dosage
This is an object representing a dose of compound administered to an animal. You can retrieve it to see the dosing method, stock, volume, concentration, date administered, user administered and the treatment group of the animal it was administered to by of the dosage.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the dosage. |
|
|
The name of the treatment type. |
|
|
The created timestamp of the dosage. |
|
|
The dose concentration associated with the dosage. |
|
|
The dose volume associated with the dosage. |
|
|
The stock concentration associated with the dosage. |
|
|
The volume of the dosage. |
|
|
The study associated with the dosage. |
|
|
The animal associated with the dosage. |
|
|
The measurement associated with the dosage. |
|
|
The user associated with the dosage. |
|
|
The treatment associated with the dosage. |
|
|
The optional weight that’s taken during a dosage. |
|
|
The created timestamp of the dosage. |
|
|
The last updated timestamp of the dosage. |
Retrieve a study dosage
Retrieves the details of an existing study dosage.
Path parameters ./api/public/v1/studies/{studyId}/dosages/{dosageId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the dosage. |
Request
GET /api/public/v1/studies/sdy_6h9oeLXjwwm173AQ9BEzhS/dosages/dsg_5tUPVGIPkU6HgtYDZM48Bn HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyYmQzZmJhOC1kYWYzLTRiNWYtOTVlNy02MWYwMjBjZGIyOGYiLCJqdGkiOiJhZDdhNGMxYS02YmRkLTQzY2ItODZmYS00ZDNmOTI5ZDZlNDciLCJpYXQiOjE3MzIyNjg1MDksIm5iZiI6MTczMjI2ODUwOSwiZXhwIjoxNzMyMzU0OTA5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.U6OOfawP9dsfLtJx69GhCk1WRhEqLQL5UDj7d-XwZB_WwTkVvLzn_zIlsJGo2jT1sCX0F5gN9qx9GvQHrk7iOo6ZrGi_y9FhT6gokIoGdvXv99sXnT64HGdvOG6h5wtIHlYOqv_bZ_9Wahi0jqOo6jro4mtCeH6k7HrYGrxRpjeJxsJEBc2Q8mL9oZ_gPSdWPtMPavAr36KlcUhBdMY6jZIqeR__8EaZHMSbGJezzfW5or8qM3Dkj3GFk91oll-4r8HmKkCaHQdWgbv9KybS1n-m-XGNTavN9xW1tWywoQTX7SSaL0rlCmSWLCa9DDrCD5t3Uid0-aSzkvHJJLtQmbsnAW7c_GHDvUmCYl69tTUAiRuLfcIsw6fTH_fTmpLWIHEBPiCYf4Hgs2kfcn9FnDwjxyTPh-LXjYmromXCznCgaDuhMV5DS2V3JYwVzGsLXbNwLcfjklHt7sz9T9Fow05j7eWDzKFOAjum8fXbFzHq0V0XG_1swcTjCX_QWlG61_r2eIFrDBWjpsORfZXB1R9pDcdeudDtTrrqQqF3ugR3VxF0jr9yXGClhUU9VdA3qkhY6wj0f-NGpPtFTWx0VZxcu5gcxSZu5wp5QTjvvMt3dNK_auXSHHNE8H4oa40ZoU93bje2zRzncd-8n8yO2FmCKO-M7j17cuPgDmnw7a8
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 4511
{
"id" : "dsg_5tUPVGIPkU6HgtYDZM48Bn",
"name" : "Example dosage",
"dosed_at" : "2024-11-22T09:41:49.918591Z",
"weight_at_dosing" : null,
"dose" : {
"unit" : "mg/kg",
"value" : "1.60",
"display_unit" : "mg/kg",
"display_value" : "1.60"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "16.26",
"display_unit" : "ml/kg",
"display_value" : "16.26"
},
"stock" : {
"unit" : "mg/ml",
"value" : "24.85",
"display_unit" : "mg/ml",
"display_value" : "24.85"
},
"volume" : {
"unit" : "µl",
"value" : "38.32",
"display_unit" : "µl",
"display_value" : "38.32"
},
"study" : {
"id" : "sdy_6h9oeLXjwwm173AQ9BEzhS",
"project_id" : "pjt_1eJlL6xEAzTYasrHNBVdge",
"name" : "orvStf0rG9",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "mleekMSw1F",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5qlkt59eROzB9gwHKsAZoR",
"name" : "x6GpS93kq6",
"email" : "THNDBatt@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_36daCn6uqXVngb1oD97uap",
"name" : "CPNXJlVhLL",
"email" : "NxzYzvNd@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:49.587668Z",
"updated_at" : "2024-11-22T09:41:49.587668Z"
},
"animal" : {
"id" : "aml_79LDfMZ3RnavgKWrUbSKw0",
"study_id" : "sdy_6h9oeLXjwwm173AQ9BEzhS",
"study_group_id" : "grp_57Pf5Ks06DamOEIN8tK6B1",
"cage_id" : "cge_4UKtvfkOyX9jWyIffrLPUC",
"catalog" : "A0000001",
"name" : "cxNnNxIzjT",
"number" : 1,
"strain" : "UDy8gN48N7",
"species" : "MooVGRr4ZG",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "Et5r1yxkTT",
"ear" : "a4CJCm0h7o",
"tag" : "FXtGpnargW",
"donor" : "g1KIIaciqQ",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_3qnkp1Tld3XFmvDWxL9S3U",
"name" : "gT4GQCvhap",
"email" : "bFgVUohF@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_5eN6YAxDOEpDsHyvBk5FcE",
"title" : "Found dead",
"comment" : "J7H8ilpbwa"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:41:49.798742Z",
"updated_at" : "2024-11-22T09:41:49.798742Z",
"disease_induction_date" : "2024-11-22"
},
"measurement" : {
"id" : "mst_3W7MOsuUljPN3KuF5YeO9o",
"study_id" : "sdy_6h9oeLXjwwm173AQ9BEzhS",
"animal_id" : "aml_79LDfMZ3RnavgKWrUbSKw0",
"measured_at" : "2024-11-22",
"calculations" : [ {
"id" : "vbl_167hVuOuuJAFUSfSy0KzFP",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "55",
"formula" : "weight",
"variables" : [ ]
} ],
"created_at" : "2024-11-22T09:41:49.897145Z",
"updated_at" : "2024-11-22T09:41:49.897145Z"
},
"user" : {
"id" : "usr_1hpw54pWp1TNEfBGOfwG4X",
"name" : "wUgY5 Overwatch",
"email" : "Mmh15p35@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:41:49.555384Z",
"updated_at" : "2024-11-22T09:41:49.555384Z"
},
"treatment" : {
"id" : "tmt_66ArR9LxWen4Z8MV7BTIpD",
"study_id" : "sdy_6h9oeLXjwwm173AQ9BEzhS",
"type" : "dose_volume",
"name" : "KykzwjNuIn",
"dose" : {
"unit" : "mg/kg",
"value" : "5",
"display_unit" : "mg/kg",
"display_value" : "5"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "15",
"display_unit" : "ml/kg",
"display_value" : "15"
},
"stock" : {
"unit" : "mg/ml",
"value" : "10",
"display_unit" : "mg/ml",
"display_value" : "10"
},
"volume" : {
"unit" : "µl",
"value" : "8",
"display_unit" : "µl",
"display_value" : "8"
},
"metadata" : {
"treatment-internal-id" : "TREATMENT-1234"
},
"created_at" : "2024-11-22T09:41:49.910527Z",
"updated_at" : "2024-11-22T09:41:49.910527Z",
"external_entity_id" : "RINlwPEP9x"
},
"created_at" : "2024-11-22T09:41:49.918605Z",
"updated_at" : "2024-11-22T09:41:49.918605Z"
}List all study dosages
Returns a list of your study dosages.
Path parameters ./api/public/v1/studies/{studyId}/dosages
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
Query parameters
| Parameter | Description |
|---|---|
|
The number of dosages to return per page. |
|
The page of dosages to return. |
Request
GET /api/public/v1/studies/sdy_53beeLT3DC0FwgVpmX6EXW/dosages HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJjYmNhZjE3ZS00NjY3LTQ1MTAtODQzNi04ODQzYTU3ODM5MDgiLCJqdGkiOiJhYTY2ZTYzYS1kOGUzLTQxZTMtYWUzYS0zZjIzNTIzYzE0OTUiLCJpYXQiOjE3MzIyNjg1MDcsIm5iZiI6MTczMjI2ODUwNywiZXhwIjoxNzMyMzU0OTA3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.jiWDKDbsE_S-HQ4aEw4G1YAqu6c9D347aw2CNCwEgksYuT7ESi_VEnOLg4WG4HUt9g-w6KfikSyasCD1CFWzxQm2rPLdXQLA1NxwftwHRUXKTxN7veoBd3Yme7U4cdhuKG91CqbYS1FvMnIw4JJD58g-uq_nUmaL6M0ACPvWWTok1fkZWhLRxz5mpT7nYADSqbGD6cV-ZNKCFU63evSWtHPz6w88dsBCyClsbQ9Q6wkA6YwJoMQvNbUcI8KekL5u73scseg5qfBzOI3nw5LaSa4fI9dkDIxRHbqX4dwHJtyg18krrUAKc4gnhvzEnIW4Y9p6SPiXpStrKEvsfXh6ma013Ezt8pVc1I8wL1dvXGZD5eVd9oXepKr5D0WtBqk6-77C6V5zsqce1E9u4LzT1x5_3mKUkpoExMcRQdpvA4wZYXzxf81aeZYj9ocvh41lFYDoWUnjJeQ_2doh1K-bJLoq9kmCmQnM9ylsmFj8vNAZAsE74WRUrcytS5CHAlm1kliJveEjPgfWU1UnaSAHIFKPcfR1ui7Ctq_WRFi4JxCMXNiHjoDHLTu_YdstCRnGKVHUT2zWGn--Xzy6Od3DQ_XtxwATNeEF81UCx0IexEpoj7zOaQivVEBjDtZ8G8eIscHzlpswf1GxGk_reQO_bRuN3i32MrQBGLkmzJUbg5g
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 5350
{
"data" : [ {
"id" : "dsg_6NyNAKw6AcYjL1hVOI3KEV",
"name" : "Example dosage",
"dosed_at" : "2024-11-22T09:41:47.058487Z",
"weight_at_dosing" : null,
"dose" : {
"unit" : "mg/kg",
"value" : "3.03",
"display_unit" : "mg/kg",
"display_value" : "3.03"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "16.62",
"display_unit" : "ml/kg",
"display_value" : "16.62"
},
"stock" : {
"unit" : "mg/ml",
"value" : "28.10",
"display_unit" : "mg/ml",
"display_value" : "28.10"
},
"volume" : {
"unit" : "µl",
"value" : "34.53",
"display_unit" : "µl",
"display_value" : "34.53"
},
"study" : {
"id" : "sdy_53beeLT3DC0FwgVpmX6EXW",
"project_id" : "pjt_1gCOAqSNhcmopf2f414u7u",
"name" : "eublDZap0f",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "bghSfhxBYB",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_vr3VsUTH9x5VHonYrIXV5",
"name" : "Or63PUbQGf",
"email" : "mQCPKzO6@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_1qFr2N0QmM8nl1j2t73zTM",
"name" : "st85qWj3my",
"email" : "bHIvvBZi@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:46.703956Z",
"updated_at" : "2024-11-22T09:41:46.703956Z"
},
"animal" : {
"id" : "aml_1V8cGlBtyaLyNoN1VXo7Y0",
"study_id" : "sdy_53beeLT3DC0FwgVpmX6EXW",
"study_group_id" : "grp_736b9UaVFbtIJrYg8hRsfB",
"cage_id" : "cge_5P2Ck3fklceZAgKDnU03s6",
"catalog" : "A0000001",
"name" : "5as7p1yq33",
"number" : 1,
"strain" : "oN5HK1Vgfy",
"species" : "0KOXHaeRPK",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "slwv4QaeT8",
"ear" : "2h0jb65gBI",
"tag" : "wowTVQpy1O",
"donor" : "hcemA8oKPm",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_55GDCzuRHrCXfT9NQvKDnw",
"name" : "S4mpqfBlZP",
"email" : "eaMSDRr6@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_4ZyJMfbvk1erYiF9d0AVvc",
"title" : "Found dead",
"comment" : "yRlTNEOhO1"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:41:46.906682Z",
"updated_at" : "2024-11-22T09:41:46.906682Z",
"disease_induction_date" : "2024-11-22"
},
"measurement" : {
"id" : "mst_13zSwsilOWuYrIZYecsOk0",
"study_id" : "sdy_53beeLT3DC0FwgVpmX6EXW",
"animal_id" : "aml_1V8cGlBtyaLyNoN1VXo7Y0",
"measured_at" : "2024-11-22",
"calculations" : [ {
"id" : "vbl_5wNweJdz22djUUW6UatPfW",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "55",
"formula" : "weight",
"variables" : [ ]
} ],
"created_at" : "2024-11-22T09:41:47.001293Z",
"updated_at" : "2024-11-22T09:41:47.001293Z"
},
"user" : {
"id" : "usr_7Jy73ZzMpuh2gGzZ2XjQMo",
"name" : "8Qb07 Overwatch",
"email" : "1nMkzsEw@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:41:46.673991Z",
"updated_at" : "2024-11-22T09:41:46.673991Z"
},
"treatment" : {
"id" : "tmt_3aFU4DthYsEddW0UGyvulD",
"study_id" : "sdy_53beeLT3DC0FwgVpmX6EXW",
"type" : "concentration_mlkg",
"name" : "73t2p9F1vP",
"dose" : {
"unit" : "mg/kg",
"value" : "5",
"display_unit" : "mg/kg",
"display_value" : "5"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "15",
"display_unit" : "ml/kg",
"display_value" : "15"
},
"stock" : {
"unit" : "mg/ml",
"value" : "10",
"display_unit" : "mg/ml",
"display_value" : "10"
},
"volume" : {
"unit" : "µl",
"value" : "8",
"display_unit" : "µl",
"display_value" : "8"
},
"metadata" : {
"treatment-internal-id" : "TREATMENT-1234"
},
"created_at" : "2024-11-22T09:41:47.035840Z",
"updated_at" : "2024-11-22T09:41:47.035840Z",
"external_entity_id" : "JfW24jOjea"
},
"created_at" : "2024-11-22T09:41:47.058984Z",
"updated_at" : "2024-11-22T09:41:47.058984Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/studies/sdy_53beeLT3DC0FwgVpmX6EXW/dosages?page=1",
"last" : "http://localhost:8080/api/public/v1/studies/sdy_53beeLT3DC0FwgVpmX6EXW/dosages?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/studies/sdy_53beeLT3DC0FwgVpmX6EXW/dosages",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Study Measurement
This is an object representing a measurement that has been recorded from an animal on a day. Measurements are created in studies which have a preset, typically for observable data like tumour volume or blood glucose.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the measurement. |
|
|
The measured at timestamp of the measurement. |
|
|
The calculations associated to the measurement. |
|
|
The study of the measurement. |
|
|
The animal of the measurement. |
|
|
The user that recorded measurement. |
|
|
The created timestamp of the measurement. |
|
|
The last updated timestamp of the measurement. |
|
|
The measurement calculation variables. |
Retrieve a study measurement
Retrieves the details of an existing study measurement.
Path parameters ./api/public/v1/studies/{studyId}/measurements/{measurementId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the measurement. |
Request
GET /api/public/v1/studies/sdy_6GK1A6m43leNccuS5Lljx7/measurements/mst_4BFwPsJGRae7BRghJUsE8e HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1OTMyNDc2OC00NTU1LTQzOTUtODg3ZS1jNjRhNTk1YjFlYzciLCJqdGkiOiI3N2ZkN2QzNy0wMTMxLTQxYWQtOWM1My04NDBhOTExNTk4OTQiLCJpYXQiOjE3MzIyNjg1MTksIm5iZiI6MTczMjI2ODUxOSwiZXhwIjoxNzMyMzU0OTE5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.WQWEcDkvAYAxLCwKkuMA8v33qqw1DUWvby4Nmk-gSXqdULv5SKYnDXVuJtAKQHhs2kFI3qZFU3cRpYvX4zBl7sMDBHcYQT7DTsjHktFHBHJAItkyinV9wagxsAsUdpCUJi3hVB7JJafFWj2g00ZJNfFEM05UDbQL9R3OAq5xu10YvdfeyBY4j6mRpCEffTWqCJv93JaVfSue-4alvJDQhn-dqARXga4rFuO7GOHD13zJEjIK4xV82dOXc5aORR-i-s_vH5cNFFFtGOFyGCLwsWdwoipBKrhVOu8xLLcRT5LHnIDXZrnoPVcBjuhYu5mkv3eQMZ02TZBQrI2FbpGvyJBeoAqaHfLSq_4ymkQTs9wrvrTl4DkG4VpQtItHhZZm96bSJ8KrbFOkoHwJDWlRsW3AnYNv6TG8TrAh6YYEJ0ecIJEBQV5dOukVuK3FTJPu3j6rH0fbEkbDlrjM3AAR-zIY6RX5QzYnOoSAtUxRa9-7kt401nwR-8g7FZfI5Ey-6S5ySE-E-jFJYjshVWHFA_fWkwYhNADrEt-w0M70LQ9mg6kD5eH2BkQIfMyn3RUB101I3Dl5faufep7anYPNHJffRI6ZJwYpPTLAOqab-uQtO6KjcThSEbTMcDnZfRQZuz8lBg5q7vSohXTG-MJzfIQnBVYe-xekcTMmZKUK-eU
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3201
{
"id" : "mst_4BFwPsJGRae7BRghJUsE8e",
"measured_at" : "2024-11-22",
"calculations" : [ {
"id" : "vbl_3FEjROEYLXBN32zlNOYPd9",
"key" : "tumour_volume",
"name" : "Tumour Volume",
"unit" : "mm³",
"excluded" : false,
"value" : "75",
"formula" : "(width * width * length) / 2",
"variables" : [ {
"id" : "vbl_7BHSHxdahH0QgFNrrbVWUk",
"key" : "width",
"value" : "5",
"unit" : "mm"
}, {
"id" : "vbl_3rZYsfKWX0NBO1oNBoihpI",
"key" : "length",
"value" : "6",
"unit" : "mm"
} ]
}, {
"id" : "vbl_3zdMi2C3k8ot5okLhkPAp0",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "55",
"formula" : "weight",
"variables" : [ ]
} ],
"study" : {
"id" : "sdy_6GK1A6m43leNccuS5Lljx7",
"project_id" : "pjt_V5vYqdRrVKTIwEUXqGj5S",
"name" : "PwPONWurgA",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "QU7p5AGCkB",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_2QfXA1Z0hA00UOTPjPXXvE",
"name" : "khy2wyHXGM",
"email" : "9s9TMYMu@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4ipXCur1cF79h1jCtsmRNO",
"name" : "2FjmwNamPx",
"email" : "Ym76fabe@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:59.163924Z",
"updated_at" : "2024-11-22T09:41:59.163924Z"
},
"animal" : {
"id" : "aml_59yHu2KVrjxBT4xUE2zQst",
"study_id" : "sdy_6GK1A6m43leNccuS5Lljx7",
"study_group_id" : "grp_4sRGYjrrZxX7FOTMv0xdCd",
"cage_id" : "cge_4PGkXKRLMP5bCqjmzVd1YH",
"catalog" : "A0000001",
"name" : "f00xh5qypq",
"number" : 1,
"strain" : "rGzSNG4gDO",
"species" : "j8jmSKV37M",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "zTyhuLyuni",
"ear" : "0uK93zhiPT",
"tag" : "yvpruUyH56",
"donor" : "SEO1kTlEMm",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_fujFXtFNBUh2t8Qrg7JtU",
"name" : "HAJwBW3zAW",
"email" : "Q6in4LGU@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_4cKBU4EZxgg5NLg3llv4Pj",
"title" : "Found dead",
"comment" : "W56EcQsqnU"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:41:59.389181Z",
"updated_at" : "2024-11-22T09:41:59.389181Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_FspVDxAQrnHJcPwKnI3p2",
"name" : "boViE Overwatch",
"email" : "2RLCESE5@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:41:59.133404Z",
"updated_at" : "2024-11-22T09:41:59.133404Z"
},
"created_at" : "2024-11-22T09:41:59.487127Z",
"updated_at" : "2024-11-22T09:41:59.487127Z"
}List all study measurements
Returns a list of your study measurements.
Path parameters ./api/public/v1/studies/{studyId}/measurements
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
Query parameters
| Parameter | Description |
|---|---|
|
The number of measurements to return per page. |
|
The page of measurements to return. |
|
Filter measurements to return by date (yyyy-mm-dd). |
Request
GET /api/public/v1/studies/sdy_5n3gWE0YD6HllZYw9gAsds/measurements HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0YmU1NGU5YS0yNTY3LTQ3ZDctYjg4ZC05MDcwYzMzMjlhNmYiLCJqdGkiOiIxNDNjMzVjNS03NjBkLTRjOGQtYTY4Ni0wNDRlZWU1YzEyOGIiLCJpYXQiOjE3MzIyNjg1MTgsIm5iZiI6MTczMjI2ODUxOCwiZXhwIjoxNzMyMzU0OTE4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.AdnNR1oNwd1PhRfkQTSnUaDbuFrffgemImHiA1GoWgW1YywKmW8vflzH1QDPUqWJtWAJvsDbS2ASiDSRvRpmoU7XQ3paGcxYSzaTrIZtDT5Ad2XhyLkWS6Wdbw31_KsfK2_P4yVRwlFSK28ctIBdOyDt7UAjQnz-EsvSMtBJ0a8DraMPtj1tNr0HvWX6E8NOLxe7GpXOVypizKH1nQ2_semX0T4x0CVL2-KZbKmL3GHFyaXeaxcEEklx7HeKjJCziTnt94X0OSrhTHt66KTV07lSX1OTkLQHu-eG0N8JB4sK6AI7AY-24Lt3kKPvg8x-dioMUuKizQF7ZsPdkJ8sZKZAvx0bWoCz14Z3i_mH0gaAB6i2xMhE7jiqUTfHMG6779FjZ1P5HsUQHFh3QPQkcbimQ74_3UcucHby0OJ3ov1usiSpoFLPyf1eTymldGKJ6OKo9JUs0JgmeFWKmS74BFbujcynWkEzPh67OFmCNJCID2ItX3m3zUd9eqS-OtGvnDIiuKlcu1SNEyRI8AlsFtAGMlpnr-7BRc2MCJ4mJs9PpVRqCrHIDcHS5Qdpww5HwllIgX7fSPNu09dLGIAtSD_VVzii9awQafr39d4iGHH_XUZokX3wrs3wzDRgDXUu0eVAshOEs63h7ehD7ZlM8iF09mxw7OyuZFm3t7G7J6g
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 7377
{
"data" : [ {
"id" : "mst_1zY4OMIFiVqS7zKhgcAkfE",
"measured_at" : "2024-11-22",
"calculations" : [ {
"id" : "vbl_1Emos7GM0jWqPAnbFVCePj",
"key" : "tumour_volume",
"name" : "Tumour Volume",
"unit" : "mm³",
"excluded" : false,
"value" : "75",
"formula" : "(width * width * length) / 2",
"variables" : [ {
"id" : "vbl_5FxIx1UuqeiCvDf2MULj5b",
"key" : "width",
"value" : "5",
"unit" : "mm"
}, {
"id" : "vbl_4Qzl9hlwJRhKXB96NyuKyz",
"key" : "length",
"value" : "6",
"unit" : "mm"
} ]
}, {
"id" : "vbl_2jSUOFR7w5hlYeFAlwN3Pa",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "55",
"formula" : "weight",
"variables" : [ ]
} ],
"study" : {
"id" : "sdy_5n3gWE0YD6HllZYw9gAsds",
"project_id" : "pjt_5H098vbrPofwxOyWvVaV7z",
"name" : "cfYyGc4OvE",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "bSe46y4qzj",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_3eEh32d0fndHH0NR1xU5cS",
"name" : "ijTvHwRHBP",
"email" : "ccV3DyYt@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_19hzu62bmc6MaztLLUHd0",
"name" : "YcWUNggBNX",
"email" : "8hmvHkU7@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:57.706782Z",
"updated_at" : "2024-11-22T09:41:57.706782Z"
},
"animal" : {
"id" : "aml_6bugxjSrhOY33YgFnX8pUv",
"study_id" : "sdy_5n3gWE0YD6HllZYw9gAsds",
"study_group_id" : "grp_7L5bwENyVOWPiTibn9wUho",
"cage_id" : "cge_45t6NOoLyPA3RwE6ZgZ9vn",
"catalog" : "A0000001",
"name" : "BDSkER0jjW",
"number" : 1,
"strain" : "AD2JIDAd2i",
"species" : "yMLSnZJn2N",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "QyIN0FmExq",
"ear" : "fzdjzQjWGk",
"tag" : "bmeKagpjeA",
"donor" : "gr7YSJ7gdr",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_2yRtgkl0i00hG2drohSVP1",
"name" : "vSwMI7JNoV",
"email" : "Ffcb3nYA@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_7LVGQBgoSRXnD7XtMGkkoJ",
"title" : "Found dead",
"comment" : "peDMFeDD3X"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:41:57.910689Z",
"updated_at" : "2024-11-22T09:41:57.910689Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_2UXgoNyEDtIVOZXIQxHuw4",
"name" : "MRRTn Overwatch",
"email" : "cE19yDdD@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:41:57.681402Z",
"updated_at" : "2024-11-22T09:41:57.681402Z"
},
"created_at" : "2024-11-22T09:41:58.002290Z",
"updated_at" : "2024-11-22T09:41:58.002290Z"
}, {
"id" : "mst_ViMIPR3z0gNaJvtuMuLff",
"measured_at" : "2024-11-21",
"calculations" : [ {
"id" : "vbl_FRPdIV3uSxiLWd9kRRnn",
"key" : "tumour_volume",
"name" : "Tumour Volume",
"unit" : "mm³",
"excluded" : false,
"value" : "196",
"formula" : "(width * width * length) / 2",
"variables" : [ {
"id" : "vbl_j4ln4bJokVm91yzT4MxhW",
"key" : "width",
"value" : "7",
"unit" : "mm"
}, {
"id" : "vbl_10qhYy3PZGl25A5XCL0tgb",
"key" : "length",
"value" : "8",
"unit" : "mm"
} ]
}, {
"id" : "vbl_4BH8z4UBtCJdL8V1SVrgC4",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "56",
"formula" : "weight",
"variables" : [ ]
} ],
"study" : {
"id" : "sdy_5n3gWE0YD6HllZYw9gAsds",
"project_id" : "pjt_5H098vbrPofwxOyWvVaV7z",
"name" : "cfYyGc4OvE",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "bSe46y4qzj",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_3eEh32d0fndHH0NR1xU5cS",
"name" : "ijTvHwRHBP",
"email" : "ccV3DyYt@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_19hzu62bmc6MaztLLUHd0",
"name" : "YcWUNggBNX",
"email" : "8hmvHkU7@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:41:57.706782Z",
"updated_at" : "2024-11-22T09:41:57.706782Z"
},
"animal" : {
"id" : "aml_6bugxjSrhOY33YgFnX8pUv",
"study_id" : "sdy_5n3gWE0YD6HllZYw9gAsds",
"study_group_id" : "grp_7L5bwENyVOWPiTibn9wUho",
"cage_id" : "cge_45t6NOoLyPA3RwE6ZgZ9vn",
"catalog" : "A0000001",
"name" : "BDSkER0jjW",
"number" : 1,
"strain" : "AD2JIDAd2i",
"species" : "yMLSnZJn2N",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "QyIN0FmExq",
"ear" : "fzdjzQjWGk",
"tag" : "bmeKagpjeA",
"donor" : "gr7YSJ7gdr",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_2yRtgkl0i00hG2drohSVP1",
"name" : "vSwMI7JNoV",
"email" : "Ffcb3nYA@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_7LVGQBgoSRXnD7XtMGkkoJ",
"title" : "Found dead",
"comment" : "peDMFeDD3X"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:41:57.910689Z",
"updated_at" : "2024-11-22T09:41:57.910689Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_2UXgoNyEDtIVOZXIQxHuw4",
"name" : "MRRTn Overwatch",
"email" : "cE19yDdD@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:41:57.681402Z",
"updated_at" : "2024-11-22T09:41:57.681402Z"
},
"created_at" : "2024-11-22T09:41:58.011739Z",
"updated_at" : "2024-11-22T09:41:58.011739Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/studies/sdy_5n3gWE0YD6HllZYw9gAsds/measurements?page=1",
"last" : "http://localhost:8080/api/public/v1/studies/sdy_5n3gWE0YD6HllZYw9gAsds/measurements?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/studies/sdy_5n3gWE0YD6HllZYw9gAsds/measurements",
"to" : 2,
"total" : 2,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Study Observation
Retrieves the details of an existing study observation.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the observation. |
|
|
The unique identifier of the glossary item. |
|
|
The title of the glossary item. |
|
|
Text related to the observation. |
|
|
The type of observation recorded. |
|
|
The value of the observation taken. |
|
|
The timestamp of when the observation occurred. |
|
|
The study of the measurement. |
|
|
The animal of the measurement. |
|
|
The user that recorded measurement. |
|
|
The created timestamp of the project. |
|
|
The last updated timestamp of the project. |
Retrieve a study observation
Retrieves the details of an existing study observation.
Path parameters ./api/public/v1/studies/{studyId}/observations/{observationId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the observation. |
Request
GET /api/public/v1/studies/sdy_aLEjSIHrGhlUpFZayVss/observations/obs_1jYecOkSe421LBXgTVjzFE HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlMTkxNWQzNS1iM2Y4LTQ1ZjItODQzMi1jMjYxMGFiNzRiZGQiLCJqdGkiOiI3ODg2YjJkNy0xM2JhLTRlNmItYTg4ZS0yYmEzMWU0YjZiOGYiLCJpYXQiOjE3MzIyNjg1MjksIm5iZiI6MTczMjI2ODUyOSwiZXhwIjoxNzMyMzU0OTI5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.CaarzgM6oeGz-KcCeO7pzXHmQeD_dyLjIEc-FxCr-rPHYUztxQFTjodjxAqtyLBLgWcbIwQTIR9ojVRyUJ4it8x4K54CUZ9VV6BnvExLiPY7LM4XXKZWRSH6jxa0Ieks-Z7o99j3BSi9z7dxIHNTXjIj17gCH2SFJlpcta1d_X_ztBYFGTZfd9dmkHrSfGXupxm8FuWz-gZkg2HuzNrCbFF1qlwVDvTnbvZBti2IWuEQRICYdaYQOT0hxI4UwE5OzCLAYr7qSQg1ETJ6UpiU4rHiM_qZvHMAKDwdlND3AesQIjg8x11LA2-Txgx69l6F6NNncNPqPhEsosZADuOxylqXqPqOdSlcUUT90eF_P2PpxGCh7lPpL9yRKgE5yRvDd-nZ5qlEk0Xcr7-Hcsp3YdDGyTrtfsQNllUU1i0czzd5IbIExsTvbCEdRPvSdOzcKsMlTL0C4Sh-X7GBp2WIgcj9erD-KzO7LBtBLNsb1cJO3GZYXoP2cEwpk3eQgN7Dox-oVYGmAhWWD-U2xK_dci8vuAYHgiYID-FK7ANgKv4NS-hNSXd5V56Q0aHZRPJ7eMHjOPfqJEGbO1stzwZsIdgadgqutZ0pGuQItWcWoeTAM13MciX_cjFIrnoALfS9Pf1zGMc3YkZ0UyF-xj5SzoVxPP1FkPwG_lZD8CE36qY
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2672
{
"id" : "obs_1jYecOkSe421LBXgTVjzFE",
"glossary_id" : "gly_25hwCM7ZWjGkq9w7Km8tks",
"title" : "Observation Glossary",
"text" : "Example text",
"type" : "severity",
"value" : "Severe",
"observed_at" : "2024-11-22T09:42:09.990738Z",
"study" : {
"id" : "sdy_aLEjSIHrGhlUpFZayVss",
"project_id" : "pjt_1tlaG64zTqSSQ0FVJTdEUK",
"name" : "k5K8epF9PW",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "wxuH30xSaR",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_1nDuh6FthQYt6ZyqCOOEZN",
"name" : "TuYkl6oDP9",
"email" : "MogLJgMT@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_2c0PTxtqgJP0HpTsvsoWVz",
"name" : "LQsi7wrj4L",
"email" : "ja2e6dVW@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:09.660731Z",
"updated_at" : "2024-11-22T09:42:09.660731Z"
},
"animal" : {
"id" : "aml_4H0AMCYuiR1KWqc7VfGwSS",
"study_id" : "sdy_aLEjSIHrGhlUpFZayVss",
"study_group_id" : "grp_5DDbAQDEPo3b7wAZMJppgV",
"cage_id" : "cge_5FiakQJdR68pejBTtMvebO",
"catalog" : "A0000001",
"name" : "GcB5w2pH1X",
"number" : 1,
"strain" : "C7OSM9iBRL",
"species" : "h8fJ1M4RKg",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "7FEL957wUO",
"ear" : "HiVvfmvIrm",
"tag" : "ManTicjTn8",
"donor" : "UzZST5ga9l",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_ZBy3XlfPgzhvt3z4XzNFX",
"name" : "YQajcAEQi9",
"email" : "LullaWit@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_3eluWgcCiE62yYW3tVEbWK",
"title" : "Found dead",
"comment" : "PLLZA59TI3"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:09.897836Z",
"updated_at" : "2024-11-22T09:42:09.897836Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_2yiRKJrV8rWTibklrHonP9",
"name" : "D6k4E Overwatch",
"email" : "70Y8Km1n@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:09.626206Z",
"updated_at" : "2024-11-22T09:42:09.626206Z"
},
"created_at" : "2024-11-22T09:42:09.990760Z",
"updated_at" : "2024-11-22T09:42:09.990760Z"
}List all study observations
Returns a list of your study observations.
Path parameters ./api/public/v1/studies/{studyId}/observations
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
Query parameters
| Parameter | Description |
|---|---|
|
The number of observations to return per page. |
|
The page of observations to return. |
Request
GET /api/public/v1/studies/sdy_39SuxeKAx6XNefAPkp7YVq/observations HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0NDM2YmZiNS0yOWExLTRiM2UtOWUwOS0zNWVhMTg4Nzc0NjEiLCJqdGkiOiIwMDM5MjdhMi1lZjI0LTQzNzgtOThlYS1iZmUyOGM1Y2Y2MjYiLCJpYXQiOjE3MzIyNjg1MzIsIm5iZiI6MTczMjI2ODUzMiwiZXhwIjoxNzMyMzU0OTMyLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.J5t_YsrqnwVABiQtLRkHXhtuKSLbP8uvCQabDswrqn5jEzbWGZzeroARfv7xCFgZgJ6ow6lmcw9b8zffIMcwzcQsgFgnClS16Fnt3E4B21hGXfrnsGxcFmFnoYbe2EIoJng7O6v9TBFTZ7Vhm-7g3JZW5jG-16BTwkNwqyRyuwK11Quvch_uKS2a9RXXcbpmtHozDQ_FzmZN45IdHOmhUXLG6AIyS0ro7gwRIwMipa_E6bs3bLJjqUN9qRMEiF4L8ml0Bnmaj9kuSiWcyE2NPV32DDkpns2gXdqHZsvTGW2JHGGIMeq0ozYevdSnKbzTXVI7NeC5ivr6iMcWaHpH7NWeXmrwRRPOecVTDk3QjX4w5d8M_Ennc9NH4vPIfz_bxMyyAdAjkkLoRa6vrvtmaMH9qmYktm9aFUiUYin5fT1mEIZouFmQwueUZvfSsV1KW8RJoQySZhfSc3wzW74P4D-zskNGv-lJQXZLf8zOyBHMw75oh-ollR8lyZ6lsrB8jtdlyAcE1PiMJJlKOZhjr7mbPNPe9bBJiZ9L-jMX7kqbM0Tzby-YW2vHT_7SDFPzlDY6fiST6crRodldxZ3DiBaDDTV6ryKs7Sg_GFPHxH0PoNRIXAd4mbMpgvPDG_mBaQ79Y4PiwE9p_VI-yU675LBMnqh6Qpxx3zyeUuRGSHg
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3374
{
"data" : [ {
"id" : "obs_3ejwcbIGBrsjh8kyoTCRqw",
"glossary_id" : "gly_17EH0r2s9nK9iNdc3yDqWS",
"title" : "Observation Glossary",
"text" : "Example text",
"type" : "severity",
"value" : "Severe",
"observed_at" : "2024-11-22T09:42:12.983745Z",
"study" : {
"id" : "sdy_39SuxeKAx6XNefAPkp7YVq",
"project_id" : "pjt_7ByDhTHMG6KPxoBSMk4UVS",
"name" : "XgmCbTkUHD",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "Af5OqsF3Yx",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_731cO8b3m7lA31YcIo9mh0",
"name" : "IX2tvCUVKs",
"email" : "lHl0e770@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_35vTRvxIpWLRIy5fbxCJDj",
"name" : "dfwavVKaQU",
"email" : "FDjH1z0s@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:12.670426Z",
"updated_at" : "2024-11-22T09:42:12.670426Z"
},
"animal" : {
"id" : "aml_2EHZM8kMfvUjYkNzdtlEDM",
"study_id" : "sdy_39SuxeKAx6XNefAPkp7YVq",
"study_group_id" : "grp_3Esc0qElzmNwKTfXnEGzhz",
"cage_id" : "cge_73o49zmX05OqGc2a3GDUQt",
"catalog" : "A0000001",
"name" : "9C6SkrNYY6",
"number" : 1,
"strain" : "yl7vb2kWUj",
"species" : "wGAQyo62jv",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "ewk1bTc2wg",
"ear" : "0arWclzEyD",
"tag" : "ZhMYDqAjnB",
"donor" : "HO3vFO2lMp",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_6hv0CkgPeRHqRXTh8k2wtl",
"name" : "fEq6esno0g",
"email" : "5binXi36@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_Wbdvtsf1HipG7Bq91YOyM",
"title" : "Found dead",
"comment" : "o5TP5irOkT"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:12.871789Z",
"updated_at" : "2024-11-22T09:42:12.871789Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_35aSz19o43ScCFLecu3K72",
"name" : "B7qf7 Overwatch",
"email" : "T9voSvxj@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:12.630486Z",
"updated_at" : "2024-11-22T09:42:12.630486Z"
},
"created_at" : "2024-11-22T09:42:12.983810Z",
"updated_at" : "2024-11-22T09:42:12.983810Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/studies/sdy_39SuxeKAx6XNefAPkp7YVq/observations?page=1",
"last" : "http://localhost:8080/api/public/v1/studies/sdy_39SuxeKAx6XNefAPkp7YVq/observations?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/studies/sdy_39SuxeKAx6XNefAPkp7YVq/observations",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Study Preset
Study group preset blurb.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The name of the study preset. |
|
|
The calculations associated to the study. |
|
|
The study of the study preset. |
Retrieve the study preset
Retrieves the details of the study preset.
Path parameters ./api/public/v1/studies/{studyId}/preset
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
Request
GET /api/public/v1/studies/sdy_7EhIVS1Mgaud5FATAmIudJ/preset HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIyM2Y3ZDk3Zi0yMWIwLTQ0NzYtOGMyYS0zMDI5NDhlNDhjOGQiLCJqdGkiOiJjYmQ3M2EwZC0wYzY4LTRmZTgtOGFkOS04ZGE2YTkyODliZGYiLCJpYXQiOjE3MzIyNjg1NTUsIm5iZiI6MTczMjI2ODU1NSwiZXhwIjoxNzMyMzU0OTU1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.GvquRjxutfdoBWdJL6J1ea_Jhuo86SeFHWI8-6Stg-afmtywRSq5Xdgnq2hqArxMetMu551VeY4FAGOykkVPUXlncGHZZa-ZyEjB-mUq089boWNwRKce2TGrMlJAS7-fIT-n8WBcoAKoImfgXMPmYrYM_NcNqq9wPAcwDLSMn-uJ7Awv_1uL6u6AIwsVHIUVQ3iwKoQEUmx_ZzaITr7mF6h1oFsTxMceWn41jZ-zfGxbe7QPHbXjcfbGGSQnyDEz0aWgewux86QL-KEHlRFB2rgjxvZHOSa3nt7vjfcVI5rycQ8umsq7LsJ3B56upMTeks_Dr3lj20-tBeEpugAg0jDRnuMVV_5OoZ9xmKJuGQwA3_sh6SxdcB4r0NutMZB7eXg-Hjc_5zWXrKEiIP-WOvjAMTkdb6RB6c1F2JwZeD3ibLVLvYscLC1nLG0qlmT5RVRcJGMr5foHDQ1KyCRM-Pyy_ZuQz-13N_RRrKP0dzGPWeJDt0DAy5AviCRcDhyIgoWTVpd-LtKwBonWCF_fUYephc5KPXChsl7Gp7A7mKLqgRRQHR0nY4uCJtVscRZoLv8j3d7KEKtnApAWN7Ufzy24Y9Bt2wrQbRnDlqy6I9UujcpRturaXoZQuxtO7U4hAM6-eHnaRoNQoNE9UnIcrKevvvyEI-wHbCn8os-5s_g
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1448
{
"name" : "Subcutaneous Tumor - Two variable",
"calculations" : [ {
"key" : "tumour_volume",
"name" : "Tumour vol.",
"unit" : "mm³",
"formula" : "(width * width * length) / 2",
"measurements" : [ {
"key" : "width",
"name" : "Width",
"unit" : "mm"
}, {
"key" : "length",
"name" : "Length",
"unit" : "mm"
} ]
}, {
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"formula" : "weight",
"measurements" : [ {
"key" : "weight",
"name" : "Weight",
"unit" : "g"
} ]
} ],
"study" : {
"id" : "sdy_7EhIVS1Mgaud5FATAmIudJ",
"project_id" : "pjt_7HRPGvRPsBdSQNt8u1pIfA",
"name" : "DhaD1hP6PA",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "4fY3Y2tqGr",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_1G7Z5oW86O0pqJgOKuEq9I",
"name" : "P7coOYp8B4",
"email" : "ApT2EqvB@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_Ya1HQmhLehbJTTIsWxKof",
"name" : "6DtG9CUJHl",
"email" : "tdPYOj28@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:34.888029Z",
"updated_at" : "2024-11-22T09:42:34.888029Z"
}
}Study Request
This is an object representing a request on a study. You can retrieve it to see the request identifier, users, groups and the fields relating to those groups.
Retrieve a study request
Retrieves the details of an existing study request.
Path parameters ./api/public/v1/studies/{studyId}/requests/{requestId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the request. |
Request
GET /api/public/v1/studies/sdy_2GsAufsoCwNDZ6VzHeeSbS/requests/req_5dSjxbj6I1iwpGYY7nVTga HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmZDljZTBiZi0yYjZiLTQ4NGItODMyMy1lZTQ3YTcxMjI4MWEiLCJqdGkiOiI1OWYzMDQyNy03M2IwLTQyNTQtOWE4NS0xY2Q0NTgzOGVjNjUiLCJpYXQiOjE3MzIyNjg1NDAsIm5iZiI6MTczMjI2ODU0MCwiZXhwIjoxNzMyMzU0OTQwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.hyfDeG9fcVkWrv_aETvvU-6KFdi0U4XMf60kMsVS_vdaiEnn8R9xOz4r-WI4kGOWLHkljf7-O3zsUl-DDv0dZ_7Tsta6KlhqPxzYI3jsX5uDkF0B5goFHUFcdxhvf7_5hr8FlXYUAz5p36R9gm23BIsLigakZjOQkGYNzeceuTc-d2ynq4kQ1uIjhHtpjidZyNMF4UVGRGT7EbuQy1Eo3A0HJT-3KLQlj5WM-VA2Xw5y8VH_FjAPHntqPaUxNZQPTMTWwbFnhA7UrazcK3Zzqg1g7C6QHCwCw9-3BIJwO_7xYfwcSXbvsaIVngrWN_Wr4lhLbCsqSvI9UjzsZes20wKLtzYL7hwkZ6-x2rfCEjsHlKzQSH-nvhulX5G8pGnNPi737-plekM0FSEJzzlwGuvogK7aawUsq3MXZygs3wNaGDRVR1BD5DA42WYIbMCQirSrgVGf2m74ALiutu4S76L70yQzQCGc47m_8wTAApu_OaBOddzrBrm9bGMYvYYO02znzj4yhHkJpSZq1wV3R57VbQAUI9UZnZpSbFlve_ENIjNakH48dcuw25hNZZZkTUjDn_eZJStegiNdc2h74fLrr5Vb1TwqgihGxE7c8VWt_z10iyt4XEFm0_U3ZyGv9JpQyObknUyYpzVtdYUylhEcU0RWql6H-1LYz4kM844
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1367
{
"id" : "req_5dSjxbj6I1iwpGYY7nVTga",
"user_id" : "usr_3MhYDbPGDEHrrY71NcqMJ",
"assigned_user_id" : "usr_3MhYDbPGDEHrrY71NcqMJ",
"status" : "pending",
"due_date" : "2024-11-22",
"groups" : [ {
"ref" : "FpGll4n6eE",
"label" : "qhsDJEPdgA"
} ],
"fields" : [ {
"group_ref" : "FpGll4n6eE",
"label" : "i0PU5sMIU9",
"value" : "UsopMx1yE7",
"options" : [ null ]
} ],
"study" : {
"id" : "sdy_2GsAufsoCwNDZ6VzHeeSbS",
"project_id" : "pjt_5HJ4HWSD04rk8r4as9HL5v",
"name" : "rF4CMLYC0W",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "xJ5wfmOyVu",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5ehR6I3FNJU0FIcivrorjG",
"name" : "396hsS2dpZ",
"email" : "6EojH15z@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4pgzSOM1n2k5I9Zf5MgsNc",
"name" : "rDlpOoFaNA",
"email" : "PpGSLliJ@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:19.898234Z",
"updated_at" : "2024-11-22T09:42:19.898234Z"
},
"created_at" : "2024-11-22T09:42:20.082421Z",
"updated_at" : "2024-11-22T09:42:20.082421Z"
}List all study requests
Returns a list of your study requests.
Path parameters ./api/public/v1/studies/{studyId}/requests
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
Query parameters
| Parameter | Description |
|---|---|
|
The number of samples to return per page. |
|
The page of samples to return. |
Request
GET /api/public/v1/studies/sdy_7D946BUSrabENd6LTMLelK/requests HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwNjdhNjNmYy0zNzMyLTRmMjQtODIxZi03ZTNmZTg3MTU3ZmMiLCJqdGkiOiIwN2IyMDk1NC04ZmZmLTQzYmQtYTYxYS1hOGY4MzQxNDgyNTQiLCJpYXQiOjE3MzIyNjg1MzksIm5iZiI6MTczMjI2ODUzOSwiZXhwIjoxNzMyMzU0OTM5LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.eJoklDH4JdyqqJky3az2mqxCVitiPedmA59NOpsDd7L9R27TE2xlwrpdLouTD71oHN2RWP4OIZ0gq2zhFKDft4rzlHS5mZvmPWVzCVvlLqmsxw2dczSWdyCRPo7IaGnXwQG3EG4YQ8mGK9l8XD4XGV_Pc8yqEImsEBHg-E6PtTUQkfBN77yzpPTSXp-2DpbDGrCUxTqtGrEgM_6h0F7o0JV19XMj35f0Bg0cnkJZEHgN5QLaHzEr7VhA-Wv-E9nLSHh-b1invoiohdcSdmVpy3qOFc5M7S2pSx0x6yAuyS8zB-8TC1Wz77wKO4W1TzU1JRsj6e-Yv3juDhEK5fhGqm2c3fx40K5O9CMzjeUR8bYUY1ii6vuga084rqS2VXEa6a3OlL-oT3W0UiQly8bcalIInuA5uPfVajW9Sb0msYdrhN-D1oQk_e-7eNdUiHIDlaj_pZQTuL98gSprDM63lShHIV-yYB0sBb5hwIKM30k4eaATfr9G39jyDWR40M1f0Na4ysKPfzmShH7fII7xLCPnj_bGH2lO77ht-HhiAxWCX7G8U7LZncDnQ_c3KQhI7Vu8s3j1_jw1pBwRttRtS5Sgt4A5DnLvvEhGUWFQCgY37h1v1sUSGuE3KMxqP8syUTJ1XC0BqpbZOY6nCFReUSDTNFrJYI9u262vVNsTsq4
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1973
{
"data" : [ {
"id" : "req_1YomEWDF4w9tAr8coGxWQY",
"user_id" : "usr_1Odm7eyZmhXV3f8DWqXNRI",
"assigned_user_id" : "usr_1Odm7eyZmhXV3f8DWqXNRI",
"status" : "pending",
"due_date" : "2024-11-22",
"groups" : [ {
"ref" : "gGP8qpaxMl",
"label" : "mlD967MTAb"
} ],
"fields" : [ {
"group_ref" : "gGP8qpaxMl",
"label" : "DckNYA1mqA",
"value" : "NdrjIEYfMR",
"options" : [ null ]
} ],
"study" : {
"id" : "sdy_7D946BUSrabENd6LTMLelK",
"project_id" : "pjt_5aGR6weOsuKNRqbckuhBoz",
"name" : "xqanh2ldRq",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "AdhGuaH9v9",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_7fe4l3p9YWHr47PWTLmTGS",
"name" : "p4IlantdU2",
"email" : "BjNoGDdK@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_16k63htYK0kIPeDnTxTR3q",
"name" : "JUkeH0iIX9",
"email" : "oXNBlpco@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:19.545444Z",
"updated_at" : "2024-11-22T09:42:19.545444Z"
},
"created_at" : "2024-11-22T09:42:19.745410Z",
"updated_at" : "2024-11-22T09:42:19.745410Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/studies/sdy_7D946BUSrabENd6LTMLelK/requests?page=1",
"last" : "http://localhost:8080/api/public/v1/studies/sdy_7D946BUSrabENd6LTMLelK/requests?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/studies/sdy_7D946BUSrabENd6LTMLelK/requests",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Study Sample
This is an object representing a sample such as blood or tissue collected from an animal enrolled in a study. You can retrieve it to see the sample identifier, type, details like volume or mass and any metadata assigned.
Retrieve a study sample
Retrieves the details of an existing study sample.
Path parameters ./api/public/v1/studies/{studyId}/samples/{sampleId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the sample. |
Request
GET /api/public/v1/studies/sdy_4v637pGmuILxIo9nqJ0RIF/samples/spl_64HBe3UvKw0YU3zdceaPxh HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI4ZDVlZTExYS02NDUwLTRlYTMtOTQ5NS1lZTVhYjBiYTMzOTQiLCJqdGkiOiJlM2RhZDIzYi1hZjk3LTQ3NWYtOTE3NC0wMTk2YTQ3Y2Y2ZjIiLCJpYXQiOjE3MzIyNjg1NDQsIm5iZiI6MTczMjI2ODU0NCwiZXhwIjoxNzMyMzU0OTQ0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.mZqNlg57EfaayhOG3K4CiTv0xEHqwxe-tI64qmN2FJaLsol65V2-7MzHBT4ikNwSgigbclnBis6wczsZiKhbsu7tv2NO6NoU3h5by-8m_9qfwc6u4yrGFOJR1Ga8kEdjixG7vNpgSkBqSYOW3q24egjAfyx0o9jtbEEY_jJ2qM9C7uBq2sErFi6mUDNBho_r8J4JLejbm5QQb7TZPkusKbCvB0N_7wPg83PU8OtFW20THg4fxVIt1svXqMIyXkaTMf87hHCnLhLQI5gQaEH6Q9IxRpQol-p7lXGZM_bwKViGHvWrj0_mb8SEOXGA-F78iIzdkyJ5Oq1iCKRqhRwqxjHkKmhIY45d0eCoNP7Xjux37t6bXYD9Fx-jsuiprxZzBJVURTTSLhbS-n4tmK8B3-gBc5MUtCDr7Gv6kodDsrsCfWRZbRjMtFRrovbc0spR7FeaiaX2OXhUkl6XpiF86V389ZwS8vPa88qalBXWThgS4i2hbL8qqm_S92VOq10uzpoXoz3Sne-hzRMSolSvrdxkKh7KDJ6TLpwKlwY4UVRn8UiCEGmf4zKK08Q_CCQPfqWXTDA2ztDZX5ljQH7WyFLng9EIrE_sgQ72Gmcgdd1hJUp2HYlv7JJVKSCShsL3IC-YVl_GYZRJnp9NToCepvZwhloHNMrOTJdSGG8Dzr8
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2741
{
"id" : "spl_64HBe3UvKw0YU3zdceaPxh",
"sample_id" : "S1582867187",
"type" : "Blood",
"collected_at" : "2024-11-22T11:42:24.614361Z",
"details" : [ {
"key" : "volume",
"unit" : "ml",
"value" : "5"
} ],
"comments" : "A blood sample",
"metadata" : {
"sample-internal-id" : "SMPL-1234"
},
"study" : {
"id" : "sdy_4v637pGmuILxIo9nqJ0RIF",
"project_id" : "pjt_3xSgeg0FA1Uqk032vdbJ8D",
"name" : "IIVWxb70gX",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "PNsFeW6pWI",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5VjC4NNo5hO5UqiKbXrOHY",
"name" : "GWyCl5rZdw",
"email" : "0J3kHBvJ@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4UrfTjapVEecL1WbBnwbdI",
"name" : "jt1OVLYYxd",
"email" : "TiEniGH3@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:24.228851Z",
"updated_at" : "2024-11-22T09:42:24.228851Z"
},
"animal" : {
"id" : "aml_1o5IsMzyhheR49bXc3dH4K",
"study_id" : "sdy_4v637pGmuILxIo9nqJ0RIF",
"study_group_id" : "grp_6VmTWJCCOw7vRzUsnqfPqu",
"cage_id" : "cge_3qAZLQSi4uy5LLQCABiZym",
"catalog" : "A0000001",
"name" : "zTur7BCtF5",
"number" : 1,
"strain" : "sZ3XrbMvcl",
"species" : "6ilcXH0Yse",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "6iRSV2Azng",
"ear" : "ZOqj5moFwl",
"tag" : "j5z6uT3vor",
"donor" : "J2DLdxhPY6",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_209jdlaAcB1zy2fIJPvjBC",
"name" : "RAemrvihD6",
"email" : "a18GujRi@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_7fMP60Y23WHSs0Z058bcEz",
"title" : "Found dead",
"comment" : "JVJ9GUvlUX"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:24.424996Z",
"updated_at" : "2024-11-22T09:42:24.424996Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_4nB2MOu7rEnCZpr6MFFRV0",
"name" : "NC4Ua1oqHd",
"email" : "WIYem3ea@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"tqnINUEhLl" : "drMRsxfD0w"
},
"created_at" : "2024-11-22T09:42:24.597282Z",
"updated_at" : "2024-11-22T09:42:24.597282Z"
},
"created_at" : "2024-11-22T09:42:24.614374Z",
"updated_at" : "2024-11-22T09:42:24.614374Z"
}List all study samples
Returns a list of your study samples.
Path parameters ./api/public/v1/studies/{studyId}/samples
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
Query parameters
| Parameter | Description |
|---|---|
|
The number of samples to return per page. |
|
The page of samples to return. |
|
Sort samples based on an attribute (animal, cage, date, group sample, study or type). |
|
The order in which the samples will be sorted (asc or desc). |
|
Filter samples to return based on animal. |
|
Filter samples to return by metadata value |
|
Filter samples to return based on sample type. |
Request
GET /api/public/v1/studies/sdy_WMyoGTT3Zp6jlRDFRphdH/samples HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhY2YwNjExMC00MmNhLTRlMDItOTc3Ny01ZTM3ZDYyNGIwZTAiLCJqdGkiOiJlNzgzNjVhYS0yNjE4LTQ2MTUtYTFmOS01NzA1MTI3OWQ5NmIiLCJpYXQiOjE3MzIyNjg1NDYsIm5iZiI6MTczMjI2ODU0NiwiZXhwIjoxNzMyMzU0OTQ2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.QU1oxq0HvVabhFonkYMU_Gsw8v_k_ZF7neuU3zgorQ4kTl5V9DGzM2excy59Bqn-YzMzkb6lId9CxbEKM1yFt-IMzn4YUJ-Pf2an0XVoKYX6MQmpkB6-pXOKidVxBjMhvp6rU5d4wRDELJvdrRisUBLSvIikHTjVTZZdVLzF8qsacmYn24vKwuKx-E_bv9GUdRjvk82cPqEU2bySAJS20NrROHEd6UxvaBjNncPPfJfJDD0WJYHfOZnOJlbZlPrKiisgMWlu0qc1KO3dhfz8jahb-FmIb8j4GFgdgKuUvqgRP7KqcZyaYf_h2BC3WntiQyaisEoK8dZWcBSy1lr1qvcHNWqL1WPMnqEphf2yM_KBLpjO-BPzpSj9tXawQaX6FgdKTgg2e0kO_p97Dr_nXy1oHiYoF82AAKrUINKcyh4CDXnzw8U9eKwT1jcIB-M9Rp2jhr_fShE10OKgKJAZIGgX4nRWQUi8AtZ75WK98bi0cHlP-GooNQ29Etdc75VrjkG2bxpgt53HHNvxrVnwRZwrEO0iyoLwZYXNTDldKFYGg0qelnXQIDgJWBQPLB2M_fAutVUjPulVE7MOfShdxuVB9w6rahQ-vkyt_xzUnU8UP9Go4tH6J2MS2uwEW6Sy7uetddHRJnexHUcbMiBqQ8TtHvemZcJmewC_b13BPfs
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 3428
{
"data" : [ {
"id" : "spl_2fvn7E57a3mny7ntA4MP9x",
"sample_id" : "S440247020",
"type" : "Blood",
"collected_at" : "2024-11-22T11:42:26.423483Z",
"details" : [ {
"key" : "volume",
"unit" : "ml",
"value" : "5"
} ],
"comments" : "A blood sample",
"metadata" : {
"sample-internal-id" : "SMPL-1234"
},
"study" : {
"id" : "sdy_WMyoGTT3Zp6jlRDFRphdH",
"project_id" : "pjt_5KeDJU0rogy5Cijyc0Z9wV",
"name" : "tDkKYxbkDL",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "66ykEYXaGt",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_w6VbjlYxe8AkeCpRNh0Ff",
"name" : "H7gi029zh1",
"email" : "iNRT7HZ7@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_7YYczI71tZjPeRMjcThzdS",
"name" : "Ax3KTFQmyW",
"email" : "WWW4Rp78@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:26.023586Z",
"updated_at" : "2024-11-22T09:42:26.023586Z"
},
"animal" : {
"id" : "aml_2AYoAoPAGLPBCHNsKT4fme",
"study_id" : "sdy_WMyoGTT3Zp6jlRDFRphdH",
"study_group_id" : "grp_w2XlHlfJZ7wmfOwL1rtoR",
"cage_id" : "cge_4JJq8FvNxt02k85r5JndO5",
"catalog" : "A0000001",
"name" : "ga0uY1LQ1q",
"number" : 1,
"strain" : "aAMAXJJ7fz",
"species" : "l1d0Ezeloq",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "aaisqC83BQ",
"ear" : "TFSJOzUR9X",
"tag" : "J6twg21Kum",
"donor" : "2wrKsz5nXO",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_3eDdQKCMSpdO3Tknm4HFTj",
"name" : "CoobEfkCeE",
"email" : "yiPRGdLX@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_3yXS5vAkLY8cp8FGRPRkrC",
"title" : "Found dead",
"comment" : "aIUAFFopWB"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:26.235547Z",
"updated_at" : "2024-11-22T09:42:26.235547Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_6v4rJi7YyY9gaf2piHtOAl",
"name" : "Ty1EfgjdGk",
"email" : "B3ertcsn@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"Gj9SosBr70" : "PZJVcktshp"
},
"created_at" : "2024-11-22T09:42:26.408972Z",
"updated_at" : "2024-11-22T09:42:26.408972Z"
},
"created_at" : "2024-11-22T09:42:26.423503Z",
"updated_at" : "2024-11-22T09:42:26.423503Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/studies/sdy_WMyoGTT3Zp6jlRDFRphdH/samples?page=1",
"last" : "http://localhost:8080/api/public/v1/studies/sdy_WMyoGTT3Zp6jlRDFRphdH/samples?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/studies/sdy_WMyoGTT3Zp6jlRDFRphdH/samples",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Study Treatment
This is an object representing a treatment entity. You can retrieve it to see the treatment’s attributes.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the treatment. |
|
|
The name of the treatment type. |
|
|
The name of the treatment. |
|
|
The external identifier of the treatment. |
|
|
The dose concentration associated with the treatment. |
|
|
The dose volume associated with the treatment. |
|
|
The stock concentration associated with the treatment. |
|
|
The volume of the treatment. |
|
|
The metadata associated to the treatment. |
|
|
The study associated with the treatment. |
|
|
The created timestamp of the treatment. |
|
|
The last updated timestamp of the treatment. |
Retrieve a study treatment
Retrieves the details of an existing study treatment.
Path parameters ./api/public/v1/studies/{studyId}/treatments/{treatmentId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the treatment. |
Request
GET /api/public/v1/studies/sdy_6tNSJoi8ZWmR5FNVWm1hZE/treatments/tmt_3bVV4txgNr06uqZlRPmUef HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI0ODBmNjRiZS05MGZjLTQ3OTEtYTZmMS1kMjA2YzQ3NzQxMmUiLCJqdGkiOiJkYjRkNTM3MC0xODFiLTRjODAtOTI1MS0zNWI5NGVmZTc5ZjAiLCJpYXQiOjE3MzIyNjg1NjEsIm5iZiI6MTczMjI2ODU2MSwiZXhwIjoxNzMyMzU0OTYxLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.KhN8cFYtEvgnILVY61t3YGAa8YGLFMy1e0pFfFtS7Hy83vHMVb68ZtZ4i7WVRZ0b9PUv_qgjDUSdHddvSmcgQSTypOQf9gUyQRaBg8Y4uwn0Rh2PQBhV6xH9MBJGNS0L7NRoksBInm8cVj3oq6DQGiPBkFl-9xaN5I2dHv4eOSjzZUMKdvUEPsKzVv2IURifPybI_LNyQZDGI-fTZ-jRq2-7DfwTBgpmOM4WTmcnarrRx9BEhlCZ4Oy-oloaeVVjlp_UQhiVCmZkOVoyCY2VWa7NIrVC9gThIVM8Kdh7jhfqikB4ldzyKolrc594FqNSEeWLpHfTUHUlOFHsEBd29kBUidrj8603dXYsmjHQjxtl5e9fCBVfByOZ2CGc2ebPLuMZsZthuxIFRF2CnPbCqWRY6sz-_ltkOu9aYYk5oADrV0Ua6U3E2TsWXf-Yb751XXahloZscgUYRIQYNv8epG2lbp0bkdkWsDzPL_8fTbCjhyBscB9DjrQXIY2EhEIt4ZXYd2DvDJkcCg_jkFmGPgVph7SwYD_AZicMHxpBK2RiEyhUICgF7taOrjesAGyf9qzfMBOajSdTL7DJdN4ASiOqHNhaPazHFaD_xa0LNoNKmLv0Xiip8z4zY9ulrTZNyya6sBtNPRzyJ87yU4vi59wSsk9EQ-N6NZnoOsOinFM
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1629
{
"id" : "tmt_3bVV4txgNr06uqZlRPmUef",
"type" : "custom",
"name" : "qpcUqFBR7x",
"external_entity_id" : "7gtzhxz4WR",
"dose" : {
"unit" : "mg/kg",
"value" : "5",
"display_unit" : "mg/kg",
"display_value" : "5"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "15",
"display_unit" : "ml/kg",
"display_value" : "15"
},
"stock" : {
"unit" : "mg/ml",
"value" : "10",
"display_unit" : "mg/ml",
"display_value" : "10"
},
"volume" : {
"unit" : "µl",
"value" : "8",
"display_unit" : "µl",
"display_value" : "8"
},
"metadata" : {
"treatment-internal-id" : "TREATMENT-1234"
},
"study" : {
"id" : "sdy_6tNSJoi8ZWmR5FNVWm1hZE",
"project_id" : "pjt_47Sk70NYyAeGHuxMygpFZa",
"name" : "kDTLp32H2Y",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "GURGf9mye5",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_1lEycC8P0qRuSR2dySeMIM",
"name" : "0YTLdRim8a",
"email" : "nm4nSRyY@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_6q3n2xmJigqcNWfMhYtZc5",
"name" : "EG4lGLgV5h",
"email" : "ttSfx5SY@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:40.858802Z",
"updated_at" : "2024-11-22T09:42:40.858802Z"
},
"created_at" : "2024-11-22T09:42:41.166795Z",
"updated_at" : "2024-11-22T09:42:41.166795Z"
}List all study treatments
Returns a list of your study treatments.
Query parameters
| Parameter | Description |
|---|---|
|
The number of measurements to return per page. |
|
The page of measurements to return. |
|
Filter studies to return by metadata value |
Request
GET /api/public/v1/studies/sdy_2SK2tE4J7OkfEMgKBP9M49/treatments HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJiNzk4N2E0OC04ZmM4LTQ2ZjAtYjhkZC1kOWU3NzIyZDljZDMiLCJqdGkiOiIzODEwZGI4Ny1mNDI2LTRlZDEtODViZS1lZWQxZjcwM2YxOGIiLCJpYXQiOjE3MzIyNjg1NjAsIm5iZiI6MTczMjI2ODU2MCwiZXhwIjoxNzMyMzU0OTYwLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.MOx4uu6xA7EMD77Hb7cJwn36MsaaKmUN7meMWpaHXVUcT_rNhB6Nt-1CWUQqy6ElMSIOBCEM60M_PA_nPc_IgN5ULuMYe9PVShcB_HcXxHcpt_j5tjpv7b9AG8YXH5PaelMCJAoTqNCElLVK_w2jLrlBFdDPCwvBmNnVorkF5FXqmO4MY7xsV_BKqr1lvMmsaHbu2b5bGUblmXVe7qo1vYUlEOKJjT8_VzBqam81yWaMTnDPnGZeWfkqEDrdtjfTuZie6Ab35PiVJ4mrdfs11BJ-t38WS2PaKog7jAoE5w6eZ1nNGWbz6jR_XHxGOj9o8vplyBMW1ckhQeNN4mmrZo2g7EBIiuyP_B1eLuk6n3nJqbxs9OMzCk3mHjZkJ7YVywAkVAYCsNkFXAgma4I29PPAf8MTWwzsxjMgT0AI9efL0mV--AS23LaGY7Kf-PwfvZ361pwVqDbsi_wPAyRX7rY3suXqHFDTzfbbEI3aQsLQxOeJMKbsbUFRmArnMrsmKH_bPRsBCOE4DO9gq6Duepf63NiooN1yqv9rB36bWC87IHIdSIfJL8oYgqZGetf1-lHD8j2GAQ2hZbSGQuMhVzbXG3Wv6jTBSmU_yTHSvH6OqUHR0WkklpavqyhF_TO97VV-EPy--yjc_pY2oS9fmYatJuloXH1MRTF7AVe8m1E
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2271
{
"data" : [ {
"id" : "tmt_5uDecB1waLe1aKRkzOuM60",
"type" : "custom",
"name" : "km5lUBOQpU",
"external_entity_id" : "pnaQJwFGis",
"dose" : {
"unit" : "mg/kg",
"value" : "5",
"display_unit" : "mg/kg",
"display_value" : "5"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "15",
"display_unit" : "ml/kg",
"display_value" : "15"
},
"stock" : {
"unit" : "mg/ml",
"value" : "10",
"display_unit" : "mg/ml",
"display_value" : "10"
},
"volume" : {
"unit" : "µl",
"value" : "8",
"display_unit" : "µl",
"display_value" : "8"
},
"metadata" : {
"treatment-internal-id" : "TREATMENT-1234"
},
"study" : {
"id" : "sdy_2SK2tE4J7OkfEMgKBP9M49",
"project_id" : "pjt_7YREbXXpzEPqhCYr2Ze2J4",
"name" : "oqp2g8IjGp",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "6EADMbopkL",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_4bxhOrFZqeMvUTpO4crC2j",
"name" : "BK3g3XsZDu",
"email" : "AWop8IXO@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_21ALEGplEg3hxvaLUEcIvt",
"name" : "Imh1v9YTCT",
"email" : "Qrv5UnVN@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:40.493195Z",
"updated_at" : "2024-11-22T09:42:40.493195Z"
},
"created_at" : "2024-11-22T09:42:40.795693Z",
"updated_at" : "2024-11-22T09:42:40.795693Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/studies/sdy_2SK2tE4J7OkfEMgKBP9M49/treatments?page=1",
"last" : "http://localhost:8080/api/public/v1/studies/sdy_2SK2tE4J7OkfEMgKBP9M49/treatments?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/studies/sdy_2SK2tE4J7OkfEMgKBP9M49/treatments",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Study User
This is an object representing a user who has been invited to study. You can retrieve it to see the user’s name, email, access to the study and any metadata assigned.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the study user. |
|
|
The name of the study user. |
|
|
The email of the study user. |
|
|
The timezone of the study user. |
|
|
The type of user on the study. |
|
|
The permission of the user on the study. |
|
|
The study associated to the study user. |
Create a study user
Create a user on the study.
Path parameters ./api/public/v1/studies/{studyId}/users/{userId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the user. |
Fields
| Path | Type | Description |
|---|---|---|
|
|
The permission of the user on the study. |
Request
POST /api/public/v1/studies/sdy_6EaUHikroc6fNyMHx0UJFt/users/usr_4RAqpS51rTSo6DLTttZTFu HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJmNzZmMjFiOS1iMzVlLTQzZjQtODlhZC00ZjdkNjE5N2E1ZDIiLCJqdGkiOiJhMTFlN2Q2Mi1kMTZkLTQzOWItYTEzZS0xZTdmODUxMzhkNDIiLCJpYXQiOjE3MzIyNjg1NTcsIm5iZiI6MTczMjI2ODU1NywiZXhwIjoxNzMyMzU0OTU3LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.OmZg2bLCfCU2advRbkg59dq1wdpc8MG8-ORwfmFrnWyzYypzZZZnjFzLP_3OgJSPvLl8Lu4tOzAPkYdnjNGBfV-ZOb5rbitGj2b0oASR0pATI4pOKAjthFIJctgsv3w3PcBibsRwlHzMCWNDB0bH5BNW3soJ5ChPQlvZiDKLgdBEdxMUL_dgk8cAg-cLEfrRPD9ZKXTfkhgpg_dLHov9WN4W8xucyHTDEct7DDWPv4993ZsrSw_3zLxS-MdVDyAJeUTSI5gyggZDZrQv8GZqrPSjAlKbY0jdWuR7nchMIGtPJoKFh1pF8MSNkv9c91MCoNszl6ZeiXbjjlX_iFHdOWP1NsLZuqpl7dxp0BdM4jG6D-lElrq86UPMcMQtOvK9fwzDpu5cmB5YNWyLryBAUAEz57DwkWoavTL7XXExJ2cYGTx9HEz3tDsEypTYWyruEgD-xtrOCNQEWZgBFM96cle7RVcTGr_529mP3WfSwUIvUCay5RrB2sxlLzOPhK5nFjqjgJD6RdDsI9mAf6A7NbieexsyciZIgWpysWOQHB9cENpkl0Pr5_yE_eZqkl4XrkAyr9f6AetrPJJBzbiz4dfQAgQPbMVBX5G-sVkZq66DcWIZl3A_wUYfB5_is2OzxXz37VcmWmb6MAVBfAJ60tTeAMDFKeZV99pnmgkYHeo
Content-Length: 24
Host: localhost:8080
{
"access" : "write"
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1035
{
"id" : "usr_4RAqpS51rTSo6DLTttZTFu",
"name" : "zJthgmjAzV",
"email" : "9BVSBitS@benchling.com",
"timezone" : "UTC",
"type" : "team",
"access" : "write",
"study" : {
"id" : "sdy_6EaUHikroc6fNyMHx0UJFt",
"project_id" : "pjt_6YbQJAhhWvS6K5Vl11K1nT",
"name" : "rzhEkgrEo6",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "9KjxlGwbji",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_3P6fDoR2KxS84vMEqsceQs",
"name" : "5P0IC5TLRX",
"email" : "j8SrExSP@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_54MNPUEBdC88R49UQttZjl",
"name" : "hKvzM0j7HL",
"email" : "sg8Abi8g@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:37.287189Z",
"updated_at" : "2024-11-22T09:42:37.287189Z"
}
}Retrieve a study user
Retrieves the details of an existing study user. You need only supply the unique user identifier that was returned upon study user creation.
Path parameters ./api/public/v1/studies/{studyId}/users/{userId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the study user. |
Request
GET /api/public/v1/studies/sdy_gApBtu93GzocdL5ubB6tD/users/usr_30B7TatYud4lEMJ3fmKaU8 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIwYjAxNDI3Mi1lZTM1LTQ1NWItYmU0YS05NmY1Yjk5MmI5Y2QiLCJqdGkiOiI2Y2E0YzgxOS00MTlmLTRmMzgtOGY3YS0yMzFiYmI4NjIzMTkiLCJpYXQiOjE3MzIyNjg1NTYsIm5iZiI6MTczMjI2ODU1NiwiZXhwIjoxNzMyMzU0OTU2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.VBswzPhWDQ5jCaRnBcG8jQMB_L9AMLuMusqkw7Ut8n287QuaEecLEw4btcU3MDAlCtlQwnp0e2Ee6uJSxJFlgzmHRmQSYKI7BzHOM9Sl_1l4041bMVw0NZAc142TddqishsNhX1kYfddIdLgpef9Hkstcs_6DBa_B31tCttltSIbQPVXmext7u_YrrK0dOzgks4l9FqgKrY6PIlcuGX-iN1pAFVK1iZ35bE2EWiRYBKcJg19S8SA_KEpL5aHoski_sRIt-cmSWSgwnXzvBJton0rBIkX8qZryLIBU0TdjfAj1rQGyxJPLW6IEpPeWRcECOhq8skkKsfYhnOVuQJnXXnyqBjn3EAIluuFI-143AF-4LsB3Irxaqxbd4suc8l7lIk2bEf_xX3Mhd4P7mVEKX--_Q01DMbT3SWkZ1MgXy_PSNsUdLW4fHuE_HB7G0vezoI70zS9uF3ttgWGjNmYxhGG15K7-AUpT3-LnJ-vo_Ap2KAQMquUOHixErog5zx6cZ4x9bGFgK2CKleh4stM3swcp_MmwnCOiKRg8-MrkTsm2aKVrX90Te-ZI8v-67PV1ZxmZrTXAjwQiCwN93IPtIjmM11ANIoOoScd7yrpKcx3UG5SiU_54vpVtgUBQoteAkuIzg_ZAh6nIhLGUCTmscYlCHsdSQ6DQWBbdSrKdr8
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1036
{
"id" : "usr_30B7TatYud4lEMJ3fmKaU8",
"name" : "1lOc1X8EIp",
"email" : "8BADDjcu@benchling.com",
"timezone" : "UTC",
"type" : "author",
"access" : "write",
"study" : {
"id" : "sdy_gApBtu93GzocdL5ubB6tD",
"project_id" : "pjt_7MyWvDiqGQYDHGIYAtm9jE",
"name" : "L5FGr1VmBO",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "5lXFOK96n6",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_30B7TatYud4lEMJ3fmKaU8",
"name" : "1lOc1X8EIp",
"email" : "8BADDjcu@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_22QUS6djdYFDpODE1nEDiq",
"name" : "KAJDwLikJR",
"email" : "ZjSjlEFy@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:36.349873Z",
"updated_at" : "2024-11-22T09:42:36.349873Z"
}
}Update a study user
Update a user on the study.
Path parameters ./api/public/v1/studies/{studyId}/users/{userId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the user. |
Fields
| Path | Type | Description |
|---|---|---|
|
|
The permission of the user on the study. |
Request
PATCH /api/public/v1/studies/sdy_2UDSmvO00tiNPuB9eeJL5s/users/usr_7TEBdVhrId02F1RNSXUqec HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlYTAzYTJiNC1lOGYzLTQzNmYtYTgxZC04MTJmZWEyMjU0MzciLCJqdGkiOiJlZDA0NjFhZi0wZjNkLTRiN2YtODYxMy05YTJlNWZkMTBjNjAiLCJpYXQiOjE3MzIyNjg1NTgsIm5iZiI6MTczMjI2ODU1OCwiZXhwIjoxNzMyMzU0OTU4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.fHH_a_X8FR7fxD5DneF6nQcBWrGOeqdY99QoW1bFnG3didVFnhEISNLzdry43mhKTXMQ7s136V2Ot7d2pFNRBJXdcr7CmBNdR8Yq5pvjkWOlbAtFC6--JWinVvcw6TKjwRrFcWaNfaCY1qPKP3qFQR_wJCEYtf2huhniLEZrT8HtIdtkjWxf5jkdXWtMHZ-JsgzL5cHyMUTZ676TYtBp5a2Ud_Hp2EL3UdeRyYsHLRVFuKG4EO2IVp5GXVQxDKyPv4OioDgctFo925rIraoCm1ZXPS9Vsp12Qqy8eADJocvMZOi_rPvTLfIX9e7DxzHCCZq6Oc8SCp5x_2QqAQSmj25yDWzgOPvarwkcAtzpZFP0im7Zca7z6trpXkGeAyT5_2hNSEwhu0L9XVj8Qzfa9YcLzL6inS0C5bvW054YedWI3gRzj3Zk6FRVFhwRYKkcoM7-PsQgyvvHcUEAGQ0ytuxtViB0qMBdqlzuCNtMHVrP2GWUla3Ai4rOVEW1xKmZinJ4jqpORrj4h3THXHAstgIX0Cv9D6OyJ0OxkFvyZT82OH5Jq80agOTEDROpvphhLvQkZ1BZ7Vaoq5xfqUAGjm5h0-ltaLNrtrNokAtjZD25FzO7139nP8ZfrMoE6N5aswnRA3raYlUr0jn2_4R4Wlgt-Uu9lUSaSypwHeNJfEU
Content-Length: 23
Host: localhost:8080
{
"access" : "read"
}Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 1035
{
"id" : "usr_7TEBdVhrId02F1RNSXUqec",
"name" : "865I75nM4z",
"email" : "C3gl4ovv@benchling.com",
"timezone" : "UTC",
"type" : "author",
"access" : "read",
"study" : {
"id" : "sdy_2UDSmvO00tiNPuB9eeJL5s",
"project_id" : "pjt_2YpGELm9XwSdAfQjtE2jpi",
"name" : "18DfEmSpPp",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "1PpdMgNgmI",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_4ZuqHICRLYDXgnsWxZ181I",
"name" : "w4CXFRODqJ",
"email" : "QMcmzGHz@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_czGl8Kz7NuesoFvFGE6Fq",
"name" : "3QXk0QnoHB",
"email" : "GOPGlR3g@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:38.096090Z",
"updated_at" : "2024-11-22T09:42:38.096090Z"
}
}List all study users
Returns a list of your study users.
Path parameters ./api/public/v1/studies/{studyId}/users
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
Query parameters
| Parameter | Description |
|---|---|
|
The number of study users to return per page. |
|
The page of study users to return. |
Request
GET /api/public/v1/studies/sdy_4VZdApa70NzFqyxtYTQ3S1/users HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI2NTQ3ZmI0YS01OWRhLTRhZTYtOTMyNi05NDQwZGU2ZTZmZWMiLCJqdGkiOiJmYjc5YTAwYy04ZGFiLTRiMmYtOWFkYS1mNDI4Njc2YmQ4NTUiLCJpYXQiOjE3MzIyNjg1NTYsIm5iZiI6MTczMjI2ODU1NiwiZXhwIjoxNzMyMzU0OTU2LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.F3U7mXDVElUhhZjqa_sa2brJX8OXmeFGd_wfcazcqDdQ40FeakeFWiO6VEtFoyPxlTG7nrHQQZUGp1n2m8mYQrkDuCC9yxl_ubZP36NFgVqtYBBP34_PQlsE3fFrhvdjT3c9EaV2aaH7-MJd79NSFLAXSpNUJYykR3kvTacDXl2Sa8qPkLuDTSKg0XxfbkalxY_zBPw67FqKi20gmjdnx-GsQoZf-Hv8qe0Ywd0xzYyZo7nOWQT26SCoFp3dK7mSNhtYWmrUTJmJ6EsP8A4eMxOVU1rFO7sAzIFTweV1vQ4uFpXHUmgGuFgxmX8TGfOzyoPKWSNTLxo7C89v589esH7uvJ4Fe90pWO0h6DbW6SMpUDt81qAo6EhmOwnrf3rzd4CQMcmExvwPpE-nXrHNyiWhh9uUcSE9GrSVh6LzANhqrvd5n0VZojRD7nsPCH7ou-CWR9jVAtpRFJkwncfVIRWMEark8ZKtBqUI7grAUvx_yA3zpm8oEfTCu6YFsdQUpkoKILPsA22MfwqnmDUnMoUJlrt56mQt-243L0CGGBp2tLwcVjoSZqKLa81nz2W-eae9LWOOn6ZjT7rKVdoyZcJ6p40-Jfz-i7yPpmzJd8K6kG2vImekaavthX0gkLlbYV7r5IrtceAZoCQzm4gvOx6a8gkuLuA08mwRmc5FDH0
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 4937
{
"data" : [ {
"id" : "usr_5Cxg5f1G4iabVbRHNy1jm",
"name" : "aQz8bCHjNZ",
"email" : "8NY6jhtD@benchling.com",
"timezone" : "UTC",
"type" : "author",
"access" : "write",
"study" : {
"id" : "sdy_4VZdApa70NzFqyxtYTQ3S1",
"project_id" : "pjt_2eU01MTq4QycyyyA7yBg5I",
"name" : "dgDHDwlryF",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "toDM2dp4Fz",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5Cxg5f1G4iabVbRHNy1jm",
"name" : "aQz8bCHjNZ",
"email" : "8NY6jhtD@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_7GBYdnUQuzJePm7fotsrtO",
"name" : "vAZoHv3g2O",
"email" : "AVeNXCy4@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:35.905235Z",
"updated_at" : "2024-11-22T09:42:35.905235Z"
}
}, {
"id" : "usr_7GBYdnUQuzJePm7fotsrtO",
"name" : "vAZoHv3g2O",
"email" : "AVeNXCy4@benchling.com",
"timezone" : "UTC",
"type" : "owner",
"access" : "write",
"study" : {
"id" : "sdy_4VZdApa70NzFqyxtYTQ3S1",
"project_id" : "pjt_2eU01MTq4QycyyyA7yBg5I",
"name" : "dgDHDwlryF",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "toDM2dp4Fz",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5Cxg5f1G4iabVbRHNy1jm",
"name" : "aQz8bCHjNZ",
"email" : "8NY6jhtD@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_7GBYdnUQuzJePm7fotsrtO",
"name" : "vAZoHv3g2O",
"email" : "AVeNXCy4@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:35.905235Z",
"updated_at" : "2024-11-22T09:42:35.905235Z"
}
}, {
"id" : "usr_433YuxeAeN3ClzIicpYpsJ",
"name" : "knGGAP4Kya",
"email" : "BVI4zZs0@benchling.com",
"timezone" : "UTC",
"type" : "team",
"access" : "read",
"study" : {
"id" : "sdy_4VZdApa70NzFqyxtYTQ3S1",
"project_id" : "pjt_2eU01MTq4QycyyyA7yBg5I",
"name" : "dgDHDwlryF",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "toDM2dp4Fz",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5Cxg5f1G4iabVbRHNy1jm",
"name" : "aQz8bCHjNZ",
"email" : "8NY6jhtD@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_7GBYdnUQuzJePm7fotsrtO",
"name" : "vAZoHv3g2O",
"email" : "AVeNXCy4@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:35.905235Z",
"updated_at" : "2024-11-22T09:42:35.905235Z"
}
}, {
"id" : "usr_Rlymqi2I6tm2JSdmHFa0n",
"name" : "8GTZIyyYA8",
"email" : "oE1av6Wb@benchling.com",
"timezone" : "UTC",
"type" : "team",
"access" : "write",
"study" : {
"id" : "sdy_4VZdApa70NzFqyxtYTQ3S1",
"project_id" : "pjt_2eU01MTq4QycyyyA7yBg5I",
"name" : "dgDHDwlryF",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "toDM2dp4Fz",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5Cxg5f1G4iabVbRHNy1jm",
"name" : "aQz8bCHjNZ",
"email" : "8NY6jhtD@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_7GBYdnUQuzJePm7fotsrtO",
"name" : "vAZoHv3g2O",
"email" : "AVeNXCy4@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:35.905235Z",
"updated_at" : "2024-11-22T09:42:35.905235Z"
}
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/studies/sdy_4VZdApa70NzFqyxtYTQ3S1/users?page=1",
"last" : "http://localhost:8080/api/public/v1/studies/sdy_4VZdApa70NzFqyxtYTQ3S1/users?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/studies/sdy_4VZdApa70NzFqyxtYTQ3S1/users",
"to" : 4,
"total" : 4,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Delete a study user
Removes a user from the study.
Path parameters ./api/public/v1/studies/{studyId}/users/{userId}
| Parameter | Description |
|---|---|
|
The unique identifier of the study. |
|
The unique identifier of the study user. |
Request
DELETE /api/public/v1/studies/sdy_6tV1wQlJvw2K4dDI2Vvvrf/users/usr_4fiu5SBzAUuFxhYafgS507 HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJhYWJiZGVjNi0wODYxLTQ4NWUtYjc4My1jMzU1ODQ4MDdjMGQiLCJqdGkiOiJjZThjMmQxMS1lMDU0LTQ1NjUtOWY4NS1mNGFiOTUxZDMxNTMiLCJpYXQiOjE3MzIyNjg1NTgsIm5iZiI6MTczMjI2ODU1OCwiZXhwIjoxNzMyMzU0OTU4LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.Enugrac3z14zPU1F4ZM2Yd41wQAmJv-vtpXGwisZG78E1wB8ZZTD3nnT_Q5irnPjFm2yj0FcormnsdurTk92OSsEJBIzuOV0rnSluRAWkLkV01nxJL6GjTaNsg5T_o9fgpwupdD8xCY2dbDRapNngHd2g7iiWKC7ZhdER1wOzvKtGJu7T859r750O7sb8eICgJxUr0FyyVP1o88W8HEn8SUzBo00bRKtVZcHp1LNi3lZzchtL7-itKaCYPNCO8NbJEahd_k90WfkEBU4-2-7Tir_KQoH4N99WvaMM3I8LYMXMEneTT2oygiSV0h69rHr_YdHRerLISDn-Tabma__-5mZp4PU_hghfjDiYEbTw4hVsaByUVdC7Lgyrupmgh87IQJY0RNdRo-dvgrMMlIRmwhY5djlf1vXh3-ZsDDKSHjHc8UOcByMIumeejoFWhRNNcHfSu0RUcMo54L8nv1bHZl4win85YcPT7NRTufew6j4HEzH6sbC-RHbT5PMf8mIGgNnkN71d2btB3u7AyralBKrvRt9CO84FaLooBSd5pF3j_WrUopLPgvIaBVLCZNBCaxkGLynxW-5ojHhzHGEwCNDeh1NXkJRSLLyFkH_msm7eaZoryREja34wdLrMcmlEzeK7O6CGMy_8tGzqNIckjpBO4eDAS4edECewZMrT-w
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22
{
"deleted" : true
}Team Glossary Resources
Team Glossary
The team glossary includes the configuration for each glossary item including—sample type, observation and euthanize reason. This includes the details that are collected from a sample or the scoring method of an observation.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the team glossary. |
|
|
The title the team glossary. |
|
|
The group associated to the team glossary. |
|
|
The description of the team glossary. |
|
|
The type of the team glossary. |
|
|
The options of the team glossary. |
Update a team glossary item
Updates the specified team glossary by setting the values of the parameters passed.
Path parameters ./api/public/v1/team-glossary/{teamGlossaryId}
| Parameter | Description |
|---|---|
|
The unique identifier of the team glossary. |
Fields
| Path | Type | Description |
|---|---|---|
|
|
The type of the team glossary. |
|
|
The description of the team glossary. |
|
|
The options of the team glossary. |
Request
PATCH /api/public/v1/team-glossary/tgy_3dSKdaJ1greRiJwVwdmsED HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlYTBlYzllOS0yZDAxLTRiZmMtYTM0MC0yNTc1MzkzNDZmNzQiLCJqdGkiOiI3YmUyY2MzZC04YzdkLTQ1OGUtYTBkNS00MTQwNTgxM2M4ZDIiLCJpYXQiOjE3MzIyNjg1MTUsIm5iZiI6MTczMjI2ODUxNSwiZXhwIjoxNzMyMzU0OTE1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.c2zP67XsCQWJOEUjlYMZOb-z7TGhRgsbx0VE6PzJkyZsaNoMwbXHYoJc0oviGpD0kezZoZRE6mtqwbbz9Dz8Fh-YlYyxD1Nw0ai21NHz4Gji52Q2lQUbTI7vxjVS6S49WvqN_VqbIi6kjz1_ffdH2SBotgQpLapjNNEneajaMMsA6Tv9GLrU7cqw8CKcxhFwFcc3scjFLOko1h-GZO44QmZ4KX9rwePGyCJI2A_h4IP-jiFINMuGBVlQKbc1MLsKZL3Ee52JjzHuqoQ9-gE7_4ZVWGM70K1-_uL4g9KYegVsMRw2hou-piDd648gvLEMcfzLIt-M5uFz2VR67MbNlw_AP3_YOKIrHmmXjrBMqCAThAgzx2yfBDH2iluwUmXhTeM5RvR7Stm0mSJMI7LtqXuKruZbaIPRSspfIwmTjuKNJO4TqhwdipVlAUFAquvsEQU7FSeZ7i-FC1gM2xbhkoUA_IbZs8aLr7HAu4V65HM61N_0WsF9oV2DJCFI7EVTEUoUohEhRS0fNU62OMiHMp7zqB9CNsHpMGZvoTUYDjhWpZM4hWRmn1xKlJr7ybG2nQhE3iGVssVmBuqaGrvpfRpHZsh0uilcULQRqP52yegtG6dBLibIZum7uIFZ2110dEg7VlCIM-T3HtPGGx0SdOnoYk8fgUDCLPTCyA2bxCs
Content-Length: 112
Host: localhost:8080
{
"description" : "1 = it is ok",
"type" : "numeric",
"options" : {
"min" : "1",
"max" : "6"
}
}Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 209
{
"id" : "tgy_3dSKdaJ1greRiJwVwdmsED",
"title" : "Coat condition",
"group" : "observations",
"description" : "1 = it is ok",
"type" : "numeric",
"options" : {
"min" : "1",
"max" : "6"
}
}List all team glossary items
Returns a list of your team glossary.
Query parameters
| Parameter | Description |
|---|---|
|
The number of team glossaries to return per page. |
|
The page of team glossaries to return. |
|
Filter team glossaries by type |
Request
GET /api/public/v1/team-glossary HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiJlNjBmZmZjZS05ZDE2LTRiZDgtYWQ4Ny0yZGQ5OTAxM2Q0ODYiLCJqdGkiOiI2ODE5YTNhYS1jMzYwLTQ5ZmItODYwMC1iMDU1ZTZmMTlhMTQiLCJpYXQiOjE3MzIyNjg1MTUsIm5iZiI6MTczMjI2ODUxNSwiZXhwIjoxNzMyMzU0OTE1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.M3Guu_J9oSSAjHSKziKynuNFbmIMPx5w07tJSxkSfnn00HJznX60fj6yHVLDchA1p9AH8H0PWCQee5CKUI_Zp9dVHDhLQS4aOPc09HxvtsAE6XlKpoNBIy-L3tlJ0jkLna91L3a7asQBIy-3RE_j95iNy8P6114bGWUT2dS_kQRutprPmVC9YlNB7t5k7PtQcEA2QhjvdqILK0cjcbeQ0qlYoTpEFvf-VNpWQbxKm62-r8E-OIbggZ_r_4aMmI0HhyEK3aZDk0r5uFgtZLWphCah2kbO_-aqltAhayOZQkyL4rBVwG_8Lui-_Me-iQKx82Y8o1Mxvpr0hNEIMcXkwJ_JtUKlx9cmO7S03TYqoZKkS6l2Ls-4mgWbUjESIwXG1psjZEi1verhUfRasnb8RjnT0TTXumhjqYKevTVvnLcnOz03v6q6Ed4Al5SPf8_Y6zP-c8aCkEjppcbNggiGOORjjQOp823kmcL9VtsksR-A1IOg6c2jjNdvGux2SQm4fijxQu-_dENMuqWALZQwk2D_9Uka1MBFJzKF1reflKB-hVu_94U1lnBWxAtH_v6f33tjK65Afhza94Vi_Keb_vEnOwmZ2cb_kb-VBl1BHbL5GSwMDLVXnP2Y_RMFzg1Rop5PZI4MdYx4P7BG_n-pM_pmoCk9LK0nG7sqdEBLzGM
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 647
{
"data" : [ {
"id" : "tgy_1jBlTYVI2KLLiwXQ86wKW4",
"title" : "Coat condition",
"group" : "observations",
"description" : "0 = it is ok",
"type" : "numeric",
"options" : {
"min" : "0",
"max" : "6"
}
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/team-glossary?page=1",
"last" : "http://localhost:8080/api/public/v1/team-glossary?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/team-glossary",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Delete a team glossary item
Delete a team glossary item.
Path parameters ./api/public/v1/team-glossary/{teamGlossaryId}
| Parameter | Description |
|---|---|
|
The unique identifier of the team glossary. |
Request
DELETE /api/public/v1/team-glossary/tgy_5MhrQm4sTJIBGl3UBYhgjW HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzYmZmNTY2NS1jYjY4LTQ4NTAtYTE3NC1lODdlMDA1ZWY0YjgiLCJqdGkiOiJlMzExODM2Yi0wMGIwLTRhOWYtOGRkYi0xZDE4OTc4YzU5ZGYiLCJpYXQiOjE3MzIyNjg1MTUsIm5iZiI6MTczMjI2ODUxNSwiZXhwIjoxNzMyMzU0OTE1LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.O2JU1Kjpw42JCotf3Iu4vj_-l-mybJn9_KZQY99uIYDcK-Ic2mDHn-RX1RpV9HpGQki4ruQAZReNNHdCTTSE_oDSGRZ4WYIR1thl7oqpngM7Oc4hsuMZtKJIv8tvHtRtISfuABkoYtxoBKxdMBxtIyGKhCgxReQceWat2iW80fx2cnVwzx5ATbboaIJ-9TX7fmetMu_gAgLHWNMEU35Be0Oxd6MxyJUMhqAFYF5ony9r9VFetuHCf6V-INVkQ6eRfBSUsmqobRj2H8FG_HZLvkNBMU6LF-VsrnccegUP3m8SHc5CDDygzAJ7vXLw0h4-TouE4W1h1uwAg-9HRwX6A2zgo_qZMceGeiBD71UD4yweUnGEisEVl74Is9XNlHxnV78pe3cHRw_PsopIBqDDNmXaVvz4dOBwgHggBPVEH2dyz95ub7pDr0JnTdTRXwJWwExzuvK-L_KGiVygFJr5PjGkNtLAA2mcARd5sDdhFeOuyGe0jQRz6hL7k2wcL9kAbQbl1Cem5N_Y-1AH3LntpQpMkVUD43szU1qnI186RrEkkuTHF0RDE6YKLX7J1uT56x1THJtCpc733KSwK0EQgNhxNpd59fGS4p-gCUZpQOSmQK5O4uHugqZJN0KmvNBRXp7PJunH1-LH1KSa5thFKirPjt1E9XtZYBeJNyvk3as
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 22
{
"deleted" : true
}User Resources
User
This is an object representing a user who has been invited to your team. You can retrieve it to see the user’s name, email, account status and any metadata assigned.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the user. |
|
|
The name of the user. |
|
|
The email of the user. |
|
|
The timezone of the user. |
|
|
The team status of the user. |
|
|
The metadata associated to the user. |
|
|
The created timestamp of the user. |
|
|
The last updated timestamp of the user. |
Create a user
Fields
| Path | Type | Description |
|---|---|---|
|
|
The name of the user. |
|
|
The email of the user. |
|
|
The timezone of the user. |
|
|
The metadata to be associated the user. |
Request
POST /api/public/v1/users HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1MzkxNDYzZS03ODE4LTQxNjktOGZmNi0yMjIzYWQ1MjBiZWIiLCJqdGkiOiIxZDYxYTU0Ni0xYzgyLTQzMWUtODY4Yi1lZDgwNzU4ZGY5YmEiLCJpYXQiOjE3MzIyNjg1NjMsIm5iZiI6MTczMjI2ODU2MywiZXhwIjoxNzMyMzU0OTYzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.BJh2JbaUMGChfwFMjEuAiNZ0tjwoa4DdEbLm4AtLjkJWPuwcC0FX-RCb1kXaQuUPuIZqhRB-6obabHdq8vVE_hMzrIZQYsMrryDLW26TtBvO3k6QiHJBSYluPzF9cJ0zgOFsQCW79ckkWQEQ9gCqapL50soAd-lPAxbgtpoIdOOQrWYI1osO_0gA5vizG1cMrII7OoKBLgvnX9LGtB2nnDnht3fuSLtkVH53ERP7y-Hm5HKKdmvbkbVQ2oa6tde2tBpH8752X5ijXrp9bjhQCeyS9_JTf_LAjTroKzY2T65QFkTGidpphdL0dZzmiGgyYhMZqhqD5Ky-G9G2mBFHR0SEoAIAq_pVeO1vH8K6-0nmlpkZ52ZUWB3HzawYCVzYvBB_mrpVtySm3az3pO9xfiXfEgxfVCIVfc9z9Rsi_E5ZccBa1G1dD0sr502PGFDjRixHSMqjG3C1DrCu0sSKx25WP5X6Ikmt5aeHI23m6a8V9emW_DvOKufxaPW9vps0KRaClPOqgR4s0klQW7bbKWOjoYwe8z5R_gal27_k_DVVRgCNr9UyHmWYbp889ay0lYs8KqsHlyapA991SMjPS1B0q2WPRP0GoSNa-UWsqKzcoFWjjL4KMvngB-X5Z59YZfhb9fSfRuTVPl5vbQOwh12kQc1wIBvYIc5h6aHpaJs
Content-Length: 146
Host: localhost:8080
{
"name" : "goze7VJ3tg",
"email" : "bklPBVj1@benchling.com",
"timezone" : "UTC",
"metadata" : {
"user-internal-id" : "USER-1234"
}
}Response
HTTP/1.1 201 Created
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 305
{
"id" : "usr_3SeAeMKHL3BOZw5wFbiur4",
"name" : "goze7VJ3tg",
"email" : "bklpbvj1@benchling.com",
"timezone" : "UTC",
"status" : "pending",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:43.572641Z",
"updated_at" : "2024-11-22T09:42:43.572641Z"
}Retrieve a user
Retrieves the details of an existing user. You need only supply the unique user identifier that was returned upon user creation.
Path parameters ./api/public/v1/users/{userId}
| Parameter | Description |
|---|---|
|
The unique identifier of the user. |
Request
GET /api/public/v1/users/usr_MdDAJCCbS3JW34deuFHsI HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzNGVlZTNkYS03YjJkLTQyYWUtODQ0OS00M2Q2ZDg0NWM1MGMiLCJqdGkiOiJkMjdmMDRjMC02MWVjLTQ1YzQtOGY3OC1hNWZmNDZmNjllMDgiLCJpYXQiOjE3MzIyNjg1NjQsIm5iZiI6MTczMjI2ODU2NCwiZXhwIjoxNzMyMzU0OTY0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.F2O1ax7oV_Z5wC3PrzNtahI1sWPLI32aPekpmHPfvq5hFd2IJvCU2X0EVJ46MJv1l3zQ3HJFk207XAaFXIM641z-1hwlhaBsKrM8enbiu6GLoIFXRhQ7-mcCSrIXlqbzHaUcjsuuoxP6tasrrm7pcAt0iantEYHV9Sht1ex5n-BMn_uamafaZQLtxtSVQjRX0N_51a2TkMXXYQiGgggoIonWl7TN66eFxwGDVCQPhWoHG97DUp9zebB2QoMnw46CIQtDQvWBrnwLSO88aNl0DG_SKfVLQn2sUa4qxorNEFbXKgRDY48ph1a0LxE0fcuiAi5xSKGJl5wFhn6aF6Z_zs0DS4S3USqqMQt8pRjEr_EsIIVCrzfL5WeFjbm9HEKxDPCl5gqYVgiFSmT48yNnJVZo_-K3BnB5Al-DC_6_SFO5MF_Bui17GlxRO3RP2kTu3QSrDxCCixmIggjDiJTq7-Is8WN4Q0UGdCsHW5rO73M5ZuIjl4GVnqfsHuzEJOUX3LKUP-PLKyhW8teJOuc9_YRiZ-Vw1tU3ORmGz6FxiJnUz2KNfl4lm4rtAOg9VA53_CcqeIyfOZQiRGIlQNMZbPVBMmelsjvWJSoqouzDsbEUbN30qaJSkQCvEzyw8mpGtDGqaoKaVuY_wvSlT1k2W8fbDr3eGFUkxJFI4-SWxrE
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 308
{
"id" : "usr_MdDAJCCbS3JW34deuFHsI",
"name" : "hSVcx Overwatch",
"email" : "NZqwohQM@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:44.541932Z",
"updated_at" : "2024-11-22T09:42:44.541932Z"
}Update a user
Updates the specified user by setting the values of the parameters passed.
Path parameters ./api/public/v1/users/{userId}
| Parameter | Description |
|---|---|
|
The unique identifier of the user. |
Fields
| Path | Type | Description |
|---|---|---|
|
|
The name of the user. |
|
|
The timezone of the user. |
|
|
The team status of the user. |
|
|
The metadata to be associated the user. |
Request
PATCH /api/public/v1/users/usr_3IqNw01z8V1a3mQ5spt4ve HTTP/1.1
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI3YmEwOGYzYS02MmIyLTRhY2YtOTFjYS0zMmJkZGIxYzM2YzgiLCJqdGkiOiIzOTBkNDVhZS1hZmMxLTRiZTQtYTIxNy1iZThiM2Q2NzA5ZGQiLCJpYXQiOjE3MzIyNjg1NjQsIm5iZiI6MTczMjI2ODU2NCwiZXhwIjoxNzMyMzU0OTY0LCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.QeJpTkRDx4XCQdWVPar-D2KuoARz6wMbbHbjbi3EYp41iF6YHewnzOwnQT8kyNanMMmo7BpYWJLTTbbmLnqHLjhS66iGe3MLvsmHBWFs7rZpEFOpEn9p_VJAfloiD3NliizBbrLsEDrt6rjxMqMHFLZf1yfAVCVQ6SSqYxI9Cp1B2hzKOhEZ8tDIMpBv6sn4MiWPyO1TJnIvDkXvYLdTha90A-5sUVBpxeoZ_RtPodiW1d_wQhdBBRD2u5gUc7sqM8JfDkEonvBZ9l5mhaHa2Y2oLbDcfWtemc0GQ318cA0QmQVnJUaKE4fjZR-mfSiSYvSxYDDYWzV3euLbS3KBvRkYndLi0rJm9PEVhnCw48VSIOsQHykw0Ny7vj0Zl-vi9F62LxLkftwDrhAnq1M_JdWfjbzhUJ0O3i1E2zUwrqQHp05kC-xL8taMEkvzpoc9LS1gMRiChboGHC3TTHf0h4WjQztvC9nrvh0QUlojbCrG3J3o0wtFeOnFd-Jyd98SiNGXmQoBiUZK7OXYyr9zlj227SUsjc7ykThzh3CrbVyYUrVE1NlW0UdJEfP2fCo6Yu3upgdvoaNtCyUfhhYgCh99RoMipKKl8gQnSzPx4D-RIafI7NlUI5g1tVyb6peNhmD0ERcqsSwE1_rkWQbDafH-N5n1s_bRGN47rezizxc
Content-Length: 150
Host: localhost:8080
{
"name" : "Benchling In Vivo",
"timezone" : "Europe/London",
"status" : "inactive",
"metadata" : {
"user-internal-id" : "USER-4321"
}
}Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 323
{
"id" : "usr_3IqNw01z8V1a3mQ5spt4ve",
"name" : "Benchling In Vivo",
"email" : "hjpgymXl@benchling.com",
"timezone" : "Europe/London",
"status" : "inactive",
"metadata" : {
"user-internal-id" : "USER-4321"
},
"created_at" : "2024-11-22T09:42:41.253276Z",
"updated_at" : "2024-11-22T09:42:44.275616Z"
}List all users
Returns a list of your users.
Query parameters
| Parameter | Description |
|---|---|
|
The number of users to return per page. |
|
The page of users to return. |
|
Filter users to return by name |
|
Filter users to return by email |
|
Filter users to return by metadata value |
Request
GET /api/public/v1/users HTTP/1.1
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIxN2ZlODBiMC0xYWU3LTQ4MDEtYThkYS1mMDM2ODcyOTFlYTAiLCJqdGkiOiIyY2VmOTRhNy05ODE0LTQ5MGEtOGVkMy1lYTJhMGQ4YmNlM2UiLCJpYXQiOjE3MzIyNjg1NjMsIm5iZiI6MTczMjI2ODU2MywiZXhwIjoxNzMyMzU0OTYzLCJzdWIiOiIiLCJzY29wZXMiOlsiKiJdfQ.gxoEsyy6EURBiOhUokX34tGocYjnWIo0s3kB_bWROp1jvbybC4zqda5tXsF_gEcN12rJ2lnarQ1DvAb8oBhak27NCdoNvwlajEPtp5dkGeDqwoIFQ2tJiwZepH-KbgOhT9f8LZCTPzDP8D6zJy6E-8NGLBwv57yl0wpwePwWMzQ408WsBs7NEqWG5nfsnvCuEN2P5prj_CRpks0B0HpFs_LzJeTicbTcIcl0DMMPCrKMNUxegZwSxJgCxsMLovALvtTPagzvIniAhr5eKR6Z4jVa2xtBSxnjW0PhoiSW8vOIU4EMa80JL8LRsNKUm3uKFxa52K9jJPP7p44P32WXec3S6oHEU_VHMDoUgBrnIdnLVoLllMqtYSK1WpIm3pptmZZqBQlZmfaOb-vsz4vuVzRJRL3j_nOL3c4eGyIqyyOLsXv9Ga_m5cjyiFN6V7WMDVevyI3owiZXWbAva0NJDeVaViAI0q9JSQMaXgxsVorG0EuqK8HxpjjEdNUExIBWFID7QHaklPBv2fUoJ6xxtognDbMPXMf7gDDAclZCEBssEv5b_JIWnoW12gsGpogQqHXSI9znqv-70ETinIco1M9sAYd1eMKrqFRfSAuSd3tNvJxf4RiC2kfzVoACt4Cb-TVCQRuZTfRYNv1J42-ltrQz_XZeFuZ5ELWCq0KRtCY
Host: localhost:8080Response
HTTP/1.1 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 725
{
"data" : [ {
"id" : "usr_5jj5jUP5JsOcWMd3LWTICT",
"name" : "t9h6K Overwatch",
"email" : "rihM4UK7@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:43.698841Z",
"updated_at" : "2024-11-22T09:42:43.698841Z"
} ],
"links" : {
"first" : "http://localhost:8080/api/public/v1/users?page=1",
"last" : "http://localhost:8080/api/public/v1/users?page=1",
"prev" : null,
"next" : null
},
"meta" : {
"from" : 1,
"path" : "http://localhost:8080/api/public/v1/users",
"to" : 1,
"total" : 1,
"current_page" : 1,
"last_page" : 1,
"per_page" : 10
}
}Webhooks
Listen for events on your team so your integration can automatically trigger reactions.
Attributes
| Path | Type | Description |
|---|---|---|
|
|
The unique identifier of the webhook event. |
|
|
The client ID of the API key that triggered the webhook event. |
|
|
The name of the webhook event. |
|
|
The version of the webhook event. |
|
|
The created timestamp of the webhook event. |
|
|
The payload data associated to the webhook event. |
Animal
animal.created
Triggered when an animal is created.
{
"id" : "whe_6LI5Ev8WRbZvtjXNDiLcrh",
"client_id" : "57c8d144-1be5-43a9-be3c-efe84d1257bc",
"event" : "animal.created",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:49.244616Z",
"payload" : {
"id" : "aml_6GwE1EnjFHq5oSPdm8fxH1",
"catalog" : "A0000001",
"name" : "696fi2UrOt",
"number" : 1,
"strain" : "LsqGTAMBrA",
"species" : "tL96mrBrL2",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "GDPm6e8Jun",
"ear" : "PKXZ8BDB5p",
"tag" : "RZP6VJY1t8",
"donor" : "9mOtAE7Zka",
"tracking_date" : "2024-11-22",
"disease_induction_date" : "2024-11-22",
"terminated_at" : null,
"terminated_by" : null,
"terminated_reason" : null,
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"study" : {
"id" : "sdy_4oBQOWdfEf1xEBHX45YnNL",
"project_id" : "pjt_2iI4pyrtkFNwm2tPGDud4x",
"name" : "UhbbrBINCt",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "q6FQbG86bD",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_1HTZXh23v3Z9VkqZjGLqa5",
"name" : "AWXFFjerhR",
"email" : "csl7TDg8@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_zwKAPL0ve7G2HV6Dpf0in",
"name" : "TCnkjOYBzf",
"email" : "4ZZlSaIG@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:49.028404Z",
"updated_at" : "2024-11-22T09:42:49.028404Z"
},
"study_group" : {
"id" : "grp_VhK5iyuuU3ovAkKMpCYHz",
"study_id" : "sdy_4oBQOWdfEf1xEBHX45YnNL",
"name" : "rgPEii4Sti",
"no" : 1844040351,
"color" : "PjA520VOeL",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-internal-id" : "GROUP-1234"
},
"created_at" : "2024-11-22T09:42:49.218453Z",
"updated_at" : "2024-11-22T09:42:49.218453Z"
},
"cage" : {
"id" : "cge_7d03OO002EQfC2cQnnJqXH",
"study_id" : "sdy_4oBQOWdfEf1xEBHX45YnNL",
"name" : "WAdJTNLUIM",
"catalog" : "C0000001",
"metadata" : {
"cage-internal-id" : "CAGE-1234"
},
"created_at" : "2024-11-22T09:42:49.204203Z",
"updated_at" : "2024-11-22T09:42:49.204203Z"
},
"created_at" : "2024-11-22T09:42:49.223093Z",
"updated_at" : "2024-11-22T09:42:49.223093Z"
}
}animal.updated
Triggered when an animal is updated.
{
"id" : "whe_4w5fErVrKOoHvdqvTXm2pj",
"client_id" : "d95b7ec8-a1c8-4793-9fee-ed36c51063b9",
"event" : "animal.updated",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:46.383468Z",
"payload" : {
"id" : "aml_3ZAgdN8wJAi4yFI1MoFfqf",
"catalog" : "A0000001",
"name" : "QKG576LT1Q",
"number" : 1,
"strain" : "g5iDG6l0AD",
"species" : "IIHtGD2Nze",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "EGOWJGromI",
"ear" : "QzeY1tUaup",
"tag" : "pgR9hsG4FO",
"donor" : "SJdshHjZ37",
"tracking_date" : "2024-11-22",
"disease_induction_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_D8NSgsJN0UANG1T9DuZuz",
"name" : "czlbiHM1rz",
"email" : "yJoJe88g@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_2wrcjv5C0ydbyETgDebRWw",
"title" : "Found dead",
"comment" : "CELSAjMgI2"
},
"disease_survivor" : false,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"study" : {
"id" : "sdy_Dsshf6adICIPZ4vhuo15C",
"project_id" : "pjt_WcKjfSADkdJ17Ak4WGqh2",
"name" : "AhGTKkjVKA",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "ptocREBnb9",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_3AoSM79Dc6odbKaPkPwaVP",
"name" : "njiMWjy9bt",
"email" : "AFGlwZD7@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4MUJJvRLYA7aFZpOfQ2eDf",
"name" : "JkGbKwVwwC",
"email" : "g42e5aKb@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:46.066426Z",
"updated_at" : "2024-11-22T09:42:46.066426Z"
},
"study_group" : {
"id" : "grp_59mT6BJOmUqWd5yQvnPNVi",
"study_id" : "sdy_Dsshf6adICIPZ4vhuo15C",
"name" : "OsDXfgMsoH",
"no" : 1956578008,
"color" : "vSXSuWWM75",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-internal-id" : "GROUP-1234"
},
"created_at" : "2024-11-22T09:42:46.259412Z",
"updated_at" : "2024-11-22T09:42:46.259412Z"
},
"cage" : {
"id" : "cge_gQiovcQLHbG0Z7CcNheXr",
"study_id" : "sdy_Dsshf6adICIPZ4vhuo15C",
"name" : "URmj64I0Is",
"catalog" : "C0000001",
"metadata" : {
"cage-internal-id" : "CAGE-1234"
},
"created_at" : "2024-11-22T09:42:46.245746Z",
"updated_at" : "2024-11-22T09:42:46.245746Z"
},
"created_at" : "2024-11-22T09:42:46.262821Z",
"updated_at" : "2024-11-22T09:42:46.262821Z"
}
}animal.deleted
Triggered when an animal is deleted.
{
"id" : "whe_31bnTvHk4Mns1Dwfub5x53",
"client_id" : "a266ff41-dc2c-4724-b3d5-85c9e905b903",
"event" : "animal.deleted",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:46.384860Z",
"payload" : {
"id" : "aml_3ZAgdN8wJAi4yFI1MoFfqf",
"catalog" : "A0000001",
"name" : "QKG576LT1Q",
"number" : 1,
"strain" : "g5iDG6l0AD",
"species" : "IIHtGD2Nze",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "EGOWJGromI",
"ear" : "QzeY1tUaup",
"tag" : "pgR9hsG4FO",
"donor" : "SJdshHjZ37",
"tracking_date" : "2024-11-22",
"disease_induction_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_D8NSgsJN0UANG1T9DuZuz",
"name" : "czlbiHM1rz",
"email" : "yJoJe88g@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_2wrcjv5C0ydbyETgDebRWw",
"title" : "Found dead",
"comment" : "CELSAjMgI2"
},
"disease_survivor" : false,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"study" : {
"id" : "sdy_Dsshf6adICIPZ4vhuo15C",
"project_id" : "pjt_WcKjfSADkdJ17Ak4WGqh2",
"name" : "AhGTKkjVKA",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "ptocREBnb9",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_3AoSM79Dc6odbKaPkPwaVP",
"name" : "njiMWjy9bt",
"email" : "AFGlwZD7@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4MUJJvRLYA7aFZpOfQ2eDf",
"name" : "JkGbKwVwwC",
"email" : "g42e5aKb@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:46.066426Z",
"updated_at" : "2024-11-22T09:42:46.066426Z"
},
"study_group" : {
"id" : "grp_59mT6BJOmUqWd5yQvnPNVi",
"study_id" : "sdy_Dsshf6adICIPZ4vhuo15C",
"name" : "OsDXfgMsoH",
"no" : 1956578008,
"color" : "vSXSuWWM75",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-internal-id" : "GROUP-1234"
},
"created_at" : "2024-11-22T09:42:46.259412Z",
"updated_at" : "2024-11-22T09:42:46.259412Z"
},
"cage" : {
"id" : "cge_gQiovcQLHbG0Z7CcNheXr",
"study_id" : "sdy_Dsshf6adICIPZ4vhuo15C",
"name" : "URmj64I0Is",
"catalog" : "C0000001",
"metadata" : {
"cage-internal-id" : "CAGE-1234"
},
"created_at" : "2024-11-22T09:42:46.245746Z",
"updated_at" : "2024-11-22T09:42:46.245746Z"
},
"created_at" : "2024-11-22T09:42:46.262821Z",
"updated_at" : "2024-11-22T09:42:46.262821Z"
}
}animal.metadata.updated
Triggered when an animal metadata is updated.
{
"id" : "whe_20kSmrXcannRCxzucXWkK0",
"client_id" : "8c82956e-5cf2-4f35-97d4-86ca560c0772",
"event" : "animal.metadata.updated",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:46.385743Z",
"payload" : {
"id" : "aml_3ZAgdN8wJAi4yFI1MoFfqf",
"catalog" : "A0000001",
"name" : "QKG576LT1Q",
"number" : 1,
"strain" : "g5iDG6l0AD",
"species" : "IIHtGD2Nze",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "EGOWJGromI",
"ear" : "QzeY1tUaup",
"tag" : "pgR9hsG4FO",
"donor" : "SJdshHjZ37",
"tracking_date" : "2024-11-22",
"disease_induction_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_D8NSgsJN0UANG1T9DuZuz",
"name" : "czlbiHM1rz",
"email" : "yJoJe88g@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_2wrcjv5C0ydbyETgDebRWw",
"title" : "Found dead",
"comment" : "CELSAjMgI2"
},
"disease_survivor" : false,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"study" : {
"id" : "sdy_Dsshf6adICIPZ4vhuo15C",
"project_id" : "pjt_WcKjfSADkdJ17Ak4WGqh2",
"name" : "AhGTKkjVKA",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "ptocREBnb9",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_3AoSM79Dc6odbKaPkPwaVP",
"name" : "njiMWjy9bt",
"email" : "AFGlwZD7@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4MUJJvRLYA7aFZpOfQ2eDf",
"name" : "JkGbKwVwwC",
"email" : "g42e5aKb@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:46.066426Z",
"updated_at" : "2024-11-22T09:42:46.066426Z"
},
"study_group" : {
"id" : "grp_59mT6BJOmUqWd5yQvnPNVi",
"study_id" : "sdy_Dsshf6adICIPZ4vhuo15C",
"name" : "OsDXfgMsoH",
"no" : 1956578008,
"color" : "vSXSuWWM75",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-internal-id" : "GROUP-1234"
},
"created_at" : "2024-11-22T09:42:46.259412Z",
"updated_at" : "2024-11-22T09:42:46.259412Z"
},
"cage" : {
"id" : "cge_gQiovcQLHbG0Z7CcNheXr",
"study_id" : "sdy_Dsshf6adICIPZ4vhuo15C",
"name" : "URmj64I0Is",
"catalog" : "C0000001",
"metadata" : {
"cage-internal-id" : "CAGE-1234"
},
"created_at" : "2024-11-22T09:42:46.245746Z",
"updated_at" : "2024-11-22T09:42:46.245746Z"
},
"created_at" : "2024-11-22T09:42:46.262821Z",
"updated_at" : "2024-11-22T09:42:46.262821Z"
}
}Animal Dosage
animal.dosage.created
Triggered when an animal dosage is created.
{
"id" : "whe_2LSHzt2a4KvPZAxYWd0AQv",
"client_id" : "cfb4c623-9578-4dd0-b5ab-ccc9b0c936ca",
"event" : "animal.dosage.created",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:45.824302Z",
"payload" : {
"id" : "dsg_4adCxTWyA9cD85cizRq0IF",
"name" : "Example dosage",
"dosed_at" : "2024-11-22T09:42:45.804134Z",
"weight_at_dosing" : null,
"dose" : {
"unit" : "mg/kg",
"value" : "5.85",
"display_unit" : "mg/kg",
"display_value" : "5.85"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "12.54",
"display_unit" : "ml/kg",
"display_value" : "12.54"
},
"stock" : {
"unit" : "mg/ml",
"value" : "24.03",
"display_unit" : "mg/ml",
"display_value" : "24.03"
},
"volume" : {
"unit" : "µl",
"value" : "31.45",
"display_unit" : "µl",
"display_value" : "31.45"
},
"study" : {
"id" : "sdy_2xUU1J3imIvwz9ITHSXIRf",
"project_id" : "pjt_3KMe3hJADo1Ye7BkUKxycR",
"name" : "cGsLAvktut",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "OOGla18TY3",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_kgrpJwKQ4o7iqJnDnI5qV",
"name" : "ib1kQEG7RQ",
"email" : "f31BXvc1@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4qffA6HYSA1ondNMFNYnR8",
"name" : "W4RPfMYXpk",
"email" : "feJBZSeK@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:45.576026Z",
"updated_at" : "2024-11-22T09:42:45.576026Z"
},
"animal" : {
"id" : "aml_75kTR6CGJqEf5hPSnt00If",
"study_id" : "sdy_2xUU1J3imIvwz9ITHSXIRf",
"study_group_id" : "grp_6DuDsm04Lr4lu2OYS7ysDH",
"cage_id" : "cge_3hOOgrbWGewzVjWa32I1AV",
"catalog" : "A0000001",
"name" : "JgCnVLpUX6",
"number" : 1,
"strain" : "SX23jk1EQN",
"species" : "WMt1f9WUEZ",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "Z1qPXw5VA2",
"ear" : "mYErKPOzcq",
"tag" : "J0KgKBX4sc",
"donor" : "GpecGSOMDk",
"tracking_date" : "2024-11-22",
"terminated_at" : null,
"terminated_by" : null,
"terminated_reason" : null,
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:45.783428Z",
"updated_at" : "2024-11-22T09:42:45.783428Z",
"disease_induction_date" : "2024-11-22"
},
"measurement" : {
"id" : "mst_1v3dIUBxwY3wo6mZ3fp7Vk",
"study_id" : "sdy_2xUU1J3imIvwz9ITHSXIRf",
"animal_id" : "aml_75kTR6CGJqEf5hPSnt00If",
"measured_at" : "2024-11-22",
"calculations" : [ {
"id" : "vbl_3wCjQZgphU4as874nNh0et",
"key" : "tumour_volume",
"name" : "Tumour Volume",
"unit" : "mm³",
"excluded" : false,
"value" : "75",
"formula" : "(width * width * length) / 2",
"variables" : [ {
"id" : "vbl_11rAx6MtYdAmzG4USvJoZ5",
"key" : "width",
"value" : "5",
"unit" : "mm"
}, {
"id" : "vbl_310w6JiMG91ALYX7Udrc8m",
"key" : "length",
"value" : "6",
"unit" : "mm"
} ]
}, {
"id" : "vbl_4Ipcn3t2diAV8Jax2iuiMM",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "55",
"formula" : "weight",
"variables" : [ ]
} ],
"created_at" : "2024-11-22T09:42:45.788864Z",
"updated_at" : "2024-11-22T09:42:45.788864Z"
},
"user" : {
"id" : "usr_7JYTbWSG6mpsjRqcjQEhj",
"name" : "CIYzH Overwatch",
"email" : "hIbRGRqq@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:45.549796Z",
"updated_at" : "2024-11-22T09:42:45.549796Z"
},
"treatment" : {
"id" : "tmt_2pyobdTfL6XPy825QhcHdw",
"study_id" : "sdy_2xUU1J3imIvwz9ITHSXIRf",
"type" : "concentration_mlkg",
"name" : "pgDZ7ACqCY",
"dose" : {
"unit" : "mg/kg",
"value" : "5",
"display_unit" : "mg/kg",
"display_value" : "5"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "15",
"display_unit" : "ml/kg",
"display_value" : "15"
},
"stock" : {
"unit" : "mg/ml",
"value" : "10",
"display_unit" : "mg/ml",
"display_value" : "10"
},
"volume" : {
"unit" : "µl",
"value" : "8",
"display_unit" : "µl",
"display_value" : "8"
},
"metadata" : {
"treatment-internal-id" : "TREATMENT-1234"
},
"created_at" : "2024-11-22T09:42:45.799893Z",
"updated_at" : "2024-11-22T09:42:45.799893Z",
"external_entity_id" : "Hqy2RmxKca"
},
"created_at" : "2024-11-22T09:42:45.804145Z",
"updated_at" : "2024-11-22T09:42:45.804145Z"
}
}animal.dosage.deleted
Triggered when an animal dosage is deleted.
{
"id" : "whe_yEBcNPETTM6T0tnYvac9A",
"client_id" : "a1d5e72b-4d63-4b2d-8356-5cc52f781fe0",
"event" : "animal.dosage.deleted",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:45.827692Z",
"payload" : {
"id" : "dsg_4adCxTWyA9cD85cizRq0IF",
"name" : "Example dosage",
"dosed_at" : "2024-11-22T09:42:45.804134Z",
"weight_at_dosing" : null,
"dose" : {
"unit" : "mg/kg",
"value" : "5.85",
"display_unit" : "mg/kg",
"display_value" : "5.85"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "12.54",
"display_unit" : "ml/kg",
"display_value" : "12.54"
},
"stock" : {
"unit" : "mg/ml",
"value" : "24.03",
"display_unit" : "mg/ml",
"display_value" : "24.03"
},
"volume" : {
"unit" : "µl",
"value" : "31.45",
"display_unit" : "µl",
"display_value" : "31.45"
},
"study" : {
"id" : "sdy_2xUU1J3imIvwz9ITHSXIRf",
"project_id" : "pjt_3KMe3hJADo1Ye7BkUKxycR",
"name" : "cGsLAvktut",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "OOGla18TY3",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_kgrpJwKQ4o7iqJnDnI5qV",
"name" : "ib1kQEG7RQ",
"email" : "f31BXvc1@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4qffA6HYSA1ondNMFNYnR8",
"name" : "W4RPfMYXpk",
"email" : "feJBZSeK@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:45.576026Z",
"updated_at" : "2024-11-22T09:42:45.576026Z"
},
"animal" : {
"id" : "aml_75kTR6CGJqEf5hPSnt00If",
"study_id" : "sdy_2xUU1J3imIvwz9ITHSXIRf",
"study_group_id" : "grp_6DuDsm04Lr4lu2OYS7ysDH",
"cage_id" : "cge_3hOOgrbWGewzVjWa32I1AV",
"catalog" : "A0000001",
"name" : "JgCnVLpUX6",
"number" : 1,
"strain" : "SX23jk1EQN",
"species" : "WMt1f9WUEZ",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "Z1qPXw5VA2",
"ear" : "mYErKPOzcq",
"tag" : "J0KgKBX4sc",
"donor" : "GpecGSOMDk",
"tracking_date" : "2024-11-22",
"terminated_at" : null,
"terminated_by" : null,
"terminated_reason" : null,
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:45.783428Z",
"updated_at" : "2024-11-22T09:42:45.783428Z",
"disease_induction_date" : "2024-11-22"
},
"measurement" : {
"id" : "mst_1v3dIUBxwY3wo6mZ3fp7Vk",
"study_id" : "sdy_2xUU1J3imIvwz9ITHSXIRf",
"animal_id" : "aml_75kTR6CGJqEf5hPSnt00If",
"measured_at" : "2024-11-22",
"calculations" : [ {
"id" : "vbl_3wCjQZgphU4as874nNh0et",
"key" : "tumour_volume",
"name" : "Tumour Volume",
"unit" : "mm³",
"excluded" : false,
"value" : "75",
"formula" : "(width * width * length) / 2",
"variables" : [ {
"id" : "vbl_11rAx6MtYdAmzG4USvJoZ5",
"key" : "width",
"value" : "5",
"unit" : "mm"
}, {
"id" : "vbl_310w6JiMG91ALYX7Udrc8m",
"key" : "length",
"value" : "6",
"unit" : "mm"
} ]
}, {
"id" : "vbl_4Ipcn3t2diAV8Jax2iuiMM",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "55",
"formula" : "weight",
"variables" : [ ]
} ],
"created_at" : "2024-11-22T09:42:45.788864Z",
"updated_at" : "2024-11-22T09:42:45.788864Z"
},
"user" : {
"id" : "usr_7JYTbWSG6mpsjRqcjQEhj",
"name" : "CIYzH Overwatch",
"email" : "hIbRGRqq@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:45.549796Z",
"updated_at" : "2024-11-22T09:42:45.549796Z"
},
"treatment" : {
"id" : "tmt_2pyobdTfL6XPy825QhcHdw",
"study_id" : "sdy_2xUU1J3imIvwz9ITHSXIRf",
"type" : "concentration_mlkg",
"name" : "pgDZ7ACqCY",
"dose" : {
"unit" : "mg/kg",
"value" : "5",
"display_unit" : "mg/kg",
"display_value" : "5"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "15",
"display_unit" : "ml/kg",
"display_value" : "15"
},
"stock" : {
"unit" : "mg/ml",
"value" : "10",
"display_unit" : "mg/ml",
"display_value" : "10"
},
"volume" : {
"unit" : "µl",
"value" : "8",
"display_unit" : "µl",
"display_value" : "8"
},
"metadata" : {
"treatment-internal-id" : "TREATMENT-1234"
},
"created_at" : "2024-11-22T09:42:45.799893Z",
"updated_at" : "2024-11-22T09:42:45.799893Z",
"external_entity_id" : "Hqy2RmxKca"
},
"created_at" : "2024-11-22T09:42:45.804145Z",
"updated_at" : "2024-11-22T09:42:45.804145Z"
}
}Animal Measurement
animal.measurement.created
Triggered when an animal measurement is created.
{
"id" : "whe_6t4OF6YOSmMW43VTfYjfiE",
"client_id" : "c51734b1-b818-4de8-bf77-97c45a234405",
"event" : "animal.measurement.created",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:49.491884Z",
"payload" : {
"id" : "mst_7KkIlrsdKH3h4VrYQVPLTj",
"measured_at" : "2024-11-22",
"calculations" : [ {
"id" : "vbl_tdqW2RApGrqCiAjSkfWG0",
"key" : "tumour_volume",
"name" : "Tumour Volume",
"unit" : "mm³",
"excluded" : false,
"value" : "75",
"formula" : "(width * width * length) / 2",
"variables" : [ {
"id" : "vbl_4rHoObnKaWVWekk5gJWZA0",
"key" : "width",
"value" : "5",
"unit" : "mm"
}, {
"id" : "vbl_60eZT5lnEEoC5EX2izsN2T",
"key" : "length",
"value" : "6",
"unit" : "mm"
} ]
}, {
"id" : "vbl_2jNgEZDViuIn55U1LrYhCG",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "55",
"formula" : "weight",
"variables" : [ ]
} ],
"study" : {
"id" : "sdy_2SoXjlbfrbgpSnmmUNRHrD",
"project_id" : "pjt_6xOzyRSY98gkG7o4RfGp6t",
"name" : "HhOytkpB7L",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "5RFt3xFHe2",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_33DMC7exAZxYm4wC7hHuxT",
"name" : "sxCrOoDc2S",
"email" : "PyNKnyLJ@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_2ASqfVwJbKRr8HG1guZwF8",
"name" : "2yYBjmXSEF",
"email" : "oxLl6JqE@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:49.261955Z",
"updated_at" : "2024-11-22T09:42:49.261955Z"
},
"animal" : {
"id" : "aml_5n2MrllWbfYOX0z122C5Cp",
"study_id" : "sdy_2SoXjlbfrbgpSnmmUNRHrD",
"study_group_id" : "grp_6rK7ATwPhlsQ6HJUh353VI",
"cage_id" : "cge_63Je2ADvWClrcL8ccjAbrl",
"catalog" : "A0000001",
"name" : "Iqo2O9GHau",
"number" : 1,
"strain" : "nzP8jQ0aDS",
"species" : "hx08YxgKO3",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "FRGEudYJ58",
"ear" : "0mMe7hBoQj",
"tag" : "MfoyHmXLSI",
"donor" : "R2UahbKGyb",
"tracking_date" : "2024-11-22",
"terminated_at" : null,
"terminated_by" : null,
"terminated_reason" : null,
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:49.460693Z",
"updated_at" : "2024-11-22T09:42:49.460693Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_5dy8Q9GdIwkFtqJ3srq9FP",
"name" : "C1T0olPw8S",
"email" : "l3YsFmSW@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : null,
"created_at" : "2024-11-22T09:42:49.252284Z",
"updated_at" : "2024-11-22T09:42:49.252284Z"
},
"created_at" : "2024-11-22T09:42:49.467393Z",
"updated_at" : "2024-11-22T09:42:49.467393Z"
}
}animal.measurement.updated
Triggered when an animal measurement is updated.
{
"id" : "whe_1AIcIs6afENH3rMZK5RjDJ",
"client_id" : "815a13df-a404-41b6-8aa6-dcfba3d0a578",
"event" : "animal.measurement.updated",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:49.495849Z",
"payload" : {
"id" : "mst_7KkIlrsdKH3h4VrYQVPLTj",
"measured_at" : "2024-11-22",
"calculations" : [ {
"id" : "vbl_tdqW2RApGrqCiAjSkfWG0",
"key" : "tumour_volume",
"name" : "Tumour Volume",
"unit" : "mm³",
"excluded" : false,
"value" : "75",
"formula" : "(width * width * length) / 2",
"variables" : [ {
"id" : "vbl_4rHoObnKaWVWekk5gJWZA0",
"key" : "width",
"value" : "5",
"unit" : "mm"
}, {
"id" : "vbl_60eZT5lnEEoC5EX2izsN2T",
"key" : "length",
"value" : "6",
"unit" : "mm"
} ]
}, {
"id" : "vbl_2jNgEZDViuIn55U1LrYhCG",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "55",
"formula" : "weight",
"variables" : [ ]
} ],
"study" : {
"id" : "sdy_2SoXjlbfrbgpSnmmUNRHrD",
"project_id" : "pjt_6xOzyRSY98gkG7o4RfGp6t",
"name" : "HhOytkpB7L",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "5RFt3xFHe2",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_33DMC7exAZxYm4wC7hHuxT",
"name" : "sxCrOoDc2S",
"email" : "PyNKnyLJ@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_2ASqfVwJbKRr8HG1guZwF8",
"name" : "2yYBjmXSEF",
"email" : "oxLl6JqE@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:49.261955Z",
"updated_at" : "2024-11-22T09:42:49.261955Z"
},
"animal" : {
"id" : "aml_5n2MrllWbfYOX0z122C5Cp",
"study_id" : "sdy_2SoXjlbfrbgpSnmmUNRHrD",
"study_group_id" : "grp_6rK7ATwPhlsQ6HJUh353VI",
"cage_id" : "cge_63Je2ADvWClrcL8ccjAbrl",
"catalog" : "A0000001",
"name" : "Iqo2O9GHau",
"number" : 1,
"strain" : "nzP8jQ0aDS",
"species" : "hx08YxgKO3",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "FRGEudYJ58",
"ear" : "0mMe7hBoQj",
"tag" : "MfoyHmXLSI",
"donor" : "R2UahbKGyb",
"tracking_date" : "2024-11-22",
"terminated_at" : null,
"terminated_by" : null,
"terminated_reason" : null,
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:49.460693Z",
"updated_at" : "2024-11-22T09:42:49.460693Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_5dy8Q9GdIwkFtqJ3srq9FP",
"name" : "C1T0olPw8S",
"email" : "l3YsFmSW@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : null,
"created_at" : "2024-11-22T09:42:49.252284Z",
"updated_at" : "2024-11-22T09:42:49.252284Z"
},
"created_at" : "2024-11-22T09:42:49.467393Z",
"updated_at" : "2024-11-22T09:42:49.467393Z"
}
}animal.measurement.deleted
Triggered when an animal measurement is delete.
{
"id" : "whe_4AqQOjCHFBaWCzyGFNAahA",
"client_id" : "b1835772-2d93-4e9b-bf5e-2c0471695473",
"event" : "animal.measurement.deleted",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:49.496718Z",
"payload" : {
"id" : "mst_7KkIlrsdKH3h4VrYQVPLTj",
"measured_at" : "2024-11-22",
"calculations" : [ {
"id" : "vbl_tdqW2RApGrqCiAjSkfWG0",
"key" : "tumour_volume",
"name" : "Tumour Volume",
"unit" : "mm³",
"excluded" : false,
"value" : "75",
"formula" : "(width * width * length) / 2",
"variables" : [ {
"id" : "vbl_4rHoObnKaWVWekk5gJWZA0",
"key" : "width",
"value" : "5",
"unit" : "mm"
}, {
"id" : "vbl_60eZT5lnEEoC5EX2izsN2T",
"key" : "length",
"value" : "6",
"unit" : "mm"
} ]
}, {
"id" : "vbl_2jNgEZDViuIn55U1LrYhCG",
"key" : "weight",
"name" : "Weight",
"unit" : "g",
"excluded" : false,
"value" : "55",
"formula" : "weight",
"variables" : [ ]
} ],
"study" : {
"id" : "sdy_2SoXjlbfrbgpSnmmUNRHrD",
"project_id" : "pjt_6xOzyRSY98gkG7o4RfGp6t",
"name" : "HhOytkpB7L",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "5RFt3xFHe2",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_33DMC7exAZxYm4wC7hHuxT",
"name" : "sxCrOoDc2S",
"email" : "PyNKnyLJ@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_2ASqfVwJbKRr8HG1guZwF8",
"name" : "2yYBjmXSEF",
"email" : "oxLl6JqE@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:49.261955Z",
"updated_at" : "2024-11-22T09:42:49.261955Z"
},
"animal" : {
"id" : "aml_5n2MrllWbfYOX0z122C5Cp",
"study_id" : "sdy_2SoXjlbfrbgpSnmmUNRHrD",
"study_group_id" : "grp_6rK7ATwPhlsQ6HJUh353VI",
"cage_id" : "cge_63Je2ADvWClrcL8ccjAbrl",
"catalog" : "A0000001",
"name" : "Iqo2O9GHau",
"number" : 1,
"strain" : "nzP8jQ0aDS",
"species" : "hx08YxgKO3",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "FRGEudYJ58",
"ear" : "0mMe7hBoQj",
"tag" : "MfoyHmXLSI",
"donor" : "R2UahbKGyb",
"tracking_date" : "2024-11-22",
"terminated_at" : null,
"terminated_by" : null,
"terminated_reason" : null,
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:49.460693Z",
"updated_at" : "2024-11-22T09:42:49.460693Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_5dy8Q9GdIwkFtqJ3srq9FP",
"name" : "C1T0olPw8S",
"email" : "l3YsFmSW@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : null,
"created_at" : "2024-11-22T09:42:49.252284Z",
"updated_at" : "2024-11-22T09:42:49.252284Z"
},
"created_at" : "2024-11-22T09:42:49.467393Z",
"updated_at" : "2024-11-22T09:42:49.467393Z"
}
}Animal Observation
animal.observation.created
Triggered when an animal observation is created.
{
"id" : "whe_267fvkRXcyvrcXXZF0ePh6",
"client_id" : "2f482fd0-4a9a-4714-ab90-3b652c359021",
"event" : "animal.observation.created",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:47.071284Z",
"payload" : {
"id" : "obs_4StMC12ApTgRBYYP7iWlxp",
"glossary_id" : "gly_1CMmW8f4k5X8farMhM43IX",
"title" : "Observation Glossary",
"text" : "Example text",
"type" : "severity",
"value" : "Severe",
"observed_at" : "2024-11-22T09:42:47.036440Z",
"study" : {
"id" : "sdy_5YQQLnZos7BnVRWJSVPWUc",
"project_id" : "pjt_14OV1QwxYPJD9H1qGBniII",
"name" : "roSu2h2vxN",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "crC9BXDfKc",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_4JS5bNufhUO3wCoN9gn7EW",
"name" : "e8KDGxyu0l",
"email" : "6rKV217A@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_5ySJ0RV5prC4lm78z7Xvy9",
"name" : "YEV1qdjeM6",
"email" : "qN4h3hJP@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:46.732638Z",
"updated_at" : "2024-11-22T09:42:46.732638Z"
},
"animal" : {
"id" : "aml_75uMhhU69KpByjlWLiFLro",
"study_id" : "sdy_5YQQLnZos7BnVRWJSVPWUc",
"study_group_id" : "grp_7LiPUWMy3zmp3aITzW1Htm",
"cage_id" : "cge_1wnLloWsx34GXbrNiMXQ2",
"catalog" : "A0000001",
"name" : "J1PwknM3tS",
"number" : 1,
"strain" : "bD0zpkSN3y",
"species" : "ErguMjtcfS",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "3Kebq4vUjv",
"ear" : "k4HH1usb3C",
"tag" : "hsS4Zvu40c",
"donor" : "valnBSstSQ",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_7GLCtnZNUUjX75rdswUC7m",
"name" : "ZAuEFjuVpm",
"email" : "MIwdPZhx@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_1kdqcq2OcrY8IEdS1QZ3TI",
"title" : "Found dead",
"comment" : "Bji1rgvPg6"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:46.938732Z",
"updated_at" : "2024-11-22T09:42:46.938732Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_D5nyQazUXT6OryE1exy93",
"name" : "hYEvs Overwatch",
"email" : "0Je8vT14@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:46.706439Z",
"updated_at" : "2024-11-22T09:42:46.706439Z"
},
"created_at" : "2024-11-22T09:42:47.036487Z",
"updated_at" : "2024-11-22T09:42:47.036487Z"
}
}animal.observation.updated
Triggered when an animal observation is updated.
{
"id" : "whe_13nld4QixZos7ijy2NLvWj",
"client_id" : "d184bb60-f9ff-4d2d-9895-9d1740c67e06",
"event" : "animal.observation.updated",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:47.072896Z",
"payload" : {
"id" : "obs_4StMC12ApTgRBYYP7iWlxp",
"glossary_id" : "gly_1CMmW8f4k5X8farMhM43IX",
"title" : "Observation Glossary",
"text" : "Example text",
"type" : "severity",
"value" : "Severe",
"observed_at" : "2024-11-22T09:42:47.036440Z",
"study" : {
"id" : "sdy_5YQQLnZos7BnVRWJSVPWUc",
"project_id" : "pjt_14OV1QwxYPJD9H1qGBniII",
"name" : "roSu2h2vxN",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "crC9BXDfKc",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_4JS5bNufhUO3wCoN9gn7EW",
"name" : "e8KDGxyu0l",
"email" : "6rKV217A@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_5ySJ0RV5prC4lm78z7Xvy9",
"name" : "YEV1qdjeM6",
"email" : "qN4h3hJP@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:46.732638Z",
"updated_at" : "2024-11-22T09:42:46.732638Z"
},
"animal" : {
"id" : "aml_75uMhhU69KpByjlWLiFLro",
"study_id" : "sdy_5YQQLnZos7BnVRWJSVPWUc",
"study_group_id" : "grp_7LiPUWMy3zmp3aITzW1Htm",
"cage_id" : "cge_1wnLloWsx34GXbrNiMXQ2",
"catalog" : "A0000001",
"name" : "J1PwknM3tS",
"number" : 1,
"strain" : "bD0zpkSN3y",
"species" : "ErguMjtcfS",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "3Kebq4vUjv",
"ear" : "k4HH1usb3C",
"tag" : "hsS4Zvu40c",
"donor" : "valnBSstSQ",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_7GLCtnZNUUjX75rdswUC7m",
"name" : "ZAuEFjuVpm",
"email" : "MIwdPZhx@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_1kdqcq2OcrY8IEdS1QZ3TI",
"title" : "Found dead",
"comment" : "Bji1rgvPg6"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:46.938732Z",
"updated_at" : "2024-11-22T09:42:46.938732Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_D5nyQazUXT6OryE1exy93",
"name" : "hYEvs Overwatch",
"email" : "0Je8vT14@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:46.706439Z",
"updated_at" : "2024-11-22T09:42:46.706439Z"
},
"created_at" : "2024-11-22T09:42:47.036487Z",
"updated_at" : "2024-11-22T09:42:47.036487Z"
}
}animal.observation.deleted
Triggered when an animal observation is deleted.
{
"id" : "whe_2h0Yd8GYF8Yw30CYTCsNEV",
"client_id" : "5297d9ee-2d1e-455f-a7aa-7129ef505c7a",
"event" : "animal.observation.deleted",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:47.076498Z",
"payload" : {
"id" : "obs_4StMC12ApTgRBYYP7iWlxp",
"glossary_id" : "gly_1CMmW8f4k5X8farMhM43IX",
"title" : "Observation Glossary",
"text" : "Example text",
"type" : "severity",
"value" : "Severe",
"observed_at" : "2024-11-22T09:42:47.036440Z",
"study" : {
"id" : "sdy_5YQQLnZos7BnVRWJSVPWUc",
"project_id" : "pjt_14OV1QwxYPJD9H1qGBniII",
"name" : "roSu2h2vxN",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "crC9BXDfKc",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_4JS5bNufhUO3wCoN9gn7EW",
"name" : "e8KDGxyu0l",
"email" : "6rKV217A@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_5ySJ0RV5prC4lm78z7Xvy9",
"name" : "YEV1qdjeM6",
"email" : "qN4h3hJP@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:46.732638Z",
"updated_at" : "2024-11-22T09:42:46.732638Z"
},
"animal" : {
"id" : "aml_75uMhhU69KpByjlWLiFLro",
"study_id" : "sdy_5YQQLnZos7BnVRWJSVPWUc",
"study_group_id" : "grp_7LiPUWMy3zmp3aITzW1Htm",
"cage_id" : "cge_1wnLloWsx34GXbrNiMXQ2",
"catalog" : "A0000001",
"name" : "J1PwknM3tS",
"number" : 1,
"strain" : "bD0zpkSN3y",
"species" : "ErguMjtcfS",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "3Kebq4vUjv",
"ear" : "k4HH1usb3C",
"tag" : "hsS4Zvu40c",
"donor" : "valnBSstSQ",
"tracking_date" : "2024-11-22",
"terminated_at" : "2024-11-22",
"terminated_by" : {
"id" : "usr_7GLCtnZNUUjX75rdswUC7m",
"name" : "ZAuEFjuVpm",
"email" : "MIwdPZhx@benchling.com",
"timezone" : "UTC"
},
"terminated_reason" : {
"glossary_id" : "gly_1kdqcq2OcrY8IEdS1QZ3TI",
"title" : "Found dead",
"comment" : "Bji1rgvPg6"
},
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:46.938732Z",
"updated_at" : "2024-11-22T09:42:46.938732Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_D5nyQazUXT6OryE1exy93",
"name" : "hYEvs Overwatch",
"email" : "0Je8vT14@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:46.706439Z",
"updated_at" : "2024-11-22T09:42:46.706439Z"
},
"created_at" : "2024-11-22T09:42:47.036487Z",
"updated_at" : "2024-11-22T09:42:47.036487Z"
}
}Animal Sample
animal.sample.created
Triggered when an animal sample is created.
{
"id" : "whe_3ExoH0dUFQP2GmAojtDHYs",
"client_id" : "316e2f83-bd8f-438c-9203-075bde79d2b4",
"event" : "animal.sample.created",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:47.670370Z",
"payload" : {
"id" : "spl_hfSldv447iLeZWhL1U07C",
"sample_id" : "S1811330110",
"type" : "Blood",
"collected_at" : "2024-11-22T11:42:47.639247Z",
"details" : [ {
"key" : "volume",
"unit" : "ml",
"value" : "5"
} ],
"comments" : "A blood sample",
"metadata" : {
"sample-internal-id" : "SMPL-1234"
},
"study" : {
"id" : "sdy_2RuF2JdDz6gyQmz3RMkFAV",
"project_id" : "pjt_7S9ZXR4JzDtZg1gS2nNmYy",
"name" : "Xp0ISceGca",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "SXaxLQbH3x",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_1QgBg8fpRyppPT5vvHI4VL",
"name" : "1koxuYZaVN",
"email" : "9p4vL166@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4omnri4kxPehU3tHmaaxLl",
"name" : "kvIwhDlC4b",
"email" : "qAQHE53t@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:47.355215Z",
"updated_at" : "2024-11-22T09:42:47.355215Z"
},
"animal" : {
"id" : "aml_2wKOHcFelgex2jbbKemH0d",
"study_id" : "sdy_2RuF2JdDz6gyQmz3RMkFAV",
"study_group_id" : "grp_7bJXXEoQyWrIv0oYJvd9Hr",
"cage_id" : "cge_6D61a3TCxmrWKMtLfD9YQP",
"catalog" : "A0000001",
"name" : "SiBy0Fsi3y",
"number" : 1,
"strain" : "pP5eT4nerz",
"species" : "9lk9A8riqz",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "AwjrgRwIrs",
"ear" : "BYyuax6nJO",
"tag" : "LSUZq0sbaY",
"donor" : "uDI715NjkM",
"tracking_date" : "2024-11-22",
"terminated_at" : null,
"terminated_by" : null,
"terminated_reason" : null,
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:47.547496Z",
"updated_at" : "2024-11-22T09:42:47.547496Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_5Qb3xSVwZvnu0gEEpxRDE7",
"name" : "pxaVMBDDem",
"email" : "zADvi21W@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"fohroa7Q4z" : "WLaegoLCwN"
},
"created_at" : "2024-11-22T09:42:47.627674Z",
"updated_at" : "2024-11-22T09:42:47.627674Z"
},
"created_at" : "2024-11-22T09:42:47.639260Z",
"updated_at" : "2024-11-22T09:42:47.639260Z"
}
}animal.sample.updated
Triggered when an animal sample is updated.
{
"id" : "whe_H3yGi2HAotFN6C5G94SXA",
"client_id" : "34f26d4f-3258-4a75-939a-525f2bb073a8",
"event" : "animal.sample.updated",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:47.672828Z",
"payload" : {
"id" : "spl_hfSldv447iLeZWhL1U07C",
"sample_id" : "S1811330110",
"type" : "Blood",
"collected_at" : "2024-11-22T11:42:47.639247Z",
"details" : [ {
"key" : "volume",
"unit" : "ml",
"value" : "5"
} ],
"comments" : "A blood sample",
"metadata" : {
"sample-internal-id" : "SMPL-1234"
},
"study" : {
"id" : "sdy_2RuF2JdDz6gyQmz3RMkFAV",
"project_id" : "pjt_7S9ZXR4JzDtZg1gS2nNmYy",
"name" : "Xp0ISceGca",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "SXaxLQbH3x",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_1QgBg8fpRyppPT5vvHI4VL",
"name" : "1koxuYZaVN",
"email" : "9p4vL166@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4omnri4kxPehU3tHmaaxLl",
"name" : "kvIwhDlC4b",
"email" : "qAQHE53t@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:47.355215Z",
"updated_at" : "2024-11-22T09:42:47.355215Z"
},
"animal" : {
"id" : "aml_2wKOHcFelgex2jbbKemH0d",
"study_id" : "sdy_2RuF2JdDz6gyQmz3RMkFAV",
"study_group_id" : "grp_7bJXXEoQyWrIv0oYJvd9Hr",
"cage_id" : "cge_6D61a3TCxmrWKMtLfD9YQP",
"catalog" : "A0000001",
"name" : "SiBy0Fsi3y",
"number" : 1,
"strain" : "pP5eT4nerz",
"species" : "9lk9A8riqz",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "AwjrgRwIrs",
"ear" : "BYyuax6nJO",
"tag" : "LSUZq0sbaY",
"donor" : "uDI715NjkM",
"tracking_date" : "2024-11-22",
"terminated_at" : null,
"terminated_by" : null,
"terminated_reason" : null,
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:47.547496Z",
"updated_at" : "2024-11-22T09:42:47.547496Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_5Qb3xSVwZvnu0gEEpxRDE7",
"name" : "pxaVMBDDem",
"email" : "zADvi21W@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"fohroa7Q4z" : "WLaegoLCwN"
},
"created_at" : "2024-11-22T09:42:47.627674Z",
"updated_at" : "2024-11-22T09:42:47.627674Z"
},
"created_at" : "2024-11-22T09:42:47.639260Z",
"updated_at" : "2024-11-22T09:42:47.639260Z"
}
}animal.sample.deleted
Triggered when an animal sample is deleted.
{
"id" : "whe_f6NQhayBOdwvJNlnmYjNv",
"client_id" : "6bfa4d43-80ef-4e13-81d3-5c93a4c9887d",
"event" : "animal.sample.deleted",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:47.673891Z",
"payload" : {
"id" : "spl_hfSldv447iLeZWhL1U07C",
"sample_id" : "S1811330110",
"type" : "Blood",
"collected_at" : "2024-11-22T11:42:47.639247Z",
"details" : [ {
"key" : "volume",
"unit" : "ml",
"value" : "5"
} ],
"comments" : "A blood sample",
"metadata" : {
"sample-internal-id" : "SMPL-1234"
},
"study" : {
"id" : "sdy_2RuF2JdDz6gyQmz3RMkFAV",
"project_id" : "pjt_7S9ZXR4JzDtZg1gS2nNmYy",
"name" : "Xp0ISceGca",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "SXaxLQbH3x",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_1QgBg8fpRyppPT5vvHI4VL",
"name" : "1koxuYZaVN",
"email" : "9p4vL166@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4omnri4kxPehU3tHmaaxLl",
"name" : "kvIwhDlC4b",
"email" : "qAQHE53t@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:47.355215Z",
"updated_at" : "2024-11-22T09:42:47.355215Z"
},
"animal" : {
"id" : "aml_2wKOHcFelgex2jbbKemH0d",
"study_id" : "sdy_2RuF2JdDz6gyQmz3RMkFAV",
"study_group_id" : "grp_7bJXXEoQyWrIv0oYJvd9Hr",
"cage_id" : "cge_6D61a3TCxmrWKMtLfD9YQP",
"catalog" : "A0000001",
"name" : "SiBy0Fsi3y",
"number" : 1,
"strain" : "pP5eT4nerz",
"species" : "9lk9A8riqz",
"sex" : "m",
"dob" : "2024-11-21",
"tail" : "AwjrgRwIrs",
"ear" : "BYyuax6nJO",
"tag" : "LSUZq0sbaY",
"donor" : "uDI715NjkM",
"tracking_date" : "2024-11-22",
"terminated_at" : null,
"terminated_by" : null,
"terminated_reason" : null,
"disease_survivor" : null,
"metadata" : {
"animal-internal-id" : "ANIMAL-1234"
},
"created_at" : "2024-11-22T09:42:47.547496Z",
"updated_at" : "2024-11-22T09:42:47.547496Z",
"disease_induction_date" : "2024-11-22"
},
"user" : {
"id" : "usr_5Qb3xSVwZvnu0gEEpxRDE7",
"name" : "pxaVMBDDem",
"email" : "zADvi21W@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"fohroa7Q4z" : "WLaegoLCwN"
},
"created_at" : "2024-11-22T09:42:47.627674Z",
"updated_at" : "2024-11-22T09:42:47.627674Z"
},
"created_at" : "2024-11-22T09:42:47.639260Z",
"updated_at" : "2024-11-22T09:42:47.639260Z"
}
}Cage
cage.created
Triggered when an cage is created.
{
"id" : "whe_ZYluasxcKHFQv0aQTfhUd",
"client_id" : "a96cd201-1451-4dd1-98bb-1302344cce7b",
"event" : "cage.created",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:45.187927Z",
"payload" : {
"id" : "cge_1N8nkG7XICTZ404eEhTdS8",
"name" : "l60bu7SQT4",
"catalog" : "C0000001",
"metadata" : {
"cage-internal-id" : "CAGE-1234"
},
"study" : {
"id" : "sdy_1JMuJhPly9TJeBiiT6zCLL",
"project_id" : "pjt_4XKzwDRHlHJw9CHe9DUAIB",
"name" : "u2YfRfJhem",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "vYTdbud9P8",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5zSG7q3m9sAIix7C7Jk4xi",
"name" : "2XcNO6KKA8",
"email" : "cC69XiGk@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_2ECsI32jrILOUZSHMB85C2",
"name" : "MY2VYrXIHJ",
"email" : "190EuLfV@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:44.980705Z",
"updated_at" : "2024-11-22T09:42:44.980705Z"
},
"created_at" : "2024-11-22T09:42:45.163836Z",
"updated_at" : "2024-11-22T09:42:45.163836Z"
}
}cage.updated
Triggered when an cage is updated.
{
"id" : "whe_3jnCZKD9mj6ztJeLuhItZg",
"client_id" : "e2195b4f-600e-4d08-8f10-b88e50cd8632",
"event" : "cage.updated",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:45.189599Z",
"payload" : {
"id" : "cge_1N8nkG7XICTZ404eEhTdS8",
"name" : "l60bu7SQT4",
"catalog" : "C0000001",
"metadata" : {
"cage-internal-id" : "CAGE-1234"
},
"study" : {
"id" : "sdy_1JMuJhPly9TJeBiiT6zCLL",
"project_id" : "pjt_4XKzwDRHlHJw9CHe9DUAIB",
"name" : "u2YfRfJhem",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "vYTdbud9P8",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5zSG7q3m9sAIix7C7Jk4xi",
"name" : "2XcNO6KKA8",
"email" : "cC69XiGk@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_2ECsI32jrILOUZSHMB85C2",
"name" : "MY2VYrXIHJ",
"email" : "190EuLfV@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:44.980705Z",
"updated_at" : "2024-11-22T09:42:44.980705Z"
},
"created_at" : "2024-11-22T09:42:45.163836Z",
"updated_at" : "2024-11-22T09:42:45.163836Z"
}
}cage.deleted
Triggered when an cage is deleted.
{
"id" : "whe_1T4BATY2BgQf5asCoi527x",
"client_id" : "f476ae06-2394-44cd-9e3a-406a5e8bac63",
"event" : "cage.deleted",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:45.196570Z",
"payload" : {
"id" : "cge_1N8nkG7XICTZ404eEhTdS8",
"name" : "l60bu7SQT4",
"catalog" : "C0000001",
"metadata" : {
"cage-internal-id" : "CAGE-1234"
},
"study" : {
"id" : "sdy_1JMuJhPly9TJeBiiT6zCLL",
"project_id" : "pjt_4XKzwDRHlHJw9CHe9DUAIB",
"name" : "u2YfRfJhem",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "vYTdbud9P8",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5zSG7q3m9sAIix7C7Jk4xi",
"name" : "2XcNO6KKA8",
"email" : "cC69XiGk@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_2ECsI32jrILOUZSHMB85C2",
"name" : "MY2VYrXIHJ",
"email" : "190EuLfV@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:44.980705Z",
"updated_at" : "2024-11-22T09:42:44.980705Z"
},
"created_at" : "2024-11-22T09:42:45.163836Z",
"updated_at" : "2024-11-22T09:42:45.163836Z"
}
}Species
species.created
Triggered when a species is created.
{
"id" : "whe_6n7Emojrvv0nelSP20qqKp",
"client_id" : "51b2cb12-e2cb-4db8-b557-3f3440bad084",
"event" : "species.created",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:48.481843Z",
"payload" : {
"id" : "spc_5NjFQeALUVdzFHBHOIS7ZT",
"name" : "y123GaWbVd",
"active" : true,
"created_at" : "2024-11-22T09:42:48.466289Z",
"updated_at" : "2024-11-22T09:42:48.466289Z"
}
}species.updated
Triggered when a species is updated.
{
"id" : "whe_3f2ImkwAyiCXszM6EO50TS",
"client_id" : "da91383b-8c56-4cc3-b296-dd00186b9712",
"event" : "species.updated",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:48.483161Z",
"payload" : {
"id" : "spc_5NjFQeALUVdzFHBHOIS7ZT",
"name" : "y123GaWbVd",
"active" : true,
"created_at" : "2024-11-22T09:42:48.466289Z",
"updated_at" : "2024-11-22T09:42:48.466289Z"
}
}species.deleted
Triggered when a species is deleted.
{
"id" : "whe_2CLK6tWJFlnP1bLJ1eRIS5",
"client_id" : "9d6e0959-7d23-4876-89aa-6aee35329225",
"event" : "species.deleted",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:48.483852Z",
"payload" : {
"id" : "spc_5NjFQeALUVdzFHBHOIS7ZT",
"name" : "y123GaWbVd",
"active" : true,
"created_at" : "2024-11-22T09:42:48.466289Z",
"updated_at" : "2024-11-22T09:42:48.466289Z"
}
}Strain
strain.created
Triggered when a strain is created.
{
"id" : "whe_29mcm2jywDRevZ71nSHLyQ",
"client_id" : "3c8a6d73-277b-44ff-b2bb-6431c780a240",
"event" : "strain.created",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:48.265919Z",
"payload" : {
"id" : "stn_6F2lKxSoJF2HYB8BVPlM7F",
"name" : "CacjawhKUt",
"species" : {
"id" : "spc_DxsRgiVxXdf17TminlPnU",
"name" : "bcDk4PnyQL",
"active" : true,
"created_at" : "2024-11-22T09:42:48.242541Z",
"updated_at" : "2024-11-22T09:42:48.242541Z"
},
"active" : true,
"created_at" : "2024-11-22T09:42:48.244957Z",
"updated_at" : "2024-11-22T09:42:48.244957Z"
}
}strain.updated
Triggered when a strain is updated.
{
"id" : "whe_667V7gvVbTGSTm40XhSSG4",
"client_id" : "8560df78-27a1-461c-9caa-a03ded9c884c",
"event" : "strain.updated",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:48.267446Z",
"payload" : {
"id" : "stn_6F2lKxSoJF2HYB8BVPlM7F",
"name" : "CacjawhKUt",
"species" : {
"id" : "spc_DxsRgiVxXdf17TminlPnU",
"name" : "bcDk4PnyQL",
"active" : true,
"created_at" : "2024-11-22T09:42:48.242541Z",
"updated_at" : "2024-11-22T09:42:48.242541Z"
},
"active" : true,
"created_at" : "2024-11-22T09:42:48.244957Z",
"updated_at" : "2024-11-22T09:42:48.244957Z"
}
}strain.deleted
Triggered when a strain is deleted.
{
"id" : "whe_4t3mtKxFGe0tzbIm3mxUYd",
"client_id" : "1d1d564f-1dcc-4419-9e2a-aabb29cbda73",
"event" : "strain.deleted",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:48.268250Z",
"payload" : {
"id" : "stn_6F2lKxSoJF2HYB8BVPlM7F",
"name" : "CacjawhKUt",
"species" : {
"id" : "spc_DxsRgiVxXdf17TminlPnU",
"name" : "bcDk4PnyQL",
"active" : true,
"created_at" : "2024-11-22T09:42:48.242541Z",
"updated_at" : "2024-11-22T09:42:48.242541Z"
},
"active" : true,
"created_at" : "2024-11-22T09:42:48.244957Z",
"updated_at" : "2024-11-22T09:42:48.244957Z"
}
}Study
study.created
Triggered when a study is created.
{
"id" : "whe_29LCsHtmoGDsWqIxLLHVTN",
"client_id" : "d2f7b7f3-06e2-4706-aed2-be226036d2fd",
"event" : "study.created",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:46.034681Z",
"payload" : {
"id" : "sdy_6uFOlHEdADExYrOeXbkOv6",
"name" : "gnpbKLd3dg",
"code" : "CD-24-445",
"type" : "internal",
"status" : "in_progress",
"description" : "YBkWjO1cUh",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_22ptzGmWCAIqTXDkGWwsPY",
"name" : "R0cliqbSGQ",
"email" : "4YoOqLg2@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_75cQBQcNyDT9XNA3juIR2o",
"name" : "Ph9fq5CFDb",
"email" : "DhxhP42T@benchling.com",
"timezone" : "UTC"
},
"project" : {
"id" : "pjt_2J6LQwgt62SWhcpPhJFvne",
"name" : "5L2BWha8JG",
"metadata" : {
"project-internal-id" : "PROJ-1234"
},
"created_at" : "2024-11-22T09:42:45.834642Z",
"updated_at" : "2024-11-22T09:42:45.834642Z"
},
"started_on" : "2024-11-22",
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:45.838782Z",
"updated_at" : "2024-11-22T09:42:45.838782Z"
}
}study.updated
Triggered when a study is updated.
{
"id" : "whe_uAbN2YFY7FE8Be0MjJHpk",
"client_id" : "2a6240e6-2eea-4d4e-9f8a-0f0dd88db282",
"event" : "study.updated",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:46.036999Z",
"payload" : {
"id" : "sdy_6uFOlHEdADExYrOeXbkOv6",
"name" : "gnpbKLd3dg",
"code" : "CD-24-445",
"type" : "internal",
"status" : "in_progress",
"description" : "YBkWjO1cUh",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_22ptzGmWCAIqTXDkGWwsPY",
"name" : "R0cliqbSGQ",
"email" : "4YoOqLg2@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_75cQBQcNyDT9XNA3juIR2o",
"name" : "Ph9fq5CFDb",
"email" : "DhxhP42T@benchling.com",
"timezone" : "UTC"
},
"project" : {
"id" : "pjt_2J6LQwgt62SWhcpPhJFvne",
"name" : "5L2BWha8JG",
"metadata" : {
"project-internal-id" : "PROJ-1234"
},
"created_at" : "2024-11-22T09:42:45.834642Z",
"updated_at" : "2024-11-22T09:42:45.834642Z"
},
"started_on" : "2024-11-22",
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:45.838782Z",
"updated_at" : "2024-11-22T09:42:45.838782Z"
}
}study.deleted
Triggered when a study is deleted.
{
"id" : "whe_3jOW6H63UU4ZW7YbdJJ0sG",
"client_id" : "53ae8ef7-c081-42bb-a596-efaaea9c62a6",
"event" : "study.deleted",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:46.037876Z",
"payload" : {
"id" : "sdy_6uFOlHEdADExYrOeXbkOv6",
"name" : "gnpbKLd3dg",
"code" : "CD-24-445",
"type" : "internal",
"status" : "in_progress",
"description" : "YBkWjO1cUh",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_22ptzGmWCAIqTXDkGWwsPY",
"name" : "R0cliqbSGQ",
"email" : "4YoOqLg2@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_75cQBQcNyDT9XNA3juIR2o",
"name" : "Ph9fq5CFDb",
"email" : "DhxhP42T@benchling.com",
"timezone" : "UTC"
},
"project" : {
"id" : "pjt_2J6LQwgt62SWhcpPhJFvne",
"name" : "5L2BWha8JG",
"metadata" : {
"project-internal-id" : "PROJ-1234"
},
"created_at" : "2024-11-22T09:42:45.834642Z",
"updated_at" : "2024-11-22T09:42:45.834642Z"
},
"started_on" : "2024-11-22",
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:45.838782Z",
"updated_at" : "2024-11-22T09:42:45.838782Z"
}
}study.metadata.updated
Triggered when a study metadata is updated.
{
"id" : "whe_2vwHqrrXcYc0QdvdD9cDS0",
"client_id" : "bd4f698c-1797-4c33-a856-8b841b89cf09",
"event" : "study.metadata.updated",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:46.038657Z",
"payload" : {
"id" : "sdy_6uFOlHEdADExYrOeXbkOv6",
"name" : "gnpbKLd3dg",
"code" : "CD-24-445",
"type" : "internal",
"status" : "in_progress",
"description" : "YBkWjO1cUh",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_22ptzGmWCAIqTXDkGWwsPY",
"name" : "R0cliqbSGQ",
"email" : "4YoOqLg2@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_75cQBQcNyDT9XNA3juIR2o",
"name" : "Ph9fq5CFDb",
"email" : "DhxhP42T@benchling.com",
"timezone" : "UTC"
},
"project" : {
"id" : "pjt_2J6LQwgt62SWhcpPhJFvne",
"name" : "5L2BWha8JG",
"metadata" : {
"project-internal-id" : "PROJ-1234"
},
"created_at" : "2024-11-22T09:42:45.834642Z",
"updated_at" : "2024-11-22T09:42:45.834642Z"
},
"started_on" : "2024-11-22",
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:45.838782Z",
"updated_at" : "2024-11-22T09:42:45.838782Z"
}
}Study Group
study.group.created
Triggered when a study group is created.
{
"id" : "whe_64Y3PLw1YqHuinxTrK4kjU",
"client_id" : "2056abaa-f1e6-45e5-8471-31f93cc96c73",
"event" : "study.group.created",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:46.621664Z",
"payload" : {
"id" : "grp_PjLvsAuXqvXmHsyWoUE7K",
"name" : "A",
"no" : 1,
"color" : "#34e8eb",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-internal-id" : "SYSGROUP-A1"
},
"study" : {
"id" : "sdy_66Be0fqEIsUYdU96hp5KdC",
"project_id" : "pjt_5p12u7fG6o8Njs52cS4mks",
"name" : "TG8xyzQW1R",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "5KILz3Bd4J",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5srIwih7ikLWFgbq6fwcu2",
"name" : "LVJ2hmPXKo",
"email" : "vsgJ7tBs@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4lhOPyzzYoBInseBXMqEgx",
"name" : "4jKaBC3QX8",
"email" : "xmckD46u@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:46.413447Z",
"updated_at" : "2024-11-22T09:42:46.413447Z"
},
"created_at" : "2024-11-22T09:42:46.586515Z",
"updated_at" : "2024-11-22T09:42:46.586515Z"
}
}study.group.updated
Triggered when a study group is updated.
{
"id" : "whe_4wRHf9pFu9dkEf0ks1Uzxk",
"client_id" : "809f75e3-a534-4466-b5e7-296333e175b0",
"event" : "study.group.updated",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:46.623067Z",
"payload" : {
"id" : "grp_PjLvsAuXqvXmHsyWoUE7K",
"name" : "A",
"no" : 1,
"color" : "#34e8eb",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-internal-id" : "SYSGROUP-A1"
},
"study" : {
"id" : "sdy_66Be0fqEIsUYdU96hp5KdC",
"project_id" : "pjt_5p12u7fG6o8Njs52cS4mks",
"name" : "TG8xyzQW1R",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "5KILz3Bd4J",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5srIwih7ikLWFgbq6fwcu2",
"name" : "LVJ2hmPXKo",
"email" : "vsgJ7tBs@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4lhOPyzzYoBInseBXMqEgx",
"name" : "4jKaBC3QX8",
"email" : "xmckD46u@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:46.413447Z",
"updated_at" : "2024-11-22T09:42:46.413447Z"
},
"created_at" : "2024-11-22T09:42:46.586515Z",
"updated_at" : "2024-11-22T09:42:46.586515Z"
}
}study.group.deleted
Triggered when a study group is deleted.
{
"id" : "whe_4Nrh6VZf9KGoJ46UmTWLIv",
"client_id" : "4d4a562f-a80c-4be9-b2ca-0aa95d830327",
"event" : "study.group.deleted",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:46.623965Z",
"payload" : {
"id" : "grp_PjLvsAuXqvXmHsyWoUE7K",
"name" : "A",
"no" : 1,
"color" : "#34e8eb",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-internal-id" : "SYSGROUP-A1"
},
"study" : {
"id" : "sdy_66Be0fqEIsUYdU96hp5KdC",
"project_id" : "pjt_5p12u7fG6o8Njs52cS4mks",
"name" : "TG8xyzQW1R",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "5KILz3Bd4J",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5srIwih7ikLWFgbq6fwcu2",
"name" : "LVJ2hmPXKo",
"email" : "vsgJ7tBs@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4lhOPyzzYoBInseBXMqEgx",
"name" : "4jKaBC3QX8",
"email" : "xmckD46u@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:46.413447Z",
"updated_at" : "2024-11-22T09:42:46.413447Z"
},
"created_at" : "2024-11-22T09:42:46.586515Z",
"updated_at" : "2024-11-22T09:42:46.586515Z"
}
}Study Request
study.request.created
Triggered when a request is created.
{
"id" : "whe_2cRd8VpkvF0VSzP0TD4Iw8",
"client_id" : "5f3d8ff6-441c-4d51-9705-83c62f5424e3",
"event" : "study.request.created",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:44.949304Z",
"payload" : {
"id" : "req_4sNlbd6ORAGmWajqCgesn0",
"user_id" : "usr_bg76TT5KcyTA3mGsz0atV",
"assigned_user_id" : "usr_bg76TT5KcyTA3mGsz0atV",
"status" : "pending",
"due_date" : "2024-11-22",
"groups" : [ {
"ref" : "fiRw5zyYKM",
"label" : "KyoaFJBlVt"
} ],
"fields" : [ {
"group_ref" : "fiRw5zyYKM",
"label" : "77OQVPaiqm",
"value" : "51HNFhvI72",
"options" : [ null ]
} ],
"study" : {
"id" : "sdy_6SCcXfltGEKV2hJPOi3ipV",
"project_id" : "pjt_2hnFRcd0KeE8sxRqDmjc4g",
"name" : "dZAgyFtrtc",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "W4WYOF31TP",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_7jdj4beZsGytdlEUBIHnof",
"name" : "ralfTgqf0Q",
"email" : "KeceeQRG@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_1zPmFOw5f4P4MnU0fZfbC",
"name" : "vxfR2wIQ8W",
"email" : "7jxgnoKG@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:44.651216Z",
"updated_at" : "2024-11-22T09:42:44.651216Z"
},
"created_at" : "2024-11-22T09:42:44.921865Z",
"updated_at" : "2024-11-22T09:42:44.921865Z"
}
}study.request.updated
Triggered when a request is updated.
{
"id" : "whe_4NkoiPvKsVikOCJVeNugq4",
"client_id" : "29e208a5-068b-4a3c-a0b2-8a0a5313be62",
"event" : "study.request.updated",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:44.955175Z",
"payload" : {
"id" : "req_4sNlbd6ORAGmWajqCgesn0",
"user_id" : "usr_bg76TT5KcyTA3mGsz0atV",
"assigned_user_id" : "usr_bg76TT5KcyTA3mGsz0atV",
"status" : "pending",
"due_date" : "2024-11-22",
"groups" : [ {
"ref" : "fiRw5zyYKM",
"label" : "KyoaFJBlVt"
} ],
"fields" : [ {
"group_ref" : "fiRw5zyYKM",
"label" : "77OQVPaiqm",
"value" : "51HNFhvI72",
"options" : [ null ]
} ],
"study" : {
"id" : "sdy_6SCcXfltGEKV2hJPOi3ipV",
"project_id" : "pjt_2hnFRcd0KeE8sxRqDmjc4g",
"name" : "dZAgyFtrtc",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "W4WYOF31TP",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_7jdj4beZsGytdlEUBIHnof",
"name" : "ralfTgqf0Q",
"email" : "KeceeQRG@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_1zPmFOw5f4P4MnU0fZfbC",
"name" : "vxfR2wIQ8W",
"email" : "7jxgnoKG@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:44.651216Z",
"updated_at" : "2024-11-22T09:42:44.651216Z"
},
"created_at" : "2024-11-22T09:42:44.921865Z",
"updated_at" : "2024-11-22T09:42:44.921865Z"
}
}study.request.deleted
Triggered when a request is deleted.
{
"id" : "whe_3CQ6puoagkfcz5pGl0LrfC",
"client_id" : "05b2ed1b-4cf1-4257-a437-a60e79d47da6",
"event" : "study.request.deleted",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:44.957828Z",
"payload" : {
"id" : "req_4sNlbd6ORAGmWajqCgesn0",
"user_id" : "usr_bg76TT5KcyTA3mGsz0atV",
"assigned_user_id" : "usr_bg76TT5KcyTA3mGsz0atV",
"status" : "pending",
"due_date" : "2024-11-22",
"groups" : [ {
"ref" : "fiRw5zyYKM",
"label" : "KyoaFJBlVt"
} ],
"fields" : [ {
"group_ref" : "fiRw5zyYKM",
"label" : "77OQVPaiqm",
"value" : "51HNFhvI72",
"options" : [ null ]
} ],
"study" : {
"id" : "sdy_6SCcXfltGEKV2hJPOi3ipV",
"project_id" : "pjt_2hnFRcd0KeE8sxRqDmjc4g",
"name" : "dZAgyFtrtc",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "W4WYOF31TP",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_7jdj4beZsGytdlEUBIHnof",
"name" : "ralfTgqf0Q",
"email" : "KeceeQRG@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_1zPmFOw5f4P4MnU0fZfbC",
"name" : "vxfR2wIQ8W",
"email" : "7jxgnoKG@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:44.651216Z",
"updated_at" : "2024-11-22T09:42:44.651216Z"
},
"created_at" : "2024-11-22T09:42:44.921865Z",
"updated_at" : "2024-11-22T09:42:44.921865Z"
}
}Study Treatment
study.treatment.created
Triggered when a treatment is created.
{
"id" : "whe_1y2wX2fF69EiIIV6JVyNDv",
"client_id" : "2ceb8f4c-8359-489e-aa56-9f5dd1ca13b7",
"event" : "study.treatment.created",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:48.030567Z",
"payload" : {
"id" : "tmt_1kgS5LO4MnHNQhMJJZ20OW",
"type" : "concentration_vgkg",
"name" : "gBWxGxlxYX",
"external_entity_id" : "lI1ad3vL6B",
"dose" : {
"unit" : "mg/kg",
"value" : "5",
"display_unit" : "mg/kg",
"display_value" : "5"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "15",
"display_unit" : "ml/kg",
"display_value" : "15"
},
"stock" : {
"unit" : "mg/ml",
"value" : "10",
"display_unit" : "mg/ml",
"display_value" : "10"
},
"volume" : {
"unit" : "µl",
"value" : "8",
"display_unit" : "µl",
"display_value" : "8"
},
"metadata" : {
"treatment-internal-id" : "TREATMENT-1234"
},
"study" : {
"id" : "sdy_6fIBn9h1vQRi3wVb2oUmH2",
"project_id" : "pjt_7mXfRpENFF2k77oWRiMsAP",
"name" : "WaYa7t7w62",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "daRqM9honC",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5QD5JdPyGL30ctsswdnueL",
"name" : "mpdEAcVknD",
"email" : "6T87AUyS@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_6wugDAHmdYVsvZNZrfwYVr",
"name" : "CWGIfm0tyD",
"email" : "D2fGaKDz@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:47.702349Z",
"updated_at" : "2024-11-22T09:42:47.702349Z"
},
"created_at" : "2024-11-22T09:42:48.001779Z",
"updated_at" : "2024-11-22T09:42:48.001779Z"
}
}study.treatment.updated
Triggered when a treatment is updated.
{
"id" : "whe_5mQBHagC5HV8SzTnP85zOj",
"client_id" : "4409de71-c2a1-44ac-ae6c-f815872b090f",
"event" : "study.treatment.updated",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:48.033146Z",
"payload" : {
"id" : "tmt_1kgS5LO4MnHNQhMJJZ20OW",
"type" : "concentration_vgkg",
"name" : "gBWxGxlxYX",
"external_entity_id" : "lI1ad3vL6B",
"dose" : {
"unit" : "mg/kg",
"value" : "5",
"display_unit" : "mg/kg",
"display_value" : "5"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "15",
"display_unit" : "ml/kg",
"display_value" : "15"
},
"stock" : {
"unit" : "mg/ml",
"value" : "10",
"display_unit" : "mg/ml",
"display_value" : "10"
},
"volume" : {
"unit" : "µl",
"value" : "8",
"display_unit" : "µl",
"display_value" : "8"
},
"metadata" : {
"treatment-internal-id" : "TREATMENT-1234"
},
"study" : {
"id" : "sdy_6fIBn9h1vQRi3wVb2oUmH2",
"project_id" : "pjt_7mXfRpENFF2k77oWRiMsAP",
"name" : "WaYa7t7w62",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "daRqM9honC",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5QD5JdPyGL30ctsswdnueL",
"name" : "mpdEAcVknD",
"email" : "6T87AUyS@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_6wugDAHmdYVsvZNZrfwYVr",
"name" : "CWGIfm0tyD",
"email" : "D2fGaKDz@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:47.702349Z",
"updated_at" : "2024-11-22T09:42:47.702349Z"
},
"created_at" : "2024-11-22T09:42:48.001779Z",
"updated_at" : "2024-11-22T09:42:48.001779Z"
}
}study.treatment.deleted
Triggered when a treatment is deleted.
{
"id" : "whe_57pM26DYenmGsIbhybHENG",
"client_id" : "c6d7b9b0-28ea-49e8-8ce0-0e3e6477572d",
"event" : "study.treatment.deleted",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:48.034118Z",
"payload" : {
"id" : "tmt_1kgS5LO4MnHNQhMJJZ20OW",
"type" : "concentration_vgkg",
"name" : "gBWxGxlxYX",
"external_entity_id" : "lI1ad3vL6B",
"dose" : {
"unit" : "mg/kg",
"value" : "5",
"display_unit" : "mg/kg",
"display_value" : "5"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "15",
"display_unit" : "ml/kg",
"display_value" : "15"
},
"stock" : {
"unit" : "mg/ml",
"value" : "10",
"display_unit" : "mg/ml",
"display_value" : "10"
},
"volume" : {
"unit" : "µl",
"value" : "8",
"display_unit" : "µl",
"display_value" : "8"
},
"metadata" : {
"treatment-internal-id" : "TREATMENT-1234"
},
"study" : {
"id" : "sdy_6fIBn9h1vQRi3wVb2oUmH2",
"project_id" : "pjt_7mXfRpENFF2k77oWRiMsAP",
"name" : "WaYa7t7w62",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "daRqM9honC",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5QD5JdPyGL30ctsswdnueL",
"name" : "mpdEAcVknD",
"email" : "6T87AUyS@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_6wugDAHmdYVsvZNZrfwYVr",
"name" : "CWGIfm0tyD",
"email" : "D2fGaKDz@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:47.702349Z",
"updated_at" : "2024-11-22T09:42:47.702349Z"
},
"created_at" : "2024-11-22T09:42:48.001779Z",
"updated_at" : "2024-11-22T09:42:48.001779Z"
}
}study.treatment.assigned
Triggered when a treatment is assigned to a study group.
{
"id" : "whe_5c0OyQv8yodgtfhGNYtSnt",
"client_id" : "b008ffd7-7de5-42ec-97be-45c71ce5274f",
"event" : "study.treatment.assigned",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:47.335120Z",
"payload" : {
"treatment" : {
"id" : "tmt_7TA7oS7TfiBR4l2SzqNRWD",
"type" : "concentration_mlkg",
"name" : "Rlxz19i5OO",
"external_entity_id" : "NgyVAIXn9Y",
"dose" : {
"unit" : "mg/kg",
"value" : "5",
"display_unit" : "mg/kg",
"display_value" : "5"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "15",
"display_unit" : "ml/kg",
"display_value" : "15"
},
"stock" : {
"unit" : "mg/ml",
"value" : "10",
"display_unit" : "mg/ml",
"display_value" : "10"
},
"volume" : {
"unit" : "µl",
"value" : "8",
"display_unit" : "µl",
"display_value" : "8"
},
"metadata" : {
"treatment-internal-id" : "TREATMENT-1234"
},
"study" : {
"id" : "sdy_4fqDhX39Gsgg9dGirWkr3E",
"project_id" : "pjt_7gWC4NU5Px6UnWfdkG1EBY",
"name" : "1O0i91DyW2",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "p0ZgnjcUJC",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5p0XBXEwO1PFLidG2UMyxd",
"name" : "Lov43vZ3sl",
"email" : "Iy2x69Gt@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4tFgIC4Ms4C4rE9TFtoeJp",
"name" : "fbnydPMy3y",
"email" : "vWC57HNx@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:47.119527Z",
"updated_at" : "2024-11-22T09:42:47.119527Z"
},
"created_at" : "2024-11-22T09:42:47.321436Z",
"updated_at" : "2024-11-22T09:42:47.321436Z"
},
"study_group" : {
"id" : "grp_3oTxrqJ1RCwNGpgmKZKEic",
"name" : "IwouBQCtoU",
"no" : 2032886631,
"color" : "#82918a",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-external-id" : "GROUP-1234"
},
"study" : {
"id" : "sdy_4fqDhX39Gsgg9dGirWkr3E",
"project_id" : "pjt_7gWC4NU5Px6UnWfdkG1EBY",
"name" : "1O0i91DyW2",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "p0ZgnjcUJC",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5p0XBXEwO1PFLidG2UMyxd",
"name" : "Lov43vZ3sl",
"email" : "Iy2x69Gt@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4tFgIC4Ms4C4rE9TFtoeJp",
"name" : "fbnydPMy3y",
"email" : "vWC57HNx@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:47.119527Z",
"updated_at" : "2024-11-22T09:42:47.119527Z"
},
"created_at" : "2024-11-22T09:42:47.299484Z",
"updated_at" : "2024-11-22T09:42:47.299484Z"
}
}
}study.treatment.unassigned
Triggered when a treatment is unassigned from a study group.
{
"id" : "whe_6zE6a1yuqJPXYte74RM0dt",
"client_id" : "cd64fa75-9433-4eb0-af17-ef84fae748ae",
"event" : "study.treatment.unassigned",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:47.337335Z",
"payload" : {
"treatment" : {
"id" : "tmt_7TA7oS7TfiBR4l2SzqNRWD",
"type" : "concentration_mlkg",
"name" : "Rlxz19i5OO",
"external_entity_id" : "NgyVAIXn9Y",
"dose" : {
"unit" : "mg/kg",
"value" : "5",
"display_unit" : "mg/kg",
"display_value" : "5"
},
"dose_volume" : {
"unit" : "ml/kg",
"value" : "15",
"display_unit" : "ml/kg",
"display_value" : "15"
},
"stock" : {
"unit" : "mg/ml",
"value" : "10",
"display_unit" : "mg/ml",
"display_value" : "10"
},
"volume" : {
"unit" : "µl",
"value" : "8",
"display_unit" : "µl",
"display_value" : "8"
},
"metadata" : {
"treatment-internal-id" : "TREATMENT-1234"
},
"study" : {
"id" : "sdy_4fqDhX39Gsgg9dGirWkr3E",
"project_id" : "pjt_7gWC4NU5Px6UnWfdkG1EBY",
"name" : "1O0i91DyW2",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "p0ZgnjcUJC",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5p0XBXEwO1PFLidG2UMyxd",
"name" : "Lov43vZ3sl",
"email" : "Iy2x69Gt@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4tFgIC4Ms4C4rE9TFtoeJp",
"name" : "fbnydPMy3y",
"email" : "vWC57HNx@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:47.119527Z",
"updated_at" : "2024-11-22T09:42:47.119527Z"
},
"created_at" : "2024-11-22T09:42:47.321436Z",
"updated_at" : "2024-11-22T09:42:47.321436Z"
},
"study_group" : {
"id" : "grp_3oTxrqJ1RCwNGpgmKZKEic",
"name" : "IwouBQCtoU",
"no" : 2032886631,
"color" : "#82918a",
"max_animals" : 10,
"control" : false,
"metadata" : {
"study-group-external-id" : "GROUP-1234"
},
"study" : {
"id" : "sdy_4fqDhX39Gsgg9dGirWkr3E",
"project_id" : "pjt_7gWC4NU5Px6UnWfdkG1EBY",
"name" : "1O0i91DyW2",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "p0ZgnjcUJC",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_5p0XBXEwO1PFLidG2UMyxd",
"name" : "Lov43vZ3sl",
"email" : "Iy2x69Gt@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_4tFgIC4Ms4C4rE9TFtoeJp",
"name" : "fbnydPMy3y",
"email" : "vWC57HNx@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:47.119527Z",
"updated_at" : "2024-11-22T09:42:47.119527Z"
},
"created_at" : "2024-11-22T09:42:47.299484Z",
"updated_at" : "2024-11-22T09:42:47.299484Z"
}
}
}Study User
study.user.created
Triggered when a study user is created.
{
"id" : "whe_1rFWnQgCOuQMwMzQQ0qwrK",
"client_id" : "15e9faa9-818c-49fe-ab86-6b9975893cec",
"event" : "study.user.created",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:48.878983Z",
"payload" : {
"id" : "usr_hT3SAVC6olcZM3i9RTTd5",
"name" : "Y386EyRsWu",
"email" : "AucItSy4@benchling.com",
"timezone" : "UTC",
"type" : "author",
"access" : "write",
"study" : {
"id" : "sdy_45Bb588TxhdWRI1DczkWmX",
"project_id" : "pjt_2vY4hRGTgPEpmwwgcvmsJI",
"name" : "HFYpuhkvhi",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "rqInGnj8Kb",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_hT3SAVC6olcZM3i9RTTd5",
"name" : "Y386EyRsWu",
"email" : "AucItSy4@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_nDoEYTc4tAydpJAAUd98M",
"name" : "1rSkOll1c0",
"email" : "Vb24JNMe@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:48.507748Z",
"updated_at" : "2024-11-22T09:42:48.507748Z"
}
}
}study.user.updated
Triggered when a study user is updated.
{
"id" : "whe_4x68VEeB886bF7IgcHT6pG",
"client_id" : "c3a4625d-7372-422b-bed4-e44e991a9cc5",
"event" : "study.user.updated",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:48.880410Z",
"payload" : {
"id" : "usr_hT3SAVC6olcZM3i9RTTd5",
"name" : "Y386EyRsWu",
"email" : "AucItSy4@benchling.com",
"timezone" : "UTC",
"type" : "author",
"access" : "write",
"study" : {
"id" : "sdy_45Bb588TxhdWRI1DczkWmX",
"project_id" : "pjt_2vY4hRGTgPEpmwwgcvmsJI",
"name" : "HFYpuhkvhi",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "rqInGnj8Kb",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_hT3SAVC6olcZM3i9RTTd5",
"name" : "Y386EyRsWu",
"email" : "AucItSy4@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_nDoEYTc4tAydpJAAUd98M",
"name" : "1rSkOll1c0",
"email" : "Vb24JNMe@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:48.507748Z",
"updated_at" : "2024-11-22T09:42:48.507748Z"
}
}
}study.user.deleted
Triggered when a study user is deleted.
{
"id" : "whe_3XjvOWnXiOY5srciJne3sj",
"client_id" : "c6a8f799-1615-4f5d-9eb3-4ac5cb33b88b",
"event" : "study.user.deleted",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:48.882183Z",
"payload" : {
"id" : "usr_hT3SAVC6olcZM3i9RTTd5",
"name" : "Y386EyRsWu",
"email" : "AucItSy4@benchling.com",
"timezone" : "UTC",
"type" : "author",
"access" : "write",
"study" : {
"id" : "sdy_45Bb588TxhdWRI1DczkWmX",
"project_id" : "pjt_2vY4hRGTgPEpmwwgcvmsJI",
"name" : "HFYpuhkvhi",
"code" : "CD-24-445",
"type" : "internal",
"started_on" : "2024-11-22",
"status" : "in_progress",
"description" : "rqInGnj8Kb",
"timezone" : "America/Los_Angeles",
"metadata" : {
"study-internal-id" : "STUDY-1234"
},
"author" : {
"id" : "usr_hT3SAVC6olcZM3i9RTTd5",
"name" : "Y386EyRsWu",
"email" : "AucItSy4@benchling.com",
"timezone" : "UTC"
},
"owner" : {
"id" : "usr_nDoEYTc4tAydpJAAUd98M",
"name" : "1rSkOll1c0",
"email" : "Vb24JNMe@benchling.com",
"timezone" : "UTC"
},
"completed_at" : null,
"canceled_at" : null,
"created_at" : "2024-11-22T09:42:48.507748Z",
"updated_at" : "2024-11-22T09:42:48.507748Z"
}
}
}User
user.created
Triggered when a user is created on a team.
{
"id" : "whe_5UO1F8zUF7YzuacZcZX688",
"client_id" : "c73be3b2-a7db-4718-9849-7eea8ea39f64",
"event" : "user.created",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:48.997840Z",
"payload" : {
"id" : "usr_3Nh2dJIh3tor1g3AZqmbIG",
"name" : "5HST5 Overwatch",
"email" : "qTonf0Xy@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:48.964277Z",
"updated_at" : "2024-11-22T09:42:48.964277Z"
}
}user.updated
Triggered when a user is updated on a team.
{
"id" : "whe_4OfQRHQy4itmJuYP7dvhIm",
"client_id" : "be030ee5-5033-434c-b5fb-fb95aa50b016",
"event" : "user.updated",
"version" : "2022-12-14",
"created_at" : "2024-11-22T09:42:48.999751Z",
"payload" : {
"id" : "usr_3Nh2dJIh3tor1g3AZqmbIG",
"name" : "5HST5 Overwatch",
"email" : "qTonf0Xy@benchling.com",
"timezone" : "UTC",
"status" : "active",
"metadata" : {
"user-internal-id" : "USER-1234"
},
"created_at" : "2024-11-22T09:42:48.964277Z",
"updated_at" : "2024-11-22T09:42:48.964277Z"
}
}