Skip to content
Snippets Groups Projects
uuid.yaml 3.03 KiB
Newer Older
parameters:
  - $ref: '../../parameters/caseId.yaml'

patch:
  operationId: patch-case
  summary: Vorgang partiell aktualisieren
  description: Über diesen Endpunkt kann ein Vorgang partiell aktualisiert werden.
  tags:
    - Vorgangsverwaltung
  security:
    - OAuth2:
        - 'subscribe:destination:<id>'
        - 'manage:destination:<id>'
        - 'send:region:DE<region-id>+send:service:<service-uri>'
        - 'send:region:DE<region-id>'
  requestBody:
    required: true
    content:
      application/json:
        schema:
          $ref: '../../schemas/case/patch-case.yaml'
        examples:
          Vorgang offen halten:
            $ref: '../../examples/case/patch-case-active.yaml'
          Vorgang schließen:
            $ref: '../../examples/case/patch-case-closed.yaml'
  responses:
    '202':
      description: Accepted
      content:
        application/json:
          schema:
            $ref: '../../schemas/case/case.yaml'
          examples:
            Offener Vorgang:
              $ref: '../../examples/case/case-active.yaml'
            Geschlossener Vorgang:
              $ref: '../../examples/case/case-closed.yaml'
    '400':
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: ../../schemas/error.yaml
    '401':
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: ../../schemas/error.yaml
    '403':
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: ../../schemas/error.yaml
    '404':
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: ../../schemas/error.yaml

get:
  summary: Vorgang abrufen
  operationId: get-case
  description: >
    Mit diesem Endpunkt kann ein Vorgang abgerufen werden.
  tags:
    - Vorgangsverwaltung
  security:
    - OAuth2:
        - 'subscribe:destination:<id>'
        - 'manage:destination:<id>'
        - 'send:region:DE<region-id>+send:service:<service-uri>'
        - 'send:region:DE<region-id>'
  responses:
    '200':
      description: OK
      content:
        application/json:
          schema:
            $ref: '../../schemas/case/case.yaml'
          examples:
            Offener Vorgang:
              $ref: '../../examples/case/case-active.yaml'
            Geschlossener Vorgang:
              $ref: '../../examples/case/case-closed.yaml'
    '400':
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: ../../schemas/error.yaml
    '401':
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: ../../schemas/error.yaml
    '403':
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: ../../schemas/error.yaml
    '404':
      description: Case not found
      content:
        application/problem+json:
          schema:
            $ref: ../../schemas/error.yaml