Jump to

• Request
• Response

Get Emission Rules

get

/emissionRules

Request

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/emissionRules"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object emissionRules

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

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : emissionRules

Type: object

Show Source

• actDFormulaExpresGid: string
  Formula Expression for calculating the emission at emission activity detail level.
• actFormulaExpresGid: string
  Formula Expression for calculating the emission at emission activity level.
• description: string
  Description of the emission rule.
• domainName: string
  No description.
• effectiveDate: effectiveDate
  The effective date of the emission rule.
• emisRuleConstraintSetGid: string
  Constraint set which used to pick the emission factor based on the additional attributes
• emissionFactors: emissionFactors
• emissionRuleGid: string
  The globally unique ID of an emission rule.
• emissionRuleName: string
  The name of the emission rule.
• emissionRuleXid: string
  The unique ID of an emission rule specific to a domain.
• expirationDate: expirationDate
  The expiration date of the emission rule.
• fromRegionGid: string
  The region from which the shipment is started.
• insertDate: insertDate
  Read Only: true

  insert date
• isActive: boolean
  This flag determines whether the emission rule is active or not.
• links: array links
  Read Only: true
• modeProfileGid: string
  Mode profile for which the emission rule is defined.
• priority: number (int64)
  The lower the priority, the higher the preference for the given emission rule. So 1 is the highest priority.
• toRegionGid: string
  The region from which the shipment is reached.
• updateDate: updateDate
  Read Only: true

  update date

{
    "properties":{
        "emissionRuleGid":{
            "description":"The globally unique ID of an emission rule.",
            "type":"string"
        },
        "emissionRuleXid":{
            "description":"The unique ID of an emission rule specific to a domain.",
            "type":"string"
        },
        "emissionRuleName":{
            "description":"The name of the emission rule.",
            "type":"string"
        },
        "description":{
            "description":"Description of the emission rule.",
            "type":"string"
        },
        "isActive":{
            "description":"This flag determines whether the emission rule is active or not.",
            "type":"boolean"
        },
        "effectiveDate":{
            "description":"The effective date of the emission rule.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"The expiration date of the emission rule.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "modeProfileGid":{
            "description":"Mode profile for which the emission rule is defined.",
            "type":"string"
        },
        "fromRegionGid":{
            "description":"The region from which the shipment is started.",
            "type":"string"
        },
        "toRegionGid":{
            "description":"The region from which the shipment is reached.",
            "type":"string"
        },
        "priority":{
            "description":"The lower the priority, the higher the preference for the given emission rule.  So 1 is the highest priority.",
            "type":"number",
            "format":"int64"
        },
        "emisRuleConstraintSetGid":{
            "description":"Constraint set which used to pick the emission factor based on the additional attributes",
            "type":"string"
        },
        "actFormulaExpresGid":{
            "description":"Formula Expression for calculating the emission at emission activity level.",
            "type":"string"
        },
        "actDFormulaExpresGid":{
            "description":"Formula Expression for calculating the emission at emission activity detail level.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "emissionFactors":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/emissionRules.emissionFactors"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

The effective date of the emission rule.

Match All

The effective date of the emission rule.

Show Source

• object dateType

{
    "description":"The effective date of the emission rule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : emissionFactors

Type: object

Show Source

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

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

Nested Schema : expirationDate

The expiration date of the emission rule.

Match All

The expiration date of the emission rule.

Show Source

• object dateType

{
    "description":"The expiration date of the emission rule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

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

Type: array

Show Source

• Array of: object emissionRules.emissionFactors

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/emissionRules.emissionFactors"
    }
}

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 : emissionRules.emissionFactors

Type: object

Show Source

• attribute1: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute10: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute11: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute12: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute13: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute14: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute15: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute16: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute17: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute18: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute19: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute2: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute20: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute3: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute4: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute5: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute6: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute7: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute8: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• attribute9: string
  Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
• description: string
  Description for the emission factor.
• domainName: string
  No description.
• emissionFactorSeqNo: number (int64)
  Sequence of the emission factor in the emission rule.
• emissionFactorValue: number (double)
  Value of the emission factor for emission specified.
• emissionFactorValueUomCode: string
  UOM code of the emission factor value for the emission.
• esgEmissionTypeGid: string
  Emission for which the emission factor is defined.
• links: array links
  Read Only: true
• servprovAlias: string
  Service Provider Alias of the service provider for which the emission factor is defined.

{
    "properties":{
        "emissionFactorSeqNo":{
            "description":"Sequence of the emission factor in the emission rule.",
            "type":"number",
            "format":"int64"
        },
        "description":{
            "description":"Description for the emission factor.",
            "type":"string"
        },
        "esgEmissionTypeGid":{
            "description":"Emission for which the emission factor is defined.",
            "type":"string"
        },
        "emissionFactorValue":{
            "description":"Value of the emission factor for emission specified. ",
            "type":"number",
            "format":"double"
        },
        "emissionFactorValueUomCode":{
            "description":"UOM code of the emission factor value for the emission.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "servprovAlias":{
            "description":"Service Provider Alias of the service provider for which the emission factor is defined.",
            "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 : links

Type: object

Show Source

• href: string
• rel: string

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

Back to Top