Project Abbreviations

Retrieves Project glossary based on the {project_id} path parameter. Project ID is retrieved by calling the "Project List" endpoint.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

version

number

required

Target API version

Example:

project_id

string

required

Project ID retrieved by calling the "Project List" endpoint

Example:

6582ed0344adfe123d04f772

Header Params

x-api-key

string

required

Example:

1234abcd

string

optional

use text/xml if XML is required

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success — JSON

application/json

Body

array of:

integer

required

project_id

integer

required

code

string

required

text

string

required

created_at

string

required

updated_at

string

required

deleted_at

null

required

item_content

null

required

Example

[
    {
        "id": 1,
        "project_id": 1,
        "code": "GBM",
        "text": "Glioblastoma Multiforme",
        "created_at": "2022-10-23T12:00:30.000000Z",
        "updated_at": "2022-10-23T12:00:30.000000Z",
        "deleted_at": null,
        "item_content": null
    },
    {
        "id": 103,
        "project_id": 1,
        "code": "WHO",
        "text": "World Health Organisation",
        "created_at": "2023-02-09T12:22:52.000000Z",
        "updated_at": "2023-02-09T12:22:52.000000Z",
        "deleted_at": null,
        "item_content": null
    },
    {
        "id": 330,
        "project_id": 1,
        "code": "MRI",
        "text": "Magnetic resonance imaging",
        "created_at": "2023-03-15T11:06:09.000000Z",
        "updated_at": "2023-03-15T11:06:09.000000Z",
        "deleted_at": null,
        "item_content": null
    },
    {
        "id": 331,
        "project_id": 1,
        "code": "response",
        "text": "sehjdfbjshdvcjasdhfgsvhadgf",
        "created_at": "2023-03-15T13:59:04.000000Z",
        "updated_at": "2023-03-15T13:59:04.000000Z",
        "deleted_at": null,
        "item_content": null
    },
    {
        "id": 355,
        "project_id": 1,
        "code": "AE",
        "text": "Adverse Event",
        "created_at": "2023-03-31T11:14:58.000000Z",
        "updated_at": "2023-03-31T11:14:58.000000Z",
        "deleted_at": null,
        "item_content": null
    },
    {
        "id": 671,
        "project_id": 1,
        "code": "CNS",
        "text": "central nervous system",
        "created_at": "2023-07-10T13:37:25.000000Z",
        "updated_at": "2023-07-10T13:37:25.000000Z",
        "deleted_at": null,
        "item_content": null
    },
    {
        "id": 772,
        "project_id": 1,
        "code": "US",
        "text": "United States",
        "created_at": "2023-07-31T15:38:40.000000Z",
        "updated_at": "2023-07-31T15:38:40.000000Z",
        "deleted_at": null,
        "item_content": null
    }
]

🟢200Success — XML

🟠401Unauthorized — JSON

🟠401Unauthorized — XML

🔴500Server Error — JSON

🔴500Server Error — XML