Update one activity record
patch
/fscmRestApi/resources/11.13.18.05/sustainabilityActivities/{ActivityId}
Request
Path Parameters
-
ActivityId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActivityDate: string
(date)
Title:
Activity Date
Date of the activity record. -
ActivityDff: array
ActivityDff
-
CalculationOverride: string
Title:
Calculation Mode
Maximum Length:255
Mode used for calculation of emissions. For example, using matched factors, by manual entry of factors, or by manual entry of emissions. -
CalculationOverrideCode: string
Title:
Calculation Mode Code
Maximum Length:100
Code that uniquely identifies the calculation mode. -
Comments: string
Title:
Comments
Maximum Length:4000
Additional information for an activity that can be entered in a free-text field. -
ConsumptionEndDate: string
(date)
Title:
Consumption End Date
Date when the consumption related to the activity will end. -
ConsumptionStartDate: string
(date)
Title:
Consumption Start Date
Date when the consumption related to the activity started. -
Country: string
Title:
Country
Maximum Length:255
Name of the country. -
CountryCode: string
Title:
Country Code
Maximum Length:2
Code used to uniquely identify a country. -
DataQuality: string
Title:
Data Quality
Maximum Length:255
Indicates the data quality of the activity record. For example, High confidence, Moderate confidence, and Low confidence. -
DataQualityCode: string
Title:
Data Quality Code
Maximum Length:30
Code that helps uniquely identify data quality. -
Description: string
Title:
Description
Maximum Length:4000
Description of the activity record. -
DistributionLineNumber: integer
Distribution Line Number
-
EmissionFactorMapDFF: array
EmissionFactorMapDFF
-
Emissions: array
Emissions
Title:
Emissions
Represents the details in an emission record of a sustainability activity, including emission type, emission factor, emission quantity and, where applicable, the associated carbon dioxide equivalent. For example, an activity record representing the consumption of 5,000 standard cubic feet of natural gas might have several emission records such as emission type methane, an associated emission factor, the resulting calculated emissions, and the associated carbon dioxide equivalent. -
EntryType: string
Title:
Entry Type
Maximum Length:255
Type of entry for the record such as Standard or Adjustment. -
EntryTypeCode: string
Title:
Entry Type Code
Maximum Length:30
Code that helps uniquely identify the type of entry. -
ExternalReferenceNumber: string
Title:
External Reference Number
Maximum Length:100
Reference to a record in another application. -
InventoryItemId: integer
(int64)
Title:
Item ID
Unique identifier of the item. -
InvoiceDistributionId: integer
(int64)
Invoice Distribution ID
-
InvoiceId: integer
(int64)
Invoice ID
-
InvoiceLineNumber: integer
(int64)
Invoice Line Number
-
InvoiceNumber: string
Maximum Length:
80
Invoice Number -
ItemNumber: string
Title:
Item
Maximum Length:255
Unique number of the item. -
LegalEntity: string
Title:
Legal Entity
Maximum Length:255
Name of the legal entity. -
LegalEntityId: integer
(int64)
Title:
Legal Entity ID
Unique identifier of the legal entity. -
Measures: array
Activity Measures
Title:
Activity Measures
Represents the details of the measure record of a sustainability activity. The details include measure type, measure quantity, unit of measure, and currency. For example, for an activity record that represents the burning of 10 cubic feet of natural gas, the measure type is Quantity, the measure quantity is 10, and the unit of measure is cubic feet. -
OriginalActivityId: integer
(int64)
Title:
Original Activity ID
Unique identifier of the original activity record. -
OriginalActivityNumber: string
Title:
Original Activity Number
Maximum Length:255
Unique number of the original activity record. -
Period: string
Maximum Length:
255
Period -
PeriodId: integer
(int64)
Title:
Period ID
Unique identifier for the period under which the activity is reported. -
Scope: string
Title:
Scope
Maximum Length:255
Scope of emissions as defined by the Greenhouse Gas Protocol, that's, Scope 1, Scope 2 Location-based, Scope 2 Market-based or Scope 3. -
ScopeCategory: string
Title:
Scope Category
Maximum Length:80
Category under which Scope 3 emissions are reported. Purchased goods and services, waste generated in operations are few such categories. -
ScopeCategoryCode: string
Title:
Scope Category Code
Maximum Length:30
Code that identifies a Scope 3 category. -
ScopeCode: string
Title:
Scope Code
Maximum Length:30
Code that identifies a scope. -
Supplier: string
Title:
Supplier
Maximum Length:255
Unique name of the supplier. -
SupplierId: integer
(int64)
Title:
Supplier ID
Unique identifier of the supplier. -
ValidationMessages: array
Validation Messages
Title:
Validation Messages
Contains details of the validation issues that are generated when an activity record is validated. Validation messages explain the reasons for inconsistencies in an activity record, that must be addressed before the record can be posted.
Nested Schema : EmissionFactorMapDFF
Type:
Show Source
array
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "Mobile Combustion CALC":"#/components/schemas/oracle_apps_flex_prc_sus_activitiesefm_view_EfMapMobile____Combustion____CALCVO-item-patch-request" } }
Nested Schema : Emissions
Type:
array
Title:
Emissions
Represents the details in an emission record of a sustainability activity, including emission type, emission factor, emission quantity and, where applicable, the associated carbon dioxide equivalent. For example, an activity record representing the consumption of 5,000 standard cubic feet of natural gas might have several emission records such as emission type methane, an associated emission factor, the resulting calculated emissions, and the associated carbon dioxide equivalent.
Show Source
Nested Schema : Activity Measures
Type:
array
Title:
Activity Measures
Represents the details of the measure record of a sustainability activity. The details include measure type, measure quantity, unit of measure, and currency. For example, for an activity record that represents the burning of 10 cubic feet of natural gas, the measure type is Quantity, the measure quantity is 10, and the unit of measure is cubic feet.
Show Source
Nested Schema : Validation Messages
Type:
array
Title:
Validation Messages
Contains details of the validation issues that are generated when an activity record is validated. Validation messages explain the reasons for inconsistencies in an activity record, that must be addressed before the record can be posted.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Context Segment
Nested Schema : Discriminator: __FLEX_Context
Type:
object
Discriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_flex_prc_sus_activitiesefm_view_EfMapMobile____Combustion____CALCVO-item-patch-request
Type:
Show Source
object
-
__FLEX_Context_DisplayValue: string
Title:
Activity Type
Activity Type -
fuelType: string
Title:
Fuel Type
Maximum Length:150
Fuel Type -
percentLaden: string
Title:
Percent Laden
Maximum Length:150
Percent Laden -
vehicleType: string
Title:
Vehicle Type
Maximum Length:150
Vehicle Type
Nested Schema : sustainabilityActivities-Emissions-item-patch-request
Type:
Show Source
object
-
ActivityId: integer
(int64)
Title:
Activity ID
Unique identifier of an activity record. -
DenominatorCurrency: string
Title:
Denominator Currency
Maximum Length:80
Currency of the denominator of the emission factor. -
DenominatorCurrencyCode: string
Title:
Denominator Currency Code
Maximum Length:15
Currency code of the denominator of the emission factor. -
DenominatorUOM: string
Title:
Denominator UOM
Maximum Length:80
Unit of measure of the denominator of the emission factor. -
DenominatorUOMCode: string
Title:
Denominator UOM Code
Maximum Length:3
Code for the unit of measure of the denominator of the emission factor. -
Description: string
Title:
Description
Maximum Length:4000
Description of the emission factor. -
EmissionFactor: number
Title:
Factor
Value of the emission factor. -
EmissionQuantity: number
Title:
Emission Quantity
Quantity of emission. -
EmissionUOM: string
Title:
Emission UOM
Maximum Length:255
Unit of measure for the quantity of emission. -
EmissionUOMCode: string
Title:
Emission UOM Code
Maximum Length:3
Code identifying the unit of measure for the quantity of emission. -
FactorSource: string
Title:
Source
Maximum Length:1000
Source of the emission factor provided as free-form text. For example, Supplier-provided carbon footprint. -
NumeratorUOM: string
Title:
Numerator UOM
Maximum Length:255
Unit of measure of the numerator of the emission factor. -
NumeratorUOMCode: string
Title:
Numerator UOM Code
Maximum Length:3
Code for the unit of measure of the numerator of the emission factor.
Nested Schema : schema
Type:
Show Source
object
-
Currency: string
Title:
Currency
Maximum Length:80
Currency when the measure is monetary, for example, Amount. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
Code that identifies the currency when the measure is monetary, for example, Amount. -
Measure: number
Title:
Measure
Measure to be used for emission calculation and reporting. -
UOM: string
Title:
UOM
Maximum Length:80
Unit of measure when the measure isn't monetary, for example, Quantity or Distance. -
UOMCode: string
Title:
UOM Code
Maximum Length:3
Code that identifies the unit of measure when the measure isn't monetary, for example, Quantity or Distance.
Nested Schema : sustainabilityActivities-ValidationMessages-item-patch-request
Type:
Show Source
object
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : sustainabilityActivities-item-response
Type:
Show Source
object
-
ActivityDate: string
(date)
Title:
Activity Date
Date of the activity record. -
ActivityDff: array
ActivityDff
-
ActivityId: integer
(int64)
Title:
Activity ID
Read Only:true
Unique identifier of an activity record. -
ActivityNumber: string
Title:
Activity Number
Read Only:true
Maximum Length:100
Unique number for the activity record. -
AlertFlag: boolean
Read Only:
true
Alert -
CalculationDate: string
Title:
Calculation Date
Read Only:true
Maximum Length:255
Date when the emissions were last calculated. -
CalculationOverride: string
Title:
Calculation Mode
Maximum Length:255
Mode used for calculation of emissions. For example, using matched factors, by manual entry of factors, or by manual entry of emissions. -
CalculationOverrideCode: string
Title:
Calculation Mode Code
Maximum Length:100
Code that uniquely identifies the calculation mode. -
ClassificationCategory: string
Read Only:
true
Maximum Length:255
Classification Category -
ClassificationCategoryId: integer
(int64)
Read Only:
true
Classification Category ID -
ClassificationRuleId: integer
(int64)
Read Only:
true
Classification Rule ID -
ClassificationRuleName: string
Read Only:
true
Maximum Length:255
Classification Rule -
Comments: string
Title:
Comments
Maximum Length:4000
Additional information for an activity that can be entered in a free-text field. -
ConsumptionEndDate: string
(date)
Title:
Consumption End Date
Date when the consumption related to the activity will end. -
ConsumptionStartDate: string
(date)
Title:
Consumption Start Date
Date when the consumption related to the activity started. -
Country: string
Title:
Country
Maximum Length:255
Name of the country. -
CountryCode: string
Title:
Country Code
Maximum Length:2
Code used to uniquely identify a country. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the record was created. -
DataQuality: string
Title:
Data Quality
Maximum Length:255
Indicates the data quality of the activity record. For example, High confidence, Moderate confidence, and Low confidence. -
DataQualityCode: string
Title:
Data Quality Code
Maximum Length:30
Code that helps uniquely identify data quality. -
Description: string
Title:
Description
Maximum Length:4000
Description of the activity record. -
DistributionLineNumber: integer
Distribution Line Number
-
EmissionFactorMapDFF: array
EmissionFactorMapDFF
-
Emissions: array
Emissions
Title:
Emissions
Represents the details in an emission record of a sustainability activity, including emission type, emission factor, emission quantity and, where applicable, the associated carbon dioxide equivalent. For example, an activity record representing the consumption of 5,000 standard cubic feet of natural gas might have several emission records such as emission type methane, an associated emission factor, the resulting calculated emissions, and the associated carbon dioxide equivalent. -
EntryType: string
Title:
Entry Type
Maximum Length:255
Type of entry for the record such as Standard or Adjustment. -
EntryTypeCode: string
Title:
Entry Type Code
Maximum Length:30
Code that helps uniquely identify the type of entry. -
EsgLedgerId: integer
(int64)
Title:
Sustainability Ledger ID
Read Only:true
Unique identifier of the sustainability ledger. -
ExternalReferenceNumber: string
Title:
External Reference Number
Maximum Length:100
Reference to a record in another application. -
InventoryItemId: integer
(int64)
Title:
Item ID
Unique identifier of the item. -
InvoiceDistributionId: integer
(int64)
Invoice Distribution ID
-
InvoiceId: integer
(int64)
Invoice ID
-
InvoiceLineNumber: integer
(int64)
Invoice Line Number
-
InvoiceNumber: string
Maximum Length:
80
Invoice Number -
ItemDescription: string
Read Only:
true
Maximum Length:255
Item Description -
ItemNumber: string
Title:
Item
Maximum Length:255
Unique number of the item. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User login by whom the record was last updated. -
Ledger: string
Read Only:
true
Maximum Length:255
Sustainability Ledger -
LegalEntity: string
Title:
Legal Entity
Maximum Length:255
Name of the legal entity. -
LegalEntityId: integer
(int64)
Title:
Legal Entity ID
Unique identifier of the legal entity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Measures: array
Activity Measures
Title:
Activity Measures
Represents the details of the measure record of a sustainability activity. The details include measure type, measure quantity, unit of measure, and currency. For example, for an activity record that represents the burning of 10 cubic feet of natural gas, the measure type is Quantity, the measure quantity is 10, and the unit of measure is cubic feet. -
OriginalActivityId: integer
(int64)
Title:
Original Activity ID
Unique identifier of the original activity record. -
OriginalActivityNumber: string
Title:
Original Activity Number
Maximum Length:255
Unique number of the original activity record. -
Period: string
Maximum Length:
255
Period -
PeriodId: integer
(int64)
Title:
Period ID
Unique identifier for the period under which the activity is reported. -
PostingDate: string
(date-time)
Title:
Posting Date
Read Only:true
Date on which the activity status was changed to posted. -
Scope: string
Title:
Scope
Maximum Length:255
Scope of emissions as defined by the Greenhouse Gas Protocol, that's, Scope 1, Scope 2 Location-based, Scope 2 Market-based or Scope 3. -
ScopeCategory: string
Title:
Scope Category
Maximum Length:80
Category under which Scope 3 emissions are reported. Purchased goods and services, waste generated in operations are few such categories. -
ScopeCategoryCode: string
Title:
Scope Category Code
Maximum Length:30
Code that identifies a Scope 3 category. -
ScopeCode: string
Title:
Scope Code
Maximum Length:30
Code that identifies a scope. -
SourceType: string
Title:
Source Type
Maximum Length:255
Source of the activity record, such as Manual, External, Invoice autocreate, or File-Based Data Import. -
SourceTypeCode: string
Title:
Source Type Code
Maximum Length:100
Code of the source type that helps to uniquely identify the source type. -
Status: string
Title:
Status
Read Only:true
Maximum Length:255
Status of the activity record such as Draft, Posted, or Canceled. -
StatusCode: string
Title:
Status Code
Read Only:true
Maximum Length:30
Default Value:ORA_SUS_STATUS_DRAFT
Status code that helps to uniquely identify a status. -
Supplier: string
Title:
Supplier
Maximum Length:255
Unique name of the supplier. -
SupplierId: integer
(int64)
Title:
Supplier ID
Unique identifier of the supplier. -
TotalCo2e: number
Title:
Total CO2e
Read Only:true
Total calculated CO2e for the activity record. -
TotalCo2eUOM: string
Title:
Total CO2e UOM Code
Read Only:true
Maximum Length:3
Code identifying the UOM for the total CO2e. -
TotalCo2eUOMName: string
Read Only:
true
Maximum Length:255
Total CO2e UOM -
ValidationMessages: array
Validation Messages
Title:
Validation Messages
Contains details of the validation issues that are generated when an activity record is validated. Validation messages explain the reasons for inconsistencies in an activity record, that must be addressed before the record can be posted.
Nested Schema : EmissionFactorMapDFF
Type:
Show Source
array
-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context", "mapping":{ "Mobile Combustion CALC":"#/components/schemas/oracle_apps_flex_prc_sus_activitiesefm_view_EfMapMobile____Combustion____CALCVO-item-response" } }
Nested Schema : Emissions
Type:
array
Title:
Emissions
Represents the details in an emission record of a sustainability activity, including emission type, emission factor, emission quantity and, where applicable, the associated carbon dioxide equivalent. For example, an activity record representing the consumption of 5,000 standard cubic feet of natural gas might have several emission records such as emission type methane, an associated emission factor, the resulting calculated emissions, and the associated carbon dioxide equivalent.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Activity Measures
Type:
array
Title:
Activity Measures
Represents the details of the measure record of a sustainability activity. The details include measure type, measure quantity, unit of measure, and currency. For example, for an activity record that represents the burning of 10 cubic feet of natural gas, the measure type is Quantity, the measure quantity is 10, and the unit of measure is cubic feet.
Show Source
Nested Schema : Validation Messages
Type:
array
Title:
Validation Messages
Contains details of the validation issues that are generated when an activity record is validated. Validation messages explain the reasons for inconsistencies in an activity record, that must be addressed before the record can be posted.
Show Source
Nested Schema : sustainabilityActivities-ActivityDff-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Context Segment -
ActivityId: integer
(int64)
Read Only:
true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : Discriminator: __FLEX_Context
Type:
object
Discriminator: __FLEX_Context
Discriminator Values
Match One Schema
Show Source
Nested Schema : oracle_apps_flex_prc_sus_activitiesefm_view_EfMapMobile____Combustion____CALCVO-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Activity Type
Maximum Length:150
Default Value:Mobile Combustion CALC
Activity Type -
__FLEX_Context_DisplayValue: string
Title:
Activity Type
Activity Type -
ActivityId: integer
(int64)
Read Only:
true
-
fuelType: string
Title:
Fuel Type
Maximum Length:150
Fuel Type -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
percentLaden: string
Title:
Percent Laden
Maximum Length:150
Percent Laden -
vehicleType: string
Title:
Vehicle Type
Maximum Length:150
Vehicle Type
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : sustainabilityActivities-Emissions-item-response
Type:
Show Source
object
-
ActivityEmissionId: integer
(int64)
Title:
Activity Emission ID
Read Only:true
Unique identifier of an activity emission record. -
ActivityId: integer
(int64)
Title:
Activity ID
Unique identifier of an activity record. -
ActivityMeasureId: integer
(int64)
Title:
Activity Measure ID
Read Only:true
Unique identifier of an activity measure record. -
Co2eEmissionQuantity: number
Title:
CO2e
Read Only:true
Quantity of CO2e emission. -
Co2eUOM: string
Title:
CO2e UOM
Read Only:true
Maximum Length:255
Unit of measure for the quantity of CO2e emission. -
Co2eUOMCode: string
Title:
CO2e UOM Code
Read Only:true
Maximum Length:3
Code identifying the unit of measure for the quantity of CO2e emission. -
DenominatorCurrency: string
Title:
Denominator Currency
Maximum Length:80
Currency of the denominator of the emission factor. -
DenominatorCurrencyCode: string
Title:
Denominator Currency Code
Maximum Length:15
Currency code of the denominator of the emission factor. -
DenominatorUOM: string
Title:
Denominator UOM
Maximum Length:80
Unit of measure of the denominator of the emission factor. -
DenominatorUOMCode: string
Title:
Denominator UOM Code
Maximum Length:3
Code for the unit of measure of the denominator of the emission factor. -
Description: string
Title:
Description
Maximum Length:4000
Description of the emission factor. -
EmissionFactor: number
Title:
Factor
Value of the emission factor. -
EmissionFactorMappingId: integer
(int64)
Title:
Emission Factor Mapping ID
Read Only:true
Unique identifier of the emission factor mapping. -
EmissionQuantity: number
Title:
Emission Quantity
Quantity of emission. -
EmissionType: string
Title:
Emission Type
Maximum Length:80
Name of the type of emission. An emission type is a substance such as a greenhouse gas or an air pollutant that's emitted by a process such as fossil fuel combustion or a chemical reaction. For example, CO2 and CH4 could be associated with an activity type, stationary combustion. -
EmissionTypeCode: string
Title:
Emission Type Code
Maximum Length:30
Code identifying an emission type. -
EmissionUOM: string
Title:
Emission UOM
Maximum Length:255
Unit of measure for the quantity of emission. -
EmissionUOMCode: string
Title:
Emission UOM Code
Maximum Length:3
Code identifying the unit of measure for the quantity of emission. -
FactorSource: string
Title:
Source
Maximum Length:1000
Source of the emission factor provided as free-form text. For example, Supplier-provided carbon footprint. -
GwpFactor: number
Title:
GWP Factor
Read Only:true
Metric value used to assess the potential contribution of different greenhouse gases to global warming over a specific period, usually 100 years. -
GwpId: integer
(int64)
Title:
GWP Identifier
Read Only:true
Unique identifier of global warming potential (GWP) that's a metric used to assess the potential contribution of different greenhouse gases to global warming over a specific period, usually 100 years. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Measure: integer
(int64)
Title:
Measure
Read Only:true
Value for the measure type used for calculating the emission. -
MeasureType: string
Title:
Measure Type
Maximum Length:80
Name of the measure type. For example, quantity, amount, or distance. -
MeasureTypeCode: string
Title:
Measure Type Code
Maximum Length:30
Code identifying a measure type. -
MeasureUnit: string
Title:
Measure Unit
Read Only:true
Maximum Length:255
Unit for the measure value. For example, US Dollar, Kilometer, or Kilogram. -
NumeratorUOM: string
Title:
Numerator UOM
Maximum Length:255
Unit of measure of the numerator of the emission factor. -
NumeratorUOMCode: string
Title:
Numerator UOM Code
Maximum Length:3
Code for the unit of measure of the numerator of the emission factor.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : sustainabilityActivities-Measures-item-response
Type:
Show Source
object
-
ActivityMeasureId: integer
(int64)
Title:
Activity Measure ID
Read Only:true
Unique identifier of an activity measure record. -
Currency: string
Title:
Currency
Maximum Length:80
Currency when the measure is monetary, for example, Amount. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
Code that identifies the currency when the measure is monetary, for example, Amount. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Measure: number
Title:
Measure
Measure to be used for emission calculation and reporting. -
MeasureType: string
Title:
Measure Type
Maximum Length:255
Name of the measure type. For example, quantity, amount, or distance. -
MeasureTypeCode: string
Title:
Measure Type Code
Maximum Length:30
Code identifying a measure type. -
UOM: string
Title:
UOM
Maximum Length:80
Unit of measure when the measure isn't monetary, for example, Quantity or Distance. -
UOMCode: string
Title:
UOM Code
Maximum Length:3
Code that identifies the unit of measure when the measure isn't monetary, for example, Quantity or Distance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : sustainabilityActivities-ValidationMessages-item-response
Type:
Show Source
object
-
ActivityId: integer
(int64)
Title:
Activity ID
Read Only:true
Unique identifier of the activity record for which the validation message is generated. -
EmissionTypeCode: string
Title:
Emission Type Code
Read Only:true
Maximum Length:30
Emission type code for which the validation message is generated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Message: string
Title:
Message
Read Only:true
Maximum Length:255
Full text of the validation message that was generated during activity validation. -
MessageCode: string
Title:
Message Code
Read Only:true
Maximum Length:30
Message code that helps to uniquely identify the message details. -
MessageLevel: string
Title:
Message Level
Read Only:true
Maximum Length:255
Indicates the level of the message, error, warning, or informational. -
MessageLevelCode: string
Title:
Message Level Code
Read Only:true
Maximum Length:30
Message level code that helps to uniquely identify the message level. -
MessageSummary: string
Title:
Message Summary
Read Only:true
Maximum Length:255
Summarized explanation of the validation message. -
MessageSummaryCode: string
Title:
Message Summary Code
Read Only:true
Maximum Length:30
Message summary code that helps to uniquely identify the message summary. -
ValidationMessageId: integer
(int64)
Title:
Validation Message ID
Read Only:true
Unique identifier of the validation message.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ActivityDff
-
Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityActivities/{ActivityId}/child/ActivityDffParameters:
- ActivityId:
$request.path.ActivityId
- ActivityId:
- ActivityIdVA
-
Parameters:
- finder:
ActivityIdFinder
The following properties are defined on the LOV link relation:- Source Attribute: OriginalActivityNumber; Target Attribute: ActivityNumber
- Display Attribute: ActivityNumber
- finder:
- CalculationOverrideCodeVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SUS_CAL_MODE%2CActiveDate%3D2025-04-18
The following properties are defined on the LOV link relation:- Source Attribute: CalculationOverride; Target Attribute: Meaning
- Display Attribute: Meaning
- finder:
- CountryCodeVA
-
Parameters:
- finder:
TerritoryCodeFinder
The following properties are defined on the LOV link relation:- Source Attribute: Country; Target Attribute: TerritoryShortName
- Display Attribute: TerritoryShortName
- finder:
- DataQualityCodeVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SUS_DATA_QUALITY%2CActiveDate%3D2025-04-18
The following properties are defined on the LOV link relation:- Source Attribute: DataQuality; Target Attribute: Meaning
- Display Attribute: Meaning
- finder:
- EmissionFactorMapDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityActivities/{ActivityId}/child/EmissionFactorMapDFFParameters:
- ActivityId:
$request.path.ActivityId
- ActivityId:
- Emissions
-
Parameters:
- ActivityId:
$request.path.ActivityId
Represents the details in an emission record of a sustainability activity, including emission type, emission factor, emission quantity and, where applicable, the associated carbon dioxide equivalent. For example, an activity record representing the consumption of 5,000 standard cubic feet of natural gas might have several emission records such as emission type methane, an associated emission factor, the resulting calculated emissions, and the associated carbon dioxide equivalent. - ActivityId:
- EntryTypeCodeVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SUS_ENTRY_TYPE%2CActiveDate%3D2025-04-18
The following properties are defined on the LOV link relation:- Source Attribute: EntryType; Target Attribute: Meaning
- Display Attribute: Meaning
- finder:
- Measures
-
Parameters:
- ActivityId:
$request.path.ActivityId
Represents the details of the measure record of a sustainability activity. The details include measure type, measure quantity, unit of measure, and currency. For example, for an activity record that represents the burning of 10 cubic feet of natural gas, the measure type is Quantity, the measure quantity is 10, and the unit of measure is cubic feet. - ActivityId:
- ScopeCategoryCodeVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SUS_SCOPE_CATEGORIES%2CActiveDate%3D2025-04-18
The following properties are defined on the LOV link relation:- Source Attribute: ScopeCategory; Target Attribute: Meaning
- Display Attribute: Meaning
- finder:
- ScopeCodeVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SUS_SCOPES%2CActiveDate%3D2025-04-18
The following properties are defined on the LOV link relation:- Source Attribute: Scope; Target Attribute: Meaning
- Display Attribute: Meaning
- finder:
- SourceTypeCodeVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SUS_SOURCE_TYPE%2CActiveDate%3D2025-04-18
The following properties are defined on the LOV link relation:- Source Attribute: SourceType; Target Attribute: Meaning
- Display Attribute: Meaning
- finder:
- StatusCodeVA
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_SUS_ACT_STATUS%2CActiveDate%3D2025-04-18
The following properties are defined on the LOV link relation:- Source Attribute: Status; Target Attribute: Meaning
- Display Attribute: Meaning
- finder:
- ValidationMessages
-
Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityActivities/{ActivityId}/child/ValidationMessagesParameters:
- ActivityId:
$request.path.ActivityId
Contains details of the validation issues that are generated when an activity record is validated. Validation messages explain the reasons for inconsistencies in an activity record, that must be addressed before the record can be posted. - ActivityId:
- cancelActivity
-
Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityActivities/{ActivityId}/action/cancelActivityParameters:
- ActivityId:
$request.path.ActivityId
Cancels a posted activity. This action verifies whether the activity has been posted and if the corresponding period is still open. If no issues are identified, the activity is then canceled. - ActivityId:
- postToLedger
-
Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityActivities/{ActivityId}/action/postToLedgerParameters:
- ActivityId:
$request.path.ActivityId
Posts an activity to the sustainability ledger. This action involves validating the activity to identify any potential validation issues. If no errors are found, the activity is then posted to the ledger. - ActivityId:
- validateActivity
-
Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityActivities/{ActivityId}/action/validateActivityParameters:
- ActivityId:
$request.path.ActivityId
Recalculates and validates an activity record. The action first recalculates emissions where relevant, validates the activity, and records validation messages for any identified validation issues. - ActivityId: