gate.yaml

openapi: 3.0.1
info:
  title: Business Partner Data Management Gate
  description: A gate for a member to share business partner data with CatenaX
  version: 6.3.0-SNAPSHOT
servers:
  - url: http://localhost:8081
    description: Generated server url
security:
  - open_id_scheme: []
  - bearer_scheme: []
paths:
  /v6/input/business-partners:
    put:
      tags:
        - business-partner-controller
      summary: Create or update business partner with given external ID
      description: Create or update generic business partner. Updates instead of creating a new business partner if an already existing external ID is used. The same external ID may not occur more than once in a single request. For a single request, the maximum number of business partners in the request is limited to 100 entries.
      operationId: upsertBusinessPartnersInput
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BusinessPartnerInputRequest'
        required: true
      responses:
        '200':
          description: Business partner were successfully updated or created
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BusinessPartnerInputDto'
        '400':
          description: On malformed legal entity request
  /v6/input/business-partner-relations:
    get:
      tags:
        - relation-controller
      summary: Find business partner input relations
      description: Find paginated list of business partner relations from the input stage. There are various filter criteria available. All filters are 'AND' filters.
      operationId: get
      parameters:
        - name: tenantBpnL
          in: query
          description: The BPNL of the tenant to search in. If not given, the system attempts to infer the tenant from the authentication.
          required: false
          schema:
            type: string
            description: The BPNL of the tenant to search in. If not given, the system attempts to infer the tenant from the authentication.
        - name: externalIds
          in: query
          description: Only show relations with the given external identifiers
          required: false
          schema:
            type: array
            description: Only show relations with the given external identifiers
            items:
              type: string
              description: Only show relations with the given external identifiers
        - name: relationType
          in: query
          description: Only show relations of the given type
          required: false
          schema:
            type: string
            description: Only show relations of the given type
            enum:
              - IsManagedBy
        - name: businessPartnerSourceExternalIds
          in: query
          description: Only show relations which have the given business partners as sources
          required: false
          schema:
            type: array
            description: Only show relations which have the given business partners as sources
            items:
              type: string
              description: Only show relations which have the given business partners as sources
        - name: businessPartnerTargetExternalIds
          in: query
          description: Only show relations which have the given business partners as targets
          required: false
          schema:
            type: array
            description: Only show relations which have the given business partners as targets
            items:
              type: string
              description: Only show relations which have the given business partners as targets
        - name: updatedAtFrom
          in: query
          description: Only show relations which have been modified after the given time stamp
          required: false
          schema:
            type: string
            description: Only show relations which have been modified after the given time stamp
            format: date-time
        - name: page
          in: query
          description: Number of page to get results from
          required: false
          schema:
            minimum: 0
            type: string
        - name: size
          in: query
          description: Size of each page
          required: false
          schema:
            maximum: 100
            minimum: 0
            type: string
      responses:
        '200':
          description: A paginated list of business partner relations for the input stage
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageDtoRelationDto'
    put:
      tags:
        - relation-controller
      summary: Update a business partner input relation
      description: 'Update an existing business partner relation on the input stage. By using a request parameter it is also possible to create a relation if the relation with the given external identifier does not exist. '
      operationId: put
      parameters:
        - name: createIfNotExist
          in: query
          description: If true a business partner relation will be created even if a relation could not be found under the given external identifier.
          required: false
          schema:
            type: boolean
            description: If true a business partner relation will be created even if a relation could not be found under the given external identifier.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RelationPutRequest'
        required: true
      responses:
        '200':
          description: The given business partner relation has been updated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelationDto'
        '400':
          description: 'On wrong or insufficient user provided data like references to non-existent business partners or relations that violate the relation constraints. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GateErrorResponse'
    post:
      tags:
        - relation-controller
      summary: Create a new business partner input relation
      description: Create a new relation between two business partner entries on the input stage. The external identifier is optional and a new one will be automatically created if not given. A given external identifier has to be unique.
      operationId: post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RelationPostRequest'
        required: true
      responses:
        '201':
          description: The created business partner input relation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RelationDto'
        '400':
          description: 'If the business partner could not be created based on wrong or insufficient data provided such as non-existent business partners or violated relation constraints. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GateErrorResponse'
        '409':
          description: If a relation with the given external identifier already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GateErrorResponse'
    delete:
      tags:
        - relation-controller
      summary: Delete an existing business partner relation
      description: Delete a relation between two business partners on the input stage.
      operationId: delete
      parameters:
        - name: tenantBpnL
          in: query
          description: The BPNL of the tenant to search in. If not given, the system attempts to infer the tenant from the authentication.
          required: false
          schema:
            type: string
            description: The BPNL of the tenant to search in. If not given, the system attempts to infer the tenant from the authentication.
        - name: externalId
          in: query
          description: The external identifier of the business partner relation to delete
          required: true
          schema:
            type: string
            description: The external identifier of the business partner relation to delete
      responses:
        '200':
          description: The specified relation has been deleted.
        '400':
          description: 'On specifying a relation that does not exist. '
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GateErrorResponse'
  /v6/sharing-state/ready:
    post:
      tags:
        - sharing-state-controller
      summary: Sets the given business partners into ready to be shared state
      description: The business partners to set the ready state for are identified by their external-id. Only business partners in an initial or error state can be set to ready. If any given business partner could not be set into ready state for any reason (for example, it has not been found or it is in the wrong state) the whole request fails (all or nothing approach).
      operationId: postSharingStateReady
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostSharingStateReadyRequest'
        required: true
      responses:
        '204':
          description: All business partners put in ready to be shared state
        '400':
          description: Business partners can't be put into ready state (e.g. external-ID not found, wrong sharing state)
  /v6/output/changelog/search:
    post:
      tags:
        - changelog-controller
      summary: Returns changelog entries for changes to the business partner output stage
      description: Returns changelog entries as of a specified timestamp from the output stage, optionally filtered by timestamp, an array of external IDs and a business partner type.
      operationId: getOutputChangelog
      parameters:
        - name: page
          in: query
          description: Number of page to get results from
          required: false
          schema:
            minimum: 0
            type: string
        - name: size
          in: query
          description: Size of each page
          required: false
          schema:
            maximum: 100
            minimum: 0
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangelogSearchRequest'
        required: true
      responses:
        '200':
          description: The changelog entries for the specified parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageChangeLogDtoChangelogGateDto'
        '400':
          description: On malformed pagination request
  /v6/output/business-partners/search:
    post:
      tags:
        - business-partner-controller
      summary: Search business partners by an array of external IDs from the output stage
      description: Get page of business partners output data filtered by a collection of external IDs. An empty external ID list will return a paginated list of all business partners.
      operationId: getBusinessPartnersOutput
      parameters:
        - name: page
          in: query
          description: Number of page to get results from
          required: false
          schema:
            minimum: 0
            type: string
        - name: size
          in: query
          description: Size of each page
          required: false
          schema:
            maximum: 100
            minimum: 0
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: The requested page of business partners
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageDtoBusinessPartnerOutputDto'
        '400':
          description: On malformed pagination request
  /v6/input/partner-upload-process:
    post:
      tags:
        - partner-upload-controller
      summary: Create or update business partners from uploaded CSV file
      description: 'Create or update generic business partners. Updates instead of creating a new business partner if an already existing external ID is used. The same external ID may not occur more than once in a requested file. '
      operationId: uploadPartnerCsvFile
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - file
              type: object
              properties:
                file:
                  type: string
                  format: binary
      responses:
        '200':
          description: Business partners were successfully updated or created
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BusinessPartnerInputDto'
            multipart/form-data:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/BusinessPartnerInputDto'
        '400':
          description: On malformed Business partner upload request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GateErrorResponse'
  /v6/input/changelog/search:
    post:
      tags:
        - changelog-controller
      summary: Returns changelog entries for changes to the business partner input stage
      description: Returns changelog entries as of a specified timestamp from the input stage, optionally filtered by timestamp, an array of external IDs and a business partner type.
      operationId: getInputChangelog
      parameters:
        - name: page
          in: query
          description: Number of page to get results from
          required: false
          schema:
            minimum: 0
            type: string
        - name: size
          in: query
          description: Size of each page
          required: false
          schema:
            maximum: 100
            minimum: 0
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangelogSearchRequest'
        required: true
      responses:
        '200':
          description: The changelog entries for the specified parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageChangeLogDtoChangelogGateDto'
        '400':
          description: On malformed pagination request
  /v6/input/business-partners/search:
    post:
      tags:
        - business-partner-controller
      summary: Search business partner by external ID. An empty external ID list returns a paginated list of all business partners.
      description: Get page of business partners filtered by a collection of external IDs.
      operationId: getBusinessPartnersInput
      parameters:
        - name: page
          in: query
          description: Number of page to get results from
          required: false
          schema:
            minimum: 0
            type: string
        - name: size
          in: query
          description: Size of each page
          required: false
          schema:
            maximum: 100
            minimum: 0
            type: string
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                type: string
      responses:
        '200':
          description: The requested page of busines partners
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageDtoBusinessPartnerInputDto'
        '400':
          description: On malformed pagination request
  /v6/stats/{stage}/address-types:
    get:
      tags:
        - stats-controller
      operationId: countAddressTypes
      parameters:
        - name: stage
          in: path
          required: true
          schema:
            type: string
            enum:
              - Input
              - Output
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatsAddressTypesResponse'
  /v6/stats/stages:
    get:
      tags:
        - stats-controller
      operationId: countPartnersPerStage
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatsStagesResponse'
  /v6/stats/sharing-states:
    get:
      tags:
        - stats-controller
      operationId: countPartnersBySharingState
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatsSharingStatesResponse'
  /v6/stats/confidence-criteria:
    get:
      tags:
        - stats-controller
      operationId: getConfidenceCriteriaStats
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StatsConfidenceCriteriaResponse'
  /v6/sharing-state:
    get:
      tags:
        - sharing-state-controller
      summary: Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs
      operationId: getSharingStates
      parameters:
        - name: page
          in: query
          description: Number of page to get results from
          required: false
          schema:
            minimum: 0
            type: string
        - name: size
          in: query
          description: Size of each page
          required: false
          schema:
            maximum: 100
            minimum: 0
            type: string
        - name: externalIds
          in: query
          description: External IDs
          required: false
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: Page of sharing states
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PageDtoSharingStateDto'
  /v6/input/partner-upload-template:
    get:
      tags:
        - partner-upload-controller
      summary: Get CSV template with headers in file
      description: Create empty CSV file template including headers.Generated CSV file can later be used for uploading business partner data.
      operationId: getPartnerCsvTemplate
      responses:
        '200':
          description: CSV file template generated successfully
          content:
            application/json:
              schema:
                type: string
                format: binary
            multipart/form-data:
              schema:
                type: string
                format: binary
components:
  schemas:
    AddressComponentOutputDto:
      required:
        - addressBpn
        - bpnA
        - confidenceCriteria
        - physicalPostalAddress
        - states
      type: object
      properties:
        addressBpn:
          type: string
          description: The BPNA of the address, on which the business partner provides a view.
        name:
          type: string
          description: The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance.
        addressType:
          type: string
          description: 'One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address. '
          enum:
            - LegalAndSiteMainAddress
            - LegalAddress
            - SiteMainAddress
            - AdditionalAddress
        physicalPostalAddress:
          $ref: '#/components/schemas/PhysicalPostalAddressDto'
        alternativePostalAddress:
          $ref: '#/components/schemas/AlternativePostalAddressDto'
        confidenceCriteria:
          $ref: '#/components/schemas/ConfidenceCriteriaDto'
        states:
          type: array
          items:
            $ref: '#/components/schemas/BusinessPartnerStateDto'
      description: Address properties of business partner output data
    AddressRepresentationInputDto:
      required:
        - physicalPostalAddress
        - states
      type: object
      properties:
        addressBpn:
          type: string
          description: The BPNA of the address, on which the business partner provides a view.
        name:
          type: string
          description: The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance.
        addressType:
          type: string
          description: 'One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address. '
          enum:
            - LegalAndSiteMainAddress
            - LegalAddress
            - SiteMainAddress
            - AdditionalAddress
        physicalPostalAddress:
          $ref: '#/components/schemas/PhysicalPostalAddressDto'
        alternativePostalAddress:
          $ref: '#/components/schemas/AlternativePostalAddressDto'
        states:
          type: array
          items:
            $ref: '#/components/schemas/BusinessPartnerStateDto'
      description: 'The address, on which the business partner provides a view. '
    AlternativePostalAddressDto:
      type: object
      properties:
        geographicCoordinates:
          $ref: '#/components/schemas/GeoCoordinateDto'
        country:
          type: string
          description: The 2-digit country code of the physical postal address according to ISO 3166-1.
          enum:
            - UNDEFINED
            - AC
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AN
            - AO
            - AQ
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BU
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CP
            - CR
            - CS
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DG
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EA
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - EU
            - EZ
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - FX
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HM
            - HN
            - HR
            - HT
            - HU
            - IC
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MP
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NT
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SF
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SU
            - SV
            - SX
            - SY
            - SZ
            - TA
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TP
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UK
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - XI
            - XU
            - XK
            - YE
            - YT
            - YU
            - ZA
            - ZM
            - ZR
            - ZW
        administrativeAreaLevel1:
          type: string
          description: The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.
        postalCode:
          type: string
          description: The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.
        city:
          type: string
          description: 'The name of the city of the physical postal address, synonyms: town, village, municipality.'
        deliveryServiceType:
          type: string
          description: 'One of the alternative postal address types: P.O. box, private bag, boite postale.'
          enum:
            - PO_BOX
            - PRIVATE_BAG
            - BOITE_POSTALE
        deliveryServiceQualifier:
          type: string
          description: The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities.
        deliveryServiceNumber:
          type: string
          description: The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number.
      description: An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else.
    BusinessPartnerIdentifierDto:
      type: object
      properties:
        type:
          type: string
          description: The type of the identifier.
        value:
          type: string
          description: The value of the identifier like “DE123465789.
        issuingBody:
          type: string
          description: The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Registergericht and Registerart.
    BusinessPartnerInputDto:
      required:
        - address
        - bpnA
        - bpnL
        - createdAt
        - externalId
        - identifiers
        - isOwnCompanyData
        - legalEntity
        - nameParts
        - postalAddress
        - roles
        - site
        - states
        - updatedAt
      type: object
      properties:
        externalId:
          type: string
          description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner.
        nameParts:
          type: array
          description: The list of name parts to accommodate the different number of name fields in different systems.
          items:
            type: string
        identifiers:
          type: array
          description: The list of identifiers of the business partner. Sorted and duplicates removed by the service.
          items:
            $ref: '#/components/schemas/BusinessPartnerIdentifierDto'
        states:
          type: array
          description: The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.
          items:
            $ref: '#/components/schemas/BusinessPartnerStateDto'
        roles:
          type: array
          description: 'One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.'
          items:
            type: string
            enum:
              - SUPPLIER
              - CUSTOMER
              - ONE_TIME_SUPPLIER
              - ONE_TIME_CUSTOMER
        isOwnCompanyData:
          type: boolean
          description: Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member.
        legalEntity:
          $ref: '#/components/schemas/LegalEntityRepresentationInputDto'
        site:
          $ref: '#/components/schemas/SiteRepresentationInputDto'
        address:
          $ref: '#/components/schemas/AddressRepresentationInputDto'
        createdAt:
          type: string
          description: The date when the data record has been created.
          format: date-time
        updatedAt:
          type: string
          description: The date when the data record has been last updated.
          format: date-time
      description: Generic business partner with external id
    BusinessPartnerInputRequest:
      required:
        - address
        - externalId
        - identifiers
        - isOwnCompanyData
        - legalEntity
        - nameParts
        - roles
        - site
        - states
      type: object
      properties:
        externalId:
          type: string
          description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner.
        nameParts:
          type: array
          description: The list of name parts to accommodate the different number of name fields in different systems.
          items:
            type: string
        identifiers:
          type: array
          description: The list of identifiers of the business partner. Sorted and duplicates removed by the service.
          items:
            $ref: '#/components/schemas/BusinessPartnerIdentifierDto'
        states:
          type: array
          description: The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.
          items:
            $ref: '#/components/schemas/BusinessPartnerStateDto'
        roles:
          type: array
          description: 'One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.'
          items:
            type: string
            enum:
              - SUPPLIER
              - CUSTOMER
              - ONE_TIME_SUPPLIER
              - ONE_TIME_CUSTOMER
        isOwnCompanyData:
          type: boolean
          description: Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member.
        legalEntity:
          $ref: '#/components/schemas/LegalEntityRepresentationInputDto'
        site:
          $ref: '#/components/schemas/SiteRepresentationInputDto'
        address:
          $ref: '#/components/schemas/AddressRepresentationInputDto'
      description: Generic business partner with external id
    BusinessPartnerOutputDto:
      required:
        - address
        - createdAt
        - externalId
        - identifiers
        - isOwnCompanyData
        - legalEntity
        - nameParts
        - roles
        - states
        - updatedAt
      type: object
      properties:
        externalId:
          type: string
          description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner.
        nameParts:
          type: array
          description: The list of name parts to accommodate the different number of name fields in different systems.
          items:
            type: string
        identifiers:
          type: array
          description: The list of identifiers of the business partner. Sorted and duplicates removed by the service.
          items:
            $ref: '#/components/schemas/BusinessPartnerIdentifierDto'
        states:
          type: array
          description: The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.
          items:
            $ref: '#/components/schemas/BusinessPartnerStateDto'
        roles:
          type: array
          description: 'One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.'
          items:
            type: string
            enum:
              - SUPPLIER
              - CUSTOMER
              - ONE_TIME_SUPPLIER
              - ONE_TIME_CUSTOMER
        isOwnCompanyData:
          type: boolean
          description: Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member.
        legalEntity:
          $ref: '#/components/schemas/LegalEntityRepresentationOutputDto'
        site:
          $ref: '#/components/schemas/SiteRepresentationOutputDto'
        address:
          $ref: '#/components/schemas/AddressComponentOutputDto'
        createdAt:
          type: string
          description: The date when the data record has been created.
          format: date-time
        updatedAt:
          type: string
          description: The date when the data record has been last updated.
          format: date-time
      description: Generic business partner output with external id
    BusinessPartnerStateDto:
      type: object
      properties:
        validFrom:
          type: string
          description: Date since when the status is/was valid.
          format: date-time
        validTo:
          type: string
          description: Date until the status was valid, if applicable.
          format: date-time
        type:
          type: string
          description: The type of this specified status.
          enum:
            - ACTIVE
            - INACTIVE
    ChangelogGateDto:
      required:
        - changelogType
        - externalId
        - timestamp
      type: object
      properties:
        externalId:
          type: string
          description: The external identifier of the business partner for which the changelog entry was created.
        timestamp:
          type: string
          description: The date and time when the changelog entry was created.
          format: date-time
        changelogType:
          type: string
          description: 'One of the actions for which the changelog entry was created: create, update.'
          enum:
            - CREATE
            - UPDATE
      description: An entry of the changelog, which is created each time a business partner is modified and contains data about the change. The actual new state of the business partner is not included.
    ChangelogSearchRequest:
      type: object
      properties:
        timestampAfter:
          type: string
          description: Only changelog entries created after this time. Ignored if empty.
          format: date-time
          example: '2023-03-20T10:23:28.194Z'
        externalIds:
          uniqueItems: true
          type: array
          description: Only for business partners with the given array of external IDs. Ignored if empty.
          items:
            type: string
    ConfidenceCriteriaDto:
      required:
        - checkedByExternalDataSource
        - confidenceLevel
        - lastConfidenceCheckAt
        - nextConfidenceCheckAt
        - numberOfSharingMembers
        - sharedByOwner
      type: object
      properties:
        sharedByOwner:
          type: boolean
        checkedByExternalDataSource:
          type: boolean
        numberOfSharingMembers:
          type: integer
          format: int32
        lastConfidenceCheckAt:
          type: string
          format: date-time
        nextConfidenceCheckAt:
          type: string
          format: date-time
        confidenceLevel:
          type: integer
          format: int32
    ErrorInfoChangeLogOutputError:
      title: ErrorInfo
      required:
        - errorCode
        - message
      type: object
      properties:
        errorCode:
          type: string
          description: Error code identifying the error
          enum:
            - ExternalIdNotFound
        message:
          type: string
          description: Error message that explains the error
        entityKey:
          type: string
          description: Key (externalId) of the entity that failed
      description: Holds information about failures
    GateErrorResponse:
      required:
        - error
        - path
        - status
        - timestamp
      type: object
      properties:
        timestamp:
          type: string
          description: Timestamp of the error occurrence
          format: date-time
        status:
          type: string
          description: HTTP status of the error response
          enum:
            - 100 CONTINUE
            - 101 SWITCHING_PROTOCOLS
            - 102 PROCESSING
            - 103 EARLY_HINTS
            - 103 CHECKPOINT
            - 200 OK
            - 201 CREATED
            - 202 ACCEPTED
            - 203 NON_AUTHORITATIVE_INFORMATION
            - 204 NO_CONTENT
            - 205 RESET_CONTENT
            - 206 PARTIAL_CONTENT
            - 207 MULTI_STATUS
            - 208 ALREADY_REPORTED
            - 226 IM_USED
            - 300 MULTIPLE_CHOICES
            - 301 MOVED_PERMANENTLY
            - 302 FOUND
            - 302 MOVED_TEMPORARILY
            - 303 SEE_OTHER
            - 304 NOT_MODIFIED
            - 305 USE_PROXY
            - 307 TEMPORARY_REDIRECT
            - 308 PERMANENT_REDIRECT
            - 400 BAD_REQUEST
            - 401 UNAUTHORIZED
            - 402 PAYMENT_REQUIRED
            - 403 FORBIDDEN
            - 404 NOT_FOUND
            - 405 METHOD_NOT_ALLOWED
            - 406 NOT_ACCEPTABLE
            - 407 PROXY_AUTHENTICATION_REQUIRED
            - 408 REQUEST_TIMEOUT
            - 409 CONFLICT
            - 410 GONE
            - 411 LENGTH_REQUIRED
            - 412 PRECONDITION_FAILED
            - 413 PAYLOAD_TOO_LARGE
            - 413 REQUEST_ENTITY_TOO_LARGE
            - 414 URI_TOO_LONG
            - 414 REQUEST_URI_TOO_LONG
            - 415 UNSUPPORTED_MEDIA_TYPE
            - 416 REQUESTED_RANGE_NOT_SATISFIABLE
            - 417 EXPECTATION_FAILED
            - 418 I_AM_A_TEAPOT
            - 419 INSUFFICIENT_SPACE_ON_RESOURCE
            - 420 METHOD_FAILURE
            - 421 DESTINATION_LOCKED
            - 422 UNPROCESSABLE_ENTITY
            - 423 LOCKED
            - 424 FAILED_DEPENDENCY
            - 425 TOO_EARLY
            - 426 UPGRADE_REQUIRED
            - 428 PRECONDITION_REQUIRED
            - 429 TOO_MANY_REQUESTS
            - 431 REQUEST_HEADER_FIELDS_TOO_LARGE
            - 451 UNAVAILABLE_FOR_LEGAL_REASONS
            - 500 INTERNAL_SERVER_ERROR
            - 501 NOT_IMPLEMENTED
            - 502 BAD_GATEWAY
            - 503 SERVICE_UNAVAILABLE
            - 504 GATEWAY_TIMEOUT
            - 505 HTTP_VERSION_NOT_SUPPORTED
            - 506 VARIANT_ALSO_NEGOTIATES
            - 507 INSUFFICIENT_STORAGE
            - 508 LOOP_DETECTED
            - 509 BANDWIDTH_LIMIT_EXCEEDED
            - 510 NOT_EXTENDED
            - 511 NETWORK_AUTHENTICATION_REQUIRED
        error:
          type: array
          description: List of error messages
          items:
            type: string
            description: List of error messages
        path:
          type: string
          description: Request path where the error occurred
      description: Error response for invalid partner upload
    GeoCoordinateDto:
      required:
        - latitude
        - longitude
      type: object
      properties:
        longitude:
          type: number
          description: Longitude coordinate
          format: double
        latitude:
          type: number
          description: Latitude coordinate
          format: double
        altitude:
          type: number
          description: Altitude, if applicable
          format: double
      description: The exact location of the physical postal address in latitude, longitude, and altitude.
    LegalEntityRepresentationInputDto:
      required:
        - states
      type: object
      properties:
        legalEntityBpn:
          type: string
          description: The BPNL of the legal entity, on which the business partner provides a view.
        legalName:
          type: string
          description: The name of the legal entity, on which the business partner provides a view, according to official registers.
        shortName:
          type: string
          description: The abbreviated name of the legal entity, on which the business partner provides a view.
        legalForm:
          type: string
          description: The legal form of the legal entity, on which the business partner provides a view.
        states:
          type: array
          items:
            $ref: '#/components/schemas/BusinessPartnerStateDto'
      description: The legal entity, on which the business partner provides a view.
    LegalEntityRepresentationOutputDto:
      required:
        - bpnL
        - confidenceCriteria
        - legalEntityBpn
        - states
      type: object
      properties:
        legalEntityBpn:
          type: string
          description: The BPNL of the legal entity, on which the business partner provides a view.
        legalName:
          type: string
          description: The name of the legal entity, on which the business partner provides a view, according to official registers.
        shortName:
          type: string
          description: The abbreviated name of the legal entity, on which the business partner provides a view.
        legalForm:
          type: string
          description: The legal form of the legal entity, on which the business partner provides a view.
        confidenceCriteria:
          $ref: '#/components/schemas/ConfidenceCriteriaDto'
        states:
          type: array
          items:
            $ref: '#/components/schemas/BusinessPartnerStateDto'
      description: Legal Entity properties of business partner output data
    PageChangeLogDtoChangelogGateDto:
      required:
        - content
        - contentSize
        - errors
        - invalidEntries
        - page
        - totalElements
        - totalPages
      type: object
      properties:
        totalElements:
          type: integer
          description: Total number of all results in all pages
          format: int64
        totalPages:
          type: integer
          description: Total number pages
          format: int32
        page:
          type: integer
          description: Current page number
          format: int32
        contentSize:
          type: integer
          description: Number of results in the page
          format: int32
        content:
          type: array
          description: Collection of results in the page
          items:
            $ref: '#/components/schemas/ChangelogGateDto'
        invalidEntries:
          type: integer
          description: Number of entries in the page that have been omitted due to being invalid (error)
          format: int32
        errors:
          type: array
          description: Infos about the entries with errors
          items:
            $ref: '#/components/schemas/ErrorInfoChangeLogOutputError'
      description: Paginated collection of results
    PageDtoBusinessPartnerInputDto:
      required:
        - content
        - contentSize
        - page
        - totalElements
        - totalPages
      type: object
      properties:
        totalElements:
          type: integer
          description: Total number of all results in all pages
          format: int64
        totalPages:
          type: integer
          description: Total number pages
          format: int32
        page:
          type: integer
          description: Current page number
          format: int32
        contentSize:
          type: integer
          description: Number of results in the page
          format: int32
        content:
          type: array
          description: Collection of results in the page
          items:
            $ref: '#/components/schemas/BusinessPartnerInputDto'
      description: Paginated collection of results
    PageDtoBusinessPartnerOutputDto:
      required:
        - content
        - contentSize
        - page
        - totalElements
        - totalPages
      type: object
      properties:
        totalElements:
          type: integer
          description: Total number of all results in all pages
          format: int64
        totalPages:
          type: integer
          description: Total number pages
          format: int32
        page:
          type: integer
          description: Current page number
          format: int32
        contentSize:
          type: integer
          description: Number of results in the page
          format: int32
        content:
          type: array
          description: Collection of results in the page
          items:
            $ref: '#/components/schemas/BusinessPartnerOutputDto'
      description: Paginated collection of results
    PageDtoRelationDto:
      required:
        - content
        - contentSize
        - page
        - totalElements
        - totalPages
      type: object
      properties:
        totalElements:
          type: integer
          description: Total number of all results in all pages
          format: int64
        totalPages:
          type: integer
          description: Total number pages
          format: int32
        page:
          type: integer
          description: Current page number
          format: int32
        contentSize:
          type: integer
          description: Number of results in the page
          format: int32
        content:
          type: array
          description: Collection of results in the page
          items:
            $ref: '#/components/schemas/RelationDto'
      description: Paginated collection of results
    PageDtoSharingStateDto:
      required:
        - content
        - contentSize
        - page
        - totalElements
        - totalPages
      type: object
      properties:
        totalElements:
          type: integer
          description: Total number of all results in all pages
          format: int64
        totalPages:
          type: integer
          description: Total number pages
          format: int32
        page:
          type: integer
          description: Current page number
          format: int32
        contentSize:
          type: integer
          description: Number of results in the page
          format: int32
        content:
          type: array
          description: Collection of results in the page
          items:
            $ref: '#/components/schemas/SharingStateDto'
      description: Paginated collection of results
    PhysicalPostalAddressDto:
      type: object
      properties:
        geographicCoordinates:
          $ref: '#/components/schemas/GeoCoordinateDto'
        country:
          type: string
          description: The 2-digit country code of the physical postal address according to ISO 3166-1.
          enum:
            - UNDEFINED
            - AC
            - AD
            - AE
            - AF
            - AG
            - AI
            - AL
            - AM
            - AN
            - AO
            - AQ
            - AR
            - AS
            - AT
            - AU
            - AW
            - AX
            - AZ
            - BA
            - BB
            - BD
            - BE
            - BF
            - BG
            - BH
            - BI
            - BJ
            - BL
            - BM
            - BN
            - BO
            - BQ
            - BR
            - BS
            - BT
            - BU
            - BV
            - BW
            - BY
            - BZ
            - CA
            - CC
            - CD
            - CF
            - CG
            - CH
            - CI
            - CK
            - CL
            - CM
            - CN
            - CO
            - CP
            - CR
            - CS
            - CU
            - CV
            - CW
            - CX
            - CY
            - CZ
            - DE
            - DG
            - DJ
            - DK
            - DM
            - DO
            - DZ
            - EA
            - EC
            - EE
            - EG
            - EH
            - ER
            - ES
            - ET
            - EU
            - EZ
            - FI
            - FJ
            - FK
            - FM
            - FO
            - FR
            - FX
            - GA
            - GB
            - GD
            - GE
            - GF
            - GG
            - GH
            - GI
            - GL
            - GM
            - GN
            - GP
            - GQ
            - GR
            - GS
            - GT
            - GU
            - GW
            - GY
            - HK
            - HM
            - HN
            - HR
            - HT
            - HU
            - IC
            - ID
            - IE
            - IL
            - IM
            - IN
            - IO
            - IQ
            - IR
            - IS
            - IT
            - JE
            - JM
            - JO
            - JP
            - KE
            - KG
            - KH
            - KI
            - KM
            - KN
            - KP
            - KR
            - KW
            - KY
            - KZ
            - LA
            - LB
            - LC
            - LI
            - LK
            - LR
            - LS
            - LT
            - LU
            - LV
            - LY
            - MA
            - MC
            - MD
            - ME
            - MF
            - MG
            - MH
            - MK
            - ML
            - MM
            - MN
            - MO
            - MP
            - MQ
            - MR
            - MS
            - MT
            - MU
            - MV
            - MW
            - MX
            - MY
            - MZ
            - NA
            - NC
            - NE
            - NF
            - NG
            - NI
            - NL
            - 'NO'
            - NP
            - NR
            - NT
            - NU
            - NZ
            - OM
            - PA
            - PE
            - PF
            - PG
            - PH
            - PK
            - PL
            - PM
            - PN
            - PR
            - PS
            - PT
            - PW
            - PY
            - QA
            - RE
            - RO
            - RS
            - RU
            - RW
            - SA
            - SB
            - SC
            - SD
            - SE
            - SF
            - SG
            - SH
            - SI
            - SJ
            - SK
            - SL
            - SM
            - SN
            - SO
            - SR
            - SS
            - ST
            - SU
            - SV
            - SX
            - SY
            - SZ
            - TA
            - TC
            - TD
            - TF
            - TG
            - TH
            - TJ
            - TK
            - TL
            - TM
            - TN
            - TO
            - TP
            - TR
            - TT
            - TV
            - TW
            - TZ
            - UA
            - UG
            - UK
            - UM
            - US
            - UY
            - UZ
            - VA
            - VC
            - VE
            - VG
            - VI
            - VN
            - VU
            - WF
            - WS
            - XI
            - XU
            - XK
            - YE
            - YT
            - YU
            - ZA
            - ZM
            - ZR
            - ZW
        administrativeAreaLevel1:
          type: string
          description: The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.
        administrativeAreaLevel2:
          type: string
          description: The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country.
        administrativeAreaLevel3:
          type: string
          description: The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country.
        postalCode:
          type: string
          description: The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.
        city:
          type: string
          description: 'The name of the city of the physical postal address, synonyms: town, village, municipality.'
        district:
          type: string
          description: The name of the district of the physical postal address which divides the city in several smaller areas.
        street:
          $ref: '#/components/schemas/StreetDto'
        companyPostalCode:
          type: string
          description: The company postal code of the physical postal address, which is sometimes required for large companies.
        industrialZone:
          type: string
          description: 'The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area.'
        building:
          type: string
          description: The alphanumeric identifier of the building addressed by the physical postal address.
        floor:
          type: string
          description: 'The number of a floor in the building addressed by the physical postal address, synonym: level.'
        door:
          type: string
          description: 'The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite.'
        taxJurisdictionCode:
          type: string
          description: Tax jurisdiction codes are used to identify the specific jurisdiction(s) that a company belong to, particularly in bureaucratic processes such as tax returns and IRS forms.
      description: A physical postal address describes the physical location of an office, warehouse, gate, etc.
    PostSharingStateReadyRequest:
      required:
        - externalIds
      type: object
      properties:
        externalIds:
          type: array
          items:
            type: string
      description: Request for setting business partners into ready to be shared to golden record state
    RelationDto:
      required:
        - businessPartnerSourceExternalId
        - businessPartnerTargetExternalId
        - createdAt
        - externalId
        - relationType
        - updatedAt
      type: object
      properties:
        externalId:
          type: string
          description: The identifier with which to reference this relation
        relationType:
          type: string
          description: The type of relation between the business partners
          enum:
            - IsManagedBy
        businessPartnerSourceExternalId:
          type: string
          description: The business partner from which the relation emerges (the source)
        businessPartnerTargetExternalId:
          type: string
          description: The business partner to which this relation goes (the target)
        tenantBpnL:
          type: string
          description: The BPNL of the tenant this relation belongs to
        updatedAt:
          type: string
          description: The time when this relation was last modified
          format: date-time
        createdAt:
          type: string
          description: The time when this relation was created
          format: date-time
      description: 'A relation from one business partner (the source) to another business partner (the target). '
    RelationPostRequest:
      required:
        - businessPartnerSourceExternalId
        - businessPartnerTargetExternalId
        - relationType
      type: object
      properties:
        tenantBpnL:
          type: string
          description: The BPNL of the tenant to post in. If not given, the system attempts to infer the tenant from the authentication.
        externalId:
          type: string
          description: The identifier under which the relation will be referenced. If not given a unique identifier will be automatically assigned by the system. A given external identifier needs be unique.
        relationType:
          type: string
          description: The type of relation that should be created
          enum:
            - IsManagedBy
        businessPartnerSourceExternalId:
          type: string
          description: The external identifier of the business partner from which the relation should emerge (the source)
        businessPartnerTargetExternalId:
          type: string
          description: The external identifier of the business partner to which the relation should point (the target)
      description: A request to create a new relation between two business partners
    RelationPutRequest:
      required:
        - businessPartnerSourceExternalId
        - businessPartnerTargetExternalId
        - externalId
        - relationType
      type: object
      properties:
        tenantBpnL:
          type: string
          description: The BPNL of the tenant in which to update. If not given, the system attempts to infer the tenant from the authentication.
        externalId:
          type: string
          description: The external identifier of the business partner relation to update
        relationType:
          type: string
          description: The type the relation should be
          enum:
            - IsManagedBy
        businessPartnerSourceExternalId:
          type: string
          description: The external identifier of the business partner from which the relation should emerge (the source)
        businessPartnerTargetExternalId:
          type: string
          description: The external identifier of the business partner to which the relation should point (the target)
      description: A request to update the content of the given business partner relation
    SharingStateDto:
      required:
        - externalId
        - sharingStateType
      type: object
      properties:
        externalId:
          type: string
          description: The external identifier of the business partner for which the sharing state entry was created.
        sharingStateType:
          type: string
          description: One of the sharing state types of the current sharing state.
          enum:
            - Pending
            - Success
            - Error
            - Initial
            - Ready
        sharingErrorCode:
          type: string
          description: |-
            One of the sharing error codes in case the current sharing state type is "error". 
            * `NaturalPersonError`: The provided record contains natural person information.
            * `BpnErrorNotFound`: The provided record can not be matched to a legal entity or an address.
            * `BpnErrorTooManyOptions`: The provided record can not link to a clear legal entity.
            * `MandatoryFieldValidationFailed`: The provided record does not fulfill mandatory validation rules.
            * `BlacklistCountryPresent`: The provided record is part of a country that is not allowed to be processed by the GR process (example: Brazil).
            * `UnknownSpecialCharacters`: The provided record contains unallowed special characters.
          enum:
            - SharingProcessError
            - SharingTimeout
            - BpnNotInPool
            - MissingTaskID
            - NaturalPersonError
            - BpnErrorNotFound
            - BpnErrorTooManyOptions
            - MandatoryFieldValidationFailed
            - BlacklistCountryPresent
            - UnknownSpecialCharacters
        sharingErrorMessage:
          type: string
          description: The error message in case the current sharing state type is "error".
        sharingProcessStarted:
          type: string
          description: The date and time when the sharing process was started.
          format: date-time
        taskId:
          type: string
          description: The orchestrator task identifier that was created
      description: |
        A sharing state entry shows the progress in the sharing process and is updated each time the progress for a business partner changes. The business partner is identified by a combination of external ID and business partner type.
    SiteRepresentationInputDto:
      required:
        - states
      type: object
      properties:
        siteBpn:
          type: string
          description: The BPNS of the site, on which the business partner provides a view.
        name:
          type: string
          description: The name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses.
        states:
          type: array
          items:
            $ref: '#/components/schemas/BusinessPartnerStateDto'
      description: The site, on which the business partner provides a view.
    SiteRepresentationOutputDto:
      required:
        - confidenceCriteria
        - siteBpn
        - states
      type: object
      properties:
        siteBpn:
          type: string
          description: The BPNS of the site, on which the business partner provides a view.
        name:
          type: string
          description: The name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses.
        confidenceCriteria:
          $ref: '#/components/schemas/ConfidenceCriteriaDto'
        states:
          type: array
          items:
            $ref: '#/components/schemas/BusinessPartnerStateDto'
      description: Site properties of business partner output data
    StatsAddressTypesResponse:
      required:
        - additionalTotal
        - legalAndSiteTotal
        - legalTotal
        - siteTotal
      type: object
      properties:
        legalAndSiteTotal:
          type: integer
          format: int32
        legalTotal:
          type: integer
          format: int32
        siteTotal:
          type: integer
          format: int32
        additionalTotal:
          type: integer
          format: int32
    StatsConfidenceCriteriaResponse:
      required:
        - checkedByExternalDataSourceTotal
        - confidenceLevelAverage
        - numberOfBusinessPartnersAverage
        - sharedByOwnerTotal
        - uniqueTotal
      type: object
      properties:
        numberOfBusinessPartnersAverage:
          type: number
          format: float
        uniqueTotal:
          type: integer
          format: int64
        sharedByOwnerTotal:
          type: integer
          format: int64
        checkedByExternalDataSourceTotal:
          type: integer
          format: int64
        confidenceLevelAverage:
          type: number
          format: float
    StatsSharingStatesResponse:
      required:
        - errorTotal
        - initialTotal
        - pendingTotal
        - readyTotal
        - successTotal
      type: object
      properties:
        initialTotal:
          type: integer
          format: int32
        readyTotal:
          type: integer
          format: int32
        pendingTotal:
          type: integer
          format: int32
        successTotal:
          type: integer
          format: int32
        errorTotal:
          type: integer
          format: int32
    StatsStagesResponse:
      required:
        - inputTotal
        - outputTotal
      type: object
      properties:
        inputTotal:
          type: integer
          format: int32
        outputTotal:
          type: integer
          format: int32
    StreetDto:
      type: object
      properties:
        namePrefix:
          type: string
          description: The street related information, which is usually printed before the official street name on an address label.
        additionalNamePrefix:
          type: string
          description: The additional street related information, which is usually printed before the official street name on an address label.
        name:
          type: string
          description: The name of the street.
        nameSuffix:
          type: string
          description: The street related information, which is usually printed after the official street name on an address label.
        additionalNameSuffix:
          type: string
          description: The additional street related information, which is usually printed after the official street name on an address label.
        houseNumber:
          type: string
          description: The number representing the exact location of a building within the street.
        houseNumberSupplement:
          type: string
        milestone:
          type: string
          description: The number representing the exact location of an addressed object within a street without house numbers, such as within long roads.
        direction:
          type: string
          description: The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South.
      description: 'The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway'
  securitySchemes:
    open_id_scheme:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: http://localhost:8180/realms/CX-Central/protocol/openid-connect/token
          scopes: {}
        authorizationCode:
          authorizationUrl: http://localhost:8180/realms/CX-Central/protocol/openid-connect/auth
          tokenUrl: http://localhost:8180/realms/CX-Central/protocol/openid-connect/token
          refreshUrl: http://localhost:8180/realms/CX-Central/protocol/openid-connect/token
          scopes: {}
    bearer_scheme:
      type: http
      scheme: bearer
      bearerFormat: JWT