Changelog
Changelog
The format is based on Keep a Changelog.
[1.15.0] - 2025-06-23
Breaking Changes
POST /suppliers/identifierTypes
Request:
Changed content type : application/json
New required properties: - mandatory
- Added property mandatory (boolean) > Whether this identifier is mandatory or not. Mandatory properties must be provided
note
Please note that this change will only affect new data. Existing data will not be affected unless they are updated.
PATCH /suppliers/identifierTypes/{id}
Request:
Changed content type : application/json
New required properties: - mandatory
- Added property mandatory (boolean) > Whether this identifier is mandatory or not. Mandatory properties must be provided
note
Please note that this change will only affect new data. Existing data will not be affected unless they are updated.
POST /components/identifierTypes
Request:
Changed content type : application/json
New required properties: - mandatory
- Added property mandatory (boolean) > Whether this identifier is mandatory or not. Mandatory properties must be provided
note
Please note that this change will only affect new data. Existing data will not be affected unless they are updated.
PATCH /components/identifierTypes/{id}
Request:
Changed content type : application/json
New required properties: - mandatory
- Added property mandatory (boolean) > Whether this identifier is mandatory or not. Mandatory properties must be provided
note
Please note that this change will only affect new data. Existing data will not be affected unless they are updated.
What's Changed
GET /suppliers/identifierTypes
Return Type:
Changed response : 200 OK
List of supplier identifier types
Changed content type : application/json
Changed property items (array)
Changed items (object):
New required properties: - isMandatory
- Added property isMandatory (boolean) > Whether this identifier is mandatory or not. Mandatory properties must be provided
POST /suppliers/identifierTypes
Request:
Changed content type : application/json
New required properties: - mandatory
- Added property mandatory (boolean) > Whether this identifier is mandatory or not. Mandatory properties must be provided
PATCH /suppliers/identifierTypes/{id}
Request:
Changed content type : application/json
New required properties: - mandatory
- Added property mandatory (boolean) > Whether this identifier is mandatory or not. Mandatory properties must be provided
GET /suppliers
Parameters:
Deleted: sigreenId in query
Supplier company SiGREEN Id. Available only in when supplier status is AVAILABLE.
Return Type:
Changed response : 200 OK
A list of supplier
Changed content type : application/json
Changed property items (array)
Changed items (object):
- Changed property sigreenId (string) > SiGREEN Identifier is to be able to uniquely identify a supplier company(legal entities) globally within the SiGREEN platform. The SiGREEN ID will always be present for ACTIVE suppliers.
POST /suppliers
Request:
Changed content type : application/json
- Added property sigreenId (string) > SiGREEN Identifier is to be able to uniquely identify a supplier company(legal entities) globally within the SiGREEN platform. The SiGREEN ID can be updated only if the supplier status is not ACTIVE
GET /suppliers/{id}
Return Type:
Changed response : 200 OK
Supplier detail by id
Changed content type : application/json
- Changed property sigreenId (string) > SiGREEN Identifier is to be able to uniquely identify a supplier company(legal entities) globally within the SiGREEN platform. The SiGREEN ID will always be present for ACTIVE suppliers.
PUT /suppliers/{id}
Request:
Changed content type : application/json
- Added property sigreenId (string) > SiGREEN Identifier is to be able to uniquely identify a supplier company(legal entities) globally within the SiGREEN platform. The SiGREEN ID can be updated only if the supplier status is not ACTIVE
GET /components/identifierTypes
Return Type:
Changed response : 200 OK
List of component identifier types.
Changed content type : application/json
Changed property items (array)
Changed items (object):
New required properties: - isMandatory
- Added property isMandatory (boolean) > Whether this identifier is mandatory or not. Mandatory properties must be provided
POST /components/identifierTypes
Request:
Changed content type : application/json
New required properties: - mandatory
- Added property mandatory (boolean) > Whether this identifier is mandatory or not. Mandatory properties must be provided
PATCH /components/identifierTypes/{id}
Request:
Changed content type : application/json
New required properties: - mandatory
- Added property mandatory (boolean) > Whether this identifier is mandatory or not. Mandatory properties must be provided
POST /components/{id}/suppliers/{supplierId}/pcfRequest
Request:
Changed content type : application/json
Added property geographySubRegion (string) > Preferred region sub region of PCF request.
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
- Several
[1.14.0] - 2025-03-14
What's Changed
GET /suppliers
Parameters:
Added: sigreenId in query
Supplier company SiGREEN Id. Available only in when supplier status is AVAILABLE.
Return Type:
Changed response : 200 OK
A list of supplier
Changed content type : application/json
Changed property items (array)
Changed items (object):
- Added property sigreenId (string) > Supplier company SiGREEN Id. Available only in when supplier status is AVAILABLE.
GET /suppliers/{id}
Return Type:
Changed response : 200 OK
Supplier detail by id
Changed content type : application/json
- Added property sigreenId (string) > Supplier company SiGREEN Id. Available only in when supplier status is AVAILABLE.
[1.13.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)
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)
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)
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)
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)
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: rejected in query
Include PCF's which are received but rejected
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)
[1.12.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.
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)
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)
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)
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)
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)
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)
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)
[1.11.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)
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)
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)
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)