-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpact-openapi-3.0.0.yaml
1005 lines (1002 loc) · 38.5 KB
/
pact-openapi-3.0.0.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.1.0
info:
title: PACT API Specification
summary: Technical Specifications for PCF Data Exchange (Version 3.0.0)
version: 3.0.0
contact:
name: WBCSD PACT Project
url: https://github.com/wbcsd
email: [email protected]
description: >
This document describes the technical specifications for the exchange of
Product Carbon Footprint (PCF) data between systems. The specification is
maintained by the WBCSD PACT project and intended to be used by organizations
that wish to exchange PCF data with other organizations. The specifications
are designed to be technology-agnostic.
tags:
- name: footprint
description: Synchronous retrieval of footprints
- name: event
description: Asynchronous exchange of footprints
servers:
- url: https://example.com
paths:
/2/footprints:
get:
summary: Action ListFootprints
description: >
Retrieve a list of Product Carbon Footprints (PCFs) that are available.
The list can be filtered by various criteria.
operationId: listFootprints
tags: [footprint]
parameters:
- name: limit
in: query
schema:
type: integer
format: uint
minimum: 0
- name: '$filter'
in: query
description: Syntax as defined by the ODatav4 specification
allowEmptyValue: true
schema:
type: string
responses:
'200':
description: Success
headers:
link:
description: Link header to next result set. See Tech Specs section 6.6.1
schema:
type: string
example: https://api.example.com/2/footprints?[...]
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
type: array
items:
$ref: '#/components/schemas/ProductFootprint'
'400':
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- BearerAuth: []
/2/footprints/{id}:
get:
summary: Action GetFootprint
description: ^
Retrieve a single Product Carbon Footprint (PCF) by its unique identifier.
operationId: getFootprintById
tags: [footprint]
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
required:
- data
properties:
data:
$ref: '#/components/schemas/ProductFootprint'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not Found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal Server Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- BearerAuth: []
/2/events:
post:
summary: Action Event
description: >
Post an event to the system. The event will be processed by the system
and may trigger further actions.
operationId: post_event
tags: [event]
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PathfinderEvent'
responses:
'200':
description: Success
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'501':
description: Not implemented
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- BearerAuth: []
components:
schemas:
ProductFootprint:
description: >
The ProductFootprint is a data type which represents the footprint
of a product under a specific scope (§ 5.2.1 Scope of a Footprint)
and with values calculated in accordance with the PACT Methodology.
Conceptually, the data type ProductFootprint is modeled as a multi-purpose
container for product-specific emissions factors which is supported by
extensibility through Data Model Extensions.
Each ProductFootprint can and should be updated over time, for instance
to incorporate new or refined data from data owners (see § 6 Product
Footprint Lifecycle).
type: object
title: ProductFootprint
required:
- id
- specVersion
- version
- created
- status
- comment
- companyName
- companyIds
- productDescription
- productIds
- productCategoryCpc
- productNameCompany
- pcf
properties:
id:
description: >
A unique identifier that a system uses to refer to the entire dataset of the PCF.
This is typically an automatically-generated number by the technology solution to maintain
the required technical references to data within the system.
UUID v4 [RFC4122](https://tools.ietf.org/html/rfc4122).
type: string
format: uuid
examples:
- "f4b1225a-bd44-4c8e-861d-079e4e1dfd69"
specVersion:
description: >
The version of the PACT Tech Specs that the data being shared complies with.
This is a string in the format of "major.minor.patch" (e.g. "2.3.0").
type: string
pattern: '^\d+\.\d+\.\d+(-\d{8})?$'
examples:
- "2.3.0"
precedingPfIds:
description: >
A given PCF may change over time, due to updates to the calculation.
This field lists all id's that reflect "past versions" of the current PCF.
This is typically an automatically generated field of unique identifiers,
maintained by the technology solution.
type: array
items:
type: string
format: uuid
minItems: 1
uniqueItems: true
examples:
- ["f4b1225a-bd44-4c8e-861d-079e4e1dfd69","079e425a-464f-528d-341d-4a944a1dfd70"]
version:
description: >
The version number of the PCF; for example starting with 1 and incrementing.
If changes are made to the PCF, this version number will increment.
type: integer
format: int32
minimum: 0
examples:
- 1
- 3303
created:
description: >
The date and time when the PCF was created. This is typically an automatically
generated field by the software solution.
type: string
format: date-time
updated:
description: >
The date and time when the PCF was last updated. This is typically an automatically
generated field by the software solution. If the data has never been updated,
leave blank.
type: string
format: date-time
status:
description: >
The status of the PCF. Active means that the PCF is the most recent version
and is the one that should be used. Deprecated means that the PCF is no longer
the most recent version and should not be used.
This attribute typically will be automatically generated by the technology
system and will not need to be entered by the user.
type: string
enum:
- Active
- Deprecated
statusComment:
type: string
description: >
A descriptive reasoning explaining the current status of the PCF, what was
changed since the last version, etc.
validityPeriodStart:
description: >
The start date and time of the validity period. The period of time between the
validityPeriodStart and validityPeriodEnd is defined as the "validity period",
and represents the time period during which the PCF is valid. Specifying the
validity period is optional. If this is not specified, then it is assumed the
PCF is valid for 3 years, beginning with the referencePeriodEnd.
type: string
format: date-time
validityPeriodEnd:
description: >
The end date and time of the validity period. See validityPeriodStart for more details.
type: string
format: date-time
companyName:
description: >
The (legal) name of the company supplying the product and reporting the PCF (aka the data owner)
$ref: '#/components/schemas/NonEmptyString'
companyIds:
description: >
A list of company identifiers which represent the companies that are considered
data owners of the provided PCF. In a large organization, this may include multiple
subsidiaries or legal entities of a given corporation, hence the need to provide
multiple identifiers. A list of only one identifier is also valid. The format
of each companyID must be provided as a URN (Uniform Resource Name), which
helps ensure the data provided is standardized and can be interpreted by the
receiving system.
type: array
minItems: 1
uniqueItems: true
items:
$ref: '#/components/schemas/Urn'
productDescription:
description: >
A description of the product, including any additional relevant information
such as production technology, production technology, packaging, process, feedstock
and technical parameters (e.g. dimensions). Products which are services
(i.e. consulting) should include a short description of the service.
type: string
productIds:
description: >
All relevant product identifiers to identify the product for which the provided
PCF was calculated (e.g. supplier part number, GTIN, article number, CPC
classification, CAS Number, BOM Version, batch number, etc.)
type: array
minItems: 1
uniqueItems: true
items:
$ref: '#/components/schemas/Urn'
productCategoryCpc:
description: >
The UN Central Product Classification Code (CPC) for the given product. The relevant
CPC code may be identified here https://unstats.un.org/unsd/classifications/Econ/cpc
Advisement: This property will become optional in v3
$ref: '#/components/schemas/NonEmptyString'
productClassifications:
description: >
A list of classification or category identifiers in URN format. Use well known urn's here,
or adhere to recommended urn:pact: format. This replaces the productCategoryCpc property.
type: array
minItems: 1
uniqueItems: true
items:
$ref: '#/components/schemas/Urn'
productNameCompany:
description: >
The trade name of the product in order for it to be recognizable by the receiver of the PCF information
$ref: '#/components/schemas/NonEmptyString'
comment:
description: >
Any additional information related to the PCF. Whereas the property productDescription
contains product-level information, comment should be used for information and instructions
related to the calculation of the PCF, or other information which informs the ability to interpret
(e.g. LUC not included as unable to calculate LUC), to audit or to verify the PCF
Advisement: This property will become OPTIONAL in version 3 of the Technical Specifications.
type: string
pcf:
$ref: '#/components/schemas/CarbonFootprint'
NonEmptyString:
type: string
minLength: 1
Urn:
type: string
pattern: '^([uU][rR][nN]):'
CarbonFootprint:
description: ^
The CarbonFootprint represents the carbon footprint of a product and related data
in accordance with the PACT Methodology.
title: CarbonFootprint
type: object
required:
- declaredUnit
- unitaryProductAmount
- referencePeriodStart
- referencePeriodEnd
- pCfExcludingBiogenic
- fossilGhgEmissions
- fossilCarbonContent
- biogenicCarbonContent
- characterizationFactors
- ipccCharacterizationFactorsSources
- crossSectoralStandardsUsed
- boundaryProcessesDescription
- exemptedEmissionsPercent
- exemptedEmissionsDescription
- packagingEmissionsIncluded
oneOf:
- oneOf:
- required:
- geographyRegionOrSubregion
- required:
- geographyCountry
- required:
- geographyCountrySubdivision
- not:
anyOf:
- required:
- geographyRegionOrSubregion
- required:
- geographyCountry
- required:
- geographyCountrySubdivision
properties:
declaredUnit:
description: >
The unit with which the PCF was calculated
type: string
enum:
- liter
- kilogram
- cubic meter
- kilowatt hour
- megajoule
- ton kilometer
- square meter
unitaryProductAmount:
description: >
The amount of Declared Units contained within the product to which the PCF refers to.
This is not representing the total annual quantity supplied (e.g. if the product is
supplied in bulk in kg, which is the declared unit selected, please enter 1)
x-pact-unit: declared unit
$ref: '#/components/schemas/PositiveNonZeroDecimal'
pCfExcludingBiogenic:
description: >
The PCF of the product excluding biogenic CO2 emissions.
x-pact-unit: kgCO2e/declared unit
$ref: '#/components/schemas/PositiveOrZeroDecimal'
pCfIncludingBiogenic:
description: >
The PCF of the product including ALL biogenic emissions (CO2 and otherwise).
x-pact-unit: kgCO2e/declared unit
$ref: '#/components/schemas/Decimal'
fossilGhgEmissions:
description: >
The emissions from fossil sources as a result of fuel combustion, from fugitive
emissions, and from process emissions.
x-pact-unit: kgCO2e/declared unit
$ref: '#/components/schemas/PositiveOrZeroDecimal'
fossilCarbonContent:
description: >
The fossil carbon content of the product (mass of carbon).
x-pact-unit: kgC/declared unit
$ref: '#/components/schemas/PositiveOrZeroDecimal'
biogenicCarbonContent:
description: >
The biogenic carbon content of the product (mass of carbon).
x-pact-unit: kgC/declared unit
$ref: '#/components/schemas/PositiveOrZeroDecimal'
dLucGhgEmissions:
description: >
The emissions from land use change (LUC) activities.Emissions resulting from
recent (i.e., previous 20 years) carbon stock loss due to land conversion directly
on the area of land under consideration. The value of this property MUST include
direct land use change (dLUC) where available, otherwise statistical land use
change (sLUC) can be used.
x-pact-unit: kgCO2e/declared unit
$ref: '#/components/schemas/PositiveOrZeroDecimal'
landManagementGhgEmissions:
description: >
GHG emissions and removals associated with land-management-related changes,
including non-CO2 sources.
x-pact-unit: kgCO2e/declared unit
$ref: '#/components/schemas/PositiveOrZeroDecimal'
otherBiogenicGhgEmissions:
description: >
All other biogenic GHG emissions associated with product manufacturing and transport
that are not included in dLUC (dLucGhgEmissions), iLUC (iLucGhgEmissions), and land
management (landManagementGhgEmissions).
x-pact-unit: kgCO2e/declared unit
$ref: '#/components/schemas/PositiveOrZeroDecimal'
iLucGhgEmissions:
description: >
Emissions resulting from recent (i.e., previous 20 years) carbon stock loss due to
land conversion on land not owned or controlled by the company or in its supply
chain, induced by change in demand for products produced or sourced by the company.
x-pact-unit: kgCO2e/declared unit
$ref: '#/components/schemas/PositiveOrZeroDecimal'
biogenicCarbonWithdrawal:
description: >
The Biogenic Carbon contained in the product converted to kilogram of CO2e.
x-pact-unit: kgCO2e/declared unit
$ref: '#/components/schemas/NegativeOrZeroDecimal'
aircraftGhgEmissions:
description: >
The GHG emissions resulting from aircraft engine usage for the transport of the
product, excluding radiative forcing.
x-pact-unit: kgCO2e/declared unit
$ref: '#/components/schemas/PositiveOrZeroDecimal'
characterizationFactors:
description: >
The IPCC (Intergovernmental Panel of Climate Change) frequently releases (GWP)
global warming potential values for climate gases related to CO2. These GWP
values are released in Assessment Reports (AR), which are numbered. The AR
umber can be used to track the age and accuracy of the GWP values used in
reporting. This field indicates the IPCC version of the GWP characterization
factors used in the calculation of the PCF.
Advisement: This property is DEPRECATED and only kept to ensure backwards-compatibility. It will be removed in version 3 of these Technical Specifications. It does not replace the (also mandatory) property <{CarbonFootprint/ipccCharacterizationFactorsSources}>.
deprecated: true
comment: This property is deprecated and only kept to ensure backwards-compatibility.
It will be removed in version 3. It is replaced by ipccCharacterizationFactors.
type: string
enum:
- AR6
- AR5
ipccCharacterizationFactorsSources:
description: >
"The IPCC (Intergovernmental Panel of Climate Change) frequently releases (GWP)
global warming potential values for climate gases related to CO2. These GWP
values are released in Assessment Reports (AR), which are numbered. The AR
umber can be used to track the age and accuracy of the GWP values used in
reporting. This field indicates the IPCC version of the GWP characterization
factors used in the calculation of the PCF.
Per the PACT Methodology, the latest available characterization factor version shall
be used, i.e., [""AR6""]. In the event this is not possible, include the set
of all characterization factors used."
type: array
items:
type: string
pattern: '^AR\d+$'
minItems: 1
uniqueItems: true
crossSectoralStandardsUsed:
description: >
The cross sectoral standard(s) used as a basis for the PCF calculation.
If multiple apply, list all.
type: array
items:
type: string
enum:
- GHG Protocol Product standard
- ISO Standard 14067
- ISO Standard 14044
minItems: 1
uniqueItems: true
deprecated: true
comment: This property is deprecated and only kept to ensure backwards-
compatibility. It will be removed in version 3. It does not replace the
(also mandatory) property crossSectoralStandards.
crossSectoralStandards:
description: >
The cross-sectoral standards applied for calculating or allocating GHG
emissions. If multiple apply, list all.
type: array
items:
type: string
enum:
- ISO14067
- ISO14083
- ISO14040-44
- GHGP-Product
- PEF
- PACT-1.0
- PACT-2.0
- PACT-2.1
- PACT-2.2
- PACT-2.3
# - PACT Methodology 3.0
minItems: 1
uniqueItems: true
productOrSectorSpecificRules:
description: >
The product-specific or sector-specific rules applied for calculating or
allocating GHG emissions. Sector specific guidance frameworks, such as
Product Category Rules (PCR), are sets of rules for how to calculate and
document Life Cycle Assessments. They provide product category specific
guidance and enhance comparability between assessments of the different
suppliers for the same category (sector). The same applies to Product
Environmental Footprint Category Rules (PEFCR)). If no rules were used,
leave this field empty.
type: array
items:
$ref: '#/components/schemas/ProductOrSectorSpecificRule'
minItems: 1
uniqueItems: true
biogenicAccountingMethodology:
description: >
Name of the standard followed to account for biogenic emissions and removals.
type: string
enum:
- PEF
- ISO
- GHGP
- Quantis
boundaryProcessesDescription:
description: >
Brief description of the processes attributable to each life cycle stage included
in the PCF (e.g. electricity consumption for manufacturing), especially those
that significantly contribute manufacturing steps of the product (including
general description of used technologies).
Advisement: This property will become OPTIONAL in version 3 of the Technical Specifications.
type: string
referencePeriodStart:
description: >
The start date and time of the earliest activity data used to calculate the
PCF. This start date can be considered the start of the period over which
the given PCF is referencing, or reporting on.
type: string
format: date-time
referencePeriodEnd:
description: >
The end date and time of the latest activity data used to calculate the PCF.
This end date can be considered the end of the period over which the given
PCF is referencing, or reporting on.
type: string
format: date-time
geographyRegionOrSubregion:
description: >
The geographic representation of the PCF may be reported at different
levels of granularity, depending on the prefere of the data provider
(e.g., at a plant, region, or country level). This attribute specifies
the geographic region to which the PCF refers, i.e. "Africa",
"Central Asia", etc.
type: string
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
geographyCountry:
description: >
The geographic representation of the PCF may be reported at different levels
of granularity, depending on the prefere of the data provider (e.g., at a
plant, region, or country level). This field indicates the country to which
the PCF refers. The country name must be according to ISO 3166-2 alpha-2
country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)
type: string
pattern: '^[A-Z]{2}$'
comment: ISO 3166-1 alpha-2
examples:
- US
- DE
geographyCountrySubdivision:
description: >
The geographic representation of the PCF may be reported at different
levels of granularity, depending on the prefere of the data provider
(e.g., at a plant, region, or country level). This attribute represents
the most granular (i.e. "most specific") geography, i.e. the specific
subdivision within a given country, for example New York State within
the USA. Follows ISO 3166-2.
type: string
pattern: '^[A-Z]{2}-[A-Z0-9]{1,3}$'
comment: ISO 3166-2
examples:
- US-CA
- DE-BW
secondaryEmissionFactorSources:
description: >
The list of secondary data sources and versions which have been used by
you or by suppliers (e.g. data bases such as ecoinvent) for the PCF
calculation
type: array
minItems: 1
items:
$ref: '#/components/schemas/EmissionFactorDS'
exemptedEmissionsPercent:
description: >
Percentage of emissions EXCLUDED from the cradle to gate PCF in total.
The percentage MUST be expressed as a decimal number, and SHOULD comply
with the PACT Methodology (a maximum of 5% of the cradle to gate PCF emissions
may be excluded) as well as any relevant sector specific guidelines
referring to exemption rules/cut-off criteria.
Advisement: The upper boundary of this property (currently `5`) will be removed in version 3 of the Technical Specifications.
$ref: '#/components/schemas/Percent'
maximum: 5
exemptedEmissionsDescription:
description: >
If emissions exempted, rationale behind exclusion of specific PCF emissions.
Advisement: This property will become OPTIONAL in version 3 of the Technical Specifications.
type: string
packagingEmissionsIncluded:
description: >
True or False to indicate whether packaging emissions are including in the PCF.
type: boolean
packagingGhgEmissions:
description: >
Emissions resulting from the packaging of the product. The value MUST NOT
be defined if packagingEmissionsIncluded is False.
$ref: '#/components/schemas/PositiveOrZeroDecimal'
x-pact-unit: kgCO2e/declared unit
allocationRulesDescription:
description: >
Description of the allocation rules applied to the PCF's foreground data
including an explanation of the underlying reasons (way of allocating
all activities from your manufacturing steps to the declared unit).
type: string
uncertaintyAssessmentDescription:
description: >
Results, key drivers, and a short qualitative description of the
uncertainty assessment, if applicable.
type: string
primaryDataShare:
description: >
Share of primary data in the final PCF, calculated according to
the PACT Methodology.
$ref: '#/components/schemas/Percent'
dqi:
description: >
Data Quality Indicators (dqi) in accordance with the PACT Methodology.
$ref: '#/components/schemas/DataQualityIndicators'
assurance:
description: >
If present, the Assurance information in accordance with PACT Methodology.
$ref: '#/components/schemas/Assurance'
PositiveNonZeroDecimal:
type: string
pattern: ^[+]?(\d*[1-9]\d*)(\.\d+)?|(0+\.\d*[1-9]\d*)$
PositiveOrZeroDecimal:
type: string
pattern: ^[+]?\d+(\.\d+)?$
comment: A positive or zero decimal number.
Decimal:
type: string
pattern: ^[+-]?\d+(\.\d+)?$
NegativeOrZeroDecimal:
type: string
pattern: ^(-\d+(\.\d+)?)|0+(\.0+)?$
NegativeNonZeroDecimal:
type: string
pattern: ^-((\d*[1-9]\d*)(\.\d+)?|(0+\.\d*[1-9]\d*))$
ProductOrSectorSpecificRule:
type: object
required:
- operator
- ruleNames
properties:
operator:
description: >
Selection of operator of PCR being used for the PCF calculation. If
operator is not available in the given list, or if you have followed
a sector specific guidance, please select "Other" and include details
under "otherOperatorName".
type: string
enum:
- PEF
- EPD International
- Other
ruleNames:
description: >
Names of the product or sector specific rules being used for the PCF
calculation.
type: array
items:
type: string
minLength: 1
minItems: 1
uniqueItems: true
otherOperatorName:
description: >
If operator is Other, then this attribute must be populated with the name
of the operator.
type: string
minLength: 1
EmissionFactorDS:
type: object
required:
- name
- version
properties:
name:
description: >
Name of the secondary emission factor databases
$ref: '#/components/schemas/NonEmptyString'
version:
description: >
Version of the secondary emission factor databases
$ref: '#/components/schemas/NonEmptyString'
Percent:
type: number
format: double
minimum: 0
maximum: 100
DataQualityIndicators:
description: Data Type "DataQualityIndicators" of Spec Version 2
title: DataQualityIndicators
type: object
required:
- coveragePercent
- technologicalDQR
- temporalDQR
- geographicalDQR
- completenessDQR
- reliabilityDQR
properties:
coveragePercent:
description: >
Percentage of PCF included in the data quality assessment based on
the >5% emissions threshold.
$ref: '#/components/schemas/Percent'
technologicalDQR:
description: >
Quantitative data quality rating (DQR) based on the data quality matrix
(PACT Methodology Table 9), scoring the technological representativeness of the
sources used for PCF calculation based on weighted average of all inputs
representing >5% of PCF emissions.
$ref: '#/components/schemas/FloatBetween1And3'
temporalDQR:
description: >
Quantitative data quality rating (DQR) based on the data quality matrix
(PACT Methodology Table 9), scoring the temporal representativeness of the sources
used for PCF calculation based on weighted average of all inputs
representing >5% of PCF emissions.
$ref: '#/components/schemas/FloatBetween1And3'
geographicalDQR:
description: >
Quantitative data quality rating (DQR) based on the data quality matrix
(PACT Methodology Table 9), scoring the geographical representativeness of the
sources used for PCF calculation based on weighted average of all inputs
representing >5% of PCF emissions.
$ref: '#/components/schemas/FloatBetween1And3'
completenessDQR:
description: >
Quantitative data quality rating (DQR) based on the data quality matrix
(PACT Methodology Table 9), scoring the completeness of the data collected for
PCF calculation based on weighted average of all inputs representing
>5% of PCF emissions.
$ref: '#/components/schemas/FloatBetween1And3'
reliabilityDQR:
description: >
Quantitative data quality rating (DQR) based on the data quality matrix
(PACT Methodology Table 9), scoring the reliability of the data collected for
PCF calculation based on weighted average of all inputs representing
>5% of PCF emissions.
$ref: '#/components/schemas/FloatBetween1And3'
FloatBetween1And3:
type: number
format: float
maximum: 3
minimum: 1
Assurance:
description: Data Type "Assurance" of Spec Version 2
title: Assurance
type: object
required:
- assurance
- providerName
properties:
assurance:
description: >
True or False to indicate whether the PCF has been assured in line with the PACT Methodology.
type: boolean
coverage:
description: >
Level of granularity of the emissions data assured
type: string
enum:
- corporate level
- product line
- PCF system
- product level
level:
description: >
Level of assurance applicable to the PCF
type: string
enum:
- limited
- reasonable
boundary:
description: >
Boundary of the assurance
type: string
enum:
- Gate-to-Gate
- Cradle-to-Gate
providerName:
description: >
Name of the independent third party engaged to undertake assurance
Advisement: Given this property was incorrectly and unintentionally published in V2 of the Technical Specifications as Mandatory, it will be reverted to Optional in version 3 of the Technical Specifications.
type: string
completedAt:
description: >
The date at which the assurance was completed
type: string
format: date-time
standardName:
description: >
Name of the standard against which the PCF was assured
type: string
comments:
description: >
Any additional comments that will clarify the interpretation of the assurance.
type: string
# -----------
# Event Types
PathfinderEvent:
description: possible contents of `data` property of events - see tech specs
section 6 for details
type: object
oneOf:
- description: "the contents of the `data` field of a `PF Update Event` - see
Tech Specs section 6.8.3"
type: object
required:
- data
- type
properties:
type:
type: string
enum:
- org.wbcsd.pathfinder.ProductFootprint.Published.v1
data:
$ref: '#/components/schemas/PFUpdateEventBody'
- description: "the contents of the `data` field of a `PF Request Event` – see
Tech Specs section 6.8.4.1"
type: object
required:
- data
- type
properties:
type:
type: string
enum:
- org.wbcsd.pathfinder.ProductFootprintRequest.Created.v1
data:
$ref: '#/components/schemas/PFRequestEventBody'
required:
- id
- source
- specversion
- time
properties:
specversion:
type: string
id:
type: string
source:
type: string
time:
type: string
format: date-time
PFUpdateEventBody:
type: object
required:
- pfIds
properties:
pfIds:
type: array
items:
type: string
format: uuid
PFRequestEventBody:
type: object
required:
- pf
properties:
pf: {}
comment:
type: string
# ---------------
# Error Responses
ErrorResponse:
title: ErrorResponse
description: Response with an error code and descripton. See Chapter "Error
Codes" of the Tech Specs for more details.
type: object
properties:
code:
type: string
enum:
- BadRequest
- NotImplemented
- AccessDenied
- NoSuchFootprint
- TokenExpired
- InternalError
message:
type: string
required:
- code
- message
securitySchemes:
BearerAuth:
description: OAuth2 Client Credentials Grant (RFC6749 4.4)
type: oauth2
flows: