Jump to

• Request
• Response

Update one activity measure record

patch

/fscmRestApi/resources/11.13.18.05/sustainabilityActivities/{ActivityId}/child/Measures/{ActivityMeasureId}

Request

Path Parameters

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

• Currency: string
  Title: Currency

  Maximum Length: 80

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

  Maximum Length: 15

  Code that identifies the currency when the measure is monetary, for example, Amount.
• Measure: number
  Title: Measure

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

  Maximum Length: 80

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

  Maximum Length: 3

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

{
    "type":"object",
    "properties":{
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"Code that identifies the currency when the measure is monetary, for example, Amount.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Measure":{
            "title":"Measure",
            "type":"number",
            "description":"Measure to be used for emission calculation and reporting.",
            "nullable":false
        },
        "UOM":{
            "title":"UOM",
            "maxLength":"80",
            "type":"string",
            "description":"Unit of measure when the measure isn't monetary, for example, Quantity or Distance.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "UOMCode"
                ]
            }
        },
        "UOMCode":{
            "title":"UOM Code",
            "maxLength":"3",
            "type":"string",
            "description":"Code that identifies the unit of measure when the measure isn't monetary, for example, Quantity or Distance.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Currency":{
            "title":"Currency",
            "maxLength":"80",
            "type":"string",
            "description":"Currency when the measure is monetary, for example, Amount.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "CurrencyCode"
                ]
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : sustainabilityActivities-Measures-item-response

Type: object

Show Source

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

  Read Only: true

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

  Maximum Length: 80

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

  Maximum Length: 15

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

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

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

  Maximum Length: 255

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

  Maximum Length: 30

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

  Maximum Length: 80

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

  Maximum Length: 3

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

CurrencyLOVVOVA

Operation: /fscmRestApi/resources/11.13.18.05/currenciesLOV

The following properties are defined on the LOV link relation:

• Source Attribute: Currency; Target Attribute: Name
• Display Attribute: Name

MeasureTypeCodeLookupVA

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeAllRowsFinder%3BLookupType%3DORA_SUS_MEASURE_TYPES

The following properties are defined on the LOV link relation:

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

UnitOfMeasureVA

Operation: /fscmRestApi/resources/11.13.18.05/unitsOfMeasure

The following properties are defined on the LOV link relation:

• Source Attribute: UOM; Target Attribute: UOM
• Display Attribute: UOM

Back to Top