Jump to

• Request
• Response
• Examples

Update a joint venture operational measure type

patch

/fscmRestApi/resources/11.13.18.05/jointVentureMeasureTypes/{measureTypeId}

Request

Path Parameters

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

• includePrimarySegmentFlag: boolean
  Title: Include Primary Segment Value

  Maximum Length: 1

  Indicates whether the operational measure requires an assigned primary segment value for this operational measure type.
• includeReferenceFlag: boolean
  Title: Include Reference

  Maximum Length: 1

  Indicates whether the operational measure requires an assigned reference value for this operational measure type.
• measureTypeDescription: string
  Title: Description

  Maximum Length: 240

  The description of the operational measure type.
• measureTypeDFF: array measureTypeDFF
• measureValueType: string
  Title: Value Type

  The value type used to identify the operational measure value as a number or a percent.
• unitOfMeasure: string
  Title: Unit of Measure

  The unit of measure related to the operational measure value.

{
    "type":"object",
    "properties":{
        "measureTypeDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureMeasureTypes-measureTypeDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "measureTypeDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the operational measure type.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "unitOfMeasure":{
            "title":"Unit of Measure",
            "type":"string",
            "description":"The unit of measure related to the operational measure value.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCodeUnitOfMeasure"
                ]
            }
        },
        "includePrimarySegmentFlag":{
            "title":"Include Primary Segment Value",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the operational measure requires an assigned primary segment value for this operational measure type.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_FK_WHEREATTR_ADDL":"LookupType",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.fnd.applcore.lookups.model.publicView.CommonLookupPVO",
                "fnd:FND_AUDIT_VALUE_ADDL":"'YES_NO_NOT_SPECIFIED'",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Meaning",
                "fnd:FND_AUDIT_FK_WHEREATTR":"LookupCode"
            }
        },
        "measureValueType":{
            "title":"Value Type",
            "type":"string",
            "description":"The value type used to identify the operational measure value as a number or a percent.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCodeMeasureValueType"
                ]
            }
        },
        "includeReferenceFlag":{
            "title":"Include Reference",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the operational measure requires an assigned reference value for this operational measure type.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_FK_WHEREATTR_ADDL":"LookupType",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.fnd.applcore.lookups.model.publicView.CommonLookupPVO",
                "fnd:FND_AUDIT_VALUE_ADDL":"'YES_NO_NOT_SPECIFIED'",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Meaning",
                "fnd:FND_AUDIT_FK_WHEREATTR":"LookupCode"
            }
        }
    }
}

Nested Schema : measureTypeDFF

Type: array

Show Source

• Array of: object jointVentureMeasureTypes-measureTypeDFF-item-patch-request

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

Nested Schema : jointVentureMeasureTypes-measureTypeDFF-item-patch-request

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "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",
            "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 : jointVentureMeasureTypes-item-response

Type: object

Show Source

• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the operational measure type was created.
• includePrimarySegmentFlag: boolean
  Title: Include Primary Segment Value

  Maximum Length: 1

  Indicates whether the operational measure requires an assigned primary segment value for this operational measure type.
• includeReferenceFlag: boolean
  Title: Include Reference

  Maximum Length: 1

  Indicates whether the operational measure requires an assigned reference value for this operational measure type.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• measureType: string
  Title: Measure Type

  Maximum Length: 30

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

  Maximum Length: 240

  The description of the operational measure type.
• measureTypeDFF: array measureTypeDFF
• measureTypeId: integer (int64)
  Title: Measure Type ID

  Read Only: true

  The unique identifier of the operational measure type.
• measureValueType: string
  Title: Value Type

  The value type used to identify the operational measure value as a number or a percent.
• operationalMeasuresExistFlag: boolean
  Title: Operational Measures Exist

  Read Only: true

  Indicates whether operational measures exist for the operational measure type.
• unitOfMeasure: string
  Title: Unit of Measure

  The unit of measure related to the operational measure value.

{
    "type":"object",
    "properties":{
        "measureTypeDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureMeasureTypes-measureTypeDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the operational measure type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "unitOfMeasure":{
            "title":"Unit of Measure",
            "type":"string",
            "description":"The unit of measure related to the operational measure value.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCodeUnitOfMeasure"
                ]
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the operational measure type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the operational measure type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "measureTypeId":{
            "title":"Measure Type ID",
            "type":"integer",
            "description":"The unique identifier of the operational measure type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "measureValueType":{
            "title":"Value Type",
            "type":"string",
            "description":"The value type used to identify the operational measure value as a number or a percent.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCodeMeasureValueType"
                ]
            },
            "x-queryable":true
        },
        "operationalMeasuresExistFlag":{
            "title":"Operational Measures Exist",
            "type":"boolean",
            "description":"Indicates whether operational measures exist for the operational measure type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the operational measure type.",
            "nullable":false,
            "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":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the operational measure type.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "includePrimarySegmentFlag":{
            "title":"Include Primary Segment Value",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the operational measure requires an assigned primary segment value for this operational measure type.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_FK_WHEREATTR_ADDL":"LookupType",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.fnd.applcore.lookups.model.publicView.CommonLookupPVO",
                "fnd:FND_AUDIT_VALUE_ADDL":"'YES_NO_NOT_SPECIFIED'",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Meaning",
                "fnd:FND_AUDIT_FK_WHEREATTR":"LookupCode"
            },
            "x-queryable":true
        },
        "measureType":{
            "title":"Measure Type",
            "maxLength":"30",
            "type":"string",
            "description":"The unique name of the operational measure type.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "includeReferenceFlag":{
            "title":"Include Reference",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the operational measure requires an assigned reference value for this operational measure type.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_FK_WHEREATTR_ADDL":"LookupType",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.fnd.applcore.lookups.model.publicView.CommonLookupPVO",
                "fnd:FND_AUDIT_VALUE_ADDL":"'YES_NO_NOT_SPECIFIED'",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Meaning",
                "fnd:FND_AUDIT_FK_WHEREATTR":"LookupCode"
            },
            "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 : measureTypeDFF

Type: array

Show Source

• Array of: object jointVentureMeasureTypes-measureTypeDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureMeasureTypes-measureTypeDFF-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 : jointVentureMeasureTypes-measureTypeDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• links: array Links
  Title: Links

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

  Read Only: true

{
    "type":"object",
    "properties":{
        "MeasureTypeId":{
            "title":"Measure Type ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "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",
            "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

measureTypeDFF

Operation: /fscmRestApi/resources/11.13.18.05/jointVentureMeasureTypes/{measureTypeId}/child/measureTypeDFF

Parameters:

• measureTypeId: $request.path.measureTypeId

Back to Top

Examples

The following example shows how to update a joint venture operational measure type 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/jointVentureMeasureTypes/300100544742439"

Example Request Payload

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

{
    "unitOfMeasure": "Barrels",
    "measureValueType": "Number",
    "includePrimarySegmentFlag": true,
    "includeReferenceFlag": true,
}

Example Response Body

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

{
    "measureTypeId": 300100544742439,
    "measureType": "PRODUCTIONBARRELS",
    "measureTypeDescription": "Barrels per day for the well",
    "unitOfMeasure": "Barrels",
    "measureValueType": "Number",
    "includePrimarySegmentFlag": true,
    "includeReferenceFlag": true,
    "operationalMeasuresExistFlag": false,
    "createdBy": "username",
    "creationDate": "2021-08-31T05:11:59+00:00",
    "lastUpdatedBy": "username",
    "lastUpdateDate": "2021-08-31T05:38:35+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureMeasureTypes/300100544742439",
            "name": "jointVentureMeasureTypes",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureMeasureTypes/300100544742439",
            "name": "jointVentureMeasureTypes",
            "kind": "item"
        }
    ]
}

Back to Top