Jump to

• Request
• Response

Get one activity record

get

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

Request

Path Parameters

• ActivityId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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 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-item-response

Type: object

Show Source

• ActivityDate: string (date)
  Title: Activity Date

  Date of the activity record.
• ActivityDff: array ActivityDff
• ActivityId: integer (int64)
  Title: Activity ID

  Read Only: true

  Unique identifier of an activity record.
• ActivityNumber: string
  Title: Activity Number

  Read Only: true

  Maximum Length: 100

  Unique number for the activity record.
• AlertFlag: boolean
  Read Only: true

  Alert
• CalculationDate: string
  Title: Calculation Date

  Read Only: true

  Maximum Length: 255

  Date when the emissions were last calculated.
• CalculationOverride: string
  Title: Calculation Mode

  Maximum Length: 255

  Mode used for calculation of emissions. For example, using matched factors, by manual entry of factors, or by manual entry of emissions.
• CalculationOverrideCode: string
  Title: Calculation Mode Code

  Maximum Length: 100

  Code that uniquely identifies the calculation mode.
• ClassificationCategory: string
  Read Only: true

  Maximum Length: 255

  Classification Category
• ClassificationCategoryId: integer (int64)
  Read Only: true

  Classification Category ID
• ClassificationRuleId: integer (int64)
  Read Only: true

  Classification Rule ID
• ClassificationRuleName: string
  Read Only: true

  Maximum Length: 255

  Classification Rule
• Comments: string
  Title: Comments

  Maximum Length: 4000

  Additional information for an activity that can be entered in a free-text field.
• ConsumptionEndDate: string (date)
  Title: Consumption End Date

  Date when the consumption related to the activity will end.
• ConsumptionStartDate: string (date)
  Title: Consumption Start Date

  Date when the consumption related to the activity started.
• Country: string
  Title: Country

  Maximum Length: 255

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

  Maximum Length: 2

  Code used to uniquely identify a country.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the record was created.
• DataQuality: string
  Title: Data Quality

  Maximum Length: 255

  Indicates the data quality of the activity record. For example, High confidence, Moderate confidence, and Low confidence.
• DataQualityCode: string
  Title: Data Quality Code

  Maximum Length: 30

  Code that helps uniquely identify data quality.
• Description: string
  Title: Description

  Maximum Length: 4000

  Description of the activity record.
• DistributionLineNumber: integer
  Distribution Line Number
• EmissionFactorMapDFF: array EmissionFactorMapDFF
• Emissions: array Emissions
  Title: Emissions

  Represents the details in an emission record of a sustainability activity, including emission type, emission factor, emission quantity and, where applicable, the associated carbon dioxide equivalent. For example, an activity record representing the consumption of 5,000 standard cubic feet of natural gas might have several emission records such as emission type methane, an associated emission factor, the resulting calculated emissions, and the associated carbon dioxide equivalent.
• EntryType: string
  Title: Entry Type

  Maximum Length: 255

  Type of entry for the record such as Standard or Adjustment.
• EntryTypeCode: string
  Title: Entry Type Code

  Maximum Length: 30

  Code that helps uniquely identify the type of entry.
• EsgLedgerId: integer (int64)
  Title: Sustainability Ledger ID

  Read Only: true

  Unique identifier of the sustainability ledger.
• ExternalReferenceNumber: string
  Title: External Reference Number

  Maximum Length: 100

  Reference to a record in another application.
• InventoryItemId: integer (int64)
  Title: Item ID

  Unique identifier of the item.
• InvoiceDistributionId: integer (int64)
  Invoice Distribution ID
• InvoiceId: integer (int64)
  Invoice ID
• InvoiceLineNumber: integer (int64)
  Invoice Line Number
• InvoiceNumber: string
  Maximum Length: 80

  Invoice Number
• ItemDescription: string
  Read Only: true

  Maximum Length: 255

  Item Description
• ItemNumber: string
  Title: Item

  Maximum Length: 255

  Unique number of the item.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User login by whom the record was last updated.
• Ledger: string
  Read Only: true

  Maximum Length: 255

  Sustainability Ledger
• LegalEntity: string
  Title: Legal Entity

  Maximum Length: 255

  Name of the legal entity.
• LegalEntityId: integer (int64)
  Title: Legal Entity ID

  Unique identifier of the legal entity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Measures: array Activity Measures
  Title: Activity Measures

  Represents the details of the measure record of a sustainability activity. The details include measure type, measure quantity, unit of measure, and currency. For example, for an activity record that represents the burning of 10 cubic feet of natural gas, the measure type is Quantity, the measure quantity is 10, and the unit of measure is cubic feet.
• OriginalActivityId: integer (int64)
  Title: Original Activity ID

  Unique identifier of the original activity record.
• OriginalActivityNumber: string
  Title: Original Activity Number

  Maximum Length: 255

  Unique number of the original activity record.
• Period: string
  Maximum Length: 255

  Period
• PeriodId: integer (int64)
  Title: Period ID

  Unique identifier for the period under which the activity is reported.
• PostingDate: string (date-time)
  Title: Posting Date

  Read Only: true

  Date on which the activity status was changed to posted.
• Scope: string
  Title: Scope

  Maximum Length: 255

  Scope of emissions as defined by the Greenhouse Gas Protocol, that's, Scope 1, Scope 2 Location-based, Scope 2 Market-based or Scope 3.
• ScopeCategory: string
  Title: Scope Category

  Maximum Length: 80

  Category under which Scope 3 emissions are reported. Purchased goods and services, waste generated in operations are few such categories.
• ScopeCategoryCode: string
  Title: Scope Category Code

  Maximum Length: 30

  Code that identifies a Scope 3 category.
• ScopeCode: string
  Title: Scope Code

  Maximum Length: 30

  Code that identifies a scope.
• SourceType: string
  Title: Source Type

  Maximum Length: 255

  Source of the activity record, such as Manual, External, Invoice autocreate, or File-Based Data Import.
• SourceTypeCode: string
  Title: Source Type Code

  Maximum Length: 100

  Code of the source type that helps to uniquely identify the source type.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 255

  Status of the activity record such as Draft, Posted, or Canceled.
• StatusCode: string
  Title: Status Code

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_SUS_STATUS_DRAFT

  Status code that helps to uniquely identify a status.
• Supplier: string
  Title: Supplier

  Maximum Length: 255

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

  Unique identifier of the supplier.
• TotalCo2e: number
  Title: Total CO2e

  Read Only: true

  Total calculated CO2e for the activity record.
• TotalCo2eUOM: string
  Title: Total CO2e UOM Code

  Read Only: true

  Maximum Length: 3

  Code identifying the UOM for the total CO2e.
• TotalCo2eUOMName: string
  Read Only: true

  Maximum Length: 255

  Total CO2e UOM
• ValidationMessages: array Validation Messages
  Title: Validation Messages

  Contains details of the validation issues that are generated when an activity record is validated. Validation messages explain the reasons for inconsistencies in an activity record, that must be addressed before the record can be posted.

{
    "type":"object",
    "properties":{
        "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
        },
        "InvoiceLineNumber":{
            "type":"integer",
            "description":"Invoice Line Number",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EsgLedgerId":{
            "title":"Sustainability Ledger ID",
            "type":"integer",
            "description":"Unique identifier of the sustainability ledger.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "LegalEntityId"
                ]
            },
            "x-queryable":true
        },
        "DistributionLineNumber":{
            "type":"integer",
            "description":"Distribution Line Number",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "InvoiceDistributionId"
                ]
            },
            "x-queryable":true
        },
        "SourceType":{
            "title":"Source Type",
            "maxLength":255,
            "type":"string",
            "description":"Source of the activity record, such as Manual, External, Invoice autocreate, or File-Based Data Import.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceTypeCode"
                ]
            },
            "x-queryable":true
        },
        "ScopeCategory":{
            "title":"Scope Category",
            "maxLength":80,
            "type":"string",
            "description":"Category under which Scope 3 emissions are reported. Purchased goods and services, waste generated in operations are few such categories.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScopeCategoryCode"
                ]
            },
            "x-queryable":true
        },
        "AlertFlag":{
            "type":"boolean",
            "description":"Alert",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTypeCode":{
            "title":"Source Type Code",
            "maxLength":100,
            "type":"string",
            "description":"Code of the source type that helps to uniquely identify the source type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Status code that helps to uniquely identify a status.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SUS_STATUS_DRAFT",
            "x-queryable":true
        },
        "ValidationMessages":{
            "title":"Validation Messages",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/sustainabilityActivities-ValidationMessages-item-response"
            }
        },
        "ActivityNumber":{
            "title":"Activity Number",
            "maxLength":100,
            "type":"string",
            "description":"Unique number for the activity record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalReferenceNumber":{
            "title":"External Reference Number",
            "maxLength":100,
            "type":"string",
            "description":"Reference to a record in another application.",
            "nullable":true,
            "x-queryable":true
        },
        "EmissionFactorMapDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sustainabilityActivities-EmissionFactorMapDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ClassificationCategoryId":{
            "type":"integer",
            "description":"Classification Category ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CalculationDate":{
            "title":"Calculation Date",
            "maxLength":255,
            "type":"string",
            "description":"Date when the emissions were last calculated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OriginalActivityId":{
            "title":"Original Activity ID",
            "type":"integer",
            "description":"Unique identifier of the original activity record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ClassificationRuleId":{
            "type":"integer",
            "description":"Classification Rule ID",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvoiceNumber":{
            "maxLength":80,
            "type":"string",
            "description":"Invoice Number",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InvoiceId"
                ]
            }
        },
        "Status":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "description":"Status of the activity record such as Draft, Posted, or Canceled.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "StatusCode"
                ]
            },
            "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
        },
        "TotalCo2e":{
            "title":"Total CO2e",
            "type":"number",
            "description":"Total calculated CO2e for the activity record.",
            "nullable":true,
            "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
        },
        "ActivityDate":{
            "title":"Activity Date",
            "type":"string",
            "description":"Date of the activity record.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "DataQuality":{
            "title":"Data Quality",
            "maxLength":255,
            "type":"string",
            "description":"Indicates the data quality of the activity record. For example, High confidence, Moderate confidence, and Low confidence.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "DataQualityCode"
                ]
            },
            "x-queryable":true
        },
        "ScopeCode":{
            "title":"Scope Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies a scope.",
            "nullable":true,
            "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
        },
        "Period":{
            "maxLength":255,
            "type":"string",
            "description":"Period",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PeriodId"
                ]
            },
            "x-queryable":true
        },
        "ConsumptionEndDate":{
            "title":"Consumption End Date",
            "type":"string",
            "description":"Date when the consumption related to the activity will end.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClassificationCategory":{
            "maxLength":255,
            "type":"string",
            "description":"Classification Category",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Emissions":{
            "title":"Emissions",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/sustainabilityActivities-Emissions-item-response"
            }
        },
        "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
        },
        "TotalCo2eUOM":{
            "title":"Total CO2e UOM Code",
            "maxLength":3,
            "type":"string",
            "description":"Code identifying the UOM for the total CO2e.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConsumptionStartDate":{
            "title":"Consumption Start Date",
            "type":"string",
            "description":"Date when the consumption related to the activity started.",
            "format":"date",
            "nullable":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
        },
        "TotalCo2eUOMName":{
            "maxLength":255,
            "type":"string",
            "description":"Total CO2e UOM",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the activity record.",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"Unique identifier of an activity record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClassificationRuleName":{
            "maxLength":255,
            "type":"string",
            "description":"Classification Rule",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityDff":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/sustainabilityActivities-ActivityDff-item-response"
            },
            "x-cardinality":"1"
        },
        "InvoiceId":{
            "type":"integer",
            "description":"Invoice ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Item Description",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OriginalActivityNumber":{
            "title":"Original Activity Number",
            "maxLength":255,
            "type":"string",
            "description":"Unique number of the original activity record.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OriginalActivityId"
                ]
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item",
            "maxLength":255,
            "type":"string",
            "description":"Unique number of the item.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "InventoryItemId"
                ]
            },
            "x-queryable":true
        },
        "Measures":{
            "title":"Activity Measures",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/sustainabilityActivities-Measures-item-response"
            }
        },
        "LegalEntityId":{
            "title":"Legal Entity ID",
            "type":"integer",
            "description":"Unique identifier of the legal entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "mandatory":"true"
            },
            "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
        },
        "ScopeCategoryCode":{
            "title":"Scope Category Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that identifies a Scope 3 category.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country Code",
            "maxLength":2,
            "type":"string",
            "description":"Code used to uniquely identify a country.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InvoiceDistributionId":{
            "type":"integer",
            "description":"Invoice Distribution ID",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":4000,
            "type":"string",
            "description":"Additional information for an activity that can be entered in a free-text field.",
            "nullable":true,
            "x-queryable":true
        },
        "DataQualityCode":{
            "title":"Data Quality Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that helps uniquely identify data quality.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Ledger":{
            "maxLength":255,
            "type":"string",
            "description":"Sustainability Ledger",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodId":{
            "title":"Period ID",
            "type":"integer",
            "description":"Unique identifier for the period under which the activity is reported.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "EntryTypeCode":{
            "title":"Entry Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code that helps uniquely identify the type of entry.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "mandatory":"true"
            },
            "x-queryable":true
        },
        "EntryType":{
            "title":"Entry Type",
            "maxLength":255,
            "type":"string",
            "description":"Type of entry for the record such as Standard or Adjustment.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "EntryTypeCode"
                ]
            },
            "x-queryable":true
        },
        "CalculationOverrideCode":{
            "title":"Calculation Mode Code",
            "maxLength":100,
            "type":"string",
            "description":"Code that uniquely identifies the calculation mode.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "mandatory":"true"
            },
            "x-queryable":true
        },
        "Scope":{
            "title":"Scope",
            "maxLength":255,
            "type":"string",
            "description":"Scope of emissions as defined by the Greenhouse Gas Protocol, that's, Scope 1, Scope 2 Location-based, Scope 2 Market-based or Scope 3.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScopeCode"
                ]
            },
            "x-queryable":true
        },
        "PostingDate":{
            "title":"Posting Date",
            "type":"string",
            "description":"Date on which the activity status was changed to posted.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculationOverride":{
            "title":"Calculation Mode",
            "maxLength":255,
            "type":"string",
            "description":"Mode used for calculation of emissions. For example, using matched factors, by manual entry of factors, or by manual entry of emissions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CalculationOverrideCode"
                ]
            },
            "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 : ActivityDff

Type: array

Show Source

• Array of: object sustainabilityActivities-ActivityDff-item-response

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

Nested Schema : EmissionFactorMapDFF

Type: array

Show Source

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

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

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

• Array of: object sustainabilityActivities-Emissions-item-response

{
    "title":"Emissions",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/sustainabilityActivities-Emissions-item-response"
    }
}

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

• Array of: object sustainabilityActivities-Measures-item-response

{
    "title":"Activity Measures",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/sustainabilityActivities-Measures-item-response"
    }
}

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

• Array of: object sustainabilityActivities-ValidationMessages-item-response

{
    "title":"Validation Messages",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/sustainabilityActivities-ValidationMessages-item-response"
    }
}

Nested Schema : sustainabilityActivities-ActivityDff-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• ActivityId: integer (int64)
  Read Only: true
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "ActivityId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "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."
        }
    }
}

Nested Schema : sustainabilityActivities-EmissionFactorMapDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Activity Type

  Maximum Length: 150

  Activity Type
• __FLEX_Context_DisplayValue: string
  Title: Activity Type

  Activity Type
• ActivityId: 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"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Activity Type",
            "type":"string",
            "description":"Activity Type",
            "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
        },
        "ActivityId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Activity Type",
            "maxLength":150,
            "type":"string",
            "description":"Activity Type",
            "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 : 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 : sustainabilityActivities-Measures-item-response

Type: object

Show Source

• ActivityMeasureId: integer (int64)
  Title: Activity Measure ID

  Read Only: true

  Unique identifier of an activity measure record.
• Currency: string
  Title: Currency

  Maximum Length: 80

  Currency when the measure is monetary, for example, Amount.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  Code that identifies the currency when the measure is monetary, for example, Amount.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Measure: number
  Title: Measure

  Measure to be used for emission calculation and reporting.
• MeasureType: string
  Title: Measure Type

  Maximum Length: 255

  Name of the measure type. For example, quantity, amount, or distance.
• MeasureTypeCode: string
  Title: Measure Type Code

  Maximum Length: 30

  Code identifying a measure type.
• UOM: string
  Title: UOM

  Maximum Length: 80

  Unit of measure when the measure isn't monetary, for example, Quantity or Distance.
• UOMCode: string
  Title: UOM Code

  Maximum Length: 3

  Code that identifies the unit of measure when the measure isn't monetary, for example, Quantity or Distance.

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Code that identifies the currency when the measure is monetary, for example, Amount.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UOM":{
            "title":"UOM",
            "maxLength":80,
            "type":"string",
            "description":"Unit of measure when the measure isn't monetary, for example, Quantity or Distance.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "UOMCode"
                ]
            },
            "x-queryable":true
        },
        "Currency":{
            "title":"Currency",
            "maxLength":80,
            "type":"string",
            "description":"Currency when the measure is monetary, for example, Amount.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CurrencyCode"
                ]
            }
        },
        "Measure":{
            "title":"Measure",
            "type":"number",
            "description":"Measure to be used for emission calculation and reporting.",
            "nullable":false,
            "x-queryable":true
        },
        "ActivityMeasureId":{
            "title":"Activity Measure ID",
            "type":"integer",
            "description":"Unique identifier of an activity measure record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MeasureType":{
            "title":"Measure Type",
            "maxLength":255,
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MeasureTypeCode":{
            "title":"Measure Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Code identifying a measure type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":3,
            "type":"string",
            "description":"Code that identifies the unit of measure when the measure isn't monetary, for example, Quantity or Distance.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "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 : sustainabilityActivities-ValidationMessages-item-response

Type: object

Show Source

• ActivityId: integer (int64)
  Title: Activity ID

  Read Only: true

  Unique identifier of the activity record for which the validation message is generated.
• EmissionTypeCode: string
  Title: Emission Type Code

  Read Only: true

  Maximum Length: 30

  Emission type code for which the validation message is generated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Message: string
  Title: Message

  Read Only: true

  Maximum Length: 255

  Full text of the validation message that was generated during activity validation.
• MessageCode: string
  Title: Message Code

  Read Only: true

  Maximum Length: 30

  Message code that helps to uniquely identify the message details.
• MessageLevel: string
  Title: Message Level

  Read Only: true

  Maximum Length: 255

  Indicates the level of the message, error, warning, or informational.
• MessageLevelCode: string
  Title: Message Level Code

  Read Only: true

  Maximum Length: 30

  Message level code that helps to uniquely identify the message level.
• MessageSummary: string
  Title: Message Summary

  Read Only: true

  Maximum Length: 255

  Summarized explanation of the validation message.
• MessageSummaryCode: string
  Title: Message Summary Code

  Read Only: true

  Maximum Length: 30

  Message summary code that helps to uniquely identify the message summary.
• ValidationMessageId: integer (int64)
  Title: Validation Message ID

  Read Only: true

  Unique identifier of the validation message.

{
    "type":"object",
    "properties":{
        "MessageSummaryCode":{
            "title":"Message Summary Code",
            "maxLength":30,
            "type":"string",
            "description":"Message summary code that helps to uniquely identify the message summary.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EmissionTypeCode":{
            "title":"Emission Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Emission type code for which the validation message is generated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageCode":{
            "title":"Message Code",
            "maxLength":30,
            "type":"string",
            "description":"Message code that helps to uniquely identify the message details.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Message":{
            "title":"Message",
            "maxLength":255,
            "type":"string",
            "description":"Full text of the validation message that was generated during activity validation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"Unique identifier of the activity record for which the validation message is generated.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MessageLevelCode":{
            "title":"Message Level Code",
            "maxLength":30,
            "type":"string",
            "description":"Message level code that helps to uniquely identify the message level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidationMessageId":{
            "title":"Validation Message ID",
            "type":"integer",
            "description":"Unique identifier of the validation message.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MessageSummary":{
            "title":"Message Summary",
            "maxLength":255,
            "type":"string",
            "description":"Summarized explanation of the validation message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MessageLevel":{
            "title":"Message Level",
            "maxLength":255,
            "type":"string",
            "description":"Indicates the level of the message, error, warning, or informational.",
            "nullable":true,
            "readOnly":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"
    }
}

Links

ActivityDff

Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityActivities/{ActivityId}/child/ActivityDff

Parameters:

• ActivityId: $request.path.ActivityId

ActivityIdVA

Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityActivities

Parameters:

• finder: ActivityIdFinder

The following properties are defined on the LOV link relation:

• Source Attribute: OriginalActivityNumber; Target Attribute: ActivityNumber
• Display Attribute: ActivityNumber

CalculationOverrideCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SUS_CAL_MODE%2CActiveDate%3D2025-05-23

The following properties are defined on the LOV link relation:

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

CountryCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/territoriesLOV

Parameters:

• finder: TerritoryCodeFinder

The following properties are defined on the LOV link relation:

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

DataQualityCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SUS_DATA_QUALITY%2CActiveDate%3D2025-05-23

The following properties are defined on the LOV link relation:

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

EmissionFactorMapDFF

Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityActivities/{ActivityId}/child/EmissionFactorMapDFF

Parameters:

• ActivityId: $request.path.ActivityId

Emissions

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

Parameters:

• ActivityId: $request.path.ActivityId

Represents the details in an emission record of a sustainability activity, including emission type, emission factor, emission quantity and, where applicable, the associated carbon dioxide equivalent. For example, an activity record representing the consumption of 5,000 standard cubic feet of natural gas might have several emission records such as emission type methane, an associated emission factor, the resulting calculated emissions, and the associated carbon dioxide equivalent.

EntryTypeCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SUS_ENTRY_TYPE%2CActiveDate%3D2025-05-23

The following properties are defined on the LOV link relation:

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

Measures

Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityActivities/{ActivityId}/child/Measures

Parameters:

• ActivityId: $request.path.ActivityId

Represents the details of the measure record of a sustainability activity. The details include measure type, measure quantity, unit of measure, and currency. For example, for an activity record that represents the burning of 10 cubic feet of natural gas, the measure type is Quantity, the measure quantity is 10, and the unit of measure is cubic feet.

ScopeCategoryCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SUS_SCOPE_CATEGORIES%2CActiveDate%3D2025-05-23

The following properties are defined on the LOV link relation:

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

ScopeCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SUS_SCOPES%2CActiveDate%3D2025-05-23

The following properties are defined on the LOV link relation:

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

SourceTypeCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SUS_SOURCE_TYPE%2CActiveDate%3D2025-05-23

The following properties are defined on the LOV link relation:

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

StatusCodeVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SUS_ACT_STATUS%2CActiveDate%3D2025-05-23

The following properties are defined on the LOV link relation:

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

ValidationMessages

Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityActivities/{ActivityId}/child/ValidationMessages

Parameters:

• ActivityId: $request.path.ActivityId

Contains details of the validation issues that are generated when an activity record is validated. Validation messages explain the reasons for inconsistencies in an activity record, that must be addressed before the record can be posted.

cancelActivity

Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityActivities/{ActivityId}/action/cancelActivity

Parameters:

• ActivityId: $request.path.ActivityId

Cancels a posted activity. This action verifies whether the activity has been posted and if the corresponding period is still open. If no issues are identified, the activity is then canceled.

postToLedger

Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityActivities/{ActivityId}/action/postToLedger

Parameters:

• ActivityId: $request.path.ActivityId

Posts an activity to the sustainability ledger. This action involves validating the activity to identify any potential validation issues. If no errors are found, the activity is then posted to the ledger.

validateActivity

Operation: /fscmRestApi/resources/11.13.18.05/sustainabilityActivities/{ActivityId}/action/validateActivity

Parameters:

• ActivityId: $request.path.ActivityId

Recalculates and validates an activity record. The action first recalculates emissions where relevant, validates the activity, and records validation messages for any identified validation issues.

Back to Top