Get one emission-factor mapping
get
/fscmRestApi/resources/11.13.18.05/emissionFactorMappings/{EmissionFactorMappingId}
Request
Path Parameters
-
EmissionFactorMappingId(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=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : emissionFactorMappings-item-response
Type:
Show Source
object-
CategoryId: integer
(int64)
Title:
Category IDRead Only:trueUnique identifier of the activity classification category that's used in defining invoice classification rules. -
CategoryName: string
Title:
Category NameRead Only:trueMaximum Length:1000Name of the attribute classification category that's used in invoice classification rules. The name is populated only when Category Visibility is set to Y. -
CategoryVisibility: string
Title:
Category VisibilityRead Only:trueMaximum Length:1Indicates whether or not a category name is visible for this record. Possible values are Y or Blank. -
Country: string
Title:
CountryMaximum Length:255Name of the country. -
CountryCode: string
Title:
Country CodeMaximum Length:2Country code that helps to uniquely identify a country. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64User who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate and time when the record was created. -
DenominatorCurrency: string
Title:
Denominator CurrencyMaximum Length:80Currency of the denominator of the emission factor. -
DenominatorCurrencyCode: string
Title:
Denominator Currency CodeMaximum Length:15Currency code of the denominator of the emission factor. -
DenominatorUOM: string
Title:
Denominator UOMMaximum Length:80Unit of measure of the denominator of the emission factor. -
DenominatorUOMCode: string
Title:
Denominator UOM CodeMaximum Length:3Code for the unit of measure of the denominator of the emission factor. -
Description: string
Title:
DescriptionMaximum Length:4000Description of the emission factor. -
EmissionFactor: number
Title:
FactorValue of the emission factor. -
EmissionFactorMapDFF: array
EmissionFactorMapDFF
-
EmissionFactorMappingId: integer
(int64)
Title:
Emission Factor Mapping IDRead Only:trueUnique identifier of the emission-factor mapping. -
EmissionType: string
Title:
Emission TypeMaximum Length:80Translated name that identifies the emission type. 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. -
EmissionTypeCode: string
Title:
Emission Type CodeMaximum Length:30Code that identifies the emission type. -
EndDate: string
(date)
Title:
End DateDate when the emission-factor mapping becomes inactive. -
FactorSource: string
Title:
SourceMaximum Length:1000Source of the emission factor provided. For example, Supplier-provided carbon footprint. -
InUseFlag: boolean
Title:
In Use IndicatorRead Only:trueMaximum Length:255Default Value:falseIdentifies if the activity type is used in any activity emissions or emission factor mappings. -
InventoryItem: string
Title:
ItemMaximum Length:255Unique number of the item. -
InventoryItemId: integer
(int64)
Title:
Item IDUnique identifier of the item. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueDate and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64User login by whom the record was last updated. -
LegalEntity: string
Title:
Legal EntityMaximum Length:255Name of the legal entity. -
LegalEntityId: integer
(int64)
Title:
Legal Entity IDUnique identifier of the legal entity. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MappingNumber: integer
(int64)
Title:
Mapping NumberRead Only:trueUnique number for the record of the emission factor mapping. -
MeasureType: string
Title:
Measure TypeMaximum Length:80Translated name that identifies a measure type. A measure type is a variable whose value is multiplied by an emission factor to obtain the emissions for an emission type. -
MeasureTypeCode: string
Title:
Measure Type CodeMaximum Length:30Code that identifies the measure type. -
NumeratorUOM: string
Title:
Numerator UOMMaximum Length:255Unit of measure of the numerator of the emission factor. -
NumeratorUOMCode: string
Title:
Numerator UOM CodeMaximum Length:3Code for the unit of measure of the numerator of the emission factor. -
Ranking: integer
(int64)
Title:
RankingRanking of the emission-factor mapping. Mapping with lower value is ranked higher. -
StartDate: string
(date)
Title:
Start DateDate when the emission-factor mapping becomes active. -
Supplier: string
Title:
SupplierMaximum Length:255Unique name of the supplier. -
SupplierId: integer
(int64)
Title:
Supplier IDUnique identifier of the supplier.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : emissionFactorMappings-EmissionFactorMapDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Activity TypeMaximum Length:150Activity Type -
__FLEX_Context_DisplayValue: string
Title:
Activity TypeActivity Type -
EmissionFactorMappingId: integer
(int64)
Read Only:
true -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Links
- CountryCodeVA
-
Parameters:
- finder:
TerritoryCodeAllRowsFinder
The following properties are defined on the LOV link relation:- Source Attribute: Country; Target Attribute: TerritoryShortName
- Display Attribute: TerritoryShortName
- finder:
- CurrencyCodeVA
-
Parameters:
- finder:
CurrencyCodeAllRowsFinder
The following properties are defined on the LOV link relation:- Source Attribute: DenominatorCurrency; Target Attribute: Name
- Display Attribute: Name
- finder:
- DenominatorUOMCodeVA
-
Parameters:
- finder:
ActiveUomFinder%3BDisableDate%3D2025-05-23
The following properties are defined on the LOV link relation:- Source Attribute: DenominatorUOM; Target Attribute: UOM
- Display Attribute: UOM
- finder:
- EmissionFactorMapDFF
-
Parameters:
- EmissionFactorMappingId:
$request.path.EmissionFactorMappingId
- EmissionFactorMappingId:
- EmissionTypeVA
-
Parameters:
- finder:
LookupTypeAllRowsFinder%3BLookupType%3DORA_SUS_EMISSION_TYPES
The following properties are defined on the LOV link relation:- Source Attribute: EmissionType; Target Attribute: Meaning
- Display Attribute: Meaning
- finder:
- LegalEntityVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: LegalEntity; Target Attribute: Name
- Display Attribute: Name
- MeasureTypeVA
-
Parameters:
- finder:
LookupTypeAllRowsFinder%3BLookupType%3DORA_SUS_MEASURE_TYPES
The following properties are defined on the LOV link relation:- Source Attribute: MeasureType; Target Attribute: Meaning
- Display Attribute: Meaning
- finder:
- NumeratorUOMCodeVA
-
Parameters:
- finder:
ActiveUomFinder%3BDisableDate%3D2025-05-23
The following properties are defined on the LOV link relation:- Source Attribute: NumeratorUOM; Target Attribute: UOM
- Display Attribute: UOM
- finder:
Examples
This example describes how to get one emission-factor mapping.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/emissionFactorMappings/EmissionFactorMappingId"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/emissionFactorMappings/300100604806122"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{
"EmissionFactorMappingId": 300100604806122,
"MappingNumber": 1000,
"EmissionTypeCode": "ORA_SUS_CH4",
"EmissionType": "Methane",
"MeasureTypeCode": "ORA_SUS_DISTANCE",
"MeasureType": "Distance",
"EmissionFactor": 0.921,
"NumeratorUOMCode": "G",
"NumeratorUOM": "Gram",
"DenominatorUOMCode": "MI",
"DenominatorUOM": "Mile",
"Description": null,
"FactorSource": "EPA",
"StartDate": "2020-01-01",
"EndDate": null,
"Ranking": 100,
"LegalEntityId": null,
"LegalEntity": null,
"SupplierId": null,
"Supplier": null,
"InventoryItemId": null,
"InventoryItem": null,
"CountryCode": null,
"Country": null,
"DenominatorCurrencyCode": null,
"DenominatorCurrency": null,
"CreatedBy": "SUSPMADMIN",
"CreationDate": "2024-06-12T08:17:40+00:00",
"LastUpdatedBy": "SUSPMADMIN",
"LastUpdateDate": "2024-06-12T08:17:40.168+00:00",
"CategoryId": 300100604806123,
"CategoryVisibility": "Y",
"CategoryName": "Mobile Combustion.Compressed Natural Gas (CNG).Heavy-Duty Trucks",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/emissionFactorMappings/300100604806122",
"name": "emissionFactorMappings",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/emissionFactorMappings/300100604806122",
"name": "emissionFactorMappings",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/emissionFactorMappings/300100604806122/child/EmissionFactorMapDFF",
"name": "EmissionFactorMapDFF",
"kind": "collection"
}
]
}