Apache OpenMeetings RecordingService API

openapi: 3.0.1
info:
  title: Apache OpenMeetings REST CalendarService RecordingService API
  description: The OpenMeetings REST API provides endpoints for managing rooms, users, recordings, calendars, file uploads, whiteboards, and groups. It supports SOAP API for legacy integrations and plugin APIs for LMS integration.
  version: 9.0.0
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    url: https://openmeetings.apache.org/
servers:
- url: https://{host}:5443/openmeetings/services
  description: Apache OpenMeetings REST API server
  variables:
    host:
      default: localhost
tags:
- name: RecordingService
paths:
  /record/{id}:
    delete:
      tags:
      - RecordingService
      description: Deletes a recording
      operationId: delete_3
      parameters:
      - name: sid
        in: query
        description: The SID of the User. This SID must be marked as Loggedin
        required: true
        schema:
          type: string
      - name: id
        in: path
        description: the id of the recording
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: serviceResult object with the result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResultWrapper'
        '500':
          description: Error in case of invalid credentials or server error
      summary: Apache OpenMeetings Delete_3
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /record/{externaltype}/{externalid}:
    get:
      tags:
      - RecordingService
      description: Gets a list of recordings created by particular external USER
      operationId: getExternal
      parameters:
      - name: sid
        in: query
        description: The SID of the User. This SID must be marked as Loggedin
        required: true
        schema:
          type: string
      - name: externaltype
        in: path
        description: the externalUserId
        required: true
        schema:
          type: string
      - name: externalid
        in: path
        description: the externalUserType
        required: true
        schema:
          type: string
      responses:
        '200':
          description: list of recordings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordingDTOListWrapper'
        '500':
          description: Error in case of invalid credentials or server error
      summary: Apache OpenMeetings GetExternal
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /record/room/{roomid}:
    get:
      tags:
      - RecordingService
      description: Gets a list of recordings
      operationId: getExternalByRoom
      parameters:
      - name: sid
        in: query
        description: The SID of the User. This SID must be marked as Loggedin
        required: true
        schema:
          type: string
      - name: roomid
        in: path
        description: the room id
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: list of recordings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordingDTOListWrapper'
        '500':
          description: Error in case of invalid credentials or server error
      summary: Apache OpenMeetings GetExternalByRoom
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /record/{externaltype}:
    get:
      tags:
      - RecordingService
      description: Gets a list of recordings
      operationId: getExternalByType
      parameters:
      - name: sid
        in: query
        description: The SID of the User. This SID must be marked as Loggedin
        required: true
        schema:
          type: string
      - name: externaltype
        in: path
        description: externalType specified when creating the room
        required: true
        schema:
          type: string
      responses:
        '200':
          description: list of recordings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecordingDTOListWrapper'
        '500':
          description: Error in case of invalid credentials or server error
      summary: Apache OpenMeetings GetExternalByType
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    RecordingDTO:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type: string
        hash:
          type: string
        roomId:
          type: integer
          format: int64
        status:
          type: string
        interview:
          type: boolean
        start:
          type: string
          format: date-time
        end:
          type: string
          format: date-time
        width:
          type: integer
          format: int32
        height:
          type: integer
          format: int32
        ownerId:
          type: integer
          format: int64
        externalType:
          type: string
    ServiceResult:
      type: object
      properties:
        message:
          type: string
        type:
          type: string
    RecordingDTOListWrapper:
      type: object
      properties:
        recordingDTO:
          type: array
          items:
            $ref: '#/components/schemas/RecordingDTO'
      example:
        recordingDTO:
        - id: 1
          name: Recording [file.name.recording]19/09/21, 12:43 am
          hash: 1ee00bf1-6cb6-44d2-bb91-cfbe96e2ae19
          roomId: 7
          status: PROCESSED
          interview: false
          start: '2021-09-19T10:43:39+12:00'
          end: '2021-09-19T10:43:56+12:00'
          width: 1792
          height: 1120
          ownerId: 1
    ServiceResultWrapper:
      type: object
      properties:
        serviceResult:
          $ref: '#/components/schemas/ServiceResult'
      example:
        serviceResult:
          message: 9dbb6907-61fc-42c0-a2b2-5dbfbe053ac6
          type: SUCCESS