Jump to

• Request
• Response

Create one activity emission record

post

/fscmRestApi/resources/11.13.18.05/sustainabilityActivities/{ActivityId}/child/Emissions

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:
  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

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

{
    "type":"object",
    "properties":{
        "EmissionTypeCode":{
            "title":"Emission Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code identifying an emission type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "NumeratorUOMCode":{
            "title":"Numerator UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"Code for the unit of measure of the numerator of the emission factor.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the emission factor.",
            "nullable":true
        },
        "EmissionUOM":{
            "title":"Emission UOM",
            "maxLength":"255",
            "type":"string",
            "description":"Unit of measure for the quantity of emission.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "EmissionUOMCode"
                ]
            }
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"Unique identifier of an activity record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "FactorSource":{
            "title":"Source",
            "maxLength":"1000",
            "type":"string",
            "description":"Source of the emission factor provided as free-form text. For example, Supplier-provided carbon footprint.",
            "nullable":true
        },
        "MeasureType":{
            "title":"Measure Type",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the measure type. For example, quantity, amount, or distance.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "MeasureTypeCode"
                ]
            }
        },
        "MeasureTypeCode":{
            "title":"Measure Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code identifying a measure type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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"
            }
        },
        "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"
                ]
            }
        },
        "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":true
        },
        "EmissionType":{
            "title":"Emission Type",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "EmissionTypeCode"
                ]
            }
        },
        "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"
                ]
            }
        },
        "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"
                ]
            }
        },
        "EmissionUOMCode":{
            "title":"Emission UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"Code identifying the unit of measure for the quantity of emission.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EmissionQuantity":{
            "title":"Emission Quantity",
            "type":"number",
            "description":"Quantity of emission.",
            "nullable":true
        }
    }
}

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 : sustainabilityActivities-Emissions-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "ActivityEmissionId":{
            "title":"Activity Emission ID",
            "type":"integer",
            "description":"Unique identifier of an activity emission record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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":true,
            "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
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"Unique identifier of an activity record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MeasureType":{
            "title":"Measure Type",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the measure type. For example, quantity, amount, or distance.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "MeasureTypeCode"
                ]
            },
            "x-queryable":true
        },
        "MeasureTypeCode":{
            "title":"Measure Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code identifying a measure type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Co2eUOM":{
            "title":"CO2e UOM",
            "maxLength":"255",
            "type":"string",
            "description":"Unit of measure for the quantity of CO2e emission.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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
        },
        "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":true,
            "x-queryable":true
        },
        "EmissionType":{
            "title":"Emission Type",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "EmissionTypeCode"
                ]
            },
            "x-queryable":true
        },
        "GwpFactor":{
            "title":"GWP Factor",
            "type":"number",
            "description":"Metric value used to assess the potential contribution of different greenhouse gases to global warming over a specific period, usually 100 years.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Measure":{
            "title":"Measure",
            "type":"integer",
            "description":"Value for the measure type used for calculating the emission.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"255"
            },
            "x-queryable":true
        },
        "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
        },
        "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
        },
        "EmissionTypeCode":{
            "title":"Emission Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code identifying an emission type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Co2eUOMCode":{
            "title":"CO2e UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"Code identifying the unit of measure for the quantity of CO2e emission.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmissionUOM":{
            "title":"Emission UOM",
            "maxLength":"255",
            "type":"string",
            "description":"Unit of measure for the quantity of emission.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "EmissionUOMCode"
                ]
            },
            "x-queryable":true
        },
        "FactorSource":{
            "title":"Source",
            "maxLength":"1000",
            "type":"string",
            "description":"Source of the emission factor provided as free-form text. 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":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "MeasureUnit":{
            "title":"Measure Unit",
            "maxLength":"255",
            "type":"string",
            "description":"Unit for the measure value. For example, US Dollar, Kilometer, or Kilogram.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityMeasureId":{
            "title":"Activity Measure ID",
            "type":"integer",
            "description":"Unique identifier of an activity measure record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GwpId":{
            "title":"GWP Identifier",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Co2eEmissionQuantity":{
            "title":"CO2e",
            "type":"number",
            "description":"Quantity of CO2e emission.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmissionUOMCode":{
            "title":"Emission UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"Code identifying the unit of measure for the quantity of emission.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EmissionQuantity":{
            "title":"Emission Quantity",
            "type":"number",
            "description":"Quantity of emission.",
            "nullable":true,
            "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

DenominatorCurrencyCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/currenciesLOV

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

The following properties are defined on the LOV link relation:

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

EmissionTypeCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BActiveDate%3D2025-01-24%2CLookupType%3DORA_SUS_EMISSION_TYPES

The following properties are defined on the LOV link relation:

• Source Attribute: EmissionType; Target Attribute: Meaning
• Display Attribute: Meaning

EmissionUOMCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/unitsOfMeasure

The following properties are defined on the LOV link relation:

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

MeasureTypeCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BActiveDate%3D2025-01-24%2CLookupType%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

The following properties are defined on the LOV link relation:

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

Back to Top