Update one activity record

patch

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

Request

Path Parameters
  • 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
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : ActivityDff
Type: array
Show Source
Nested Schema : EmissionFactorMapDFF
Type: array
Show Source
  • 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: object
Show Source
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: object
Show Source
Nested Schema : sustainabilityActivities-Emissions-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Currency
    Maximum Length: 80
    Currency when the measure is monetary, for example, Amount.
  • Title: Currency Code
    Maximum Length: 15
    Code that identifies the currency when the measure is monetary, for example, Amount.
  • Title: Measure
    Measure to be used for emission calculation and reporting.
  • Title: UOM
    Maximum Length: 80
    Unit of measure when the measure isn't monetary, for example, Quantity or Distance.
  • 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: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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-item-response
Type: object
Show Source
Nested Schema : ActivityDff
Type: array
Show Source
Nested Schema : EmissionFactorMapDFF
Type: array
Show Source
  • 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 : 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: object
Show Source
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: object
Show Source
Nested Schema : sustainabilityActivities-Emissions-item-response
Type: object
Show Source
  • Title: Activity Emission ID
    Read Only: true
    Unique identifier of an activity emission record.
  • Title: Activity ID
    Unique identifier of an activity record.
  • Title: Activity Measure ID
    Read Only: true
    Unique identifier of an activity measure record.
  • Title: CO2e
    Read Only: true
    Quantity of CO2e emission.
  • Title: CO2e UOM
    Read Only: true
    Maximum Length: 255
    Unit of measure for the quantity of CO2e emission.
  • Title: CO2e UOM Code
    Read Only: true
    Maximum Length: 3
    Code identifying the unit of measure for the quantity of CO2e emission.
  • Title: Denominator Currency
    Maximum Length: 80
    Currency of the denominator of the emission factor.
  • Title: Denominator Currency Code
    Maximum Length: 15
    Currency code of the denominator of the emission factor.
  • Title: Denominator UOM
    Maximum Length: 80
    Unit of measure of the denominator of the emission factor.
  • Title: Denominator UOM Code
    Maximum Length: 3
    Code for the unit of measure of the denominator of the emission factor.
  • Title: Description
    Maximum Length: 4000
    Description of the emission factor.
  • Title: Factor
    Value of the emission factor.
  • Title: Emission Factor Mapping ID
    Read Only: true
    Unique identifier of the emission factor mapping.
  • Title: Emission Quantity
    Quantity of emission.
  • 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.
  • Title: Emission Type Code
    Maximum Length: 30
    Code identifying an emission type.
  • Title: Emission UOM
    Maximum Length: 255
    Unit of measure for the quantity of emission.
  • Title: Emission UOM Code
    Maximum Length: 3
    Code identifying the unit of measure for the quantity of emission.
  • Title: Source
    Maximum Length: 1000
    Source of the emission factor provided as free-form text. For example, Supplier-provided carbon footprint.
  • 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.
  • 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
  • Title: Measure
    Read Only: true
    Value for the measure type used for calculating the emission.
  • Title: Measure Type
    Maximum Length: 80
    Name of the measure type. For example, quantity, amount, or distance.
  • Title: Measure Type Code
    Maximum Length: 30
    Code identifying a measure type.
  • Title: Measure Unit
    Read Only: true
    Maximum Length: 255
    Unit for the measure value. For example, US Dollar, Kilometer, or Kilogram.
  • Title: Numerator UOM
    Maximum Length: 255
    Unit of measure of the numerator of the emission factor.
  • Title: Numerator UOM Code
    Maximum Length: 3
    Code for the unit of measure of the numerator of the emission factor.
Nested Schema : sustainabilityActivities-Measures-item-response
Type: object
Show Source
  • Title: Activity Measure ID
    Read Only: true
    Unique identifier of an activity measure record.
  • Title: Currency
    Maximum Length: 80
    Currency when the measure is monetary, for example, Amount.
  • Title: Currency Code
    Maximum Length: 15
    Code that identifies the currency when the measure is monetary, for example, Amount.
  • Links
  • Title: Measure
    Measure to be used for emission calculation and reporting.
  • Title: Measure Type
    Maximum Length: 255
    Name of the measure type. For example, quantity, amount, or distance.
  • Title: Measure Type Code
    Maximum Length: 30
    Code identifying a measure type.
  • Title: UOM
    Maximum Length: 80
    Unit of measure when the measure isn't monetary, for example, Quantity or Distance.
  • 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-response
Type: object
Show Source
  • Title: Activity ID
    Read Only: true
    Unique identifier of the activity record for which the validation message is generated.
  • Title: Emission Type Code
    Read Only: true
    Maximum Length: 30
    Emission type code for which the validation message is generated.
  • Links
  • Title: Message
    Read Only: true
    Maximum Length: 255
    Full text of the validation message that was generated during activity validation.
  • Title: Message Code
    Read Only: true
    Maximum Length: 30
    Message code that helps to uniquely identify the message details.
  • Title: Message Level
    Read Only: true
    Maximum Length: 255
    Indicates the level of the message, error, warning, or informational.
  • Title: Message Level Code
    Read Only: true
    Maximum Length: 30
    Message level code that helps to uniquely identify the message level.
  • Title: Message Summary
    Read Only: true
    Maximum Length: 255
    Summarized explanation of the validation message.
  • Title: Message Summary Code
    Read Only: true
    Maximum Length: 30
    Message summary code that helps to uniquely identify the message summary.
  • Title: Validation Message ID
    Read Only: true
    Unique identifier of the validation message.
Back to Top