Changelog¶

The format is based on Keep a Changelog.

[1.2.0] - 2025-02-10¶

What's New¶

POST /suppliers/{id}/invite¶

Invite supplier to SiGREEN via email

GET /materialCategories¶

Get all material categories for company in SiGREEN

POST /materialCategories¶

Create material category in SiGREEN.

GET /materialCategories/{id}¶

Get material category details by id

PUT /materialCategories/{id}¶

Update material category details by id

DELETE /materialCategories/{id}¶

Delete material categories details by id

GET /materialCategories/{id}/image¶

Get material category image by id

PUT /materialCategories/{id}/image¶

Update material category image by id

DELETE /materialCategories/{id}/image¶

Delete material category image by id

POST /suppliers/{id}/invite/cancel¶

Cancel supplier invite to SiGREEN

GET /components/averageEmissions¶

Get an average emission for a component.

DELETE /suppliers/{id}¶

Delete supplier by supplier Id in SiGREEN

DELETE /components/{id}¶

Delete component by id

What's Deleted¶

GET /components/pcf¶

Get an aggregated export of a PCF of a component without cryptographic material. If you need cryptographic verifiability of this information please use DIDComm APIs.

What's Changed¶

POST /suppliers/identifierTypes¶

Return Type:¶

Changed response : 201 Created

Created. Response will return the UUID of the created supplier identifier type.

• Changed content type : application/json

  • Changed property id (string)

    UUID to identify the identifier type of the company in SiGREEN

DELETE /suppliers/identifierTypes/{id}¶

Parameters:¶

Changed: id in path

UUID to identify the supplier identifier type of the company in SiGREEN.

PATCH /suppliers/identifierTypes/{id}¶

Parameters:¶

Changed: id in path

UUID for identifying the supplier identifier type of the company in SiGREEN.

GET /suppliers¶

Parameters:¶

Added: searchText in query

Partial text search on following attributes - locations , name , identifiers.
Minimum 3 characters required to search

Added: idType in query

Supplier identifier type in SiGREEN.
idType filter is applicable only when user is searching with idValue filter.
Idea here is to find suppliers with idType and value combination.

Added: idValue in query

Filter suppliers based on either main or additional identifier value in SiGREEN.

Added: status in query

Supplier status

Added: sort in query

Sorting fields supported (name, createdOn, updateOn). Example - Ascending order '+name' , Descending order '-name'. Default order is createdOn ascending order.

Deleted: identifier in query

Main Supplier Identifier to identify the supplier of the company in SiGREEN

Return Type:¶

Changed response : 200 OK

A list of supplier

• Changed content type : application/json

  • Changed property items (array)

  Changed items (object):

  * Added property `status` (string)
    > Supplier Status <br/> <br/> NOT_INVITED_YET  - When supplier created <br/> INVITED - When supplier invited <br/> INVITE_CANCELLED - When invite cancelled <br/> DENIED_BY_ADMIN - When system/company admin rejected user <br/> AVAILABLE - When supplier in SiGREEN
  
      Enum values:
  
      * `NOT_INVITED_YET`
      * `INVITED`
      * `INVITE_CANCELLED`
      * `DENIED_BY_ADMIN`
      * `AVAILABLE`
  * Added property `createdOn` (string)
      > Created on (ISO 8601; UTC Timezone)
  
  * Added property `updatedOn` (string)
      > Updated on (ISO 8601; UTC Timezone)
  
  * Changed property `id` (string)
      > UUID to identify the supplier of the company in SiGREEN
  

POST /suppliers¶

Return Type:¶

Changed response : 201 Created

Created

• Changed content type : application/json

  • Changed property id (string)

    UUID to identify the supplier of the company in SiGREEN

GET /suppliers/{id}¶

Parameters:¶

Changed: id in path

UUID to identify the supplier of the company in SiGREEN

Return Type:¶

Changed response : 200 OK

Supplier detail by id

• Changed content type : application/json

  • Added property status (string)

    Supplier Status
    
    NOT_INVITED_YET - When supplier created
    INVITED - When supplier invited
    INVITE_CANCELLED - When invite cancelled
    DENIED_BY_ADMIN - When system/company admin rejected user
    AVAILABLE - When supplier in SiGREEN

  • Added property createdOn (string) > Created on (ISO 8601; UTC Timezone)

  • Added property updatedOn (string) > Updated on (ISO 8601; UTC Timezone)

  • Changed property id (string) > UUID to identify the supplier of the company in SiGREEN

PUT /suppliers/{id}¶

Parameters:¶

Changed: id in path

UUID to identify the supplier of the company in SiGREEN

POST /components/identifierTypes¶

Return Type:¶

Changed response : 201 Created

Created. Response will return the UUID of the created component identifier type.

• Changed content type : application/json

  • Changed property id (string)

    UUID to identify the identifier type of the company in SiGREEN

DELETE /components/identifierTypes/{id}¶

Parameters:¶

Changed: id in path

UUID to identify the component identifier type of the company in SiGREEN.

PATCH /components/identifierTypes/{id}¶

Parameters:¶

Changed: id in path

UUID for identifying the component identifier type of the company in SiGREEN.

GET /components¶

Parameters:¶

Added: searchText in query

Partial text search on following attributes - materialCategory , name , identifiers.
Search text minimum 3 characters required

Added: componentsCategory in query

CATEGORIZED -> Components belongs to material category
uncategorized -> Components doesn't belongs to any material category
ALL -> All components

Added: idType in query

Supplier identifier type in SiGREEN.
idType filter is applicable only when user is searching with idValue filter.
Idea here is to find components with idType and value combination.

Added: idValue in query

Filter components based on either main or additional identifier value in SiGREEN.

Added: sort in query

Sorting fields supported (name, createdOn, updateOn Example - Ascending order '+name' , Descending order '-name', Default order by createdOn ascending order

Deleted: identifier in query

Main Component Identifier to identify the component of the company in SiGREEN

Changed: materialCategory in query

Filter components by material category name.
Make sure don't use this filter with combination of componentsCategory as uncategorized

Return Type:¶

Changed response : 200 OK

A list of components

• Changed content type : application/json

  • Changed property items (array)

  Changed items (object):

  * Added property `createdOn` (string)
    > Created on (ISO 8601; UTC Timezone)
  
  * Added property `updatedOn` (string)
      > Updated on (ISO 8601; UTC Timezone)
  
  * Changed property `id` (string)
      > UUID to identify the component of the company in SiGREEN
  
  * Changed property `unit` (string)
      > Component Unit type
  

POST /components¶

Request:¶

Changed content type : application/json

• Changed property unit (string)

  Component Unit type

Return Type:¶

Changed response : 201 Created

Created

• Changed content type : application/json

  • Changed property id (string)

    UUID to identify the component of the company in SiGREEN

GET /components/{id}¶

Parameters:¶

Changed: id in path

UUID to identify the component of the company in SiGREEN

Return Type:¶

Changed response : 200 OK

A list of secondary data per component

• Changed content type : application/json

  • Added property createdOn (string)

    Created on (ISO 8601; UTC Timezone)

  • Added property updatedOn (string) > Updated on (ISO 8601; UTC Timezone)

  • Changed property id (string) > UUID to identify the component of the company in SiGREEN

  • Changed property unit (string) > Component Unit type

PUT /components/{id}¶

Parameters:¶

Changed: id in path

UUID to identify the component of the company in SiGREEN

Request:¶

Changed content type : application/json

• Changed property unit (string)

  Component Unit type

GET /components/{id}/secondaryData¶

Parameters:¶

Changed: id in path

UUID to identify the component of the company in SiGREEN

Return Type:¶

Changed response : 200 OK

A list of secondary data per component

• Changed content type : application/json

  • Changed property items (array)

  Changed items (object):

  * Added property `productionStage` (object)
    > Production stage emissions
  
      * Property `pcfIncludingBiogenic` (string)
          > Production stage GWP total (incl. bio.).  kg CO2e/declared unit. Either pcfIncludingBiogenic or pcfExcludingBiogenic mandatory.
  
      * Property `pcfExcludingBiogenic` (string)
          > Production stage GWP total (excl. bio.). kg CO2e/declared unit. Either pcfIncludingBiogenic or pcfExcludingBiogenic mandatory.
  
      * Property `fossilGhgEmissions` (string)
          > Production stage GWP fossil. kg CO2e/declared unit
  
      * Property `biogenic` (string)
          > Production stage GWP biogenic. kg CO2e/declared unit
  
      * Property `dLucGhgEmissions` (string)
          > Production stage GWP direct land use change (dLUC). kg CO2e/declared unit
  
      * Property `luGhgEmissions` (string)
          > Production stage GWP land use (LU). kg CO2e/declared unit
  
      * Property `aircraftGhgEmissions` (string)
          > Production stage GWP aircraft emissions. kg CO2e/declared unit
  
      One of:
  
  * Added property `distributionStage` (object)
      > Distribution stage emission details
  
      * Property `pcfIncludingBiogenic` (string)
          > Distribution stage GWP total (incl. bio.). kg CO2e/declared unit. Either pcfIncludingBiogenic or pcfExcludingBiogenic mandatory.
  
      * Property `pcfExcludingBiogenic` (string)
          > Distribution stage GWP total (excl. bio.). kg CO2e/declared unit. Either pcfIncludingBiogenic or pcfExcludingBiogenic mandatory.
  
      * Property `biogenic` (string)
          > Distribution stage GWP biogenic. kg CO2e/declared unit
  
      * Property `fossilGhgEmissions` (string)
          > Distribution stage GWP fossil. kg CO2e/declared unit
  
      * Property `dLucGhgEmissions` (string)
          > Distribution stage GWP direct land use change (dLUC). kg CO2e/declared unit
  
      * Property `luGhgEmissions` (string)
          > Distribution stage GWP land use (LU). kg CO2e/declared unit
  
      * Property `aircraftGhgEmissions` (string)
          > Distribution stage GWP aircraft emissions). kg CO2e/declared unit
  
  * Deleted property `totalInclBio` (number)
      > Total Incl Bio
  
  * Deleted property `totalExclBio` (number)
      > total Excl Bio
  
  * Deleted property `fossil` (string)
      > fossil emissions
  
  * Deleted property `biogenic` (string)
      > biogenic emissions
  
  * Deleted property `dLuc` (string)
      > dLuc
  
  * Deleted property `landUse` (string)
      > land use
  
  * Deleted property `aircraft` (string)
      > aircraft
  
  * Changed property `secondaryDataId` (string)
      > UUID to identify the Component SecondaryData of the company in SiGREEN
  
  * Changed property `quantity` (number -> string)
      > quantity
  

POST /components/{id}/secondaryData¶

Parameters:¶

Changed: id in path

UUID to identify the component of the company in SiGREEN

Request:¶

Changed content type : application/json

New required properties: - productionStage

New optional properties: - totalExclBio - totalInclBio

• Added property productionStage (object)

  Production stage emissions

• Added property distributionStage (object)

  Distribution stage emission details

• Deleted property totalInclBio (number)

  total inclusive bio emissions. Either totalInclBio or totalExclBio mandatory.

• Deleted property totalExclBio (number)

  total exclusive bio emissions. Either totalInclBio or totalExclBio mandatory.

• Deleted property fossil (string)

  fossil emissions

• Deleted property biogenic (string)

  biogenic emissions

• Deleted property dLuc (string)

  dLuc

• Deleted property landUse (string)

  land use

• Deleted property aircraft (string)

  aircraft

• Changed property quantity (number -> string)

  quantity

Return Type:¶

Changed response : 201 Created

Created

• Changed content type : application/json

  • Changed property secondaryDataId (string)

    UUID to identify the component secondaryData of the company in SiGREEN

GET /components/{id}/secondaryData/{secondaryDataId}¶

Parameters:¶

Changed: id in path

UUID to identify the component of the company in SiGREEN

Changed: secondaryDataId in path

UUID to identify the Component Secondary Data of the company in SiGREEN

Return Type:¶

Changed response : 200 OK

A list of secondary data per component

• Changed content type : application/json

  • Added property productionStage (object)

    Production stage emissions

  • Added property distributionStage (object) > Distribution stage emission details

  • Deleted property totalInclBio (number) > Total Incl Bio

  • Deleted property totalExclBio (number) > total Excl Bio

  • Deleted property fossil (string) > fossil emissions

  • Deleted property biogenic (string) > biogenic emissions

  • Deleted property dLuc (string) > dLuc

  • Deleted property landUse (string) > land use

  • Deleted property aircraft (string) > aircraft

  • Changed property secondaryDataId (string) > UUID to identify the Component SecondaryData of the company in SiGREEN

  • Changed property quantity (number -> string) > quantity

PUT /components/{id}/secondaryData/{secondaryDataId}¶

Parameters:¶

Changed: id in path

UUID to identify the component of the company in SiGREEN

Changed: secondaryDataId in path

UUID to identify the Component Secondary Data of the company in SiGREEN

Request:¶

Changed content type : application/json

New required properties: - productionStage

New optional properties: - totalExclBio - totalInclBio

• Added property productionStage (object)

  Production stage emissions

• Added property distributionStage (object)

  Distribution stage emission details

• Deleted property totalInclBio (number)

  total inclusive bio emissions. Either totalInclBio or totalExclBio mandatory.

• Deleted property totalExclBio (number)

  total exclusive bio emissions. Either totalInclBio or totalExclBio mandatory.

• Deleted property fossil (string)

  fossil emissions

• Deleted property biogenic (string)

  biogenic emissions

• Deleted property dLuc (string)

  dLuc

• Deleted property landUse (string)

  land use

• Deleted property aircraft (string)

  aircraft

• Changed property quantity (number -> string)

  quantity

GET /components/{id}/linkSuppliers¶

Parameters:¶

Added: hasSupplierShare in query

Filter suppliers who is having supplier share grater than 0. Default would give all results (with and with out share)

Changed: id in path

UUID to identify the component of the company in SiGREEN

Changed: supplierId in query

UUID to identify the supplier of the company in SiGREEN

Return Type:¶

Changed response : 200 OK

A list of secondary data per component

• Changed content type : application/json

  • Changed property items (array)

  Changed items (object):

  * Changed property `componentSupplierLinkId` (string)
    > UUID to identify the link between component and supplier of the company in SiGREEN
  
  * Changed property `supplierId` (string)
      > UUID to identify the supplier of the company in SiGREEN
  
  * Changed property `secondaryDataId` (string)
      > UUID to identify the component secondary data of the company in SiGREEN
  

POST /components/{id}/linkSuppliers¶

Parameters:¶

Changed: id in path

UUID to identify the component of the company in SiGREEN

Request:¶

Changed content type : application/json

Changed items (object):

• Changed property supplierId (string)

  UUID to identify the supplier of the company in SiGREEN

• Changed property secondaryDataId (string)

  UUID to identify the component secondary data of the company in SiGREEN

Return Type:¶

Changed response : 201 Created

Created

• Changed content type : application/json

Changed items (object):

* Changed property `componentSupplierLinkId` (string)
  > UUID to identify the link between component and supplier of the company in SiGREEN


* Changed property `supplierId` (string)
    > UUID to identify the supplier of the company in SiGREEN


* Changed property `secondaryDataId` (string)
    > UUID to identify the component secondary data of the company in SiGREEN

GET /components/{id}/linkSuppliers/{componentSupplierLinkId}¶

Parameters:¶

Changed: id in path

UUID to identify the component of the company in SiGREEN

Changed: componentSupplierLinkId in path

UUID to identify the linkedSupplier with component of the company in SiGREEN

Return Type:¶

Changed response : 200 OK

Get linked suppliers by componentSupplierLinkId with component

• Changed content type : application/json

  • Changed property componentSupplierLinkId (string)

    UUID to identify the link between component and supplier of the company in SiGREEN

  • Changed property supplierId (string) > UUID to identify the supplier of the company in SiGREEN

  • Changed property secondaryDataId (string) > UUID to identify the component secondary data of the company in SiGREEN

PUT /components/{id}/linkSuppliers/{componentSupplierLinkId}¶

Parameters:¶

Changed: id in path

UUID to identify the component of the company in SiGREEN

Changed: componentSupplierLinkId in path

UUID to identify the linkedSupplier with component of the company in SiGREEN

Request:¶

Changed content type : application/json

• Changed property supplierId (string)

  UUID to identify the supplier of the company in SiGREEN

• Changed property secondaryDataId (string)

  UUID to identify the component secondary data of the company in SiGREEN

DELETE /components/{id}/linkSuppliers/{componentSupplierLinkId}¶

Parameters:¶

Changed: id in path

UUID to identify the component of the company in SiGREEN

Changed: componentSupplierLinkId in path

UUID to identify the linkedSupplier with component of the company in SiGREEN

GET /components/{id}/suppliers/{supplierId}/pcf¶

Parameters:¶

Changed: id in path

UUID to identify the component of the company in SiGREEN

Changed: supplierId in path

UUID to identify the supplier of the company in SiGREEN

Return Type:¶

Changed response : 200 OK

A component product carbon footprints for component of a supplier.

• Changed content type : application/json

  • Changed property items (array)

  Changed items (object):

  * Changed property `id` (string)
    > UUID to identify the component of the company in SiGREEN
  
  * Changed property `supplierId` (string)
      > UUID to identify the supplier of the company in SiGREEN
  

POST /components/{id}/suppliers/{supplierId}/pcfRequest¶

Parameters:¶

Changed: id in path

UUID to identify the component of the company in SiGREEN.

Changed: supplierId in path

UUID to identify the supplier of the company in SiGREEN

Return Type:¶

Changed response : 201 Created

Task is created.

• Changed content type : application/json

  • Added property id (string)

    UUID to identify the task of the company in SiGREEN

  • Changed property taskId (string) > System Generated alphanumeric id to identify the task of the company in SiGREEN

GET /components/pcfData¶

Parameters:¶

Added: componentSupplierLinkId in query

UUID to identify the linkedSupplier with component of the company in SiGREEN

Added: accepted in query

true -> Include PCF's which are received and accepted. false -> Include PCF's which are received. Default all.

Added: denied in query

Include PCF's which are received but denied

Added: withdrawn in query

Include PCF's which are received but withdrawn

Added: active in query

Include PCF's which are active

Added: expired in query

Include PCF's which are expired

Added: revoked in query

Include PCF's which are revoked by Certifier

Added: specVersion in query

Spec version or data model standard

Changed: componentId in query

UUID to identify the component of the company in SiGREEN

Changed: supplierId in query

UUID to identify the supplier of the company in SiGREEN

Return Type:¶

Changed response : 200 OK

Get PCF data of components in SiGREEN

• Changed content type : application/json

  • Changed property items (array)

  Changed items (object):

  * Added property `componentSupplierLinkId` (string)
    > UUID to identify the link between component and supplier of the company in SiGREEN
  
  * Added property `acceptedOn` (string)
      > Proof approved DateTime.DateTime (ISO 8601; UTC Timezone)
  
  * Added property `pcfId` (string)
      > Id for identifying the pcf data of the company in SiGREEN
  
  * Added property `accepted` (boolean)
      > PCF's which is received and accepted
  
  * Added property `denied` (boolean)
      > PCF is received but denied
  
  * Added property `withdrawn` (boolean)
      > PCF which is received but withdrawn
  
  * Added property `active` (boolean)
      > Whether PCF is active or not
  
  * Added property `expired` (boolean)
      > PCF which is expired
  
  * Added property `revoked` (boolean)
      > PCF which is revoked by certifier
  
  * Deleted property `approvedTimeStamp` (string)
      > Proof approved DateTime.DateTime (ISO 8601; UTC Timezone)
  
  * Deleted property `dataQuality` (object)
      > Data Quality
  
  * Changed property `componentId` (string)
      > UUID to identify the component of the company in SiGREEN.
  
  * Changed property `supplierId` (string)
      > UUID to identify the supplier of the company in SiGREEN.
  
  * Changed property `pcfData` (object)
      > Verified Data
  
      * Changed property `pcf` (object)
          > PCF data
  
          * Changed property `declaredUnit` (string)
              > Component Unit type
  

[1.1.0] - 2024-10-14¶

What's New¶

POST /components/{id}/suppliers/{supplierId}/pcfRequest¶

Send pcf request to suppliers in SiGREEN.

What's Changed¶

GET /components/{id}¶

Parameters¶

Changed: id in path

System generated id to identify the component of the company in SiGREEN.

Return Type¶

Changed response : --200 OK--

Get component details by id

• Changed content type : application/json

  • Changed property unit (string)

    unit types

  • Changed property identifiers (array)

    You have to have one identifier where default parameter is set to true as this represents your main identifier for this entity.

  Changed items (object):

PUT /components/{id}¶

Parameters¶

Changed: id in path

System generated id to identify the component of the company in SiGREEN.

Request¶

Changed content type : application/json

• Changed property unit (string)

  unit types

• Changed property identifiers (array)

  You have to have one identifier where default parameter is set to true as this represents your main identifier for this entity.

Changed items (object):

GET /components/{id}/secondaryData¶

Parameters¶

Changed: id in path

System generated id to identify the component of the company in SiGREEN.

Return Type¶

Changed response : --200 OK--

A list of secondary data per component

• Changed content type : application/json

  • Changed property items (array)

  Changed items (object):

  New required properties: - totalExclBio - totalInclBio

  New optional properties: - fossil

  - Added property `createdOn` (string)
    > Created On
  
  - Added property `componentName` (string)
  
  - Changed property `secondaryDataId` (string)
    > System generated id to identify the component secondary data of the company in SiGREEN
  

POST /components/{id}/secondaryData¶

Parameters¶

Changed: id in path

System generated id to identify the component of the company in SiGREEN.

Request¶

Changed content type : application/json

New required properties

• totalExclBio
• totalInclBio

New optional properties

• fossil

• Added property createdOn (string)

  Created On

Return Type¶

Changed response : --201 Created--

Created

• Changed content type : application/json

  • Changed property secondaryDataId (string)

    System generated id to identify the component secondary data of the company in SiGREEN

GET /components/{id}/secondaryData/{secondaryDataId}¶

Parameters¶

Changed: id in path

System generated id to identify the component of the company in SiGREEN.

Changed: secondaryDataId in path

System generated id to identify the component secondary data of the company in SiGREEN

Return Type¶

Changed response : --200 OK--

Get component secondary data by secondary data id

• Changed content type : application/json

New required properties - totalExclBio - totalInclBio

New optional properties - fossil

- Added property `createdOn` (string)
  > Created On

- Added property `componentName` (string)

- Changed property `secondaryDataId` (string)
  > System generated id to identify the component secondary data of the company in SiGREEN

PUT /components/{id}/secondaryData/{secondaryDataId}¶

Parameters¶

Changed: id in path

System generated id to identify the component of the company in SiGREEN.

Changed: secondaryDataId in path

System generated id to identify the component secondary data of the company in SiGREEN

Request¶

Changed content type : application/json

New required properties

• totalExclBio
• totalInclBio

New optional properties

• fossil

• Added property createdOn (string)

  Created On

GET /components/{id}/linkSuppliers¶

Parameters¶

Changed: id in path

System generated id to identify the component of the company in SiGREEN.

Changed: supplierId in query

System generated id to identify the supplier of the company in SiGREEN

Return Type¶

Changed response : --200 OK--

A list of linked suppliers per component

• Changed content type : application/json

  • Changed property items (array)

  Changed items (object)

  - Changed property `componentSupplierLinkId` (string)
    > System generated id to identify the linked supplier with component of the company in SiGREEN
  
  - Changed property `supplierId` (string)
    > System generated id to identify the supplier of the company in SiGREEN
  
  - Changed property `secondaryDataId` (string)
    > System generated id to identify the component secondary data of the company in SiGREEN
  

POST /components/{id}/linkSuppliers¶

Parameters¶

Changed: id in path

System generated id to identify the component of the company in SiGREEN.

Request¶

Changed content type : application/json

Changed items (object)

• Changed property supplierId (string)

  System generated id to identify the supplier of the company in SiGREEN

• Changed property secondaryDataId (string)

  System generated id to identify the component secondary data of the company in SiGREEN

Return Type¶

Changed response : --201 Created--

Created

• Changed content type : application/json

Changed items (object)

- Added property `componentSupplierLinkId` (string)
  > System generated id to identify the linked supplier with component of the company in SiGREEN

- Changed property `supplierId` (string)
  > System generated id to identify the supplier of the company in SiGREEN

- Changed property `secondaryDataId` (string)
  > System generated id to identify the component secondary data of the company in SiGREEN

GET /components/{id}/linkSuppliers/{componentSupplierLinkId}¶

Parameters¶

Changed: id in path

System generated id to identify the component of the company in SiGREEN.

Changed: componentSupplierLinkId in path

System generated id to identify the linked supplier with component of the company in SiGREEN

Return Type¶

Changed response : --200 OK--

Get linked suppliers by componentSupplierLinkId with component

• Changed content type : application/json

  • Changed property componentSupplierLinkId (string)

    System generated id to identify the linked supplier with component of the company in SiGREEN

  • Changed property supplierId (string)

    System generated id to identify the supplier of the company in SiGREEN

  • Changed property secondaryDataId (string)

    System generated id to identify the component secondary data of the company in SiGREEN

PUT /components/{id}/linkSuppliers/{componentSupplierLinkId}¶

Parameters¶

Changed: id in path

System generated id to identify the component of the company in SiGREEN.

Changed: componentSupplierLinkId in path

System generated id to identify the linked supplier with component of the company in SiGREEN

Request¶

Changed content type : application/json

New optional properties:

• componentSupplierLinkId

• Changed property supplierId (string)

  System generated id to identify the supplier of the company in SiGREEN

• Changed property secondaryDataId (string)

  System generated id to identify the component secondary data of the company in SiGREEN

DELETE /components/{id}/linkSuppliers/{componentSupplierLinkId}¶

Parameters¶

Changed: id in path

System generated id to identify the component of the company in SiGREEN.

Changed: componentSupplierLinkId in path

System generated id to identify the linked supplier with component of the company in SiGREEN

GET /components/pcf¶

Parameters¶

Changed: size in query

page size

Return Type¶

Changed response : --200 OK--

A list of component PCF

• Changed content type : application/json

  • Changed property items (array)

  Changed items (object)

  - Changed property `id` (string)
    > System generated id to identify the component of the company in SiGREEN.
  

POST /suppliers¶

Request¶

Changed content type : application/json

• Changed property identifiers (array)

  You have to have one identifier where the default parameter is set to true as this represents your main identifier for this entity.

Changed items (object)

GET /suppliers¶

Get all suppliers for a company in SiGREEN.

Parameters¶

Changed: from in query

The start date of the date range when the supplier was created.

Changed: to in query

The start date of the date range when the supplier was created.

Changed: identifier in query

Supplier Main Identifier to identify the supplier of the company in SiGREEN.

Changed response : --200 OK--

A list of suppliers

• Changed content type : application/json

  • Changed property items (array)

  Changed items (object)

  - Changed property `id` (string)
    > System generated id to identify the supplier of the company in SiGREEN
  
  - Changed property `identifiers` (array)
    > You have to have one identifier where the default parameter is set to true as this represents your main identifier for this entity.
  
    Changed items (object)
  

POST /components¶

Request¶

Changed content type : application/json

• Changed property unit (string)

  unit types

• Changed property identifiers (array)

  You have to have one identifier where default parameter is set to true as this represents your main identifier for this entity.

Changed items (object):

Return Type¶

Changed response : --201 Created--

Created. Response will return the system id of the created component.

• Changed content type : application/json

  • Changed property id (string)

    System Generated Id to identify the component of the company in SiGREEN

GET /components¶

Parameters¶

Changed: identifier in query

Main Component Identifier to identify the component of the company in SiGREEN

Changed response : --200 OK--

A list of components

• Changed content type : application/json

  • Changed property items (array)

  Changed items (object):

  - Changed property `id` (string)
    > System generated id to identify the component of the company in SiGREEN.
  
  - Changed property `unit` (string)
    > unit types
  
  - Changed property `identifiers` (array)
    > You have to have one identifier where default parameter is set to true as this represents your main identifier for this entity.
  
    Changed items (object):
  

GET /components/{id}/suppliers/{supplierId}/pcf¶

Parameters¶

Changed: id in path

System generated id to identify the component of the company in SiGREEN.

Changed response : --200 OK--

A component product carbon footprints for component of a supplier.

• Changed content type : application/json

  • Changed property items (array)

  Changed items (object):

  - Changed property `id` (string)
    > System generated id to identify the component of the company in SiGREEN.
  

GET /components/pcfData¶

Get the PCF data for your components in SiGREEN.

Parameters¶

Changed: componentId in query

System generated id to identify the component of the company in SiGREEN.

Changed: pcfId in query

System Generated Id for identifying the pcf data of the company in SiGREEN

Changed: from in query

Proof approved from DateTime. DateTime (ISO 8601; UTC Timezone)

Changed: to in query

Proof approved to DateTime. DateTime (ISO 8601; UTC Timezone)

Changed response : --200 OK--

Get PCF data of components in SiGREEN

• Changed content type : application/json

  • Changed property items (array)

  Changed items (object)

  - Changed property `componentId` (string)
    > System generated id to identify the component of the company in SiGREEN.
  
  - Changed property `supplierId` (string)
    > System generated id to identify the supplier of the company in SiGREEN
  
  - Changed property `pcfdata` (object)
    > Verified Data
  
      - Changed property `pcf` (object)
        > PCF data
  
          - Changed property `crossSectoralStandardsUsed` (array)
            > List of Cross-sectoral standards applied.
  
            Removed enum values:
  
              - `ISO 14067`
              - `Pathfinder v1`
              - `Pathfinder v2`
              - `GHG Protocol Product`
              - `PAS 2050`
              - `ISO 14040-44`
              - `PEF`
              - `Other`
          - Changed property `productOrSectorSpecificRules` (array)
  
            Removed enum values:
  
              - `Catena-X Rulebook v1`
              - `Catena-X Rulebook v2`
              - `TFS Guideline v2`
              - `EN 50693`
              - `EN 15804`
              - `BPX 30-323`
              - `Not specified`
          - Changed property `secondaryEmissionFactorSources` (array)
            > Secondary data source & Version.
  
            Changed items (string):
  
          - Changed property `assurance` (object)
            > Assurance details
  
              - Changed property `verificationType` (string)
                > Assurance type.
  
                Added enum value:
  
                  - `third party verified PCF`
  

[1.0.0] - 2024-07-22¶

What's New¶

POST /suppliers/identifierTypes¶

Create a supplier identifier type for a company in SiGREEN.

DELETE /suppliers/identifierTypes/{id}¶

Delete an unused supplier identifier type for a company in SiGREEN.

PATCH /suppliers/identifierTypes/{id}¶

Update supplier identifier type for a company in SiGREEN.

PUT /suppliers/{id}¶

Update a supplier by supplier Id in SiGREEN

POST /components/identifierTypes¶

Create a component identifier type for a company in SiGREEN.

DELETE /components/identifierTypes/{id}¶

Delete an unused component identifier type for a company in SiGREEN.

PATCH /components/identifierTypes/{id}¶

Update a component identifier type for a company in SiGREEN.

PUT /components/{id}¶

Update component details by id

GET /components/{id}/secondaryData¶

Get all component secondary data for component in SiGREEN

POST /components/{id}/secondaryData¶

Create secondary data with component.

GET /components/{id}/secondaryData/{secondaryDataId}¶

Get component secondary data by secondary data id

PUT /components/{id}/secondaryData/{secondaryDataId}¶

Update component secondary data by secondary data id.

GET /components/{id}/linkSuppliers¶

Get all linked suppliers with component

POST /components/{id}/linkSuppliers¶

Link suppliers and secondary data with component

GET /components/{id}/linkSuppliers/{componentSupplierLinkId}¶

Get linked suppliers by componentSupplierLinkId with component

PUT /components/{id}/linkSuppliers/{componentSupplierLinkId}¶

Update location/share/secondary data/supplier product id by component supplier id

DELETE /components/{id}/linkSuppliers/{componentSupplierLinkId}¶

Delete link between component and supplier

GET /components/{id}/suppliers/{supplierId}/pcf¶

Get an export of a PCF of a component without cryptographic material. If you need cryptographic verifiability of this information please use DIDComm APIs.

What's Changed¶

GET /components/pcf¶

Get an aggregated export of a PCF of a component without cryptographic material. If you need cryptographic verifiability of this information please use DIDComm APIs.

Parameters¶

Added: componentIds in query

You can specify more than one componentId(System generated id) here (separated by comma).

Deleted: supplierId in query

Deleted: componentId in query

Changed: page in query

page number

Changed: size in query

page size

Return Type¶

New response : --403 Forbidden--

Forbidden. Deleted response : --404 Not Found-- Not found. Changed response : --200 OK-- A list of Component PCF

• Changed content type : application/json

  • Added property items (array)

  Items (object):

  - Property `id` (string)
    > System generated id to identify the component of the company in SiGREEN
  
  - Property `totalPcf` (number)
    > Total PCF
  
  - Property `pcfUnit` (string)
    > PCF Unit Types
  
    Enum values:
  
      - `kgCO2e/piece`
      - `kgCO2e/kg`
      - `kgCO2e/m2`
      - `kgCO2e/m3`
      - `kgCO2e/kWh`
      - `kgCO2e/tkm`
      - `kgCO2e/MJ`
      - `kgCO2e/L`
  

  • Deleted property results (array)

  • Changed property hasNext (boolean)

    true if next page exists (page < totalPages)

  • Changed property hasPrev (boolean)

    true if a previous page exists (page > 0)

  • Changed property page (number)

    The current page-number (starts with 0)

  • Changed property pageNumber (number)

    The current page-number (starts with 1)

  • Changed property size (number)

    The size of elements in the response

  • Changed property totalPages (number)

    The total available pages

Changed response : --400 Bad Request--

Bad request.

• New content type : application/problem+json

• Deleted content type : application/json

Changed response : --401 Unauthorized--

Unauthorized.

• New content type : application/problem+json

Changed response : --500 Internal Server Error--

Unexpected error.

• New content type : application/problem+json

GET /components/pcfData¶

Parameters¶

Changed: componentId in query

System generated id to identify the component of the company in SiGREEN

Changed: supplierId in query

System generated id to identify the supplier of the company in SiGREEN

Changed: page in query

Page number

Changed: size in query

Page size

Return Type¶

New response : --401 Unauthorized--

Unauthorized. New response : --403 Forbidden-- Forbidden. Changed response : --200 OK-- Get PCF data of components in SiGREEN

• Changed content type : application/json

  • Added property items (array)

  Items (object):

  - Property `componentIdentifier` (string)
    > Component Main Identifier.
  
  - Property `componentName` (string)
    > component Name.
  
  - Property `componentId` (string)
    > System generated id to identify the component of the company in SiGREEN.
  
  - Property `supplierId` (string)
    > System generated id to identify the supplier of the company in SiGREEN.
  
  - Property `supplierIdentifier` (string)
    > Supplier Main Identifier.
  
  - Property `supplierName` (string)
    > Supplier name.
  
  - Property `supplierProductId` (string)
    > supplier product id
  
  - Property `location` (string)
    > Supplier Location.
  
  - Property `approvedTimeStamp` (string)
    > Proof approved DateTime.DateTime (ISO 8601; UTC Timezone)
  
  - Property `pcfState` (string)
    > State of the pcf to say if it self certified or certified by a 3rd party certifier
  
  - Property `dataQuality` (object)
    > Data Quality
  
      - Property `typeOfQuality` (string)
        > Type of quality
  
        Enum values:
  
          - `Transparency`
          - `Reliability`
          - `Validity & Data Accuracy`
      - Property `percentage` (number)
        > Data quality calculated in percentage
  
  - Property `pcfData` (object)
    > Verified Data
  
      - Property `company` (object)
        > Company Details
  
          - Property `companyName` (string)
            > Company name.
  
          - Property `companyIds` (array)
            > Company IDs.
  
            Items (string):
  
          - Property `companyProducer` (string)
            > Name of producer, if it differs from the supplier of product.
  
          - Property `companyContactEmail` (string)
            > Contact email address.
  
          - Property `companyContactPhone` (string)
            > Contact phone.
  
      - Property `product` (object)
        > Product details
  
          - Property `name` (string)
            > name of product
  
          - Property `family` (string)
            > name of product family
  
          - Property `identifiers` (array)
            > You have to have one identifier where default parameter is set to true as this represents your main identifier for this entity.
  
            Items (object):
  
              - Property `idType` (string)
                > identifier type
  
              - Property `value` (string)
                > identifier value
  
              - Property `default` (boolean)
                > whether main identifier type or not
  
          - Property `description` (string)
            > product description
  
          - Property `weight` (string)
            > weight of product
  
          - Property `quantity` (string)
            > product quantity
  
          - Property `unitType` (string)
            > unit types
  
            Enum values:
  
              - `piece`
              - `kg`
              - `m2`
              - `m3`
              - `kWh`
              - `km`
              - `TEU`
              - `pkm`
              - `tkm`
              - `MJ`
              - `L`
          - Property `location` (string)
            > Product location
  
          - Property `factory` (array)
            > Factory
  
            Items (string):
  
      - Property `pcf` (object)
        > PCF data
  
          - Property `scopePcf` (object)
            > Scope of PCF
  
              - Property `specVersion` (array)
                > Data model and version.
  
                Items (string):
  
              - Property `limitedOrFullDec` (string)
                > Limited or full declaration.
  
                Enum values:
  
                  - `Mandatory inputs only`
                  - `Mandatory and optional inputs`
              - Property `partialFullPcf` (string)
                > Partial or a full PCF.
  
                Enum values:
  
                  - `Cradle-to-gate`
                  - `Cradle-to-grave`
              - Property `productionStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `materialAcquisitionAndPreProcessingSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `rawMaterialAcquistionSub2Stage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `preprocessingSub2Stage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `transportToManufacturingSiteSub2Stage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `manufacturingSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `assemblySub2Stage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `packagingEmissionsIncluded` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `eolTreatmentOfGeneratedWasteMfgSub2Stage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `distributionStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `transportAToDistributerSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `reconditioningAtDistributorSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `transportBToPlaceOfUseSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `installationAndAssemblyStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `installationSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `eolTreatmentOfGeneratedWasteInstallationSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `useStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `useSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `maintenanceSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `repairSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `replacementSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `eolTreatmentOfGeneratedWasteUseSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `refurbishmentSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `operationalEnergyUseSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `operationalWaterUseSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `eolStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `demolitionSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `transportSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `wasteProcessingSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `disposalSubStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
              - Property `reuseRecoveryRecyclingPotentialStage` (string)
                > Scope Pcf Type
  
                Enum values:
  
                  - `included`
                  - `excluded`
          - Property `declaredUnit` (string)
            > unit types
  
            Enum values:
  
              - `piece`
              - `kg`
              - `m2`
              - `m3`
              - `kWh`
              - `km`
              - `TEU`
              - `pkm`
              - `tkm`
              - `MJ`
              - `L`
          - Property `unitaryProductAmount` (string)
            > Quantity (of declared unit)
  
          - Property `productMassPerDeclaredUnit` (string)
            > Product mass [kg] per declared unit.
  
          - Property `id` (string)
            > PCF ID.Id will represent like UUID v4.
  
          - Property `precedingPfIds` (array)
            > Previous PCF IDs.Id will represent like UUID v4.
  
            Items (string):
  
          - Property `version` (string)
            > PCF version, the value can be in decimals.
  
          - Property `pfStatus` (string)
            > PCF status
  
            Enum values:
  
              - `Active`
              - `Deprecated`
          - Property `pfStatusComment` (string)
            > PCF status comment
  
          - Property `exemptedEmissionsPercent` (string)
            > Cut-off rule %
  
          - Property `exemptedEmissionsDescription` (string)
            > Cut-off and exemption rules explanation
  
          - Property `boundaryProcessesDescription` (string)
            > Important unit processes and used technologies
  
          - Property `typeRecycledContent` (string)
            > Type of recycled content
  
            Enum values:
  
              - `post-industrial`
              - `post-consumer`
          - Property `ccuCo2Origin` (string)
            > CCU CO2-origin
  
          - Property `geographyCountrySubdivision` (string)
            > City/state as country subdivision.according to ISO 3166-2 alpha-2 subdivision code
  
          - Property `geographyCountry` (string)
            > Geography country.according to ISO 3166-2 alpha-2 country code
  
          - Property `geographyRegionOrSubregion` (string)
            > Geography with region or subregion
  
            Enum values:
  
              - `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`
          - Property `locationProductHandover` (string)
            > Location of product handover
  
            Enum values:
  
              - `Own factory gate`
              - `Customer gate`
              - `Other`
          - Property `referencePeriodStart` (string)
            > Reference period start.DateTime (ISO 8601; UTC Timezone)
  
          - Property `referencePeriodEnd` (string)
            > Reference period end.DateTime (ISO 8601; UTC Timezone)
  
          - Property `created` (string)
            > Date of issue.DateTime (ISO 8601; UTC Timezone)
  
          - Property `updated` (string)
            > Date update.DateTime (ISO 8601; UTC Timezone)
  
          - Property `validityPeriodStart` (string)
            > Validity period start.DateTime (ISO 8601; UTC Timezone)
  
          - Property `validityPeriodEnd` (string)
            > Validity period end. DateTime (ISO 8601; UTC Timezone)
  
          - Property `crossSectoralStandardsUsed` (array)
            > Cross-sectoral standards applied.
  
            Items (string):
  
            Enum values:
  
              - `ISO 14067`
              - `Pathfinder v1`
              - `Pathfinder v2`
              - `GHG Protocol Product`
              - `PAS 2050`
              - `ISO 14040-44`
              - `PEF`
              - `Other`
          - Property `productOrSectorSpecificRules` (array)
            > Product or sector rules applied.
  
            Items (string):
  
            Enum values:
  
              - `Catena-X Rulebook v1`
              - `Catena-X Rulebook v2`
              - `TFS Guideline v2`
              - `EN 50693`
              - `EN 15804`
              - `BPX 30-323`
              - `Not specified`
          - Property `operator` (string)
            > select "other".
  
            Enum values:
  
              - `PEF`
              - `EPD International`
              - `Other`
          - Property `otherOperatorName` (string)
            > Publisher's URN of product or sector specific guidance.
  
          - Property `biogenicAccountingMethodology` (string)
            > Methodology used to account for biogenic emissions and removals applied.
  
            Enum values:
  
              - `PEF`
              - `ISO`
              - `GHGP`
              - `Quantis`
          - Property `characterizationFactorsTimeHorizon` (string)
            > Time horizon of GWP values.
  
            Enum values:
  
              - `GWP100`
              - `GWP20`
              - `GWP500`
              - `GWP1000`
              - `Unspecified`
          - Property `characterizationFactors` (string)
            > IPCC report version of GWP values.
  
            Enum values:
  
              - `AR1`
              - `AR2`
              - `AR3`
              - `AR4`
              - `AR5`
              - `AR6`
              - `unspecified`
          - Property `characterizationFactorsClimateCarbonFeedback` (string)
            > Are climate-carbon feedbacks included in the GWP?
  
            Enum values:
  
              - `yes`
              - `no`
              - `partly`
              - `unspecified`
          - Property `characterizationFactorsClimateCarbonFeedbackLciaMethod` (string)
            > LCIA method applied in assessment.
  
            Enum values:
  
              - `Greenhouse Gas Protocol`
              - `PEF`
              - `IPCC 2013 GWP100a`
              - `IPCC 2013 GWP20a`
              - `IPCC 2007 GWP100a`
              - `IPCC 2007 GWP20a`
              - `IPCC 2001 GWP100a`
              - `IPCC 2001 GWP20a`
              - `ReCiPe 2016 Midpoint (E)`
              - `ReCiPe 2016 Midpoint (I)`
              - `ReCiPe 2016 Midpoint (H)`
              - `CML-IA baseline`
              - `CML 1992`
              - `CML 2 baseline 2000`
              - `CML 2001 (all impact categories)`
              - `EDIP 2003`
              - `EPD (2008), EPD (2013)`
              - `ILCD 2011 Midpoint+`
              - `IMPACT 2002+`
              - `TRACI 2.1`
              - `BEES+`
              - `other`
              - `unspecified`
          - Property `characterizationFactorsGhgExclusions` (string)
            > Exclusion of greenhouse gases.
  
          - Property `allocationRulesDescription` (string)
            > Allocation rules used.
  
          - Property `recycledMaterialAllocationApproach` (string)
            > Recycled material allocation approach.
  
            Enum values:
  
              - `Recycled content method`
              - `Closed loop approximation method`
          - Property `allocationWasteIncineration` (string)
            > Allocation approach used for waste incineration with energy recovery.
  
            Enum values:
  
              - `cut-off`
              - `reverse cut-off`
              - `system expansion`
          - Property `allocationRecycledCarbon` (string)
            > Allocation approach used for recycled material & c-content.
  
            Enum values:
  
              - `upstream system expansion`
              - `cut-off`
          - Property `allocationCcuCarbon` (string)
            > Allocation approach used for CCU.
  
          - Property `primaryDataShare` (string)
            > Primary Data Share (PDS).
  
          - Property `sourceOfPrimaryData` (string)
            > Sources for primary data.
  
          - Property `secondaryEmissionFactorSources` (array)
            > Secondary data source & Version.
  
            Items (string):
  
          - Property `secondaryEmissionFactorSourcesVersion` (string)
            > Secondary data source version.
  

  • Deleted property results (array)

  • Changed property hasNext (boolean)

    true if next page exists (page < totalPages)

  • Changed property hasPrev (boolean)

    true if a previous page exists (page > 0)

  • Changed property page (number)

    The current page-number (starts with 0)

  • Changed property pageNumber (number)

    The current page-number (starts with 1)

  • Changed property size (number)

    The size of elements in the response

  • Changed property totalPages (number)

    The total available pages

Changed response : --400 Bad Request--

Bad request.

• New content type : application/problem+json

• Deleted content type : application/json

Changed response : --500 Internal Server Error--

Unexpected error.

• New content type : application/problem+json

GET /components/identifierTypes¶

Get component identifier types for a company in SiGREEN.

Parameters¶

Added: page in query

Page Number, usually starts with 0

Added: size in query

Size of the page default value is 10

Return Type¶

New response : --403 Forbidden--

Forbidden. Deleted response : --400 Bad Request-- Bad request. Changed response : --401 Unauthorized-- Unauthorized.

• New content type : application/problem+json

Changed response : --500 Internal Server Error--

Unexpected error.

• New content type : application/problem+json

Changed response : --200 OK--

List of component identifier types.

• Changed content type : application/json

  • Changed property hasNext (boolean)

    true if next page exists (page < totalPages)

  • Changed property hasPrev (boolean)

    true if a previous page exists (page > 0)

  • Changed property page (number)

    The current page-number (starts with 0)

  • Changed property pageNumber (number)

    The current page-number (starts with 1)

  • Changed property size (number)

    The size of elements in the response

  • Changed property totalPages (number)

    The total available pages

  • Changed property identifierTypes (array)

  Changed items (object):

  New required properties -id -idType -isMainIdentifierType

  - Added property `id` (string)
    > A unique id for identifier type.
  
  - Changed property `idType` (string)
    > identifier type value.
  
  - Changed property `isMainIdentifierType` (boolean)
    > Whether it is main identifier type or not.
  

GET /suppliers/identifierTypes¶

Get supplier identifier types for a company in SiGREEN.

Parameters¶

Added: page in query

Page Number, usually starts with 0

Added: size in query

Size of the page default value is 10

Return Type¶

New response : --403 Forbidden--

Forbidden. Deleted response : --400 Bad Request-- Bad request. Changed response : --401 Unauthorized-- Unauthorized.

• New content type : application/problem+json

Changed response : --500 Internal Server Error--

Unexpected error.

• New content type : application/problem+json

Changed response : --200 OK--

List of supplier identifier types

• Changed content type : application/json

  • Changed property hasNext (boolean)

    true if next page exists (page < totalPages)

  • Changed property hasPrev (boolean)

    true if a previous page exists (page > 0)

  • Changed property page (number)

    The current page-number (starts with 0)

  • Changed property pageNumber (number)

    The current page-number (starts with 1)

  • Changed property size (number)

    The size of elements in the response

  • Changed property totalPages (number)

    The total available pages

  • Changed property identifierTypes (array)

  Changed items (object):

  New required properties: -id - idType - isMainIdentifierType

  - Added property `id` (string)
    > A unique id for identifier type.
  
  - Changed property `idType` (string)
    > identifier type value.
  
  - Changed property `isMainIdentifierType` (boolean)
    > Whether it is main identifier type or not.