Manage Sustainability Activity Operations
This use case shows you how to manage sustainability activites.
Let's discuss these activities.
- Create and update sustainability activities.
- Get one sustainability activity.
- Post an activity to ledger.
- Validate an activity.
- Cancel a posted activity.
Create and Update Sustainability Activities
You can use sustainability activities resource to create and update activities.
When an activity is created, Oracle Cloud Sustainability calculates the emissions, where applicable, for the activity based on the calculation mode specified. Here's an explanation of each of the calculation modes:
- Using matched factors: The application looks for the highest-ranked matching emission factor mappings to calculate the emissions.
- Manual entry of emissions: The emissions entered on the activity are accepted as is.
- Manual entry of factors: The emission factors entered on the activity are used to calculate the emissions.
The calculation engine will also perform intraclass UOM conversions where needed, including for calculating carbon dioxide equivalent (CO2e) in the configured Reporting UOM.
You create a sustainability activity by including the following:
- Activity details, such as activity type and its attributes, legal entity, country, supplier, and calculation mode.
- Measures, by which you capture measures such as quantity, distance, or amount.
- Emissions, only when the calculation mode is Manual entry of factors or Manual entry of emissions.
Examples
These examples describe how to create or update sustainability activities.
| Example 1 | Create a sustainability activity using matched factors. |
| Example 2 | Create a sustainability activity using manual entry of factors. |
| Example 3 | Create a sustainability activity using manual entry of emissions. |
| Example 4 | Update measures on an existing sustainability activity. |
| Example 5 | Update emissions on an existing sustainability activity where the calculation mode is manual entry of emissions. |
Example 1
Let's say Richard Jones wants to create a sustainability activity for the consumption of 1,121 gallons of diesel fuel by a light duty truck. Richard can create the activity with activity details and measures. The default calculation mode, Using matched factors is applied here and the application looks for the highest-ranked matching emission factor mappings to calculate the emissions.
Use this resource URL format:
POST
curl -u username:password -X POST -H "Content-Type:application/json" -d "request payload" https://servername/fscmRestApi/resources/version/sustainabilityActivities"
Example 1 Request
Here's an example of the request body in JSON format:
{
"Description": "Light truck fleet, Sacramento warehous",
"ActivityDate": "2024-08-01",
"ConsumptionStartDate": "2024-08-01",
"ConsumptionEndDate": "2024-08-06",
"DataQuality": "High confidence",
"LegalEntity": "Vision Operations",
"Supplier": "EASTERN AMERICAN ENERGY CORP",
"Country": "United States",
"ItemNumber": "DSL105",
"CalculationOverride": "Using matched factors",
"EmissionFactorMapDFF": [
{
"__FLEX_Context": "Mobile Combustion",
"energySource": "Diesel Fuel",
"vehicleType": "Light-Duty Trucks 1983-2006"
}
],
"Measures": [
{
"MeasureType": "Quantity",
"Measure": 1121,
"UOM": "Gallon",
"Currency": null
}
]
}Example 1 Response
Here's an example of the response body in JSON format:
{
"ActivityId": 300100611788658,
"ActivityNumber": "61556",
"Description": "Light truck fleet, Sacramento warehous",
"Comments": null,
"ScopeCode": "ORA_SUS_SCOPE1",
"Scope": "Scope 1",
"ScopeCategoryCode": null,
"ScopeCategory": null,
"EntryTypeCode": "ORA_SUS_ENTRY_STANDRD",
"EntryType": "Standard",
"SourceTypeCode": "ORA_SUS_SOURCE_EXTERNAL",
"SourceType": "External",
"ExternalReferenceNumber": null,
"ActivityDate": "2024-08-01",
"ConsumptionStartDate": "2024-08-01",
"ConsumptionEndDate": "2024-08-06",
"StatusCode": "ORA_SUS_STATUS_DRAFT",
"Status": "Draft",
"DataQualityCode": "ORA_SUS_HIGH_CONFIDENCE",
"DataQuality": "High confidence",
"OriginalActivityId": null,
"OriginalActivityNumber": null,
"LegalEntityId": 204,
"LegalEntity": "Vision Operations",
"SupplierId": 999992000324837,
"Supplier": "EASTERN AMERICAN ENERGY CORP",
"CountryCode": "US",
"Country": "United States",
"InventoryItemId": 300100582777247,
"ItemNumber": "DSL105",
"ItemDescription": "Diesel",
"CalculationOverrideCode": "ORA_SUS_USE_MATCHED_FACTORS",
"CalculationOverride": "Using matched factors",
"CreatedBy": "CVBUYER01",
"CreationDate": "2024-08-06T08:45:45+00:00",
"LastUpdatedBy": "CVBUYER01",
"LastUpdateDate": "2024-08-06T08:45:45+00:00",
"TotalCo2e": 11445.41,
"TotalCo2eUOM": "KG",
"TotalCo2eUOMName": "Kilogram",
"PostingDate": null,
"EsgLedgerId": 300100604805965,
"Ledger": "Vision Ledger",
"PeriodId": 300100604803969,
"Period": "Aug-24",
"AlertFlag": "false",
"InvoiceId": null,
"InvoiceNumber": null,
"InvoiceLineNumber": null,
"InvoiceDistributionId": null,
"DistributionLineNumber": null,
"ClassificationCategoryId": null,
"ClassificationCategory": null,
"ClassificationRuleId": null,
"ClassificationRuleName": null,
"CalculationDate": "2024-08-06",
"Measures": [
{
"ActivityMeasureId": 300100611788659,
"MeasureTypeCode": "ORA_SUS_QUANTITY",
"MeasureType": "Quantity",
"Measure": 1121,
"UOMCode": "GAL",
"UOM": "Gallon",
"CurrencyCode": null,
"Currency": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658/child/Measures/300100611788659",
"name": "Measures",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658/child/Measures/300100611788659",
"name": "Measures",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658",
"name": "sustainabilityActivities",
"kind": "item"
}
]
}
],
"EmissionFactorMapDFF": [
{
"ActivityId": 300100611788658,
"__FLEX_Context": "Mobile Combustion",
"__FLEX_Context_DisplayValue": "Mobile Combustion",
"energySource": "Diesel Fuel",
"vehicleType": "Light-Duty Trucks 1983-2006",
"percentLaden": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658/child/EmissionFactorMapDFF/300100611788658",
"name": "EmissionFactorMapDFF",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658/child/EmissionFactorMapDFF/300100611788658",
"name": "EmissionFactorMapDFF",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658",
"name": "sustainabilityActivities",
"kind": "item"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658",
"name": "sustainabilityActivities",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658",
"name": "sustainabilityActivities",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658/child/ActivityDff",
"name": "ActivityDff",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658/child/EmissionFactorMapDFF",
"name": "EmissionFactorMapDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658/child/Emissions",
"name": "Emissions",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658/child/Measures",
"name": "Measures",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658/child/ValidationMessages",
"name": "ValidationMessages",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658/action/postToLedger",
"name": "postToLedger",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658/action/validateActivity",
"name": "validateActivity",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658/action/cancelActivity",
"name": "cancelActivity",
"kind": "other"
}
]
} Example 2
In this example, Richard Jones wants to create a sustainability activity by manually specifying the emission factors for emission types carbon dioxide (CO2), methane (CH4) and nitrous oxide (NO2) with calculation mode specified as Manual entry of factors. The application uses the emission factors provided by Richard in the emission record to calculate the emissions.
Use this resource URL format:
POST
curl -u username:password -X POST -H "Content-Type:application/json" -d "request payload" https://servername/fscmRestApi/resources/version/sustainabilityActivities"
Example 2 Request
Here's an example of the request body in JSON format:
{
"Description": "Steam to heat Portland campus",
"ExternalReferenceNumber": "EXT1234",
"ActivityDate": "2024-08-01",
"DataQuality": "High confidence",
"LegalEntity": "Vision Corp - Canada",
"Supplier": "EASTERN AMERICAN ENERGY CORP",
"Country": "United States",
"ItemNumber": "DSL105",
"CalculationOverride": "Manual entry of factors",
"EmissionFactorMapDFF": [
{
"__FLEX_Context": "Purchased Energy",
"gridRegion": "Steam and Heat",
"energyType": "Steam"
}
],
"Measures": [
{
"MeasureType": "Quantity",
"Measure": 1121,
"UOM": "Metric Million BTU"
}
],
"Emissions": [
{
"EmissionType": "Carbon dioxide",
"MeasureType": "Quantity",
"EmissionFactor": 66.33,
"NumeratorUOM": "Kilogram",
"DenominatorUOM": "Metric Million BTU"
},
{
"EmissionType": "Methane",
"MeasureType": "Quantity",
"EmissionFactor": 1.25,
"NumeratorUOM": "Gram",
"DenominatorUOM": "Metric Million BTU"
},
{
"EmissionType": "Nitrous oxide",
"MeasureType": "Quantity",
"EmissionFactor": 0.125,
"NumeratorUOM": "Gram",
"DenominatorUOM": "Metric Million BTU"
}
]
}Example 2 Response
Here's an example of the response body in JSON format:
{
"ActivityId": 300100611788749,
"ActivityNumber": "60656",
"Description": "Steam to heat Portland campus",
"Comments": null,
"ScopeCode": "ORA_SUS_SCOPE2_LBM",
"Scope": "Scope 2 location-based",
"ScopeCategoryCode": null,
"ScopeCategory": null,
"EntryTypeCode": "ORA_SUS_ENTRY_STANDRD",
"EntryType": "Standard",
"SourceTypeCode": "ORA_SUS_SOURCE_EXTERNAL",
"SourceType": "External",
"ExternalReferenceNumber": "EXT1234",
"ActivityDate": "2024-08-01",
"ConsumptionStartDate": null,
"ConsumptionEndDate": null,
"StatusCode": "ORA_SUS_STATUS_DRAFT",
"Status": "Draft",
"DataQualityCode": "ORA_SUS_HIGH_CONFIDENCE",
"DataQuality": "High confidence",
"OriginalActivityId": null,
"OriginalActivityNumber": null,
"LegalEntityId": 839,
"LegalEntity": "Vision Corp - Canada",
"SupplierId": 999992000324837,
"Supplier": "EASTERN AMERICAN ENERGY CORP",
"CountryCode": "US",
"Country": "United States",
"InventoryItemId": 300100582777247,
"ItemNumber": "DSL105",
"ItemDescription": "Diesel",
"CalculationOverrideCode": "ORA_SUS_MANUAL_FACTORS_ENTRY",
"CalculationOverride": "Manual entry of factors",
"CreatedBy": "CVBUYER01",
"CreationDate": "2024-08-06T08:55:09+00:00",
"LastUpdatedBy": "CVBUYER01",
"LastUpdateDate": "2024-08-06T08:55:10+00:00",
"TotalCo2e": 74425.42499375,
"TotalCo2eUOM": "KG",
"TotalCo2eUOMName": "Kilogram",
"PostingDate": null,
"EsgLedgerId": 300100609927593,
"Ledger": "ATS_LEDGER_LE-839",
"PeriodId": 300100609881525,
"Period": "2024-01",
"AlertFlag": "false",
"InvoiceId": null,
"InvoiceNumber": null,
"InvoiceLineNumber": null,
"InvoiceDistributionId": null,
"DistributionLineNumber": null,
"ClassificationCategoryId": null,
"ClassificationCategory": null,
"ClassificationRuleId": null,
"ClassificationRuleName": null,
"CalculationDate": "2024-08-06",
"Emissions": [
{
"ActivityEmissionId": 300100611788751,
"ActivityId": 300100611788749,
"EmissionTypeCode": "ORA_SUS_CO2",
"EmissionType": "Carbon dioxide",
"EmissionQuantity": 74355.93,
"EmissionUOMCode": "KG",
"EmissionUOM": "Kilogram",
"MeasureTypeCode": "ORA_SUS_QUANTITY",
"MeasureType": "Quantity",
"GwpId": 300100611271649,
"GwpFactor": 1,
"EmissionFactor": 66.33,
"FactorSource": null,
"NumeratorUOMCode": "KG",
"NumeratorUOM": "Kilogram",
"DenominatorUOMCode": "MBT",
"DenominatorUOM": "Metric Million BTU",
"DenominatorCurrencyCode": null,
"DenominatorCurrency": null,
"Description": null,
"EmissionFactorMappingId": null,
"ActivityMeasureId": null,
"Co2eEmissionQuantity": 74355.93,
"Co2eUOMCode": "KG",
"Co2eUOM": "Kilogram",
"Measure": 1121,
"MeasureUnit": "Metric Million BTU",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749/child/Emissions/300100611788751",
"name": "Emissions",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749/child/Emissions/300100611788751",
"name": "Emissions",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749",
"name": "sustainabilityActivities",
"kind": "item"
}
]
},
{
"ActivityEmissionId": 300100611788752,
"ActivityId": 300100611788749,
"EmissionTypeCode": "ORA_SUS_CH4",
"EmissionType": "Methane",
"EmissionQuantity": 1401.25,
"EmissionUOMCode": "G",
"EmissionUOM": "Gram",
"MeasureTypeCode": "ORA_SUS_QUANTITY",
"MeasureType": "Quantity",
"GwpId": 300100611337866,
"GwpFactor": 28,
"EmissionFactor": 1.25,
"FactorSource": null,
"NumeratorUOMCode": "G",
"NumeratorUOM": "Gram",
"DenominatorUOMCode": "MBT",
"DenominatorUOM": "Metric Million BTU",
"DenominatorCurrencyCode": null,
"DenominatorCurrency": null,
"Description": null,
"EmissionFactorMappingId": null,
"ActivityMeasureId": null,
"Co2eEmissionQuantity": 35.70385,
"Co2eUOMCode": "KG",
"Co2eUOM": "Kilogram",
"Measure": 1121,
"MeasureUnit": "Metric Million BTU",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749/child/Emissions/300100611788752",
"name": "Emissions",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749/child/Emissions/300100611788752",
"name": "Emissions",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749",
"name": "sustainabilityActivities",
"kind": "item"
}
]
},
{
"ActivityEmissionId": 300100611788753,
"ActivityId": 300100611788749,
"EmissionTypeCode": "ORA_SUS_N2O",
"EmissionType": "Nitrous oxide",
"EmissionQuantity": 140.125,
"EmissionUOMCode": "G",
"EmissionUOM": "Gram",
"MeasureTypeCode": "ORA_SUS_QUANTITY",
"MeasureType": "Quantity",
"GwpId": 300100597145756,
"GwpFactor": 265,
"EmissionFactor": 0.125,
"FactorSource": null,
"NumeratorUOMCode": "G",
"NumeratorUOM": "Gram",
"DenominatorUOMCode": "MBT",
"DenominatorUOM": "Metric Million BTU",
"DenominatorCurrencyCode": null,
"DenominatorCurrency": null,
"Description": null,
"EmissionFactorMappingId": null,
"ActivityMeasureId": null,
"Co2eEmissionQuantity": 33.79114375,
"Co2eUOMCode": "KG",
"Co2eUOM": "Kilogram",
"Measure": 1121,
"MeasureUnit": "Metric Million BTU",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749/child/Emissions/300100611788753",
"name": "Emissions",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749/child/Emissions/300100611788753",
"name": "Emissions",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749",
"name": "sustainabilityActivities",
"kind": "item"
}
]
}
],
"Measures": [
{
"ActivityMeasureId": 300100611788750,
"MeasureTypeCode": "ORA_SUS_QUANTITY",
"MeasureType": "Quantity",
"Measure": 1121,
"UOMCode": "MBT",
"UOM": "Metric Million BTU",
"CurrencyCode": null,
"Currency": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749/child/Measures/300100611788750",
"name": "Measures",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749/child/Measures/300100611788750",
"name": "Measures",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749",
"name": "sustainabilityActivities",
"kind": "item"
}
]
}
],
"EmissionFactorMapDFF": [
{
"ActivityId": 300100611788749,
"__FLEX_Context": "Purchased Energy",
"__FLEX_Context_DisplayValue": "Purchased Energy",
"gridRegion": "Steam and Heat",
"energyType": "Steam",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749/child/EmissionFactorMapDFF/300100611788749",
"name": "EmissionFactorMapDFF",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749/child/EmissionFactorMapDFF/300100611788749",
"name": "EmissionFactorMapDFF",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749",
"name": "sustainabilityActivities",
"kind": "item"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749",
"name": "sustainabilityActivities",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749",
"name": "sustainabilityActivities",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749/child/ActivityDff",
"name": "ActivityDff",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749/child/EmissionFactorMapDFF",
"name": "EmissionFactorMapDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749/child/Emissions",
"name": "Emissions",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749/child/Measures",
"name": "Measures",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749/child/ValidationMessages",
"name": "ValidationMessages",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749/action/postToLedger",
"name": "postToLedger",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749/action/validateActivity",
"name": "validateActivity",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788749/action/cancelActivity",
"name": "cancelActivity",
"kind": "other"
}
]
}Example 3
In this example, Richard Jones wants to create a sustainability activity by directly entering the emissions for emission type carbon dioxide equivalent (CO2e) with calculation mode specified as Manual entry of emissions. The application only calculates total CO2e where applicable.
Use this resource URL format:
POST
curl -u username:password -X POST -H "Content-Type:application/json" -d "request payload"
https://servername/fscmRestApi/resources/version/sustainabilityActivities"
Example 3 Request
Here's an example of the request body in JSON format:
{
"Description": "Light truck fleet, Sacramento warehouse",
"ExternalReferenceNumber": "BAY1234",
"ActivityDate": "2024-03-11",
"ConsumptionStartDate": "2024-03-01",
"ConsumptionEndDate": "2024-03-10",
"DataQuality": "High confidence",
"LegalEntity": "Vision Operations",
"Supplier": "EASTERN AMERICAN ENERGY CORP",
"Country": "United States",
"ItemNumber": "DSL105",
"CalculationOverride": "Manual entry of emissions",
"EmissionFactorMapDFF": [
{
"__FLEX_Context": "Mobile Combustion",
"energySource": "Diesel Fuel",
"vehicleType": "Light-Duty Trucks 1983-2006"
}
],
"Emissions": [
{
"EmissionType": "Carbon dioxide equivalent",
"EmissionQuantity": 12110,
"EmissionUOM": "Kilogram"
}
]
}Example 3 Response
Here's an example of the response body in JSON format:
{
"ActivityId": 300100611789860,
"ActivityNumber": "60658",
"Description": "Light truck fleet, Sacramento warehouse",
"Comments": null,
"ScopeCode": "ORA_SUS_SCOPE1",
"Scope": "Scope 1",
"ScopeCategoryCode": null,
"ScopeCategory": null,
"EntryTypeCode": "ORA_SUS_ENTRY_STANDRD",
"EntryType": "Standard",
"SourceTypeCode": "ORA_SUS_SOURCE_EXTERNAL",
"SourceType": "External",
"ExternalReferenceNumber": "BAY1234",
"ActivityDate": "2024-03-11",
"ConsumptionStartDate": "2024-03-01",
"ConsumptionEndDate": "2024-03-10",
"StatusCode": "ORA_SUS_STATUS_DRAFT",
"Status": "Draft",
"DataQualityCode": "ORA_SUS_HIGH_CONFIDENCE",
"DataQuality": "High confidence",
"OriginalActivityId": null,
"OriginalActivityNumber": null,
"LegalEntityId": 204,
"LegalEntity": "Vision Operations",
"SupplierId": 999992000324837,
"Supplier": "EASTERN AMERICAN ENERGY CORP",
"CountryCode": "US",
"Country": "United States",
"InventoryItemId": 300100582777247,
"ItemNumber": "DSL105",
"ItemDescription": "Diesel",
"CalculationOverrideCode": "ORA_SUS_MANUAL_EMISSIONS_ENTRY",
"CalculationOverride": "Manual entry of emissions",
"CreatedBy": "CVBUYER01",
"CreationDate": "2024-08-06T08:59:44+00:00",
"LastUpdatedBy": "CVBUYER01",
"LastUpdateDate": "2024-08-06T08:59:45+00:00",
"TotalCo2e": 12110,
"TotalCo2eUOM": "KG",
"TotalCo2eUOMName": "Kilogram",
"PostingDate": null,
"EsgLedgerId": 300100604805965,
"Ledger": "Vision Ledger",
"PeriodId": 300100604803974,
"Period": "Mar-24",
"AlertFlag": "false",
"InvoiceId": null,
"InvoiceNumber": null,
"InvoiceLineNumber": null,
"InvoiceDistributionId": null,
"DistributionLineNumber": null,
"ClassificationCategoryId": null,
"ClassificationCategory": null,
"ClassificationRuleId": null,
"ClassificationRuleName": null,
"CalculationDate": "2024-08-06",
"Emissions": [
{
"ActivityEmissionId": 300100611789861,
"ActivityId": 300100611789860,
"EmissionTypeCode": "ORA_SUS_CO2e",
"EmissionType": "Carbon dioxide equivalent",
"EmissionQuantity": 12110,
"EmissionUOMCode": "KG",
"EmissionUOM": "Kilogram",
"MeasureTypeCode": null,
"MeasureType": null,
"GwpId": 300100597145757,
"GwpFactor": 1,
"EmissionFactor": null,
"FactorSource": null,
"NumeratorUOMCode": null,
"NumeratorUOM": null,
"DenominatorUOMCode": null,
"DenominatorUOM": null,
"DenominatorCurrencyCode": null,
"DenominatorCurrency": null,
"Description": null,
"EmissionFactorMappingId": null,
"ActivityMeasureId": null,
"Co2eEmissionQuantity": 12110,
"Co2eUOMCode": "KG",
"Co2eUOM": "Kilogram",
"Measure": null,
"MeasureUnit": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860/child/Emissions/300100611789861",
"name": "Emissions",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860/child/Emissions/300100611789861",
"name": "Emissions",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860",
"name": "sustainabilityActivities",
"kind": "item"
}
]
}
],
"EmissionFactorMapDFF": [
{
"ActivityId": 300100611789860,
"__FLEX_Context": "Mobile Combustion",
"__FLEX_Context_DisplayValue": "Mobile Combustion",
"energySource": "Diesel Fuel",
"vehicleType": "Light-Duty Trucks 1983-2006",
"percentLaden": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860/child/EmissionFactorMapDFF/300100611789860",
"name": "EmissionFactorMapDFF",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860/child/EmissionFactorMapDFF/300100611789860",
"name": "EmissionFactorMapDFF",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860",
"name": "sustainabilityActivities",
"kind": "item"
}
]
}
],
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860",
"name": "sustainabilityActivities",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860",
"name": "sustainabilityActivities",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860/child/ActivityDff",
"name": "ActivityDff",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860/child/EmissionFactorMapDFF",
"name": "EmissionFactorMapDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860/child/Emissions",
"name": "Emissions",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860/child/Measures",
"name": "Measures",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860/child/ValidationMessages",
"name": "ValidationMessages",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860/action/postToLedger",
"name": "postToLedger",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860/action/validateActivity",
"name": "validateActivity",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860/action/cancelActivity",
"name": "cancelActivity",
"kind": "other"
}
]
}Update Measures on an Existing Sustainability Activity
Richard Jones can update measures on an activity that already exists.
Use this resource URL format:
PATCH
curl -u username:password -X PATCH -H "Content-Type:application/json" -d "request payload" https://servername/fscmRestApi/resources/version/sustainabilityActivities/ActivityId/child/Measures/ActivityMeasureId
Example 4 Request
Here's an example of the request body in JSON format:
{
"Measure": 2000
}Example 4 Response
Here's an example of the response body in JSON format:
{
"ActivityMeasureId": 300100611788659,
"MeasureTypeCode": "ORA_SUS_QUANTITY",
"MeasureType": "Quantity",
"Measure": 2000,
"UOMCode": "GAL",
"UOM": "Gallon",
"CurrencyCode": null,
"Currency": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658/child/Measures/300100611788659",
"name": "Measures",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658/child/Measures/300100611788659",
"name": "Measures",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611788658",
"name": "sustainabilityActivities",
"kind": "item"
}
]
}Update Emissions on an Existing Sustainability Activity Where Calculation Mode Is Manual Entry of Emissions
Richard Jones can update emissions for an activity that already exists where calculation mode is manual entry of emissions.
Use this resource URL format:
PATCH
curl -u username:password -X PATCH -H "Content-Type:application/json" -d "request payload" https://servername/fscmRestApi/resources/version/sustainabilityActivities/ActivityId/child/Emissions/ActivityEmissionId
Example 5 Request
Here's an example of the request body in JSON format:
{
"EmissionQuantity": 15110
}Example 5 Response
Here's an example of the response body in JSON format:
{
"ActivityEmissionId": 300100611789861,
"ActivityId": 300100611789860,
"EmissionTypeCode": "ORA_SUS_CO2e",
"EmissionType": "Carbon dioxide equivalent",
"EmissionQuantity": 15110,
"EmissionUOMCode": "KG",
"EmissionUOM": "Kilogram",
"MeasureTypeCode": null,
"MeasureType": null,
"GwpId": 300100597145757,
"GwpFactor": 1,
"EmissionFactor": null,
"FactorSource": null,
"NumeratorUOMCode": null,
"NumeratorUOM": null,
"DenominatorUOMCode": null,
"DenominatorUOM": null,
"DenominatorCurrencyCode": null,
"DenominatorCurrency": null,
"Description": null,
"EmissionFactorMappingId": null,
"ActivityMeasureId": null,
"Co2eEmissionQuantity": 15110,
"Co2eUOMCode": "KG",
"Co2eUOM": "Kilogram",
"Measure": null,
"MeasureUnit": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860/child/Emissions/300100611789861",
"name": "Emissions",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860/child/Emissions/300100611789861",
"name": "Emissions",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100611789860",
"name": "sustainabilityActivities",
"kind": "item"
}
]
}Get One Sustainability Activity
This example describes how to get one sustainability activity.
Example URL
Use this resource URL format:
GET
curl -u username:password "https://servername/fscmRestApi/resources/version/sustainabilityActivities/ActivityId"
Example Response
Here's an example of the response body in JSON format:
{
"ActivityId": 300100607427636,
"ActivityNumber": "30047",
"Description": "Ethylene for San Mateo plant, floor 8",
"Comments": null,
"ScopeCode": "ORA_SUS_SCOPE1",
"Scope": "Scope 1",
"ScopeCategoryCode": null,
"ScopeCategory": null,
"EntryTypeCode": "ORA_SUS_ENTRY_STANDRD",
"EntryType": "Standard",
"SourceTypeCode": "ORA_SUS_SOURCE_EXTERNAL",
"SourceType": "External",
"ExternalReferenceNumber": "BAY1234",
"ActivityDate": "2024-02-15",
"ConsumptionStartDate": null,
"ConsumptionEndDate": null,
"StatusCode": "ORA_SUS_STATUS_POSTED",
"Status": "Posted",
"DataQualityCode": null,
"DataQuality": null,
"OriginalActivityId": null,
"OriginalActivityNumber": null,
"LegalEntityId": 2541,
"LegalEntity": "Vision Financial Services (USA)",
"SupplierId": 300100559932569,
"Supplier": "Green Corp.",
"CountryCode": "US",
"Country": "United States",
"InventoryItemId": null,
"ItemNumber": null,
"ItemDescription": null,
"CalculationOverrideCode": "ORA_SUS_USE_MATCHED_FACTORS",
"CalculationOverride": "Using matched factors",
"CreatedBy": "CVBUYER01",
"CreationDate": "2024-07-01T14:53:01.838+00:00",
"LastUpdatedBy": "CVBUYER01",
"LastUpdateDate": "2024-07-01T14:56:44+00:00",
"TotalCo2e": 4189.424444990313133989401968205904617711,
"TotalCo2eUOM": "KG",
"TotalCo2eUOMName": "Kilogram",
"PostingDate": "2024-07-01T14:56:44+00:00",
"EsgLedgerId": 300100606835842,
"Ledger": "Vision North America Ledger",
"PeriodId": 300100607044900,
"Period": "Feb-24",
"AlertFlag": "false",
"InvoiceId": null,
"InvoiceNumber": null,
"InvoiceLineNumber": null,
"InvoiceDistributionId": null,
"DistributionLineNumber": null,
"ClassificationCategoryId": null,
"ClassificationCategory": null,
"ClassificationRuleId": null,
"ClassificationRuleName": null,
"CalculationDate": "2024-07-01",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100607427636",
"name": "sustainabilityActivities",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100607427636",
"name": "sustainabilityActivities",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100607427636/child/ActivityDff",
"name": "ActivityDff",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100607427636/child/EmissionFactorMapDFF",
"name": "EmissionFactorMapDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100607427636/child/Emissions",
"name": "Emissions",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100607427636/child/Measures",
"name": "Measures",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100607427636/child/ValidationMessages",
"name": "ValidationMessages",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100607427636/action/postToLedger",
"name": "postToLedger",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100607427636/action/validateActivity",
"name": "validateActivity",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/300100607427636/action/cancelActivity",
"name": "cancelActivity",
"kind": "other"
}
]
}Post an Activity to Ledger
You can use user-defined action, postToLedger, to post an activity to the Sustainability Ledger. This action involves validating a draft activity to identify any potential validation issues. If no errors are found, the activity is then posted to the ledger.
Example 1
Let's say Richard Jones created a sustainability activity for the purchase of 5,000 gallons of aviation gasoline. The application found matching emission factors and calculated the emissions. There are currently no validation errors on the activity and it is ready to be posted to the Sustainability Ledger.
In this step, Richard calls the user-defined action postToLedger on the activity.
Use this resource URL format:
POST
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d "request payload" https://servername/fscmRestApi/resources/version/sustainabilityActivities/ActivityId/action/postToLedger
Example 1 Response
Here's an example of the response body in JSON format:
{
"result": "SUCCESS"
}Example 2
Let's say Richard Jones created a sustainability activity for the purchase of 5,000 gallons of diesel. The application couldn't find matching emission factors and emissions couldn't be calculated. The activity has a validation error of Missing Emissions.
In this step, Richard calls the user-defined action postToLedger on the activity.
Use this resource URL format:
POST
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d "request payload" https://servername/fscmRestApi/resources/version/sustainabilityActivities/ActivityId/action/postToLedger
Example 2 Response
Here's an example of the response body in JSON format:
{
"result": "FAILURE"
}Validate an Activity
You can use user-defined action, validateActivity, to recalculate and validate a draft activity. The action first recalculates emissions where relevant, validates the activity, and records validation messages for any identified validation issues.
Here are the steps to perform the task:
- Get the sustainability activity details to validate.
- Call the user-defined action validateActivity.
- Get activity validation message details where the activity had validation issues.
Let's say Richard Jones created a sustainability activity for the purchase of 100 gallons of diesel where calculation mode is Using matched factors. The application could not calculate any emissions as there are no matching emission factors found to calculate emissions. The activity type on the activity is stationary combustion which is associated to emission types Carbon dioxide, Methane and Nitrous oxide in sustainability setup. The activity when validated generates validation message, Missing emissions.
Get the Activity Details to Validate
In this step, Richard gets the details of the sustainability activity which he wants to validate.
Use this resource URL format:
GET
curl -u username:password https://servername/fscmRestApi/resources/version/sustainabilityActivities/ActivityId
Example Response
Here's an example of the response body in JSON format:
{
"ActivityId": 100105470609806,
"ActivityNumber": "51031",
"Description": "Diesel",
"Comments": null,
"ScopeCode": "ORA_SUS_SCOPE1",
"Scope": "Scope 1",
"ScopeCategoryCode": null,
"ScopeCategory": null,
"EntryTypeCode": "ORA_SUS_ENTRY_STANDRD",
"EntryType": "Standard",
"SourceTypeCode": "ORA_SUS_SOURCE_MANUAL",
"SourceType": "Manual Entry",
"ExternalReferenceNumber": null,
"ActivityDate": "2024-04-17",
"ConsumptionStartDate": null,
"ConsumptionEndDate": null,
"StatusCode": "ORA_SUS_STATUS_DRAFT",
"Status": "Draft",
"DataQualityCode": null,
"DataQuality": null,
"OriginalActivityId": null,
"OriginalActivityNumber": null,
"LegalEntityId": 204,
"LegalEntity": "Vision Operations",
"SupplierId": 999992000324837,
"Supplier": "EASTERN AMERICAN ENERGY CORP",
"CountryCode": "US",
"Country": "United States",
"InventoryItemId": 300100582777247,
"ItemNumber": "DSL105",
"ItemDescription": "Diesel",
"CalculationOverrideCode": "ORA_SUS_USE_MATCHED_FACTORS",
"CalculationOverride": "Using matched factors",
"CreatedBy": "CVBUYER01",
"CreationDate": "2024-04-19T05:14:45+00:00",
"LastUpdatedBy": "CVBUYER01",
"LastUpdateDate": "2024-04-24T11:36:52+00:00",
"TotalCo2e": null,
"TotalCo2eUOM": null,
"TotalCo2eUOMName": null,
"PostingDate": null,
"EsgLedgerId": 300100590867600,
"Ledger": "Vision Ledger",
"PeriodId": 300100591006256,
"Period": "Apr-24",
"AlertFlag": null,
"InvoiceId": null,
"InvoiceNumber": null,
"InvoiceLineNumber": null,
"InvoiceDistributionId": null,
"DistributionLineNumber": null,
"ClassificationCategoryId": null,
"ClassificationCategory": null,
"ClassificationRuleId": null,
"ClassificationRuleName": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/100105470609806",
"name": "sustainabilityActivities",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/100105470609806",
"name": "sustainabilityActivities",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/100105470609806/child/ActivityDff",
"name": "ActivityDff",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/100105470609806/child/EmissionFactorMapDFF",
"name": "EmissionFactorMapDFF",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/100105470609806/child/Emissions",
"name": "Emissions",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/100105470609806/child/Measures",
"name": "Measures",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/100105470609806/child/ValidationMessages",
"name": "ValidationMessages",
"kind": "collection"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/100105470609806/action/postToLedger",
"name": "postToLedger",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/100105470609806/action/validateActivity",
"name": "validateActivity",
"kind": "other"
},
{
"rel": "action",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/100105470609806/action/cancelActivity",
"name": "cancelActivity",
"kind": "other"
}
]
}
]
} Call the User-Defined Action validateActivity
In this step, Richard calls the user-defined action validateActivity on the activity.
Use this resource URL format:
POST
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d "request payload" https://servername/fscmRestApi/resources/version/sustainabilityActivities/ActivityId/action/validateActivity
Example Response
Here's an example of the response body in JSON format:
{
"result": "SUCCESS"
}Get Validation Messages for the Activity Validated
In this step, Richard gets the details of the validation messages to see the validation messages generated.
Use this resource URL format:
GET
curl -u username:password https://servername/fscmRestApi/resources/version/sustainabilityActivities/ActivityId/ValidationMessages
Example Response
Here's an example of the response body in JSON format:
{
"items": [
{
"ActivityId": 100105470609806,
"EmissionTypeCode": null,
"MessageCode": "SUS_MISSING_EMISSIONS",
"MessageLevelCode": "ORA_SUS_ERROR",
"MessageSummaryCode": "ORA_SUS_MISSING_EMISSIONS",
"ValidationMessageId": 121693,
"Message": "No emissions are entered or calculated for the activity. Ensure there are matching emission factors in setup or directly enter emission factors or emissions.\n(SUS:::SUS_MISSING_EMISSIONS)",
"MessageLevel": "Error",
"MessageSummary": "Missing emissions",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/100105470609806/child/ValidationMessages/121693",
"name": "ValidationMessages",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/100105470609806/child/ValidationMessages/121693",
"name": "ValidationMessages",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/100105470609806",
"name": "sustainabilityActivities",
"kind": "item"
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/sustainabilityActivities/100105470609806/child/ValidationMessages",
"name": "ValidationMessages",
"kind": "collection"
}
]
}Cancel a Posted Activity
You can use user-defined action, cancelActivity, to cancel a posted sustainability activity. This action is applicable only for activities that are in the posted status and belong to an open period.
Example 1
Let's say Richard Jones posted a sustainability activity in the period July 2024. Richard realizes the activity is no longer required and the period July 2024 is still an open Sustainability Period. Richard can use user-defined action cancelActivity to cancel the posted activity.
Call the User-Defined Action cancelActivity
In this step, Richard calls the user-defined action cancelActivity on the activity.
Use this resource URL format:
POST
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d "request payload" https://servername/fscmRestApi/resources/version/sustainabilityActivities/ActivityId/action/cancelActivity
Example 1 Response
Here's an example of the response body in JSON format:
{
"result": "SUCCESS"
}Example 2
Let's say Richard Jones had posted a sustainability activity in the period Feb 2024. Richard realizes the activity is no longer required and the period Feb 2024 is a closed Sustainability Period. Richard attempts to cancel the posted activity.
Call the User-Defined Action cancelActivity
In this step, Richard calls the user-defined action cancelActivity on the activity.
Use this resource URL format:
POST
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.action+json" -d "request payload" https://servername/fscmRestApi/resources/version/sustainabilityActivities/ActivityId/action/cancelActivity
Example 2 Response
Here's an example of the response body in JSON
format:
You can cancel the activity 40043 only if the period on the activity record is open. (SUS: : :SUS_ACT_CANCEL_FAILURE)