Jump to

• Request
• Response
• Examples

Delete one global warming potential

patch

/fscmRestApi/resources/11.13.18.05/globalWarmingPotentials/{GwpId}

Request

Path Parameters

• GwpId(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=

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 4000

  Description of the global warming potential metric.
• EndDate: string (date)
  Title: End Date

  End date till when the global warming potential metric value stays valid.
• GwpFactor: number
  Title: GWP Factor

  Global warming potential is a metric value used to assess the potential contribution of different greenhouse gases to global warming over a specific time horizon, usually 100 years.
• StartDate: string (date)
  Title: Start Date

  Start date from when the global warming potential metric value becomes valid.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date from when the global warming potential metric value becomes valid.",
            "format":"date",
            "nullable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the global warming potential metric.",
            "nullable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date till when the global warming potential metric value stays valid.",
            "format":"date",
            "nullable":true
        },
        "GwpFactor":{
            "title":"GWP Factor",
            "type":"number",
            "description":"Global warming potential is a metric value used to assess the potential contribution of different greenhouse gases to global warming over a specific time horizon, usually 100 years.",
            "nullable":false
        }
    }
}

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

Type: object

Show Source

• 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.
• Description: string
  Title: Description

  Maximum Length: 4000

  Description of the global warming potential metric.
• EmissionType: string
  Title: Emission Type

  Maximum Length: 255

  Emission type name.
• EmissionTypeCode: string
  Title: Emission Type Code

  Maximum Length: 30

  Code identifying the specific emission types.
• EndDate: string (date)
  Title: End Date

  End date till when the global warming potential metric value stays valid.
• GwpFactor: number
  Title: GWP Factor

  Global warming potential is a metric value used to assess the potential contribution of different greenhouse gases to global warming over a specific time horizon, usually 100 years.
• GwpId: integer (int64)
  Title: GWP Identifier

  Read Only: true

  Unique identifier of the global warming potential, which is a metric used to calculate the potential contribution of different greenhouse gases to global warming over a specific time horizon, usually 100 years, relative to the contribution of carbon dioxide.
• InUseFlag: boolean
  Title: In Use Indicator

  Read Only: true

  Identifies if the GWP record is used in any activity emissions.
• 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• StartDate: string (date)
  Title: Start Date

  Start date from when the global warming potential metric value becomes valid.

{
    "type":"object",
    "properties":{
        "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
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmissionTypeCode":{
            "title":"Emission Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Code identifying the specific emission types.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Description of the global warming potential metric.",
            "nullable":true,
            "x-queryable":true
        },
        "InUseFlag":{
            "title":"In Use Indicator",
            "type":"boolean",
            "description":"Identifies if the GWP record is used in any activity emissions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date till when the global warming potential metric value stays valid.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date from when the global warming potential metric value becomes valid.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EmissionType":{
            "title":"Emission Type",
            "maxLength":"255",
            "type":"string",
            "description":"Emission type name.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "EmissionTypeCode"
                ]
            },
            "x-queryable":true
        },
        "GwpFactor":{
            "title":"GWP Factor",
            "type":"number",
            "description":"Global warming potential is a metric value used to assess the potential contribution of different greenhouse gases to global warming over a specific time horizon, usually 100 years.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GwpId":{
            "title":"GWP Identifier",
            "type":"integer",
            "description":"Unique identifier of the global warming potential, which is a metric used to calculate the potential contribution of different greenhouse gases to global warming over a specific time horizon, usually 100 years, relative to the contribution of carbon dioxide.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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 : 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."
        }
    }
}

Links

EmissionTypeCodeLookupVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BActiveDate%3D2025-01-24%2CLookupType%3DORA_SUS_EMISSION_TYPES

The following properties are defined on the LOV link relation:

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

Back to Top

Examples

This example describes how to update a global warming potential.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/globalWarmingPotentials/GwpId"

For example:

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/globalWarmingPotentials/300100611799135"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
                "Description": "Revised GWP of Methane",
                "GwpFactor": 27,
                "StartDate": "2024-03-01"
               
    }

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "GwpId": 300100611799135,
    "Description": "Revised GWP of Methane",
    "EmissionTypeCode": "ORA_SUS_CH4",
    "EmissionType": "Methane",
    "GwpFactor": 27,
    "StartDate": "2024-03-01",
    "EndDate": null,
    "CreatedBy": "SUSQA01",
    "CreationDate": "2024-08-06T10:24:21+00:00",
    "LastUpdateDate": "2024-08-06T10:25:05+00:00",
    "LastUpdatedBy": "SUSQA01",
    "InUseFlag": "false",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/globalWarmingPotentials/300100611799135",
            "name": "globalWarmingPotentials",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/globalWarmingPotentials/300100611799135",
            "name": "globalWarmingPotentials",
            "kind": "item"
        }
    ]
}

Back to Top