openapi: 3.0.2
info:
  title: byggrarchiver API
  version: '0.1'
paths:
  /api-docs:
    get:
      tags:
        - API
      summary: OpenAPI-definition
      parameters: []
      responses:
        '200':
          description: ok
      x-auth-type: None
  /archived/attachments:
    get:
      tags:
        - Archiver Resource
      parameters:
        - name: batchHistoryId
          in: query
          schema:
            format: int64
            type: integer
        - name: status
          in: query
          schema:
            $ref: '#/components/schemas/Status'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ArchiveHistory'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Information'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Information'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Information'
  /batch-jobs:
    get:
      tags:
        - Archiver Resource
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BatchHistory'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Information'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Information'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Information'
    post:
      tags:
        - Archiver Resource
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatchJob'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchHistory'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Information'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Information'
  /batch-jobs/{batchHistoryId}/rerun:
    post:
      tags:
        - Archiver Resource
      parameters:
        - name: batchHistoryId
          in: path
          required: true
          schema:
            format: int64
            type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BatchHistory'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Information'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Information'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Information'
security:
  - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apikey
  schemas:
    ArchiveHistory:
      required:
        - batchHistory
      type: object
      properties:
        documentId:
          type: string
        systemType:
          $ref: '#/components/schemas/SystemType'
        archiveId:
          type: string
        archiveUrl:
          type: string
        status:
          $ref: '#/components/schemas/Status'
        timestamp:
          format: date-time
          type: string
          readOnly: true
        batchHistory:
          allOf:
            - $ref: '#/components/schemas/BatchHistory'
            - nullable: false
    AttachmentCategory:
      description: Kategorisering av bilagor.
      enum:
        - ADRESS
        - ANKVU
        - ANM
        - ANMALAN_LIVSMEDELSANLAGGNING
        - ANMÄ
        - ANNO
        - ANS
        - ANSF
        - ANSFÖ
        - ANSM
        - ANSR
        - ANSS
        - ANSSL
        - ANSUP
        - ANSUPA
        - ANV
        - ARBI
        - ARIT
        - ARK
        - AVPLAN
        - BANK
        - BEGLST
        - BEGSTART
        - BEHA
        - BEK
        - BEKMOTANS
        - BEMÖ
        - BERBSA
        - BESKA
        - BESLUT
        - BIL
        - BLST
        - BRAB
        - BRAD
        - BRAU
        - BROS
        - BRS
        - BULL
        - DEB
        - DEL
        - DELK
        - DELSLU
        - DELSTA
        - DETALJ
        - DHBHUR
        - DOM
        - DPH
        - ELD
        - ENEDEK
        - ENER
        - EPOS
        - EXRIT
        - FAKTU
        - FAKTUS
        - FAP
        - FAPL
        - FAS
        - FAS2
        - FASSIT
        - FASSIT2
        - FAST
        - FOTO
        - FOTOMON
        - FPSS
        - FS
        - FS2
        - FSF
        - FUM
        - FÄRG
        - FÖLJ
        - FÖLJREVRIT
        - FÖRB
        - FÖRG2
        - FÖRGARBO
        - FÖRK
        - FÖRR
        - GBLAD
        - GEO
        - GODFÄ
        - GRA
        - GRAM
        - GRAN
        - GRUNDP
        - GRUNDR
        - HBB
        - HISSINT
        - HUR
        - INFOSS
        - INTFAK
        - INTSLUT
        - INTY
        - KA
        - KART
        - KLA
        - KM
        - KOMP
        - KOND
        - KONR
        - KONT
        - KP
        - KPLAN
        - KPR
        - KPV
        - KR
        - KVAL
        - LUFT
        - LUTE
        - MAIL
        - MAPL
        - MAST
        - MATINV
        - MEDDEL
        - MINN
        - MIRP
        - MOTBKR
        - MUR
        - MÅTT
        - NYKA
        - OMPLÄ
        - OVK
        - PERSPEKTIV
        - PFS2
        - PFSI2
        - PFSS2
        - PLA
        - PLA2
        - PLAN
        - PLANK
        - PLASIT
        - PLFA
        - PLFA2
        - PLFASE
        - PLFASESI
        - PLFASI
        - PLSE
        - PLSE2
        - PM
        - PMINN
        - POIT
        - PRES
        - PRESENTA
        - PROARB
        - PROSS
        - PROT
        - PROTAU
        - PROTKS
        - PROTPLU
        - PROTS
        - PROTSBN
        - PSI2
        - PSS
        - PSS2
        - PÅMINNTB
        - RAP
        - RAPP
        - REL
        - REMISS
        - REMS
        - REMUA
        - REVRIT
        - RIT
        - RITNING
        - RIVA
        - RIVP
        - RUE
        - RÄTT
        - SAK
        - SAKNAS
        - SAKUT
        - SBES
        - SBN
        - SCB
        - SEK
        - SEK2
        - SEKSIT
        - SEKT
        - SESI2
        - SIN
        - SITU
        - SKP
        - SKR
        - SKY
        - SKYL
        - SLUT
        - STAB
        - STIM
        - STOMR
        - SVAR
        - SVAR2år
        - SÅF
        - TAPL
        - TEBY
        - TEKN
        - TEKRAP
        - TEVS
        - TILL
        - TILLVR
        - TJ
        - TJÄ
        - TOMTPLBE
        - TSR
        - UBGARBO
        - UKA
        - UKON
        - UKP
        - UKR
        - UND
        - UNDER
        - UNDUT
        - UPLA
        - UPPM
        - URÖR
        - UTBEU
        - UTSK
        - UTSKP
        - UTSKS
        - UVEN
        - VAH
        - VENT
        - VS
        - VVSH
        - ÄRB
        - ÅTG
        - ÖVER
      type: string
    BatchHistory:
      type: object
      properties:
        id:
          format: int64
          type: integer
          readOnly: true
        start:
          format: date
          type: string
        end:
          format: date
          type: string
        status:
          $ref: '#/components/schemas/Status'
        batchTrigger:
          $ref: '#/components/schemas/BatchTrigger'
        timestamp:
          format: date-time
          type: string
          readOnly: true
    BatchJob:
      required:
        - start
        - end
      type: object
      properties:
        start:
          format: date
          description: Startdatum på körningen.
          type: string
          example: {}
          nullable: false
        end:
          format: date
          description: Slutdatum på körningen.
          type: string
          example: {}
          nullable: false
    BatchTrigger:
      enum:
        - MANUAL
        - SCHEDULED
      type: string
    Information:
      type: object
      properties:
        type:
          type: string
        status:
          format: int32
          type: integer
        title:
          type: string
        detail:
          type: string
        instance:
          type: string
    Status:
      enum:
        - COMPLETED
        - NOT_COMPLETED
      type: string
    SystemType:
      enum:
        - BYGGR
        - ECOS
      type: string
servers:
  - url: https://api-i-test.sundsvall.se/byggrarchiver/0.1
    variables: {}