Jump to

• Request
• Response
• Examples

Update a joint venture operational measure

patch

/fscmRestApi/resources/11.13.18.05/jointVentureOperationalMeasures/{operationalMeasureId}

Request

Path Parameters

• operationalMeasureId(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

• measureStatus: string
  Title: Status

  The status of the operational measure for generating statistical journal entries.
• measureValue: number
  Title: Measure Value

  The value of the operational measure.
• operationalMeasureDFF: array operationalMeasureDFF

{
    "type":"object",
    "properties":{
        "measureValue":{
            "title":"Measure Value",
            "type":"number",
            "description":"The value of the operational measure.",
            "nullable":true
        },
        "measureStatus":{
            "title":"Status",
            "type":"string",
            "description":"The status of the operational measure for generating statistical journal entries.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeStatus"
                ]
            }
        },
        "operationalMeasureDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureOperationalMeasures-operationalMeasureDFF-item-patch-request"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : operationalMeasureDFF

Type: array

Show Source

• Array of: object jointVentureOperationalMeasures-operationalMeasureDFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureOperationalMeasures-operationalMeasureDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : jointVentureOperationalMeasures-operationalMeasureDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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

Type: object

Show Source

• accountingHeaderId: integer (int64)
  Title: Accounting Header ID

  Read Only: true

  The unique identifier of the accounting header.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the operational measure.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the operational measure was created.
• documentNumber: string
  Title: Document Number

  Read Only: true

  Maximum Length: 240

  The unique document reference for the joint venture accounting transaction.
• jointVenture: string
  Title: Joint Venture

  The unique name of the joint venture.
• jointVentureDescription: string
  Title: Joint Venture Description

  Read Only: true

  Maximum Length: 240

  The description of the joint venture.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the operational measure was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the operational measure.
• links: array Links
  Title: Links

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

  The date of the operational measure.
• measureLineNumber: integer (int32)
  Title: Line Number

  Read Only: true

  The line number of the operational measure that's incremented when processing reversals and corrections of statistical journal entries.
• measureLineType: string
  Title: Line Type

  Read Only: true

  Maximum Length: 80

  The type of the operational measure line for processing reversals and corrections of statistical journal entries. Valid values are Original, Canceled, and Reversed.
• measureStatus: string
  Title: Status

  The status of the operational measure for generating statistical journal entries.
• measureType: string
  Title: Measure Type

  The unique name of the measure type.
• measureTypeDescription: string
  Title: Measure Type Description

  Read Only: true

  Maximum Length: 240

  The description of the measure type.
• measureValue: number
  Title: Measure Value

  The value of the operational measure.
• measureValueType: string
  Title: Value Type

  Read Only: true

  Maximum Length: 80

  The value type used to identify the operational measure value as a number or a percent.
• operationalMeasureDFF: array operationalMeasureDFF
• operationalMeasureId: integer (int64)
  Title: Operational Measure ID

  Read Only: true

  The unique identifier of the operational measure.
• primarySegment: string
  Title: Primary Segment

  Read Only: true

  Maximum Length: 255

  The name of the account segment labeled as the primary segment in the chart of accounts instance associated with the joint venture.
• reference: string
  Title: Reference

  Maximum Length: 64

  The reference associated with the operational measure.
• segmentValue: string
  Title: Primary Segment Value

  Maximum Length: 25

  A valid value defined for the segment labeled as the primary segment within the chart of accounts instance associated with the joint venture.
• segmentValueDescription: string
  Title: Primary Segment Value Description

  Read Only: true

  The description of the primary segment value.
• unitOfMeasure: string
  Title: Unit of Measure

  Read Only: true

  Maximum Length: 80

  The unit of measure for the operational measure value.

{
    "type":"object",
    "properties":{
        "operationalMeasureId":{
            "title":"Operational Measure ID",
            "type":"integer",
            "description":"The unique identifier of the operational measure.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the operational measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "measureLineType":{
            "title":"Line Type",
            "maxLength":"80",
            "type":"string",
            "description":"The type of the operational measure line for processing reversals and corrections of statistical journal entries. Valid values are Original, Canceled, and Reversed.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "unitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":"80",
            "type":"string",
            "description":"The unit of measure for the operational measure value.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeUnitOfMeasure"
                ]
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the operational measure was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "documentNumber":{
            "title":"Document Number",
            "maxLength":"240",
            "type":"string",
            "description":"The unique document reference for the joint venture accounting transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "primarySegment":{
            "title":"Primary Segment",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the account segment labeled as the primary segment in the chart of accounts instance associated with the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "segmentValue":{
            "title":"Primary Segment Value",
            "maxLength":"25",
            "type":"string",
            "description":"A valid value defined for the segment labeled as the primary segment within the chart of accounts instance associated with the joint venture.",
            "nullable":true,
            "x-queryable":true
        },
        "measureStatus":{
            "title":"Status",
            "type":"string",
            "description":"The status of the operational measure for generating statistical journal entries.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeStatus"
                ]
            },
            "x-queryable":true
        },
        "measureLineNumber":{
            "title":"Line Number",
            "type":"integer",
            "description":"The line number of the operational measure that's incremented when processing reversals and corrections of statistical journal entries.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the operational measure was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "accountingHeaderId":{
            "title":"Accounting Header ID",
            "type":"integer",
            "description":"The unique identifier of the accounting header.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "measureDate":{
            "title":"Measure Date",
            "type":"string",
            "description":"The date of the operational measure.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "measureValueType":{
            "title":"Value Type",
            "maxLength":"80",
            "type":"string",
            "description":"The value type used to identify the operational measure value as a number or a percent.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "lookupCodeMeasureValueType"
                ]
            },
            "x-queryable":true
        },
        "operationalMeasureDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureOperationalMeasures-operationalMeasureDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "reference":{
            "title":"Reference",
            "maxLength":"64",
            "type":"string",
            "description":"The reference associated with the operational measure.",
            "nullable":true,
            "x-queryable":true
        },
        "measureValue":{
            "title":"Measure Value",
            "type":"number",
            "description":"The value of the operational measure.",
            "nullable":true,
            "x-queryable":true
        },
        "segmentValueDescription":{
            "title":"Primary Segment Value Description",
            "type":"string",
            "description":"The description of the primary segment value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "jointVenture":{
            "title":"Joint Venture",
            "type":"string",
            "description":"The unique name of the joint venture.",
            "nullable":true,
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the operational measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "jointVentureDescription":{
            "title":"Joint Venture Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "measureTypeDescription":{
            "title":"Measure Type Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the measure type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "measureType":{
            "title":"Measure Type",
            "type":"string",
            "description":"The unique name of the measure type.",
            "nullable":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 : operationalMeasureDFF

Type: array

Show Source

• Array of: object jointVentureOperationalMeasures-operationalMeasureDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureOperationalMeasures-operationalMeasureDFF-item-response"
    },
    "x-cardinality":"1"
}

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

Nested Schema : jointVentureOperationalMeasures-operationalMeasureDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  Context Segment
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  Context Segment
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OperationalMeasureId: integer (int64)
  Title: Operational Measure ID

  Read Only: true

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OperationalMeasureId":{
            "title":"Operational Measure ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"150",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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"
    }
}

Links

operationalMeasureDFF

Operation: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalMeasures/{operationalMeasureId}/child/operationalMeasureDFF

Parameters:

• operationalMeasureId: $request.path.operationalMeasureId

reverseOperationalMeasure

Operation: /fscmRestApi/resources/11.13.18.05/jointVentureOperationalMeasures/{operationalMeasureId}/action/reverseOperationalMeasure

Parameters:

• operationalMeasureId: $request.path.operationalMeasureId

Reverses the operational measure value associated with a processed accounting transaction. If the accounting event is unprocessed, the operational measure's association with the event is removed so that it's not included when the accounting transaction is processed.

Back to Top

Examples

The following example shows how to update a joint venture operational measure by submitting a PATCH request on the REST resource using cURL.

curl -i -u "username:password" -H "Content-type: application/json" -X PATCH -d <payload> "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOperationalMeasures/300100544400992"

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
    "measureValue": 145.5578
}

Example Response Body

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

{
    "operationalMeasureId": 300100544400992,
    "measureType": "PRODUCTIONUNITS",
    "measureTypeDescription": null,
    "jointVenture": "ALBERTA",
    "jointVentureDescription": "Alberta Production",
    "primarySegment": "HEPPCostcenter",
    "segmentValue": "1005",
    "segmentValueDescription": "Bakken Wells Cost Center",
    "reference": "Bakken Wells",
    "measureDate": "2021-08-25",
    "measureValue": 145.5578,
    "unitOfMeasure": "Units",
    "measureValueType": "Number",
    "createdBy": "username",
    "creationDate": "2021-08-25T06:11:15+00:00",
    "lastUpdatedBy": "username",
    "lastUpdateDate": "2021-08-31T06:21:45+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOperationalMeasures/300100544400992",
            "name": "jointVentureOperationalMeasures",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOperationalMeasures/300100544400992",
            "name": "jointVentureOperationalMeasures",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOperationalMeasures/300100544400992/child/operationalMeasureDFF",
            "name": "operationalMeasureDFF",
            "kind": "collection"
        }
    ]
}

Back to Top