Jump to

• Request
• Response

Update an ownership percentage for a stakeholder

patch

/fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/ownershipPercentages/{ownershipPercentageId}

Request

Path Parameters

• jointVentureId(required): integer(int64)
  The unique identifier of the joint venture.
• ownershipDefinitionId(required): integer(int64)
  The unique identifier of the ownership definition.
• ownershipPercentageId(required): integer(int64)
  The unique identifier of the ownership percentage.

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

• distributionOnlyFlag: boolean
  Title: Distribution Only

  Maximum Length: 1

  Indicates that the joint venture stakeholder is only participating in the transaction distribution and is not being invoiced.
• ownershipPercentageDFF: array Ownership Percentage Descriptive Flexfields
  Title: Ownership Percentage Descriptive Flexfields

  The ownership percentage descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership percentage associated with an ownership definition.
• percentageOfInterest: number
  Title: Ownership Percentage

  Default Value: 0

  The percent of ownership a stakeholder has in a joint venture transaction.
• roundingPartnerFlag: boolean
  Title: Rounding Partner

  Maximum Length: 1

  Indicates that the joint venture stakeholder is the rounding partner, receiving any extra cost or revenue after the split. Only one stakeholder in an ownership definition can be the rounding partner.
• stakeholderName: string
  Title: Stakeholder

  The name of the joint venture stakeholder.

{
    "type":"object",
    "properties":{
        "roundingPartnerFlag":{
            "title":"Rounding Partner",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the joint venture stakeholder is the rounding partner, receiving any extra cost or revenue after the split. Only one stakeholder in an ownership definition can be the rounding partner.",
            "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"
            }
        },
        "percentageOfInterest":{
            "title":"Ownership Percentage",
            "type":"number",
            "description":"The percent of ownership a stakeholder has in a joint venture transaction.",
            "nullable":true,
            "default":0,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ownershipPercentageDFF":{
            "title":"Ownership Percentage Descriptive Flexfields",
            "type":"array",
            "description":"The ownership percentage descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership percentage associated with an ownership definition.",
            "items":{
                "$ref":"#/components/schemas/jointVentures-ownershipDefinitions-ownershipPercentages-ownershipPercentageDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "stakeholderName":{
            "title":"Stakeholder",
            "type":"string",
            "description":"The name of the joint venture stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "distributionOnlyFlag":{
            "title":"Distribution Only",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the joint venture stakeholder is only participating in the transaction distribution and is not being invoiced.",
            "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 : Ownership Percentage Descriptive Flexfields

Type: array

Title: Ownership Percentage Descriptive Flexfields

The ownership percentage descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership percentage associated with an ownership definition.

Show Source

• Array of: object schema

{
    "title":"Ownership Percentage Descriptive Flexfields",
    "type":"array",
    "description":"The ownership percentage descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership percentage associated with an ownership definition.",
    "items":{
        "$ref":"#/components/schemas/jointVentures-ownershipDefinitions-ownershipPercentages-ownershipPercentageDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  The descriptive flexfield context name for the ownership percentage associated with the ownership definition.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  The descriptive flexfield context display value for the ownership percentage associated with the ownership definition.

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"The descriptive flexfield context display value for the ownership percentage associated with the ownership definition.",
            "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":"The descriptive flexfield context name for the ownership percentage associated with the ownership definition.",
            "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 : jointVentures-ownershipDefinitions-ownershipPercentages-item-response

Type: object

Show Source

• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the ownership percentage was created.
• distributionOnlyFlag: boolean
  Title: Distribution Only

  Maximum Length: 1

  Indicates that the joint venture stakeholder is only participating in the transaction distribution and is not being invoiced.
• internalStakeholderFlag: boolean
  Title: Stakeholder Type

  Read Only: true

  Maximum Length: 1

  Indicates that the joint venture stakeholder is an internal stakeholder.
• invoicingPartnerId: integer (int64)
  Title: Invoicing Partner ID

  Read Only: true

  The unique identifier of the invoicing partner.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time the ownership percentage was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the ownership percentage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ownershipDefinitionName: string
  Title: Ownership Definition

  Read Only: true

  Maximum Length: 30

  The name of the ownership definition.
• ownershipPercentageDFF: array Ownership Percentage Descriptive Flexfields
  Title: Ownership Percentage Descriptive Flexfields

  The ownership percentage descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership percentage associated with an ownership definition.
• ownershipPercentageId: integer (int64)
  Title: Ownership Percentage ID

  Read Only: true

  The unique identifier of the ownership percentage.
• percentageOfInterest: number
  Title: Ownership Percentage

  Default Value: 0

  The percent of ownership a stakeholder has in a joint venture transaction.
• roundingPartnerFlag: boolean
  Title: Rounding Partner

  Maximum Length: 1

  Indicates that the joint venture stakeholder is the rounding partner, receiving any extra cost or revenue after the split. Only one stakeholder in an ownership definition can be the rounding partner.
• stakeholderDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the joint venture stakeholder.
• stakeholderName: string
  Title: Stakeholder

  The name of the joint venture stakeholder.

{
    "type":"object",
    "properties":{
        "roundingPartnerFlag":{
            "title":"Rounding Partner",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the joint venture stakeholder is the rounding partner, receiving any extra cost or revenue after the split. Only one stakeholder in an ownership definition can be the rounding partner.",
            "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
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the ownership percentage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the ownership percentage 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 ownership percentage was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "stakeholderDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the joint venture stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "ownershipDefinitionName":{
            "title":"Ownership Definition",
            "maxLength":30,
            "type":"string",
            "description":"The name of the ownership definition.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "stakeholderName":{
            "title":"Stakeholder",
            "type":"string",
            "description":"The name of the joint venture stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the ownership percentage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ownershipPercentageId":{
            "title":"Ownership Percentage ID",
            "type":"integer",
            "description":"The unique identifier of the ownership percentage.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "internalStakeholderFlag":{
            "title":"Stakeholder Type",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the joint venture stakeholder is an internal stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "invoicingPartnerId":{
            "title":"Invoicing Partner ID",
            "type":"integer",
            "description":"The unique identifier of the invoicing partner.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "percentageOfInterest":{
            "title":"Ownership Percentage",
            "type":"number",
            "description":"The percent of ownership a stakeholder has in a joint venture transaction.",
            "nullable":true,
            "default":0,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ownershipPercentageDFF":{
            "title":"Ownership Percentage Descriptive Flexfields",
            "type":"array",
            "description":"The ownership percentage descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership percentage associated with an ownership definition.",
            "items":{
                "$ref":"#/components/schemas/jointVentures-ownershipDefinitions-ownershipPercentages-ownershipPercentageDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "distributionOnlyFlag":{
            "title":"Distribution Only",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that the joint venture stakeholder is only participating in the transaction distribution and is not being invoiced.",
            "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 : Ownership Percentage Descriptive Flexfields

Type: array

Title: Ownership Percentage Descriptive Flexfields

The ownership percentage descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership percentage associated with an ownership definition.

Show Source

• Array of: object jointVentures-ownershipDefinitions-ownershipPercentages-ownershipPercentageDFF-item-response

{
    "title":"Ownership Percentage Descriptive Flexfields",
    "type":"array",
    "description":"The ownership percentage descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership percentage associated with an ownership definition.",
    "items":{
        "$ref":"#/components/schemas/jointVentures-ownershipDefinitions-ownershipPercentages-ownershipPercentageDFF-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 : jointVentures-ownershipDefinitions-ownershipPercentages-ownershipPercentageDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

  The descriptive flexfield context name for the ownership percentage associated with the ownership definition.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment

  The descriptive flexfield context display value for the ownership percentage associated with the ownership definition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OwnershipLineId: integer (int64)
  The unique identifier of the ownership percentage.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OwnershipLineId":{
            "type":"integer",
            "description":"The unique identifier of the ownership percentage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"The descriptive flexfield context display value for the ownership percentage associated with the ownership definition.",
            "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":"The descriptive flexfield context name for the ownership percentage associated with the ownership definition.",
            "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

ownershipPercentageDFF

Operation: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/ownershipPercentages/{ownershipPercentageId}/child/ownershipPercentageDFF

Parameters:

• jointVentureId: $request.path.jointVentureId
• ownershipDefinitionId: $request.path.ownershipDefinitionId
• ownershipPercentageId: $request.path.ownershipPercentageId

The ownership percentage descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership percentage associated with an ownership definition.

Back to Top