Jump to

• Request
• Response
• Examples

Create one emission-factor mapping

post

/fscmRestApi/resources/11.13.18.05/emissionFactorMappings

Request

Header Parameters

• 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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Country: string
  Title: Country

  Maximum Length: 255

  Name of the country.
• CountryCode: string
  Title: Country Code

  Maximum Length: 2

  Country code that helps to uniquely identify a country.
• 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(required): number
  Title: Factor

  Value of the emission factor.
• EmissionFactorMapDFF: array EmissionFactorMapDFF
• EmissionType: string
  Title: Emission Type

  Maximum Length: 80

  Translated 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(required): string
  Title: Emission Type Code

  Maximum Length: 30

  Code that identifies the emission type.
• EndDate: string (date)
  Title: End Date

  Date when the emission-factor mapping becomes inactive.
• FactorSource: string
  Title: Source

  Maximum Length: 1000

  Source of the emission factor provided. For example, Supplier-provided carbon footprint.
• InventoryItem: string
  Title: Item

  Maximum Length: 255

  Unique number of the item.
• InventoryItemId: integer (int64)
  Title: Item ID

  Unique identifier 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.
• MeasureType: string
  Title: Measure Type

  Maximum Length: 80

  Translated 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(required): string
  Title: Measure Type Code

  Maximum Length: 30

  Code that identifies the measure type.
• NumeratorUOM: string
  Title: Numerator UOM

  Maximum Length: 255

  Unit of measure of the numerator of the emission factor.
• NumeratorUOMCode(required): string
  Title: Numerator UOM Code

  Maximum Length: 3

  Code for the unit of measure of the numerator of the emission factor.
• Ranking(required): integer (int64)
  Title: Ranking

  Ranking of the emission-factor mapping. Mapping with lower value is ranked higher.
• StartDate: string (date)
  Title: Start Date

  Date when the emission-factor mapping becomes active.
• Supplier: string
  Title: Supplier

  Maximum Length: 255

  Unique name of the supplier.
• SupplierId: integer (int64)
  Title: Supplier ID

  Unique identifier of the supplier.

{
    "required":[
        "EmissionFactor",
        "EmissionTypeCode",
        "MeasureTypeCode",
        "NumeratorUOMCode",
        "Ranking"
    ],
    "type":"object",
    "properties":{
        "LegalEntity":{
            "title":"Legal Entity",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the legal entity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LegalEntityId"
                ]
            }
        },
        "InventoryItem":{
            "title":"Item",
            "maxLength":"255",
            "type":"string",
            "description":"Unique number of the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InventoryItemId"
                ]
            }
        },
        "NumeratorUOMCode":{
            "title":"Numerator UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"Code for the unit of measure of the numerator of the emission factor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the emission factor.",
            "nullable":true
        },
        "MeasureType":{
            "title":"Measure Type",
            "maxLength":"80",
            "type":"string",
            "description":"Translated 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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "MeasureTypeCode"
                ]
            }
        },
        "MeasureTypeCode":{
            "title":"Measure Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the measure type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the emission-factor mapping becomes active.",
            "format":"date",
            "nullable":false
        },
        "DenominatorCurrency":{
            "title":"Denominator Currency",
            "maxLength":"80",
            "type":"string",
            "description":"Currency of the denominator of the emission factor.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DenominatorCurrencyCode"
                ]
            }
        },
        "Ranking":{
            "title":"Ranking",
            "type":"integer",
            "description":"Ranking of the emission-factor mapping. Mapping with lower value is ranked higher.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "DenominatorCurrencyCode":{
            "title":"Denominator Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Currency code of the denominator of the emission factor.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EmissionFactor":{
            "title":"Factor",
            "type":"number",
            "description":"Value of the emission factor.",
            "nullable":false
        },
        "EmissionType":{
            "title":"Emission Type",
            "maxLength":"80",
            "type":"string",
            "description":"Translated 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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "EmissionTypeCode"
                ]
            }
        },
        "LegalEntityId":{
            "title":"Legal Entity ID",
            "type":"integer",
            "description":"Unique identifier of the legal entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "EmissionFactorMapDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/emissionFactorMappings-EmissionFactorMapDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "NumeratorUOM":{
            "title":"Numerator UOM",
            "maxLength":"255",
            "type":"string",
            "description":"Unit of measure of the numerator of the emission factor.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "NumeratorUOMCode"
                ]
            }
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":"255",
            "type":"string",
            "description":"Unique name of the supplier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SupplierId"
                ]
            }
        },
        "DenominatorUOM":{
            "title":"Denominator UOM",
            "maxLength":"80",
            "type":"string",
            "description":"Unit of measure of the denominator of the emission factor.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DenominatorUOMCode"
                ]
            }
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":"2",
            "type":"string",
            "description":"Country code that helps to uniquely identify a country.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EmissionTypeCode":{
            "title":"Emission Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the emission type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InventoryItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Unique identifier of the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "FactorSource":{
            "title":"Source",
            "maxLength":"1000",
            "type":"string",
            "description":"Source of the emission factor provided. For example, Supplier-provided carbon footprint.",
            "nullable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the emission-factor mapping becomes inactive.",
            "format":"date",
            "nullable":true
        },
        "DenominatorUOMCode":{
            "title":"Denominator UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"Code for the unit of measure of the denominator of the emission factor.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SupplierId":{
            "title":"Supplier ID",
            "type":"integer",
            "description":"Unique identifier of the supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "Country":{
            "title":"Country",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the country.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CountryCode"
                ]
            }
        }
    }
}

Nested Schema : EmissionFactorMapDFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/emissionFactorMappings-EmissionFactorMapDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Activity Type

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Activity Type

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Activity Type",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_IsRequired":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Activity Type",
            "maxLength":"150",
            "type":"string",
            "nullable":false,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_ACTIVITY_TYPES#TABLE",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_IsRequired":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : emissionFactorMappings-item-response

Type: object

Show Source

• CategoryId: integer (int64)
  Title: Category ID

  Read Only: true

  Unique identifier of the activity classification category that's used in defining invoice classification rules.
• CategoryName: string
  Title: Category Name

  Read Only: true

  Maximum Length: 1000

  Name 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 Visibility

  Read Only: true

  Maximum Length: 1

  Indicates whether or not a category name is visible for this record. Possible values are Y or Blank.
• Country: string
  Title: Country

  Maximum Length: 255

  Name of the country.
• CountryCode: string
  Title: Country Code

  Maximum Length: 2

  Country code that helps 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.
• 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.
• EmissionFactorMapDFF: array EmissionFactorMapDFF
• EmissionFactorMappingId: integer (int64)
  Title: Emission Factor Mapping ID

  Read Only: true

  Unique identifier of the emission-factor mapping.
• EmissionType: string
  Title: Emission Type

  Maximum Length: 80

  Translated 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 Code

  Maximum Length: 30

  Code that identifies the emission type.
• EndDate: string (date)
  Title: End Date

  Date when the emission-factor mapping becomes inactive.
• FactorSource: string
  Title: Source

  Maximum Length: 1000

  Source of the emission factor provided. For example, Supplier-provided carbon footprint.
• InventoryItem: string
  Title: Item

  Maximum Length: 255

  Unique number of the item.
• InventoryItemId: integer (int64)
  Title: Item ID

  Unique identifier 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.
• 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.
• MeasureType: string
  Title: Measure Type

  Maximum Length: 80

  Translated 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 Code

  Maximum Length: 30

  Code that identifies the measure type.
• 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.
• Ranking: integer (int64)
  Title: Ranking

  Ranking of the emission-factor mapping. Mapping with lower value is ranked higher.
• StartDate: string (date)
  Title: Start Date

  Date when the emission-factor mapping becomes active.
• Supplier: string
  Title: Supplier

  Maximum Length: 255

  Unique name of the supplier.
• SupplierId: integer (int64)
  Title: Supplier ID

  Unique identifier of the supplier.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Category ID",
            "type":"integer",
            "description":"Unique identifier of the activity classification category that's used in defining invoice classification rules.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalEntity":{
            "title":"Legal Entity",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the legal entity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "LegalEntityId"
                ]
            },
            "x-queryable":true
        },
        "InventoryItem":{
            "title":"Item",
            "maxLength":"255",
            "type":"string",
            "description":"Unique number of the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InventoryItemId"
                ]
            },
            "x-queryable":true
        },
        "NumeratorUOMCode":{
            "title":"Numerator UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"Code for the unit of measure of the numerator of the emission factor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the emission factor.",
            "nullable":true,
            "x-queryable":true
        },
        "MeasureType":{
            "title":"Measure Type",
            "maxLength":"80",
            "type":"string",
            "description":"Translated 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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "MeasureTypeCode"
                ]
            },
            "x-queryable":true
        },
        "MeasureTypeCode":{
            "title":"Measure Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the measure type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the emission-factor mapping becomes active.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "DenominatorCurrency":{
            "title":"Denominator Currency",
            "maxLength":"80",
            "type":"string",
            "description":"Currency of the denominator of the emission factor.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DenominatorCurrencyCode"
                ]
            },
            "x-queryable":true
        },
        "Ranking":{
            "title":"Ranking",
            "type":"integer",
            "description":"Ranking of the emission-factor mapping. Mapping with lower value is ranked higher.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DenominatorCurrencyCode":{
            "title":"Denominator Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Currency code of the denominator of the emission factor.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EmissionFactor":{
            "title":"Factor",
            "type":"number",
            "description":"Value of the emission factor.",
            "nullable":false,
            "x-queryable":true
        },
        "EmissionType":{
            "title":"Emission Type",
            "maxLength":"80",
            "type":"string",
            "description":"Translated 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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "EmissionTypeCode"
                ]
            },
            "x-queryable":true
        },
        "LegalEntityId":{
            "title":"Legal Entity ID",
            "type":"integer",
            "description":"Unique identifier of the legal entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "EmissionFactorMapDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/emissionFactorMappings-EmissionFactorMapDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "NumeratorUOM":{
            "title":"Numerator UOM",
            "maxLength":"255",
            "type":"string",
            "description":"Unit of measure of the numerator of the emission factor.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "NumeratorUOMCode"
                ]
            },
            "x-queryable":true
        },
        "Supplier":{
            "title":"Supplier",
            "maxLength":"255",
            "type":"string",
            "description":"Unique name of the supplier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SupplierId"
                ]
            },
            "x-queryable":true
        },
        "DenominatorUOM":{
            "title":"Denominator UOM",
            "maxLength":"80",
            "type":"string",
            "description":"Unit of measure of the denominator of the emission factor.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DenominatorUOMCode"
                ]
            },
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":"2",
            "type":"string",
            "description":"Country code that helps to uniquely identify a country.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"User login by whom the record was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmissionTypeCode":{
            "title":"Emission Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code that identifies the emission type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Unique identifier of the item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "FactorSource":{
            "title":"Source",
            "maxLength":"1000",
            "type":"string",
            "description":"Source of the emission factor provided. For example, Supplier-provided carbon footprint.",
            "nullable":true,
            "x-queryable":true
        },
        "EmissionFactorMappingId":{
            "title":"Emission Factor Mapping ID",
            "type":"integer",
            "description":"Unique identifier of the emission-factor mapping.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CategoryVisibility":{
            "title":"Category Visibility",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether or not a category name is visible for this record. Possible values are Y or Blank.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the emission-factor mapping becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DenominatorUOMCode":{
            "title":"Denominator UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"Code for the unit of measure of the denominator of the emission factor.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SupplierId":{
            "title":"Supplier ID",
            "type":"integer",
            "description":"Unique identifier of the supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category Name",
            "maxLength":"1000",
            "type":"string",
            "description":"Name of the attribute classification category that's used in invoice classification rules. The name is populated only when Category Visibility is set to Y.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the country.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CountryCode"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : EmissionFactorMapDFF

Type: array

Show Source

• Array of: object emissionFactorMappings-EmissionFactorMapDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/emissionFactorMappings-EmissionFactorMapDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : emissionFactorMappings-EmissionFactorMapDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Activity Type

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Activity Type
• EmissionFactorMappingId: integer (int64)
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EmissionFactorMappingId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Activity Type",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_IsRequired":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Activity Type",
            "maxLength":"150",
            "type":"string",
            "nullable":false,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"ORA_ACTIVITY_TYPES#TABLE",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_IsRequired":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

CountryCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/territoriesLOV

Parameters:

• finder: TerritoryCodeAllRowsFinder

The following properties are defined on the LOV link relation:

• Source Attribute: Country; Target Attribute: TerritoryShortName
• Display Attribute: TerritoryShortName

CurrencyCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/currenciesLOV

Parameters:

• finder: CurrencyCodeAllRowsFinder

The following properties are defined on the LOV link relation:

• Source Attribute: DenominatorCurrency; Target Attribute: Name
• Display Attribute: Name

DenominatorUOMCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/unitsOfMeasure

Parameters:

• finder: ActiveUomFinder%3BDisableDate%3D2024-10-18

The following properties are defined on the LOV link relation:

• Source Attribute: DenominatorUOM; Target Attribute: UOM
• Display Attribute: UOM

EmissionFactorMapDFF

Operation: /fscmRestApi/resources/11.13.18.05/emissionFactorMappings/{EmissionFactorMappingId}/child/EmissionFactorMapDFF

Parameters:

• EmissionFactorMappingId: $request.path.EmissionFactorMappingId

EmissionTypeVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

LegalEntityVA

Operation: /fscmRestApi/resources/11.13.18.05/legalEntitiesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: LegalEntity; Target Attribute: Name
• Display Attribute: Name

MeasureTypeVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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

NumeratorUOMCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/unitsOfMeasure

Parameters:

• finder: ActiveUomFinder%3BDisableDate%3D2024-10-18

The following properties are defined on the LOV link relation:

• Source Attribute: NumeratorUOM; Target Attribute: UOM
• Display Attribute: UOM

Back to Top

Examples

This example describes how to create emission-factor mappings..

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/emissionFactorMappings"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
    "EmissionType": "Carbon dioxide equivalent",
    "MeasureType": "Quantity",
    "EmissionFactor": 0.95522,
    "NumeratorUOM": "Kilogram",
    "DenominatorUOM": "Kilometer",
    "Description": "UK Emission Factor",
    "FactorSource": "UK",
    "StartDate": "2020-01-01",
    "Ranking": 100,
    "EmissionFactorMapDFF": [
        {
            "__FLEX_Context": "Mobile Combustion",
            "energySource": "Diesel",
            "vehicleType": "All rigids HGV",
            "percentLaden": "100% Laden"
        }
    ]
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "EmissionFactorMappingId": 300100611749324,
    "MappingNumber": 11002,
    "EmissionTypeCode": "ORA_SUS_CO2e",
    "EmissionType": "Carbon dioxide equivalent",
    "MeasureTypeCode": "ORA_SUS_QUANTITY",
    "MeasureType": "Quantity",
    "EmissionFactor": 0.95522,
    "NumeratorUOMCode": "KG",
    "NumeratorUOM": "Kilogram",
    "DenominatorUOMCode": "KM",
    "DenominatorUOM": "Kilometer",
    "Description": "UK Emission Factor",
    "FactorSource": "UK",
    "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-08-05T14:07:12+00:00",
    "LastUpdatedBy": "SUSPMADMIN",
    "LastUpdateDate": "2024-08-05T14:07:17.508+00:00",
    "CategoryId": 300100604806336,
    "CategoryVisibility": null,
    "CategoryName": null,
    "EmissionFactorMapDFF": [
        {
            "EmissionFactorMappingId": 300100611749324,
            "__FLEX_Context": "Mobile Combustion",
            "__FLEX_Context_DisplayValue": "Mobile Combustion",
            "energySource": "Diesel",
            "vehicleType": "All rigids HGV",
            "percentLaden": "100% Laden",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/emissionFactorMappings/300100611749324/child/EmissionFactorMapDFF/300100611749324",
                    "name": "EmissionFactorMapDFF",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/emissionFactorMappings/300100611749324/child/EmissionFactorMapDFF/300100611749324",
                    "name": "EmissionFactorMapDFF",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/emissionFactorMappings/300100611749324",
                    "name": "emissionFactorMappings",
                    "kind": "item"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/emissionFactorMappings/300100611749324",
            "name": "emissionFactorMappings",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/emissionFactorMappings/300100611749324",
            "name": "emissionFactorMappings",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/emissionFactorMappings/300100611749324/child/EmissionFactorMapDFF",
            "name": "EmissionFactorMapDFF",
            "kind": "collection"
        }
    ]
}

Back to Top