openapi: 3.2.0
info:
  title: Folio Export All API
  version: v1
  description: 'Operations tagged Export All across 2 of this provider''s published API definitions: folio-mod-data-export-openapi.json, folio-mod-data-export-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /data-export/
tags:
- name: Export All
paths:
  /export-all:
    post:
      description: Export all records of the specific type
      operationId: postExportAll
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/exportAllRequest'
            example:
              jobProfileId: 2fd2bf30-9d03-4f7e-9393-df55eaef2c2f
              idType: instance
              deletedRecords: true
              suppressedFromDiscovery: false
              metadata:
                createdDate: '2019-07-22T11:22:07Z'
                createdByUserId: dee12548-9cee-45fa-bbae-675c1cc0ce3b
                createdByUsername: janedoeuser
                updatedDate: '2019-07-27T13:28:54Z'
                updatedByUserId: dee12548-9cee-45fa-bbae-675c1cc0ce3b
                updatedByUsername: ''
      responses:
        '204':
          description: Data export all started
        '400':
          description: Bad request
          content:
            text/plain:
              example: invalid request parameters
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors'
        '500':
          description: Internal server errors, e.g. due to misconfiguration
          content:
            text/plain:
              example: Internal server error
      tags:
      - Export All
      summary: Post export all
      x-summary-source: derived
    servers:
    - url: /data-export/
components:
  schemas:
    exportAllRequest:
      $schema: http://json-schema.org/draft-04/schema#
      description: Necessary data to start export all process
      type: object
      additionalProperties: false
      properties:
        jobProfileId:
          description: Related Job profile id
          type: string
          format: uuid
        idType:
          description: Type of provided uuids
          type: string
          enum:
          - instance
          - holding
          - authority
          default: instance
        deletedRecords:
          description: True if need to include deleted records, otherwise false
          type: boolean
          default: true
        suppressedFromDiscovery:
          description: True if need to include suppressed from discovery records, otherwise false
          type: boolean
          default: false
        metadata:
          description: 'Meta information '
          type: object
          $ref: '#/components/schemas/metadata'
    error:
      $schema: http://json-schema.org/draft-04/schema#
      type: object
      description: Error
      properties:
        message:
          description: Error message
          type: string
        type:
          description: Error type
          type: string
        code:
          description: Error code
          type: string
        parameters:
          description: Error parameters
          type: object
          $ref: '#/components/schemas/parameters'
      required:
      - message
    errors:
      $schema: http://json-schema.org/draft-04/schema#
      type: object
      description: Error collection
      properties:
        errors:
          description: list of errors
          id: errors
          type: array
          items:
            type: object
            $ref: '#/components/schemas/error'
        total_records:
          description: Total records
          type: integer
    parameters:
      $schema: http://json-schema.org/draft-04/schema#
      type: array
      description: Error parameters
      items:
        type: object
        properties:
          key:
            type: string
          value:
            type: string
    metadata:
      $schema: http://json-schema.org/draft-04/schema#
      title: Metadata Schema
      description: Metadata about creation and changes to records, provided by the server (client should not provide)
      type: object
      properties:
        createdDate:
          description: Date and time when the record was created
          type: string
          format: date-time
        createdByUserId:
          description: ID of the user who created the record (when available)
          type: string
          pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
        createdByUsername:
          description: Username of the user who created the record (when available)
          type: string
        updatedDate:
          description: Date and time when the record was last updated
          type: string
          format: date-time
        updatedByUserId:
          description: ID of the user who last updated the record (when available)
          type: string
          pattern: ^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$
        updatedByUsername:
          description: Username of the user who last updated the record (when available)
          type: string
      additionalProperties: false
      required:
      - createdDate
x-refined-from:
- folio-mod-data-export-openapi.json
- folio-mod-data-export-openapi.yml