Project Lexicon - Polarix.io

Retrieves Project lexicon 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

preferred_term

string

required

preferred_term_note

string | null

required

non_preferred_term

string

required

non_preferred_term_note

null

required

rationale

string

required

example

string

required

project_id

integer

required

user_id

integer

required

Example

[
    {
        "id": 1,
        "preferred_term": "GBM",
        "preferred_term_note": "Use the accronym",
        "non_preferred_term": "Glioblastoma Multiforme",
        "non_preferred_term_note": null,
        "rationale": "Makes documents less wordy and we’re looking to standardise the language and the way it is used.",
        "example": "GBM is the most common form of primary malignant brain tumor in adults.",
        "project_id": 1,
        "user_id": 1
    },
    {
        "id": 2,
        "preferred_term": "Real-word evidence, RWE",
        "preferred_term_note": null,
        "non_preferred_term": "Real life evidence",
        "non_preferred_term_note": null,
        "rationale": "The clinical evidence regarding the usage and potential benefits or risks of a medical product derived from analysis of real-world data.",
        "example": "Real-world evidence can be generated by different study designs or analyses, including but not limited to randomized trials, including large simple trials, pragmatic trials, and observational studies (prospective and/or retrospective).",
        "project_id": 1,
        "user_id": 1
    }
]

🟢200Success — XML

🟠401Unauthorized — JSON

🟠401Unauthorized — XML

🔴500Server Error — JSON

🔴500Server Error — XML