Jump to

• Request
• Response

Create an Emission Activity

post

/emissionActivities

Request

Header Parameters

• Prefer:
  An optional header parameter that allows you to process the request asynchronously. Set the request header "Prefer" to "respond-async" for asynchronous processing. For synchronous processing, leave the parameter blank or do not define it.

Supported Media Types

• application/vnd.oracle.resource+json;type=singular

Request Body - application/vnd.oracle.resource+json;type=singular ()

Root Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  Accessorial Code ID associated with the ESG Activity.
• co2Emission: co2Emission
  Amount of Carbon emitted during the activity.
• co2EqEmission: co2EqEmission
  Amount of Carbon equivalent gases emitted during the activity.
• dataQueryTypeGid: string
  Data Query Type of the business object for which the ESG Activity is captured.
• dataSource: string
  Source from which the ESG Activity details are obtained. Valid Values are 'GENERATED', 'INTEGRATION', 'MANUAL'.
• description: string
  Description for the ESG Activity.
• destLocationGid: string
  The Destination Location ID for which the ESG Activity is captured.
• distance: distance
  Distance traveled for the ESG Activity.
• domainName: string
  No description.
• emissionActivityDetails: emissionActivityDetails
• emissionActivityEmissions: emissionActivityEmissions
• emissionActivityRemarks: emissionActivityRemarks
• equipmentGroupGid: string
  Equipment Group used for the ESG Activity.
• equipmentTypeGid: string
  Equipment Type used for the ESG Activity.
• esgActivityGid: string
  The GID of the ESG Activity.
• esgActivityTypeGid: string
  The ID of ESG Activity Type
• esgActivityXid: string
  The XID of the ESG Activity.
• insertDate: insertDate
  Read Only: true

  insert date
• links: array links
  Read Only: true
• note: string
  Note for the ESG Activity.
• objectGid: string
  Business Object ID for which the ESG Activity is captured.
• postedOn: postedOn
  The date on which the activity is posted.
• scopeType: string
  Scope of the ESG Activity. Valid Values are '1','2','3'
• servprovAlias: string
  Service Provider Alias of the service provider for which the ESG Activity is captured.
• sourceLocationGid: string
  The Source Location ID for which the ESG Activity is captured.
• transportHandlingUnitCount: number (int64)
  Count of the Transport Handling Unit for the ESG Activity.
• transportHandlingUnitGid: string
  The Transport Handling Unit ID for the ESG Activity.
• transportModeGid: string
  Mode of the Transport used during the ESG Activity.
• updateDate: updateDate
  Read Only: true

  update date
• volume: volume
  Volume of the shipment carried for the ESG Activity.
• weight: weight
  Weight of the shipment carried for the ESG Activity.

{
    "properties":{
        "esgActivityGid":{
            "description":"The GID of the ESG Activity.",
            "type":"string"
        },
        "esgActivityXid":{
            "description":"The XID of the ESG Activity.",
            "type":"string"
        },
        "esgActivityTypeGid":{
            "description":"The ID of ESG Activity Type",
            "type":"string"
        },
        "scopeType":{
            "description":"Scope of the ESG Activity. Valid Values are '1','2','3'",
            "type":"string"
        },
        "description":{
            "description":"Description for the ESG Activity.",
            "type":"string"
        },
        "dataSource":{
            "description":"Source from which the ESG Activity details are obtained. Valid Values are 'GENERATED', 'INTEGRATION', 'MANUAL'.",
            "type":"string"
        },
        "postedOn":{
            "description":"The date on which the activity is posted.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "dataQueryTypeGid":{
            "description":"Data Query Type of the business object for which the ESG Activity is captured.",
            "type":"string"
        },
        "objectGid":{
            "description":"Business Object ID for which the ESG Activity is captured.",
            "type":"string"
        },
        "sourceLocationGid":{
            "description":"The Source Location ID for which the ESG Activity is captured.",
            "type":"string"
        },
        "destLocationGid":{
            "description":"The Destination Location ID for which the ESG Activity is captured.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"Mode of the Transport used during the ESG Activity.",
            "type":"string"
        },
        "equipmentTypeGid":{
            "description":"Equipment Type used for the ESG Activity.",
            "type":"string"
        },
        "equipmentGroupGid":{
            "description":"Equipment Group used for the ESG Activity.",
            "type":"string"
        },
        "transportHandlingUnitGid":{
            "description":"The Transport Handling Unit ID for the ESG Activity.",
            "type":"string"
        },
        "transportHandlingUnitCount":{
            "description":"Count of the Transport Handling Unit for the ESG Activity.",
            "type":"number",
            "format":"int64"
        },
        "distance":{
            "description":"Distance traveled for the ESG Activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weight":{
            "description":"Weight of the shipment carried for the ESG Activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"Volume of the shipment carried for the ESG Activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "co2Emission":{
            "description":"Amount of Carbon emitted during the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "co2EqEmission":{
            "description":"Amount of Carbon equivalent gases emitted during the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "accessorialCodeGid":{
            "description":"Accessorial Code ID associated with the ESG Activity.",
            "type":"string"
        },
        "note":{
            "description":"Note for the ESG Activity.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "servprovAlias":{
            "description":"Service Provider Alias of the service provider for which the ESG Activity is captured.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "emissionActivityDetails":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/emissionActivities.emissionActivityDetails"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "emissionActivityEmissions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/emissionActivities.emissionActivityEmissions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "emissionActivityRemarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/emissionActivities.emissionActivityRemarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : co2Emission

Amount of Carbon emitted during the activity.

Match All

Amount of Carbon emitted during the activity.

Show Source

• object amountType

{
    "description":"Amount of Carbon emitted during the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : co2EqEmission

Amount of Carbon equivalent gases emitted during the activity.

Match All

Amount of Carbon equivalent gases emitted during the activity.

Show Source

• object amountType

{
    "description":"Amount of Carbon equivalent gases emitted during the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : distance

Distance traveled for the ESG Activity.

Match All

Distance traveled for the ESG Activity.

Show Source

• object amountType

{
    "description":"Distance traveled for the ESG Activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : emissionActivityDetails

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/emissionActivities.emissionActivityDetails"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : emissionActivityEmissions

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/emissionActivities.emissionActivityEmissions"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : emissionActivityRemarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/emissionActivities.emissionActivityRemarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : postedOn

The date on which the activity is posted.

Match All

The date on which the activity is posted.

Show Source

• object dateTimeType

{
    "description":"The date on which the activity is posted.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : volume

Volume of the shipment carried for the ESG Activity.

Match All

Volume of the shipment carried for the ESG Activity.

Show Source

• object amountType

{
    "description":"Volume of the shipment carried for the ESG Activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

Weight of the shipment carried for the ESG Activity.

Match All

Weight of the shipment carried for the ESG Activity.

Show Source

• object amountType

{
    "description":"Weight of the shipment carried for the ESG Activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object emissionActivities.emissionActivityDetails

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/emissionActivities.emissionActivityDetails"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : emissionActivities.emissionActivityDetails

Type: object

Show Source

• accessorialCodeGid: string
  Accessorial Code at the Location/Province for the activity.
• activitySeqNo: number (int64)
  ESG Activity Sequence number.
• co2Emission: co2Emission
  CO2 emissions at the Location/Province for the activity.
• co2EqEmission: co2EqEmission
  CO2 equivalent emissions at the Location/Province for the activity.
• countryCode3Gid: string
  Country Code ID where the Activity Detail is captured.
• distance: distance
  Distance traveled at the Location/Province level for the activity.
• domainName: string
  No description.
• EmissionActivityDetailEmissions: EmissionActivityDetailEmissions
• links: array links
  Read Only: true
• locationGid: string
  Location ID of the Activity Detail.
• note: string
  Note for the ESG Activity Details.
• province: string
  Province where Activity Detail is captured.
• provinceCode: string
  Province code where the Activity Detail is captured.
• transportHandlingUnitCount: number (int64)
  Count of the Transport Handling Unit at the Location/Province for the activity.
• transportHandlingUnitGid: string
  Transport Handling Unit at the Location/Province for the activity.
• volume: volume
  Carried Volume of the Shipment at the Location/Province for the activity.
• weight: weight
  Carried Weight of the Shipment at the Location/Province for the activity.

{
    "properties":{
        "activitySeqNo":{
            "description":"ESG Activity Sequence number.",
            "type":"number",
            "format":"int64"
        },
        "locationGid":{
            "description":"Location ID of the Activity Detail.",
            "type":"string"
        },
        "province":{
            "description":"Province where Activity Detail is captured.",
            "type":"string"
        },
        "provinceCode":{
            "description":"Province code where the Activity Detail is captured.",
            "type":"string"
        },
        "countryCode3Gid":{
            "description":"Country Code ID where the Activity Detail is captured.",
            "type":"string"
        },
        "distance":{
            "description":"Distance traveled at the Location/Province level for the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weight":{
            "description":"Carried Weight of the Shipment at the Location/Province for the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"Carried Volume of the Shipment at the Location/Province for the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "transportHandlingUnitGid":{
            "description":"Transport Handling Unit at the Location/Province for the activity.",
            "type":"string"
        },
        "transportHandlingUnitCount":{
            "description":"Count of the Transport Handling Unit at the Location/Province for the activity.",
            "type":"number",
            "format":"int64"
        },
        "co2Emission":{
            "description":"CO2 emissions at the Location/Province for the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "co2EqEmission":{
            "description":"CO2 equivalent emissions at the Location/Province for the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "accessorialCodeGid":{
            "description":"Accessorial Code at the Location/Province for the activity.",
            "type":"string"
        },
        "note":{
            "description":"Note for the ESG Activity Details.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "EmissionActivityDetailEmissions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/emissionActivities.emissionActivityDetails.EmissionActivityDetailEmissions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : co2Emission

CO2 emissions at the Location/Province for the activity.

Match All

CO2 emissions at the Location/Province for the activity.

Show Source

• object amountType

{
    "description":"CO2 emissions at the Location/Province for the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : co2EqEmission

CO2 equivalent emissions at the Location/Province for the activity.

Match All

CO2 equivalent emissions at the Location/Province for the activity.

Show Source

• object amountType

{
    "description":"CO2 equivalent emissions at the Location/Province for the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : distance

Distance traveled at the Location/Province level for the activity.

Match All

Distance traveled at the Location/Province level for the activity.

Show Source

• object amountType

{
    "description":"Distance traveled at the Location/Province level for the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : EmissionActivityDetailEmissions

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/emissionActivities.emissionActivityDetails.EmissionActivityDetailEmissions"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : volume

Carried Volume of the Shipment at the Location/Province for the activity.

Match All

Carried Volume of the Shipment at the Location/Province for the activity.

Show Source

• object amountType

{
    "description":"Carried Volume of the Shipment at the Location/Province for the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

Carried Weight of the Shipment at the Location/Province for the activity.

Match All

Carried Weight of the Shipment at the Location/Province for the activity.

Show Source

• object amountType

{
    "description":"Carried Weight of the Shipment at the Location/Province for the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object emissionActivities.emissionActivityDetails.EmissionActivityDetailEmissions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/emissionActivities.emissionActivityDetails.EmissionActivityDetailEmissions"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : emissionActivities.emissionActivityDetails.EmissionActivityDetailEmissions

Type: object

Show Source

• domainName: string
  No description.
• emission: emission
  The amount of emission emitted for the activity detail.
• esgEmissionTypeGid: string
  The type of emission for the activity detail.
• links: array links
  Read Only: true

{
    "properties":{
        "esgEmissionTypeGid":{
            "description":"The type of emission for the activity detail.",
            "type":"string"
        },
        "emission":{
            "description":"The amount of emission emitted for the activity detail.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : emission

The amount of emission emitted for the activity detail.

Match All

The amount of emission emitted for the activity detail.

Show Source

• object amountType

{
    "description":"The amount of emission emitted for the activity detail.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object emissionActivities.emissionActivityEmissions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/emissionActivities.emissionActivityEmissions"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : emissionActivities.emissionActivityEmissions

Type: object

Show Source

• domainName: string
  No description.
• emission: emission
  Amount of emission emitted during the activity.
• esgEmissionTypeGid: string
  The globally unique ID of an emission type.
• links: array links
  Read Only: true

{
    "properties":{
        "esgEmissionTypeGid":{
            "description":"The globally unique ID of an emission type.",
            "type":"string"
        },
        "emission":{
            "description":"Amount of emission emitted during the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : emission

Amount of emission emitted during the activity.

Match All

Amount of emission emitted during the activity.

Show Source

• object amountType

{
    "description":"Amount of emission emitted during the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object emissionActivities.emissionActivityRemarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/emissionActivities.emissionActivityRemarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : emissionActivities.emissionActivityRemarks

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• remarkQualGid: string
  A pointer to the remark type.
• remarkSequence: number (int64)
  The remark sequence (key) associated with the ESG Activity.
• remarkText: string
  A user-entered remark on the ESG Activity.

{
    "properties":{
        "remarkSequence":{
            "description":"The remark sequence (key) associated with the ESG Activity.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"A pointer to the remark type.",
            "type":"string"
        },
        "remarkText":{
            "description":"A user-entered remark on the ESG Activity.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=singular

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• accessorialCodeGid: string
  Accessorial Code ID associated with the ESG Activity.
• co2Emission: co2Emission
  Amount of Carbon emitted during the activity.
• co2EqEmission: co2EqEmission
  Amount of Carbon equivalent gases emitted during the activity.
• dataQueryTypeGid: string
  Data Query Type of the business object for which the ESG Activity is captured.
• dataSource: string
  Source from which the ESG Activity details are obtained. Valid Values are 'GENERATED', 'INTEGRATION', 'MANUAL'.
• description: string
  Description for the ESG Activity.
• destLocationGid: string
  The Destination Location ID for which the ESG Activity is captured.
• distance: distance
  Distance traveled for the ESG Activity.
• domainName: string
  No description.
• emissionActivityDetails: emissionActivityDetails
• emissionActivityEmissions: emissionActivityEmissions
• emissionActivityRemarks: emissionActivityRemarks
• equipmentGroupGid: string
  Equipment Group used for the ESG Activity.
• equipmentTypeGid: string
  Equipment Type used for the ESG Activity.
• esgActivityGid: string
  The GID of the ESG Activity.
• esgActivityTypeGid: string
  The ID of ESG Activity Type
• esgActivityXid: string
  The XID of the ESG Activity.
• insertDate: insertDate
  Read Only: true

  insert date
• links: array links
  Read Only: true
• note: string
  Note for the ESG Activity.
• objectGid: string
  Business Object ID for which the ESG Activity is captured.
• postedOn: postedOn
  The date on which the activity is posted.
• scopeType: string
  Scope of the ESG Activity. Valid Values are '1','2','3'
• servprovAlias: string
  Service Provider Alias of the service provider for which the ESG Activity is captured.
• sourceLocationGid: string
  The Source Location ID for which the ESG Activity is captured.
• transportHandlingUnitCount: number (int64)
  Count of the Transport Handling Unit for the ESG Activity.
• transportHandlingUnitGid: string
  The Transport Handling Unit ID for the ESG Activity.
• transportModeGid: string
  Mode of the Transport used during the ESG Activity.
• updateDate: updateDate
  Read Only: true

  update date
• volume: volume
  Volume of the shipment carried for the ESG Activity.
• weight: weight
  Weight of the shipment carried for the ESG Activity.

{
    "properties":{
        "esgActivityGid":{
            "description":"The GID of the ESG Activity.",
            "type":"string"
        },
        "esgActivityXid":{
            "description":"The XID of the ESG Activity.",
            "type":"string"
        },
        "esgActivityTypeGid":{
            "description":"The ID of ESG Activity Type",
            "type":"string"
        },
        "scopeType":{
            "description":"Scope of the ESG Activity. Valid Values are '1','2','3'",
            "type":"string"
        },
        "description":{
            "description":"Description for the ESG Activity.",
            "type":"string"
        },
        "dataSource":{
            "description":"Source from which the ESG Activity details are obtained. Valid Values are 'GENERATED', 'INTEGRATION', 'MANUAL'.",
            "type":"string"
        },
        "postedOn":{
            "description":"The date on which the activity is posted.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "dataQueryTypeGid":{
            "description":"Data Query Type of the business object for which the ESG Activity is captured.",
            "type":"string"
        },
        "objectGid":{
            "description":"Business Object ID for which the ESG Activity is captured.",
            "type":"string"
        },
        "sourceLocationGid":{
            "description":"The Source Location ID for which the ESG Activity is captured.",
            "type":"string"
        },
        "destLocationGid":{
            "description":"The Destination Location ID for which the ESG Activity is captured.",
            "type":"string"
        },
        "transportModeGid":{
            "description":"Mode of the Transport used during the ESG Activity.",
            "type":"string"
        },
        "equipmentTypeGid":{
            "description":"Equipment Type used for the ESG Activity.",
            "type":"string"
        },
        "equipmentGroupGid":{
            "description":"Equipment Group used for the ESG Activity.",
            "type":"string"
        },
        "transportHandlingUnitGid":{
            "description":"The Transport Handling Unit ID for the ESG Activity.",
            "type":"string"
        },
        "transportHandlingUnitCount":{
            "description":"Count of the Transport Handling Unit for the ESG Activity.",
            "type":"number",
            "format":"int64"
        },
        "distance":{
            "description":"Distance traveled for the ESG Activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weight":{
            "description":"Weight of the shipment carried for the ESG Activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"Volume of the shipment carried for the ESG Activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "co2Emission":{
            "description":"Amount of Carbon emitted during the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "co2EqEmission":{
            "description":"Amount of Carbon equivalent gases emitted during the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "accessorialCodeGid":{
            "description":"Accessorial Code ID associated with the ESG Activity.",
            "type":"string"
        },
        "note":{
            "description":"Note for the ESG Activity.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "servprovAlias":{
            "description":"Service Provider Alias of the service provider for which the ESG Activity is captured.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "emissionActivityDetails":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/emissionActivities.emissionActivityDetails"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "emissionActivityEmissions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/emissionActivities.emissionActivityEmissions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "emissionActivityRemarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/emissionActivities.emissionActivityRemarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : co2Emission

Amount of Carbon emitted during the activity.

Match All

Amount of Carbon emitted during the activity.

Show Source

• object amountType

{
    "description":"Amount of Carbon emitted during the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : co2EqEmission

Amount of Carbon equivalent gases emitted during the activity.

Match All

Amount of Carbon equivalent gases emitted during the activity.

Show Source

• object amountType

{
    "description":"Amount of Carbon equivalent gases emitted during the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : distance

Distance traveled for the ESG Activity.

Match All

Distance traveled for the ESG Activity.

Show Source

• object amountType

{
    "description":"Distance traveled for the ESG Activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : emissionActivityDetails

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/emissionActivities.emissionActivityDetails"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : emissionActivityEmissions

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/emissionActivities.emissionActivityEmissions"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : emissionActivityRemarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/emissionActivities.emissionActivityRemarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : postedOn

The date on which the activity is posted.

Match All

The date on which the activity is posted.

Show Source

• object dateTimeType

{
    "description":"The date on which the activity is posted.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : volume

Volume of the shipment carried for the ESG Activity.

Match All

Volume of the shipment carried for the ESG Activity.

Show Source

• object amountType

{
    "description":"Volume of the shipment carried for the ESG Activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

Weight of the shipment carried for the ESG Activity.

Match All

Weight of the shipment carried for the ESG Activity.

Show Source

• object amountType

{
    "description":"Weight of the shipment carried for the ESG Activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object emissionActivities.emissionActivityDetails

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/emissionActivities.emissionActivityDetails"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : emissionActivities.emissionActivityDetails

Type: object

Show Source

• accessorialCodeGid: string
  Accessorial Code at the Location/Province for the activity.
• activitySeqNo: number (int64)
  ESG Activity Sequence number.
• co2Emission: co2Emission
  CO2 emissions at the Location/Province for the activity.
• co2EqEmission: co2EqEmission
  CO2 equivalent emissions at the Location/Province for the activity.
• countryCode3Gid: string
  Country Code ID where the Activity Detail is captured.
• distance: distance
  Distance traveled at the Location/Province level for the activity.
• domainName: string
  No description.
• EmissionActivityDetailEmissions: EmissionActivityDetailEmissions
• links: array links
  Read Only: true
• locationGid: string
  Location ID of the Activity Detail.
• note: string
  Note for the ESG Activity Details.
• province: string
  Province where Activity Detail is captured.
• provinceCode: string
  Province code where the Activity Detail is captured.
• transportHandlingUnitCount: number (int64)
  Count of the Transport Handling Unit at the Location/Province for the activity.
• transportHandlingUnitGid: string
  Transport Handling Unit at the Location/Province for the activity.
• volume: volume
  Carried Volume of the Shipment at the Location/Province for the activity.
• weight: weight
  Carried Weight of the Shipment at the Location/Province for the activity.

{
    "properties":{
        "activitySeqNo":{
            "description":"ESG Activity Sequence number.",
            "type":"number",
            "format":"int64"
        },
        "locationGid":{
            "description":"Location ID of the Activity Detail.",
            "type":"string"
        },
        "province":{
            "description":"Province where Activity Detail is captured.",
            "type":"string"
        },
        "provinceCode":{
            "description":"Province code where the Activity Detail is captured.",
            "type":"string"
        },
        "countryCode3Gid":{
            "description":"Country Code ID where the Activity Detail is captured.",
            "type":"string"
        },
        "distance":{
            "description":"Distance traveled at the Location/Province level for the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weight":{
            "description":"Carried Weight of the Shipment at the Location/Province for the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"Carried Volume of the Shipment at the Location/Province for the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "transportHandlingUnitGid":{
            "description":"Transport Handling Unit at the Location/Province for the activity.",
            "type":"string"
        },
        "transportHandlingUnitCount":{
            "description":"Count of the Transport Handling Unit at the Location/Province for the activity.",
            "type":"number",
            "format":"int64"
        },
        "co2Emission":{
            "description":"CO2 emissions at the Location/Province for the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "co2EqEmission":{
            "description":"CO2 equivalent emissions at the Location/Province for the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "accessorialCodeGid":{
            "description":"Accessorial Code at the Location/Province for the activity.",
            "type":"string"
        },
        "note":{
            "description":"Note for the ESG Activity Details.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "EmissionActivityDetailEmissions":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/emissionActivities.emissionActivityDetails.EmissionActivityDetailEmissions"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : co2Emission

CO2 emissions at the Location/Province for the activity.

Match All

CO2 emissions at the Location/Province for the activity.

Show Source

• object amountType

{
    "description":"CO2 emissions at the Location/Province for the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : co2EqEmission

CO2 equivalent emissions at the Location/Province for the activity.

Match All

CO2 equivalent emissions at the Location/Province for the activity.

Show Source

• object amountType

{
    "description":"CO2 equivalent emissions at the Location/Province for the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : distance

Distance traveled at the Location/Province level for the activity.

Match All

Distance traveled at the Location/Province level for the activity.

Show Source

• object amountType

{
    "description":"Distance traveled at the Location/Province level for the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : EmissionActivityDetailEmissions

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/emissionActivities.emissionActivityDetails.EmissionActivityDetailEmissions"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : volume

Carried Volume of the Shipment at the Location/Province for the activity.

Match All

Carried Volume of the Shipment at the Location/Province for the activity.

Show Source

• object amountType

{
    "description":"Carried Volume of the Shipment at the Location/Province for the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

Carried Weight of the Shipment at the Location/Province for the activity.

Match All

Carried Weight of the Shipment at the Location/Province for the activity.

Show Source

• object amountType

{
    "description":"Carried Weight of the Shipment at the Location/Province for the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object emissionActivities.emissionActivityDetails.EmissionActivityDetailEmissions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/emissionActivities.emissionActivityDetails.EmissionActivityDetailEmissions"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : emissionActivities.emissionActivityDetails.EmissionActivityDetailEmissions

Type: object

Show Source

• domainName: string
  No description.
• emission: emission
  The amount of emission emitted for the activity detail.
• esgEmissionTypeGid: string
  The type of emission for the activity detail.
• links: array links
  Read Only: true

{
    "properties":{
        "esgEmissionTypeGid":{
            "description":"The type of emission for the activity detail.",
            "type":"string"
        },
        "emission":{
            "description":"The amount of emission emitted for the activity detail.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : emission

The amount of emission emitted for the activity detail.

Match All

The amount of emission emitted for the activity detail.

Show Source

• object amountType

{
    "description":"The amount of emission emitted for the activity detail.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object emissionActivities.emissionActivityEmissions

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/emissionActivities.emissionActivityEmissions"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : emissionActivities.emissionActivityEmissions

Type: object

Show Source

• domainName: string
  No description.
• emission: emission
  Amount of emission emitted during the activity.
• esgEmissionTypeGid: string
  The globally unique ID of an emission type.
• links: array links
  Read Only: true

{
    "properties":{
        "esgEmissionTypeGid":{
            "description":"The globally unique ID of an emission type.",
            "type":"string"
        },
        "emission":{
            "description":"Amount of emission emitted during the activity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : emission

Amount of emission emitted during the activity.

Match All

Amount of emission emitted during the activity.

Show Source

• object amountType

{
    "description":"Amount of emission emitted during the activity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object emissionActivities.emissionActivityRemarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/emissionActivities.emissionActivityRemarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : emissionActivities.emissionActivityRemarks

Type: object

Show Source

• domainName: string
  No description.
• links: array links
  Read Only: true
• remarkQualGid: string
  A pointer to the remark type.
• remarkSequence: number (int64)
  The remark sequence (key) associated with the ESG Activity.
• remarkText: string
  A user-entered remark on the ESG Activity.

{
    "properties":{
        "remarkSequence":{
            "description":"The remark sequence (key) associated with the ESG Activity.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualGid":{
            "description":"A pointer to the remark type.",
            "type":"string"
        },
        "remarkText":{
            "description":"A user-entered remark on the ESG Activity.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Back to Top