Jump to

• Request
• Response

Get Emission Activity Details

get

/emissionActivities/{esgActivityGid}/emissionActivityDetails

Request

Path Parameters

• esgActivityGid(required): string
  Resource ID

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.
• limit: integer(int32)
  Positive integer value that specifies the maximum number of items returned by the server.
• offset: integer(int32)
  Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
• orderBy: string
  Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
• q: string
  Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
• totalResults: boolean
  Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/emissionActivities.emissionActivityDetails"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

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

Show Source

• Array of: object links

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

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 : 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.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"
        }
    }
}

Back to Top