openapi: 3.0.1
info:
  title: 'SiGREEN REST API '
  description: >-
    This API specification serves as reference within SiGREEN project for how to
    design and specify HTTPs-based APIs
  contact:
    name: SiGREEN API Support
    url: https://api.sigreen-dev.siemens.cloud/
    email: sigreensupport.industry@siemens.com
  version: v1
servers:
  - url: https://app.sigreen.siemens.com/api
    description: SiGREEN Production Server
  - url: https://app-uat.sigreen-playground.siemens.cloud/api
    description: SiGREEN User Acceptance Test (UAT) Serve
tags:
  - name: PCF
    description: "![basic](https://img.shields.io/badge/API%20Package-BASIC-green) Product's pcf"
paths:
  /pcf/products/{id}/standard/tfs:
    post:
      tags:
        - PCF
      summary: >-
        To create a TFS standard credential for a specific product of a company
        in SiGREEN.
      description: >-
        This API creates TFS standard credential for a specific product of a
        company in SiGREEN.
      operationId: createPCF
      parameters:
        - name: id
          in: path
          description: UUID of the product of a company in SiGREEN.
          required: true
          schema:
            type: string
          example: 098QA1-UK9026-HJH99716-LML123H
      requestBody:
        description: Request should contain fields as mentioned in the schema.
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/TFS-V2'
        required: true
      responses:
        '202':
          description: A job id will be returned upon successful validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PCFResponseData'
        '400':
          description: Bad request.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://developer.siemens.com/sigreen/validation-error.html
                title: Bad request
                status: 400
                traceId: UUID
                instance: /api/tasks/inboundPcfRequests
                errors:
                  - detail: >-
                      Invalid Date Format. Please send valid date format (for
                      eg: yyyy-MM-dd'T'HH:mm:ss'Z')
                    code: SIG-VLD-001
                    pointer: /data/0/from
        '401':
          description: Unauthorized.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://developer.siemens.com/sigreen/validation-error.html
                title: UnAuthorised1
                status: 401
                traceId: UUID
                instance: /api/tasks/inboundPcfRequests
                errors:
                  - detail: >-
                      Invalid token, please provide appropriate token to call
                      the API
                    code: SIG-VLD-008
                    pointer: /data/0/from
        '403':
          description: Forbidden.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://developer.siemens.com/sigreen/validation-error.html
                title: Forbidden
                status: 403
                traceId: UUID
                instance: /api/tasks/inboundPcfRequests
                errors:
                  - detail: You are not authorized to perform the current operation
                    code: SIG-VLD-007
                    pointer: /data/0/from
        '404':
          description: Forbidden.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://developer.siemens.com/sigreen/validation-error.html
                title: Bad request
                status: 404
                traceId: UUID
                instance: /api/tasks/inboundPcfRequests
                errors:
                  - detail: Product identifier is not found for this company.
                    code: SIG-BUS-001
                    pointer: /data/0/from
        5XX:
          description: Unexpected error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://developer.siemens.com/sigreen/validation-error.html
                title: Internal Server Error
                status: 500
                traceId: UUID
                instance: /api/tasks/inboundPcfRequests
                errors:
                  - detail: Error while parsing
                    code: SIG-VLD-003
                    pointer: /data/0/from
      security:
        - endpoint_auth: []
  /pcf/products/{id}/standard/catena-x:
    post:
      tags:
        - PCF
      summary: >-
        To create a CatenaX standard credential for a specific product of a
        company in SiGREEN.
      description: >-
        This API creates CatenaX standard credential for a specific product of a
        company in SiGREEN.
      operationId: createPCF_1
      parameters:
        - name: id
          in: path
          description: UUID of the product of a company in SiGREEN.
          required: true
          schema:
            type: string
          example: 098QA1-UK9026-HJH99716-LML123H
      requestBody:
        description: Request should contain fields as mentioned in the schema.
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/CATENA-X-V2.2'
        required: true
      responses:
        '202':
          description: A job id will be returned upon successful validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PCFResponseData'
        '400':
          description: Bad request.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://developer.siemens.com/sigreen/validation-error.html
                title: Bad request
                status: 400
                traceId: UUID
                instance: /api/tasks/inboundPcfRequests
                errors:
                  - detail: >-
                      Invalid Date Format. Please send valid date format (for
                      eg: yyyy-MM-dd'T'HH:mm:ss'Z')
                    code: SIG-VLD-001
                    pointer: /data/0/from
        '401':
          description: Unauthorized.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://developer.siemens.com/sigreen/validation-error.html
                title: UnAuthorised1
                status: 401
                traceId: UUID
                instance: /api/tasks/inboundPcfRequests
                errors:
                  - detail: >-
                      Invalid token, please provide appropriate token to call
                      the API
                    code: SIG-VLD-008
                    pointer: /data/0/from
        '403':
          description: Forbidden.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://developer.siemens.com/sigreen/validation-error.html
                title: Forbidden
                status: 403
                traceId: UUID
                instance: /api/tasks/inboundPcfRequests
                errors:
                  - detail: You are not authorized to perform the current operation
                    code: SIG-VLD-007
                    pointer: /data/0/from
        '404':
          description: Forbidden.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://developer.siemens.com/sigreen/validation-error.html
                title: Bad request
                status: 404
                traceId: UUID
                instance: /api/tasks/inboundPcfRequests
                errors:
                  - detail: Product identifier is not found for this company.
                    code: SIG-BUS-001
                    pointer: /data/0/from
        5XX:
          description: Unexpected error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://developer.siemens.com/sigreen/validation-error.html
                title: Internal Server Error
                status: 500
                traceId: UUID
                instance: /api/tasks/inboundPcfRequests
                errors:
                  - detail: Error while parsing
                    code: SIG-VLD-003
                    pointer: /data/0/from
      security:
        - endpoint_auth: []
  /pcf/jobs/{id}/status:
    get:
      tags:
        - PCF
      summary: It is to know whether credential has been created or not.
      description: This API is used to fetch the status of a job.
      operationId: createPCF_2
      parameters:
        - name: id
          in: path
          description: Alphanumeric identifier to fetch job status in SiGREEN.
          required: true
          schema:
            type: string
            description: Alphanumeric identifier to fetch job status in SiGREEN.
            example: 098QA0-UK9099-HJH98275-LML891
          example: 098QA0-UK9099-HJH98275-LML891
      responses:
        '200':
          description: A specific job details, whether job completed or not.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PCFJobStatus'
        '401':
          description: 'No valid token provided. '
        '403':
          description: Does not have privileges to call the API
        '404':
          description: Job not found.
          content:
            application/problem+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Problem'
        5XX:
          description: Unexpected error.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
              example:
                type: https://developer.siemens.com/sigreen/validation-error.html
                title: Internal Server Error
                status: 500
                traceId: UUID
                instance: /api/tasks/inboundPcfRequests
                errors:
                  - detail: Error while parsing
                    code: SIG-VLD-003
                    pointer: /data/0/from
      security:
        - endpoint_auth: []
components:
  schemas:
    PCFResponseData:
      type: object
      properties:
        id:
          type: string
          description: >-
            A unique string identifier (UUID), representing a flow through the
            system
          example: 098QA0-UK9099-HJH98275-LML891
        jobStatus:
          type: string
          description: Status of the job
          example: PENDING
          enum:
            - PENDING
            - IN_PROGRESS
            - COMPLETED
            - FAILED
    Errors:
      type: object
      properties:
        code:
          type: string
          description: >-
            An application-specific error code, expressed as a string value,
            mostly is this used for validation errors. The format and type of
            code representation MUST be harmonized across all services within
            SiGREEN. The code focuses on programs and doesn’t have to be
            human-readable.
          example: SIG_VLD-092
        detail:
          type: string
          description: >-
            Developer friendly, human-readable, detailed description specific to
            the occurrence of the problem.
          example: >-
            Invalid Date Format. Please send valid date format (for eg:
            yyyy-MM-dd'T'HH:mm:ss'Z')
        pointer:
          type: string
          description: >-
            String with a generated pointer to the wrong value; Collections
            integrated as an integer, starts with 0
          example: /data/0/from
      description: >-
        Extended error array to include descriptions about errors like
        validation errors.
    Problem:
      type: object
      properties:
        type:
          type: string
          description: >-
            A URI reference that identifies the problem type. This should be a
            human-redable documentation for the problem type (e.g. list of
            SiGREEN Validation errors). When this member is not present, its
            value is assumed to be 'about:blank'.
          example: https://developer.siemens.com/sigreen/validation-error.html
        title:
          type: string
          description: >-
            Developer friendly, human-readable description or summary that
            SHOULD NOT change from occurrence to occurrence of the problem. In
            case of using a custom HTTP status codes in the status field of the
            error object, the title MUST provide a concise description of the
            HTTP error code (for example: status: '599', title: 'Network
            Connection Timeout').
          example: Bad request
        status:
          type: integer
          description: Numeric HTTP status code for the specific error.
          format: int32
          example: 400
        instance:
          type: string
          description: >-
            A URI reference that points to the specific resource where the
            problem was identified (for example: points to the api resource
            /api/v1/products/{productId}).
          example: /api/v1/products/{productId}
        traceId:
          type: string
          description: >-
            A unique string identifier (UUID), representing a flow through the
            system.
          example: UUID
        errors:
          type: array
          description: List of detailed error objects
          items:
            $ref: '#/components/schemas/Errors'
    CompanyTFSV2:
      required:
        - companyIds
      type: object
      properties:
        companyIds:
          type: array
          description: Company IDs
          example:
            - urn:company:id001
            - urn:company:id001
          items:
            maxLength: 200
            minLength: 0
            type: string
      description: Company details
      example:
        companyIds:
          - company
    DQI:
      type: object
      properties:
        technologicalDQR:
          maximum: 3
          minimum: 1
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            The degree to which the data reflects the actual technology(ies)
            used; 1 -Good: Data generated using the same technology; 2 -Fair:
            Data generated using a similar but different technology (based on
            secondary data sources); 3 -Poor: Data of a different or unknown.
          format: float
          example: '1.2'
        temporalDQR:
          maximum: 3
          minimum: 1
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            The degree to which the data reflects the actual time (e.g., year)
            or age of the process; 1 -Good: Data from the same reporting year;
            2- Fair: Data less than 5 years old; 3 -Poor: Data more than 5 years
            old.
          format: float
          example: '1.3'
        geographicalDQR:
          maximum: 3
          minimum: 1
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            The degree to which the data reflects the actual geographic location
            of the processes within the inventory boundary (e.g., country or
            region); 1 -Good: Data from the same country or country subdivision;
            2- Fair: Data from the Same region or subregion; 3 -Poor: Global
            data or from an unknow region.
          format: float
          example: '1.8'
        completenessDQR:
          maximum: 3
          minimum: 1
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            The degree to which the data is statistically representative of the
            process sites; 1 -Good: Activity data collected for all relevant
            sites for specified period; 2- Fair: Activity data collected for
            <50% of sites for specified period or >50% of sites for shorter
            period; 3 -Poor: Activity data collected for <50% of sites for
            shorter time period or unknown.
          format: float
          example: '2.5'
        reliabilityDQR:
          maximum: 3
          minimum: 1
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            The degree to which the sources, data collection methods, and
            verification procedures used to obtain the data are dependable; 1
            -Good: Measured activity data; 2- Fair: Activity data partly based
            on assumptions; 3 -Poor: Financial data or nonqualified estimate.
          format: float
          example: '2.5'
      description: Data quality indicators.
      example:
        technologicalDQR: '1.2'
        temporalDQR: '1.3'
        geographicalDQR: '1.8'
        completenessDQR: '2.5'
        reliabilityDQR: '2.5'
    DistributionStageTFSV2:
      type: object
      properties:
        pcfIncludingBiogenic:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Total GHG emissions and removals including biogenic CO2 (typically
            excluding iLUC). kg CO2e/declared unit
          format: float
          example: '79.86801562912'
        pcfExcludingBiogenic:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Total GHG emissions and removals excluding biogenic CO2 (typically
            excluding iLUC). kg CO2e/declared unit
          format: float
          example: '79.86801562912'
        fossilGhgEmissions:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Fossil GHG emissions and removals (including aircraft emissions, if
            aircraft emissions are not reported separately). kg CO2e/declared
            unit
          format: float
          example: '79.86801562912'
        biogenicCarbonEmissionsOtherThanCO2:
          maxLength: 15
          minLength: 0
          type: string
          description: Biogenic GHG emissions excluding biogenic CO2. kg CO2e/declared unit
          format: float
          example: '79.86801562912'
        biogenicCarbonWithdrawal:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Biogenic CO2 removal calculated by converting biogenic carbon
            contained in the product to kg CO2. kg CO2e/declared unit
          format: float
          example: '79.86801562912'
        luGhgEmissions:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            GHG emissions and removals occurring as result of land use
            (aggregated values of dLUC and LU are to be reported as dLUC). kg
            CO2e/declared unit
          format: float
          example: '79.86801562912'
        aircraftGhgEmissions:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            GHG emissions occurring as a result of aircraft engine usage for the
            transport of the product (without application of multipliers). kg
            CO2e/declared unit
          format: float
          example: '79.86801562912'
        dLucGhgEmissions:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            GHG emissions and removals occurring as result of direct land use
            change (aggregated values of dLUC and LU are to be reported as
            dLUC). kg CO2e/declared unit
          format: float
          example: '79.86801562912'
      description: Distribution stage details.
      example:
        pcfIncludingBiogenic: '79.86801562912'
        pcfExcludingBiogenic: '79.86801562912'
        fossilGhgEmissions: '79.86801562912'
        biogenicCarbonEmissionsOtherThanCO2: '79.86801562912'
        biogenicCarbonWithdrawal: '79.86801562912'
        dLucGhgEmissions: '79.86801562912'
        luGhgEmissions: '79.86801562912'
        aircraftGhgEmissions: '79.86801562912'
    PCFDataTFSV2:
      required:
        - allocationRulesDescription
        - allocationWasteIncineration
        - characterizationFactors
        - created
        - crossSectoralStandardsUsed
        - declaredUnit
        - exemptedEmissionsPercent
        - geographyRegionOrSubregion
        - productCarbonContent
        - productMassPerDeclaredUnit
        - productOrSectorSpecificRules
        - productionStage
        - referencePeriodEnd
        - referencePeriodStart
        - scopePcf
        - secondaryEmissionFactorSources
        - unitaryProductAmount
        - validityPeriodEnd
      type: object
      properties:
        scopePcf:
          $ref: '#/components/schemas/ScopePCFTFSV2'
        declaredUnit:
          type: string
          description: >-
            The declared unit is the unit in which the product is declared, e.g.
            kg, piece, L, m3, m2, kWh, MJ, tkm.
          example: kg
          enum:
            - kg
            - piece
            - m2
            - m3
            - kWh
            - tkm
            - MJ
            - L
        unitaryProductAmount:
          maxLength: 20
          minLength: 0
          type: string
          description: >-
            Quantity (amount) of the declared unit as numerical value. Commonly
            the quantity is defined a value 1, e.g. 1 kg.
          format: float
          example: '1'
        productMassPerDeclaredUnit:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Mass of the product (excluding packaging) per declared unit in kg,
            e.g. for a circuit board with a declared unit of one piece the mass
            could be stated as 0.123 kg
          format: float
          example: '1.6'
        referencePeriodStart:
          type: string
          description: >-
            Start of time period of data collection for primary data sources
            (this does not refer to publication dates of secondary data).
            DateTime (ISO 8601; UTC Timezone)
          example: '2022-11-20T08:30:00.000Z'
        referencePeriodEnd:
          type: string
          description: >-
            End of time period of data collection for primary data sources.
            DateTime (ISO 8601; UTC Timezone)
          example: '2022-11-20T08:30:00.000Z'
        validityPeriodStart:
          type: string
          description: >-
            The time stamp at which the PCF is declared valid. If not specified,
            the validity period starts with the date of issue. DateTime (ISO
            8601; UTC Timezone)
          example: '2022-11-20T08:30:00.000Z'
        validityPeriodEnd:
          type: string
          description: >-
            Time stamp declaring the expected end of the use period for this
            declaration or date of expected update (i.e. when does the data
            validity period end?). DateTime (ISO 8601; UTC Timezone)
          example: '2022-11-20T08:30:00.000Z'
        productionStage:
          $ref: '#/components/schemas/ProductionStageTFSV2'
        distributionStage:
          $ref: '#/components/schemas/DistributionStageTFSV2'
        productCarbonContent:
          $ref: '#/components/schemas/ProductCarbonContentTFSV2'
        exemptedEmissionsPercent:
          maximum: 10
          minimum: 0
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Applied cut-off criteria in percent of total emissions. This
            specifies which percentage of emissions were excluded from the PCF
            in total, in order to reduce efforts in data collection of
            irrelevant processes.
          format: float
          example: '1'
        exemptedEmissionsDescription:
          maxLength: 300
          minLength: 0
          type: string
          description: Rationale behind exclusion of specific PCF emissions.
          example: exemptedEmissionsDescription
        boundaryProcessesDescription:
          maxLength: 2000
          minLength: 0
          type: string
          description: >-
            Brief description of the significantly contributing manufacturing
            steps of the product (including general description of used
            technologies).
          example: boundaryProcessesDescription
        typeRecycledContent:
          type: string
          description: >-
            The type of recycled content. The type of the recycled content can
            only be post-industrial or post-consumer.
          example: post-industrial
          enum:
            - post-industrial
            - post-consumer
        ccuCo2Origin:
          maxLength: 1000
          minLength: 0
          type: string
          description: >-
            Source from where CO2 is captured (e.g. DAC/direct air capture or
            source ammonia plant).
          example: Direct air capture
        geographyCountrySubdivision:
          pattern: ^[A-Z]{2}-[A-Z0-9]{1,3}$
          type: string
          description: >-
            City/state as country subdivision. According to ISO 3166-2 alpha-2
            subdivision code.
          example: DE-BY
        geographyCountry:
          pattern: ^[A-Z]{2}$
          type: string
          description: Geography country according to ISO 3166-2 alpha-2 country code.
          example: DE
        geographyRegionOrSubregion:
          type: string
          description: >-
            This geographical information refers to the locations of the factory
            gates of the last manufacturing step. State as described in ISO
            3166, e.g. Global, EUROPE, DE.
          example: Europe
          enum:
            - Africa
            - Americas
            - Asia
            - Europe
            - Oceania
            - Australia and New Zealand
            - Central Asia
            - Eastern Asia
            - Eastern Europe
            - Latin America and the Caribbean
            - Melanesia
            - Micronesia
            - Northern Africa
            - Northern America
            - Northern Europe
            - Polynesia
            - South-eastern Asia
            - Southern Asia
            - Southern Europe
            - Sub-Saharan Africa
            - Western Asia
            - Western Europe
            - Global
        locationProductHandover:
          type: string
          description: >-
            The location of product handover/location up to where emissions are
            accounted for.
          example: Own factory gate
          enum:
            - Own factory gate
            - Customer gate
            - Other
        created:
          type: string
          description: >-
            The time stamp at which the PCF has been declared, independently of
            when or if it has been shared. This represents the validity period
            start unless specified separately. DateTime (ISO 8601; UTC Timezone)
          example: '2022-11-20T08:30:00.000Z'
        crossSectoralStandardsUsed:
          type: array
          description: >-
            The standard that the PCF calculation is based on and compliant to
            (multiple entries are possible). Please note: the PCF can be
            calculated according to a different standard than the standard
            defining the data model used for reporting the PCF. Following
            standards are considered ISO 14067, Pathfinder v1, Pathfinder v2,
            GHG Protocol Product, PAS 2050, ISO 14040-44, PEF. Apart from these
            standards user can allow to add one more standard which is know to
            user. This is considered as Other standard while viewing credential.
          example:
            - ISO 14067
            - Pathfinder v1
          items:
            maxLength: 200
            minLength: 0
            type: string
        productOrSectorSpecificRules:
          maxLength: 200
          minLength: 0
          type: string
          description: >-
            Any sector guidance framework, product category rule (PCR) or
            product specific rule (PSR) published by a specific operator,
            followed and applied during PCF calculation. Such rulesets provide
            specific guidance and enhance comparability between assessments of
            different suppliers in the same category (sector).
          example: Catena-X Rulebook v1
          enum:
            - Catena-X Rulebook v1
            - Catena-X Rulebook v2
            - TFS Guideline v2
            - EN 50693
            - EN 15804
            - BPX 30-323
            - Not specified
        characterizationFactors:
          type: string
          description: >-
            The IPCC (Intergovernmental Panel of Climate change) frequently
            releases global warming potential (GWP) values for climate gases
            related to CO2. These GWP values are released in Assessment Reports
            (AR), which are numbered. The AR number can be used to track the age
            and accuracy of the GWP values used in reporting.
          example: AR6
          enum:
            - AR5
            - AR6
            - Unspecified
        allocationRulesDescription:
          maxLength: 1000
          minLength: 0
          type: string
          description: >-
            Description of the allocation rules applied to multi-output
            processes in your foreground data and explain the underlying reasons
            (way of allocating all activities from your manufacturing steps to
            the declared unit). Description of the allocation rules applied to
            end-of-life processes (also refers to manufacturing related waste).
          example: Weight based allocation
        allocationWasteIncineration:
          type: string
          description: >-
            Material recycling and waste treatment with energy recovery are
            considered separate and not equal. Incineration is the least
            favorable solution because it is a final disposal. One of the three
            allocation approaches shall be followed: Cut-off approach also known
            as recycled content approach; Reverse Cut-off approach also known as
            waste allocation; Substitution. Please state which approach was
            applied and if available, according to which PCR.
          example: cut-off
          enum:
            - cut-off
            - reverse cut-off
            - system expansion
        allocationRecycledCarbon:
          type: string
          description: >-
            Selected allocation approach for any recycled material, e.g.
            upstream system expansion or cut-off in accordance with a certain
            PCR.
          example: upstream system expansion
          enum:
            - upstream system expansion
            - cut-off
        allocationCcuCarbon:
          maxLength: 1000
          minLength: 0
          type: string
          description: >-
            Allocation approach used in case of including carbon capture and
            utilization (CCU) processes within the system boundaries, e.g.
            system expansion and substitution in accordance with a certain PCR.
          example: allocationCcuCarbon
        primaryDataShare:
          maximum: 100
          minimum: 0
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Share of primary data in the final PCF, calculated according to
            current WBCSD Pathfinder Framework. This can be done by calculating
            the proportion (percentage) of the total GHG emissions (CO2e) that
            is derived using primary data.
          example: '20'
        secondaryEmissionFactorSources:
          type: array
          description: >-
            Secondary data sources and versions used for this declaration, e.g.
            data bases such as ecoinvent.
          example:
            - ecoinvent
          items:
            maxLength: 200
            minLength: 0
            type: string
        dqi:
          $ref: '#/components/schemas/DQI'
        comment:
          maxLength: 10000
          minLength: 0
          type: string
          description: >-
            Please comment/document anything relevant for a receiving party or
            yourself, necessary to understand it representative for his/her
            application.
          example: Comment
        precedingPCFIds:
          type: array
          description: >-
            PCF IDs of previously existing PCFs which will be succeeded by the
            current PCF.
          example:
            - id1
            - id2
            - id3
          items:
            maxLength: 400
            minLength: 0
            type: string
      description: PCF data details.
    ProductCarbonContentTFSV2:
      required:
        - carbonContentTotal
      type: object
      properties:
        carbonContentTotal:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Total carbon content accounts for the embodied mass of carbon (kg C)
            per declared unit of product.
          format: float
          example: '79.86801562912'
        carbonContentBiogenic:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Biogenic carbon content accounts for the embodied mass of biogenic
            carbon (kg C) per declared unit of product.
          format: float
          example: '79.86801562912'
        carbonContentRecycled:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Recycled carbon content accounts for the embodied mass of recycled
            (physically or biomass balance-based) carbon (kg C) per declared
            unit of product.
          format: float
          example: '79.86801562912'
        carbonContentCcuBased:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            CCU-based carbon content accounts for the embodied mass of carbon
            (kg C) per declared unit of product resulting from the use of carbon
            capture and utilization technologies.
          format: float
          example: '79.86801562912'
      description: Product carbon content details.
      example:
        carbonContentTotal: '79.86801562912'
        carbonContentBiogenic: '79.86801562912'
        carbonContentRecycled: '79.86801562912'
        carbonContentCcuBased: '79.86801562912'
    ProductTFSV2:
      required:
        - productIds
      type: object
      properties:
        productIds:
          uniqueItems: true
          type: array
          description: >-
            All relevant product identifiers, e.g. supplier part number, GTIN,
            article number, CPC classification, CAS Number, BOM Version, batch
            number etc.
          example:
            - '401765'
            - 4303F98A-785F
          items:
            type: string
        productCodeCas:
          maxLength: 20
          minLength: 0
          type: string
          description: >-
            The corresponding CAS number to your product (unique identification
            number assigned to chemical substances).
          example: 58-08-2
        productDescription:
          maxLength: 2000
          minLength: 0
          type: string
          description: >-
            Brief description of the product (for example functions and
            technical parameters).
          example: Ethanol, 95% solution
      description: Product details.
      example:
        productIds:
          - '401765'
          - 4303F98A-785F
        productCodeCas: 58-08-2
        productDescription: Ethanol, 95% solution
    ProductionStageTFSV2:
      required:
        - pcfExcludingBiogenic
      type: object
      properties:
        pcfIncludingBiogenic:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Total GHG emissions and removals including biogenic CO2 (typically
            excluding iLUC). kg CO2e/declared unit
          format: float
          example: '79.86801562912'
        pcfExcludingBiogenic:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Total GHG emissions and removals excluding biogenic CO2 (typically
            excluding iLUC). kg CO2e/declared unit
          format: float
          example: '79.86801562912'
        fossilGhgEmissions:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Fossil GHG emissions and removals (including aircraft emissions, if
            aircraft emissions are not reported separately). kg CO2e/declared
            unit
          format: float
          example: '79.86801562912'
        biogenicCarbonEmissionsOtherThanCO2:
          maxLength: 15
          minLength: 0
          type: string
          description: Biogenic GHG emissions excluding biogenic CO2. kg CO2e/declared unit
          format: float
          example: '79.86801562912'
        biogenicCarbonWithdrawal:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Biogenic CO2 removal calculated by converting biogenic carbon
            contained in the product to kg CO2. kg CO2e/declared unit
          format: float
          example: '79.86801562912'
        luGhgEmissions:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            GHG emissions and removals occurring as result of land use
            (aggregated values of dLUC and LU are to be reported as dLUC). kg
            CO2e/declared unit
          format: float
          example: '79.86801562912'
        aircraftGhgEmissions:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            GHG emissions occurring as a result of aircraft engine usage for the
            transport of the product (without application of multipliers). kg
            CO2e/declared unit
          format: float
          example: '79.86801562912'
        dLucGhgEmissions:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            GHG emissions and removals occurring as result of direct land use
            change (aggregated values of dLUC and LU are to be reported as
            dLUC). kg CO2e/declared unit
          format: float
          example: '79.86801562912'
      description: Production stage details.
      example:
        pcfIncludingBiogenic: '79.86801562912'
        pcfExcludingBiogenic: '79.86801562912'
        fossilGhgEmissions: '79.86801562912'
        biogenicCarbonEmissionsOtherThanCO2: '79.86801562912'
        biogenicCarbonWithdrawal: '79.86801562912'
        dLucGhgEmissions: '79.86801562912'
        luGhgEmissions: '79.86801562912'
        aircraftGhgEmissions: '79.86801562912'
    ScopePCFTFSV2:
      required:
        - packagingEmissionsIncluded
        - partialFullPcf
        - specVersion
      type: object
      properties:
        partialFullPcf:
          type: string
          description: Partial or a full PCF.
          example: Cradle-to-gate
          enum:
            - Cradle-to-gate
            - Cradle-to-grave
        packagingEmissionsIncluded:
          type: string
          description: Type of scope pcf.
          example: included
          enum:
            - included
            - excluded
        specVersion:
          type: string
          description: PCF standard and version
          example: TFS V2
      description: Scope of PCF details.
    TFS-V2:
      required:
        - company
        - pcfData
        - product
      type: object
      allOf:
        - $ref: '#/components/schemas/TfsPCFRequest'
        - type: object
          properties:
            company:
              $ref: '#/components/schemas/CompanyTFSV2'
            product:
              $ref: '#/components/schemas/ProductTFSV2'
            pcfData:
              $ref: '#/components/schemas/PCFDataTFSV2'
    TfsPCFRequest:
      type: object
    CATENA-X-V2.2:
      required:
        - company
        - pcfData
        - product
      type: object
      allOf:
        - $ref: '#/components/schemas/CatenaXPCFRequest'
        - type: object
          properties:
            company:
              $ref: '#/components/schemas/CompanyCATENA-X-V2.2'
            product:
              $ref: '#/components/schemas/ProductCATENA-X-V2.2'
            pcfData:
              $ref: '#/components/schemas/PCFDataCATENA-X-V2.2'
    CatenaXPCFRequest:
      type: object
    CompanyCATENA-X-V2.2:
      required:
        - companyIds
      type: object
      properties:
        companyIds:
          type: array
          description: Company IDs
          example:
            - urn:company:id001
            - mycompany.com
          items:
            maxLength: 200
            minLength: 0
            type: string
      description: Company details
      example:
        companyIds:
          - urn:company:id001
          - mycompany.com
    DistributionStageCATENA-X-V2.2:
      type: object
      properties:
        pcfIncludingBiogenic:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Total GHG emissions and removals including biogenic CO2 (typically
            excluding iLUC). kg CO2e/declared unit
          format: float
          example: '79.86801562912'
        pcfExcludingBiogenic:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Total GHG emissions and removals excluding biogenic CO2 (typically
            excluding iLUC). kg CO2e/declared unit
          format: float
          example: '79.86801562912'
        fossilGhgEmissions:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Fossil GHG emissions and removals (including aircraft emissions, if
            aircraft emissions are not reported separately). kg CO2e/declared
            unit
          format: float
          example: '79.86801562912'
        biogenicCarbonEmissionsOtherThanCO2:
          maxLength: 15
          minLength: 0
          type: string
          description: Biogenic GHG emissions excluding biogenic CO2. kg CO2e/declared unit
          format: float
          example: '79.86801562912'
        biogenicCarbonWithdrawal:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Biogenic CO2 removal calculated by converting biogenic carbon
            contained in the product to kg CO2. kg CO2e/declared unit
          format: float
          example: '79.86801562912'
        luGhgEmissions:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            GHG emissions and removals occurring as result of land use
            (aggregated values of dLUC and LU are to be reported as dLUC). kg
            CO2e/declared unit
          format: float
          example: '79.86801562912'
        aircraftGhgEmissions:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            GHG emissions occurring as a result of aircraft engine usage for the
            transport of the product (without application of multipliers). kg
            CO2e/declared unit
          format: float
          example: '79.86801562912'
        dLucGhgEmissions:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            GHG emissions and removals occurring as result of direct land use
            change (aggregated values of dLUC and LU are to be reported as
            dLUC). kg CO2e/declared unit
          format: float
          example: '79.86801562912'
      description: Distribution stage details.
      example:
        pcfIncludingBiogenic: '79.86801562912'
        pcfExcludingBiogenic: '79.86801562912'
        fossilGhgEmissions: '79.86801562912'
        biogenicCarbonEmissionsOtherThanCO2: '79.86801562912'
        biogenicCarbonWithdrawal: '79.86801562912'
        dLucGhgEmissions: '79.86801562912'
        luGhgEmissions: '79.86801562912'
        aircraftGhgEmissions: '79.86801562912'
    ManufacturingSubStage:
      type: object
      properties:
        packagingSub2Stage:
          $ref: '#/components/schemas/PackagingSub2Stage'
      description: manufacturing stage details.
      example: >-
        "manufacturingSubStage": { "packagingSub2Stage":
        {"pcfExcludingBiogenic":"79.86801562912"} }
    PCFDataCATENA-X-V2.2:
      required:
        - characterizationFactors
        - created
        - crossSectoralStandardsUsed
        - declaredUnit
        - exemptedEmissionsPercent
        - geographyRegionOrSubregion
        - productMassPerDeclaredUnit
        - productOrSectorSpecificRules
        - productionStage
        - referencePeriodEnd
        - referencePeriodStart
        - scopePcf
        - secondaryEmissionFactorSources
        - unitaryProductAmount
      type: object
      properties:
        scopePcf:
          $ref: '#/components/schemas/ScopePCFCATENA-X-V2.2'
        declaredUnit:
          type: string
          description: >-
            The declared unit is the unit in which the product is declared, e.g.
            kg, piece, L, m3, m2, kWh, MJ, tkm.
          example: kg
          enum:
            - kg
            - piece
            - m2
            - m3
            - kWh
            - tkm
            - MJ
            - L
        unitaryProductAmount:
          maxLength: 20
          minLength: 0
          type: string
          description: >-
            Quantity (amount) of the declared unit as numerical value. Commonly
            the quantity is defined a value 1, e.g. 1 kg.
          format: float
          example: '1'
        productMassPerDeclaredUnit:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Mass of the product (excluding packaging) per declared unit in kg,
            e.g. for a circuit board with a declared unit of one piece the mass
            could be stated as 0.123 kg
          format: float
          example: '1.6'
        productionStage:
          $ref: '#/components/schemas/ProductionStageCATENA-X-V2.2'
        distributionStage:
          $ref: '#/components/schemas/DistributionStageCATENA-X-V2.2'
        productCarbonContent:
          $ref: '#/components/schemas/ProductCarbonContentCATENA-X-V2.2'
        exemptedEmissionsPercent:
          maximum: 10
          minimum: 0
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Applied cut-off criteria in percent of total emissions. This
            specifies which percentage of emissions were excluded from the PCF
            in total, in order to reduce efforts in data collection of
            irrelevant processes.
          format: float
          example: '1'
        exemptedEmissionsDescription:
          maxLength: 300
          minLength: 0
          type: string
          description: Rationale behind exclusion of specific PCF emissions.
          example: exemptedEmissionsDescription
        boundaryProcessesDescription:
          maxLength: 2000
          minLength: 0
          type: string
          description: >-
            Brief description of the significantly contributing manufacturing
            steps of the product (including general description of used
            technologies).
          example: boundaryProcessesDescription
        geographyCountrySubdivision:
          pattern: ^[A-Z]{2}-[A-Z0-9]{1,3}$
          type: string
          description: >-
            City/state as country subdivision. According to ISO 3166-2 alpha-2
            subdivision code.
          example: DE-BY
        geographyCountry:
          pattern: ^[A-Z]{2}$
          type: string
          description: Geography country according to ISO 3166-2 alpha-2 country code.
          example: DE
        geographyRegionOrSubregion:
          type: string
          description: >-
            This geographical information refers to the locations of the factory
            gates of the last manufacturing step. State as described in ISO
            3166, e.g. Global, EUROPE, DE.
          example: Europe
          enum:
            - Africa
            - Americas
            - Asia
            - Europe
            - Oceania
            - Australia and New Zealand
            - Central Asia
            - Eastern Asia
            - Eastern Europe
            - Latin America and the Caribbean
            - Melanesia
            - Micronesia
            - Northern Africa
            - Northern America
            - Northern Europe
            - Polynesia
            - South-eastern Asia
            - Southern Asia
            - Southern Europe
            - Sub-Saharan Africa
            - Western Asia
            - Western Europe
            - Global
        locationProductHandover:
          type: string
          description: >-
            The location of product handover/location up to where emissions are
            accounted for.
          example: Own factory gate
          enum:
            - Own factory gate
            - Customer gate
            - Other
        created:
          type: string
          description: >-
            The time stamp at which the PCF has been declared, independently of
            when or if it has been shared. This represents the validity period
            start unless specified separately. DateTime (ISO 8601; UTC Timezone)
          example: '2022-11-20T08:30:00.000Z'
        referencePeriodStart:
          type: string
          description: >-
            Start of time period of data collection for primary data sources
            (this does not refer to publication dates of secondary data).
            DateTime (ISO 8601; UTC Timezone)
          example: '2022-11-20T08:30:00.000Z'
        referencePeriodEnd:
          type: string
          description: >-
            End of time period of data collection for primary data sources.
            DateTime (ISO 8601; UTC Timezone)
          example: '2022-11-20T08:30:00.000Z'
        validityPeriodStart:
          type: string
          description: >-
            The time stamp at which the PCF is declared valid. If not specified,
            the validity period starts with the date of issue. DateTime (ISO
            8601; UTC Timezone)
          example: '2022-11-20T08:30:00.000Z'
        validityPeriodEnd:
          type: string
          description: >-
            Time stamp declaring the expected end of the use period for this
            declaration or date of expected update (i.e. when does the data
            validity period end?). DateTime (ISO 8601; UTC Timezone)
          example: '2022-11-20T08:30:00.000Z'
        crossSectoralStandardsUsed:
          type: array
          description: >-
            The standard that the PCF calculation is based on and compliant to
            (multiple entries are possible). Please note: the PCF can be
            calculated according to a different standard than the standard
            defining the data model used for reporting the PCF. Following
            standards are considered ISO 14067, Pathfinder v1, Pathfinder v2,
            GHG Protocol Product, PAS 2050, ISO 14040-44, PEF. Apart from these
            standards user can allow to add one more standard which is know to
            user. This is considered as Other standard while viewing credential.
          example:
            - ISO 14067
            - Pathfinder v1
          items:
            maxLength: 200
            minLength: 0
            type: string
        productOrSectorSpecificRules:
          maxLength: 200
          minLength: 0
          type: string
          description: >-
            Any sector guidance framework, product category rule (PCR) or
            product specific rule (PSR) published by a specific operator,
            followed and applied during PCF calculation. Such rulesets provide
            specific guidance and enhance comparability between assessments of
            different suppliers in the same category (sector).
          example: Catena-X Rulebook v1
          enum:
            - Catena-X Rulebook v1
            - Catena-X Rulebook v2
            - TFS Guideline v2
            - EN 50693
            - EN 15804
            - BPX 30-323
            - Not specified
        characterizationFactors:
          type: string
          description: >-
            The IPCC (Intergovernmental Panel of Climate change) frequently
            releases global warming potential (GWP) values for climate gases
            related to CO2. These GWP values are released in Assessment Reports
            (AR), which are numbered. The AR number can be used to track the age
            and accuracy of the GWP values used in reporting.
          example: AR6
          enum:
            - AR5
            - AR6
            - Unspecified
        allocationRulesDescription:
          maxLength: 1000
          minLength: 0
          type: string
          description: >-
            Description of the allocation rules applied to multi-output
            processes in your foreground data and explain the underlying reasons
            (way of allocating all activities from your manufacturing steps to
            the declared unit). Description of the allocation rules applied to
            end-of-life processes (also refers to manufacturing related waste).
          example: Weight based allocation
        primaryDataShare:
          maximum: 100
          minimum: 0
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Share of primary data in the final PCF, calculated according to
            current WBCSD Pathfinder Framework. This can be done by calculating
            the proportion (percentage) of the total GHG emissions (CO2e) that
            is derived using primary data.
          example: '20'
        secondaryEmissionFactorSources:
          type: array
          description: >-
            Secondary data sources and versions used for this declaration, e.g.
            data bases such as ecoinvent.
          example:
            - ecoinvent
          items:
            maxLength: 200
            minLength: 0
            type: string
        dqi:
          $ref: '#/components/schemas/DQI'
        comment:
          maxLength: 10000
          minLength: 0
          type: string
          description: >-
            Please comment/document anything relevant for a receiving party or
            yourself, necessary to understand it representative for his/her
            application.
          example: Comment
        pcfLegalStatement:
          maxLength: 10000
          minLength: 0
          type: string
          description: >-
            Option to add a legal statement/disclaimer defining certain
            conditions which apply to the publication of this PCF. The
            un-arranged use of this attribute might lead to significant efforts
            on the receiving side of this PCF.
          example: Legal statement
        precedingPCFIds:
          type: array
          description: >-
            PCF IDs of previously existing PCFs which will be succeeded by the
            current PCF.
          example:
            - id1
            - id2
            - id3
          items:
            maxLength: 400
            minLength: 0
            type: string
      description: PCF data details.
    PackagingSub2Stage:
      type: object
      properties:
        pcfExcludingBiogenic:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Total GHG emissions and removals excluding biogenic CO2 (sum of
            fossil, only biogenic other than CO2, direct land use change
            (optionally including land use) and aircraft emissions).
          format: float
          example: '79.86801562912'
    ProductCATENA-X-V2.2:
      required:
        - productIds
      type: object
      properties:
        productIds:
          uniqueItems: true
          type: array
          description: >-
            All relevant product identifiers, e.g. supplier part number, GTIN,
            article number, CPC classification, CAS Number, BOM Version, batch
            number etc.
          example:
            - '401765'
            - 4303F98A-785F
          items:
            type: string
        productCodeCpc:
          maxLength: 20
          minLength: 0
          type: string
          description: The corresponding UN Central Product Classification (CPC) code
          example: 58-08-2
        productDescription:
          maxLength: 2000
          minLength: 0
          type: string
          description: >-
            Brief description of the product (for example functions and
            technical parameters).
          example: Ethanol, 95% solution
      description: Product details.
      example:
        productIds:
          - '401765'
          - 4303F98A-785F
        productCodeCpc: 58-08-2
        productDescription: Ethanol, 95% solution
    ProductCarbonContentCATENA-X-V2.2:
      type: object
      properties:
        carbonContentTotal:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Total carbon content accounts for the embodied mass of carbon (kg C)
            per declared unit of product.
          format: float
          example: '79.86801562912'
        carbonContentBiogenic:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Biogenic carbon content accounts for the embodied mass of biogenic
            carbon (kg C) per declared unit of product.
          format: float
          example: '79.86801562912'
      description: Product carbon content details.
      example:
        carbonContentTotal: '79.86801562912'
        carbonContentBiogenic: '79.86801562912'
    ProductionStageCATENA-X-V2.2:
      required:
        - pcfExcludingBiogenic
      type: object
      properties:
        pcfIncludingBiogenic:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Total GHG emissions and removals including biogenic CO2 (typically
            excluding iLUC). kg CO2e/declared unit
          format: float
          example: '79.86801562912'
        pcfExcludingBiogenic:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Total GHG emissions and removals excluding biogenic CO2 (typically
            excluding iLUC). kg CO2e/declared unit
          format: float
          example: '79.86801562912'
        fossilGhgEmissions:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Fossil GHG emissions and removals (including aircraft emissions, if
            aircraft emissions are not reported separately). kg CO2e/declared
            unit
          format: float
          example: '79.86801562912'
        biogenicCarbonEmissionsOtherThanCO2:
          maxLength: 15
          minLength: 0
          type: string
          description: Biogenic GHG emissions excluding biogenic CO2. kg CO2e/declared unit
          format: float
          example: '79.86801562912'
        biogenicCarbonWithdrawal:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            Biogenic CO2 removal calculated by converting biogenic carbon
            contained in the product to kg CO2. kg CO2e/declared unit
          format: float
          example: '79.86801562912'
        luGhgEmissions:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            GHG emissions and removals occurring as result of land use
            (aggregated values of dLUC and LU are to be reported as dLUC). kg
            CO2e/declared unit
          format: float
          example: '79.86801562912'
        aircraftGhgEmissions:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            GHG emissions occurring as a result of aircraft engine usage for the
            transport of the product (without application of multipliers). kg
            CO2e/declared unit
          format: float
          example: '79.86801562912'
        manufacturingSubStage:
          $ref: '#/components/schemas/ManufacturingSubStage'
        dLucGhgEmissions:
          maxLength: 15
          minLength: 0
          type: string
          description: >-
            GHG emissions and removals occurring as result of direct land use
            change (aggregated values of dLUC and LU are to be reported as
            dLUC). kg CO2e/declared unit
          format: float
          example: '79.86801562912'
      description: Production stage details.
      example:
        pcfIncludingBiogenic: '79.86801562912'
        pcfExcludingBiogenic: '79.86801562912'
        fossilGhgEmissions: '79.86801562912'
        biogenicCarbonEmissionsOtherThanCO2: '79.86801562912'
        biogenicCarbonWithdrawal: '79.86801562912'
        dLucGhgEmissions: '79.86801562912'
        luGhgEmissions: '79.86801562912'
        aircraftGhgEmissions: '79.86801562912'
        manufacturingSubStage:
          packagingSub2Stage:
            pcfExcludingBiogenic: '79.86801562912'
    ScopePCFCATENA-X-V2.2:
      required:
        - packagingEmissionsIncluded
        - partialFullPcf
        - specVersion
      type: object
      properties:
        partialFullPcf:
          type: string
          description: Partial or a full PCF.
          example: Cradle-to-gate
          enum:
            - Cradle-to-gate
            - Cradle-to-grave
        packagingEmissionsIncluded:
          type: string
          description: Type of scope pcf.
          example: included
          enum:
            - included
            - excluded
        specVersion:
          type: string
          description: PCF standard and version
          example: Catena-X V2.2
      description: Scope of PCF details.
    PCFJobStatus:
      type: object
      properties:
        status:
          type: string
          description: Status of the job.
          example: COMPLETED
        message:
          type: string
          description: Meaning full job status message.
          example: Credential created successfully
        pcfId:
          type: string
          description: >-
            pcf Id will be generated in the response only when the status is
            completed. If the job status is not completed, pcfId will not be
            present in the response..
          example: 328098-898JKJK-HJH54564-KJL890
        traceId:
          type: string
          description: >-
            A unique string identifier (UUID), representing a flow through the
            system.
          example: 098QA0-UK9099-HJH98275-LML891
  securitySchemes:
    endpoint_auth:
      type: http
      scheme: bearer
      bearerFormat: JWT
