openapi: 3.2.0
info:
  title: MedDRA API EUS SBX Export API
  description: Web API to access MedDRA Data
  contact:
    name: Web Admin
    url: http://www.meddra.org/
    email: wadmin@meddra.org
  version: '1'
security:
- oauth2:
  - meddraapi
tags:
- name: Export
paths:
  /api/export:
    post:
      tags:
      - Export
      summary: Returns Term objects for Search Export
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/exportDTO'
          application/json:
            schema:
              $ref: '#/components/schemas/exportDTO'
          text/json:
            schema:
              $ref: '#/components/schemas/exportDTO'
          application/*+json:
            schema:
              $ref: '#/components/schemas/exportDTO'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rbinDTO'
        200 type=1:
          description: List of historyRDTO
        200 type=10:
          description: historyDTO
        400 v1:
          description: Failed Model Validation
        400 v2:
          description: Language/Version Does Not exist
        400 v3:
          description: Insufficient Authorization
        400 v4:
          description: Invalid Input
        '401':
          description: Unauthorized Access
        '429':
          description: The throttling limit on this API has been exceeded.  Please review the MedDRA API documentation on throttling limits.
        '500':
          description: Internal Server Error
      operationId: postApiExport
      x-operation-id-source: derived
components:
  schemas:
    exportDTO:
      required:
      - bview
      - etype
      - kana
      - language
      - rsview
      - version
      type: object
      properties:
        bview:
          type: string
          description: '[Required]

            Acceptable Browser Views

            SOC/SMQ'
        rsview:
          type: string
          description: '[Required]

            Acceptable Release views

            release'
        language:
          type: string
          description: '[Required]

            Release Version to use.

            Refer to Release API for valid Language/Version Combinations.'
        etype:
          type: integer
          description: 'Future use.

            [Required]

            Determine type of Export

            1 - regular Export.'
          format: int32
        addlangs:
          type:
          - array
          - 'null'
          items:
            type: string
          description: 'Array for Additional  translations to return.

            Refer to the Language API for valid inputs'
        version:
          type: number
          description: '[Required]

            Release Version to use.

            Refer to Release API for valid Language/Version Combinations.'
          format: double
        kana:
          type: boolean
          description: Japanese only whether to return Kana Translation.
        smq:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
          description: Add code(s) to include SMQs in the Export Results.
        hlgt:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
          description: Add code(s) to include HLGTs in the Export Results.
        hlt:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
          description: Add code(s) to include HLTs in the Export Results.
        pt:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
          description: Add code(s) to include PTs in the Export Results.
        llt:
          type:
          - array
          - 'null'
          items:
            type: integer
            format: int32
          description: Add code(s) to include LLTs in the Export Results.
      additionalProperties: false
      description: Model for advanced search terms and types
    rbinDTO:
      type: object
      properties:
        c:
          type:
          - string
          - 'null'
          description: Term Code.
        t:
          type:
          - string
          - 'null'
          description: Term Name.
        lv:
          type:
          - string
          - 'null'
          description: 'Level of requested term

            SOC/HLGT/HLT/PT/LLT'
        sc:
          type:
          - string
          - 'null'
          description: SOC Code.
        st:
          type:
          - string
          - 'null'
          description: SOC Term Name.
        hgc:
          type:
          - string
          - 'null'
          description: HLGT Code.
        hgt:
          type:
          - string
          - 'null'
          description: HLGT Term Name.
        hc:
          type:
          - string
          - 'null'
          description: HLT Code.
        ht:
          type:
          - string
          - 'null'
          description: HLT Term Name.
        pc:
          type:
          - string
          - 'null'
          description: PT Code.
        pt:
          type:
          - string
          - 'null'
          description: PT Term Name.
        lc:
          type:
          - string
          - 'null'
          description: LLT Code.
        lt:
          type:
          - string
          - 'null'
          description: LLT Term Name.
        tc:
          type:
          - string
          - 'null'
          description: Term Currency.
        jc:
          type:
          - string
          - 'null'
          description: Japanese Currency.
        l:
          type:
          - string
          - 'null'
          description: Term Language.
        v:
          type:
          - string
          - 'null'
          description: Term Version.
        ps:
          type:
          - string
          - 'null'
          description: Primary SOC.
      additionalProperties: false
      description: Model for Returning Research Bin Terms.
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://mid.meddra.org/connect/authorize
          scopes:
            meddraapi: Meddra API - full access