Polarix.io
    Polarix.io
    • Introduction to the Polarix.io API
    • Polarix.io Interface & Branding
    • Authentication
      POST
    • Users
      GET
    • Project List
      GET
    • Project
      GET
    • Project Structure
      GET
    • Project Lexicon
      GET
    • Project Glossary
      GET
    • Project Tags
      GET
    • Project Items
      GET
    • Project Abbreviations
      GET
    • Project References
      GET
    • Project History
      GET

      Project Glossary

      LIVE
      https://app.polarix.io
      LIVE
      https://app.polarix.io
      GET
      https://app.polarix.io
      /api/{version}/projects/{project_id}/glossary
      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:
      {{version}}
      project_id
      string 
      required
      Project ID retrieved by calling the "Project List" endpoint
      Example:
      6582ed0344adfe123d04f772
      Header Params
      x-api-key
      string 
      required
      Example:
      1234abcd
      Accept
      string 
      optional
      use text/xml if XML is required
      Example:
      application/json

      Request samples

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location -g --request GET 'https://app.polarix.io/api/1.0/projects/6582ed0344adfe123d04f772/glossary' \
      --header 'x-api-key: 1234abcd' \
      --header 'Accept: application/json'

      Responses

      🟢200Success — JSON
      application/json
      Body
      array of:
      id
      integer 
      required
      project_id
      integer 
      required
      term
      string 
      required
      description
      string 
      required
      Example
      [
          {
              "id": 1,
              "project_id": 1,
              "term": "Mode of Action",
              "description": "In pharmacology, the term mechanism of action refers to the specific biochemical interaction through which a drug substance produces its pharmacological effect. A mechanism of action usually includes mention of the specific molecular targets to which the drug binds, such as an enzyme or receptor."
          },
          {
              "id": 2,
              "project_id": 1,
              "term": "Glioblastoma",
              "description": "Glioblastoma, previously known as glioblastoma multiforme (GBM), is the most aggressive and most common type of cancer that originates in the brain, and has very poor prognosis for survival. Initial signs and symptoms of glioblastoma are nonspecific. They may include headaches, personality changes, nausea, and symptoms similar to those of a stroke. Symptoms often worsen rapidly and may progress to unconsciousness."
          }
      ]
      🟢200Success — XML
      🟠401Unauthorized — JSON
      🟠401Unauthorized — XML
      🔴500Server Error — JSON
      🔴500Server Error — XML
      Previous
      Project Lexicon
      Next
      Project Tags
      Built with