openapi: 3.2.0
info:
  description: REST API for the Clinical Knowledge Manager.
  version: 1.6.0
  title: CKM REST Subdomains API
  contact:
    name: CKM Support
    url: https://oceanehr.atlassian.net/servicedesk/customer/portal/15
    email: ckm@oceaninformatics.com
servers:
- url: /ckm/rest/v1
tags:
- name: Subdomains
  description: Endpoint for subdomain-related services, including listing and getting subdomains.
paths:
  /subdomains/{cid-subdomain}:
    get:
      tags:
      - Subdomains
      summary: Gets the main data of one CKM subdomain
      description: ''
      operationId: getSubdomain
      parameters:
      - name: cid-subdomain
        in: path
        description: The citeable identifier of the subdomain.
        required: true
        schema:
          type: string
      security:
      - basicAuth: []
      - sessionid: []
      responses:
        '200':
          description: Successful retrieval of the subdomain's main data.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/Subdomain'
            application/json:
              schema:
                $ref: '#/components/schemas/Subdomain'
        '400':
          description: General bad request.
        '404':
          description: A subdomain with the specified citeable identifier does not exist.
  /subdomains:
    get:
      tags:
      - Subdomains
      summary: Lists the CKM subdomains
      description: ''
      operationId: listSubdomains
      security:
      - basicAuth: []
      - sessionid: []
      responses:
        '200':
          description: Successful retrieval of the main data of all subdomains.
          content:
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Subdomain'
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Subdomain'
        '400':
          description: General bad request.
  /subdomains/{cid-subdomain}/projects:
    get:
      tags:
      - Subdomains
      summary: Gets the main data of all projects (full projects and incubators) of a…
      description: ''
      operationId: listProjectsOfSubdomain
      parameters:
      - name: cid-subdomain
        in: path
        description: The citeable identifier of the subdomain.
        required: true
        schema:
          type: string
      security:
      - basicAuth: []
      - sessionid: []
      responses:
        '200':
          description: Successful retrieval of the subdomain's main data.
          content:
            application/xml:
              schema:
                $ref: '#/components/schemas/Subdomain'
            application/json:
              schema:
                $ref: '#/components/schemas/Subdomain'
        '400':
          description: General bad request.
        '404':
          description: A subdomain with the specified citeable identifier does not exist.
components:
  schemas:
    Subdomain:
      type: object
      properties:
        cid:
          type: string
        name:
          type: string
        remoteURL:
          type: string
        namespace:
          type: string
  securitySchemes:
    sessionid:
      description: Once the session id is known, it can be used for authentication until expired. The provided session id is used (and validated) on making an actual request.
      type: apiKey
      name: JSESSIONID
      in: header
    basicAuth:
      type: http
      scheme: basic
      description: Basic authentification using the CKM username and password. The provided credentials are used (and validated) on making an actual request.
externalDocs:
  description: Find out more about openEHR and the Clinical Knowledge Manager (CKM)
  url: http://www.openehr.org