Jump to

• Request
• Response
• Examples

Update an ownership definition

patch

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

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.

Header Parameters

• Metadata-Context: string
  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: string
  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

• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• changeReason: string
  Title: Change Reason

  Maximum Length: 255

  Indicates the reason for changing the effective dates on the ownership definition.
• changeReasonAdditionalText: string
  Title: Change Reason Additional Information

  Maximum Length: 240

  Additional information describing the reason for changing the ownership definition.
• effectiveEndDate: string (date)
  Title: End Date

  The end date of the effective date range of the ownership definition.
• effectiveStartDate: string (date)
  Title: Start Date

  The start date of the effective date range of the ownership definition.
• ownershipDefinitionDescription: string
  Title: Description

  Maximum Length: 240

  A description of the ownership definition.
• ownershipDefinitionDFF: array Ownership Definition Descriptive Flexfields
  Title: Ownership Definition Descriptive Flexfields

  The ownership definition descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership definition associated with a joint venture.
• ownershipDefinitionStatus: string
  Title: Status

  Maximum Length: 255

  The status of the ownership definition.
• ownershipPercentages: array Ownership Percentages
  Title: Ownership Percentages

  The ownership percentages resource is used to view, create, update, or delete each stakeholder???s percentage of ownership in an ownership definition. The percentages must total 100 percent for all stakeholders in the ownership definition.

{
    "type":"object",
    "properties":{
        "effectiveEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the effective date range of the ownership definition.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ownershipDefinitionStatus":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "description":"The status of the ownership definition.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/jointVentures-ownershipDefinitions-attachments-item-patch-request"
            }
        },
        "changeReason":{
            "title":"Change Reason",
            "maxLength":255,
            "type":"string",
            "description":"Indicates the reason for changing the effective dates on the ownership definition.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "LookupCode1"
                ]
            }
        },
        "changeReasonAdditionalText":{
            "title":"Change Reason Additional Information",
            "maxLength":240,
            "type":"string",
            "description":"Additional information describing the reason for changing the ownership definition.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "effectiveStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the effective date range of the ownership definition.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "ownershipPercentages":{
            "title":"Ownership Percentages",
            "type":"array",
            "description":"The ownership percentages resource is used to view, create, update, or delete each stakeholder???s percentage of ownership in an ownership definition. The percentages must total 100 percent for all stakeholders in the ownership definition.",
            "items":{
                "$ref":"#/components/schemas/jointVentures-ownershipDefinitions-ownershipPercentages-item-patch-request"
            }
        },
        "ownershipDefinitionDFF":{
            "title":"Ownership Definition Descriptive Flexfields",
            "type":"array",
            "description":"The ownership definition descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership definition associated with a joint venture.",
            "items":{
                "$ref":"#/components/schemas/jointVentures-ownershipDefinitions-ownershipDefinitionDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "ownershipDefinitionDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"A description of the ownership definition.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object jointVentures-ownershipDefinitions-attachments-item-patch-request

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/jointVentures-ownershipDefinitions-attachments-item-patch-request"
    }
}

Nested Schema : Ownership Definition Descriptive Flexfields

Type: array

Title: Ownership Definition Descriptive Flexfields

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

Show Source

• Array of: object schema

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

Nested Schema : Ownership Percentages

Type: array

Title: Ownership Percentages

The ownership percentages resource is used to view, create, update, or delete each stakeholder???s percentage of ownership in an ownership definition. The percentages must total 100 percent for all stakeholders in the ownership definition.

Show Source

• Array of: object jointVentures-ownershipDefinitions-ownershipPercentages-item-patch-request

{
    "title":"Ownership Percentages",
    "type":"array",
    "description":"The ownership percentages resource is used to view, create, update, or delete each stakeholder???s percentage of ownership in an ownership definition. The percentages must total 100 percent for all stakeholders in the ownership definition.",
    "items":{
        "$ref":"#/components/schemas/jointVentures-ownershipDefinitions-ownershipPercentages-item-patch-request"
    }
}

Nested Schema : jointVentures-ownershipDefinitions-attachments-item-patch-request

Type: object

Show Source

• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.

{
    "type":"object",
    "properties":{
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

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

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

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"The descriptive flexfield context display value for the ownership definition associated with the joint venture.",
            "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 definition associated with the joint venture.",
            "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"
                }
            }
        }
    }
}

Nested Schema : jointVentures-ownershipDefinitions-ownershipPercentages-item-patch-request

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

Type: object

Show Source

• activeFlag: boolean
  Title: Invoicing Partner Active

  Read Only: true

  Indicates whether the ownership definition is active or not.
• agreement: string
  Title: Agreement

  Read Only: true

  Maximum Length: 30

  The name of the carried interest agreement.
• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• changeReason: string
  Title: Change Reason

  Maximum Length: 255

  Indicates the reason for changing the effective dates on the ownership definition.
• changeReasonAdditionalText: string
  Title: Change Reason Additional Information

  Maximum Length: 240

  Additional information describing the reason for changing the ownership definition.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time the ownership definition was created.
• defaultOwnershipDefinitionFlag: boolean
  Title: Default Ownership Definition

  Read Only: true

  Indicates that the ownership definition is the default ownership definition of the joint venture.
• distributionExist: string
  Title: Distributions Exist

  Read Only: true

  Indicates whether joint venture distributions exist for the ownership definition.
• effectiveEndDate: string (date)
  Title: End Date

  The end date of the effective date range of the ownership definition.
• effectiveStartDate: string (date)
  Title: Start Date

  The start date of the effective date range of the ownership definition.
• externalStakeholderExistsFlag: boolean
  Title: External Stakeholder Exists

  Read Only: true

  Indicates that the ownership definition has at least one external stakeholder.
• internalStakeholderExistsFlag: boolean
  Title: Internal Stakeholder Exists

  Read Only: true

  Indicates that the ownership definition has at least one internal stakeholder.
• jointVentureDescription: string
  Title: Joint Venture Description

  Read Only: true

  Maximum Length: 240

  The description of the joint venture.
• jointVentureName: string
  Title: Joint Venture Name

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• ownershipChangeFlag: boolean
  Title: Ownership Definition Changed

  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether the ownership definition has changed and the associated joint venture distributions need to be rebilled.
• ownershipDefinitionDescription: string
  Title: Description

  Maximum Length: 240

  A description of the ownership definition.
• ownershipDefinitionDFF: array Ownership Definition Descriptive Flexfields
  Title: Ownership Definition Descriptive Flexfields

  The ownership definition descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership definition associated with a joint venture.
• ownershipDefinitionId: integer (int64)
  Title: Ownership Definition ID

  Read Only: true

  The unique identifier of the ownership definition.
• ownershipDefinitionShortName: string
  Title: Ownership Definition

  Maximum Length: 30

  The short name of the ownership definition that is used as an identifier across effective dates for the joint venture.
• ownershipDefinitionStatus: string
  Title: Status

  Maximum Length: 255

  The status of the ownership definition.
• ownershipPercentages: array Ownership Percentages
  Title: Ownership Percentages

  The ownership percentages resource is used to view, create, update, or delete each stakeholder???s percentage of ownership in an ownership definition. The percentages must total 100 percent for all stakeholders in the ownership definition.
• ownershipVersion: integer (int32)
  Title: Ownership Definition Version

  Read Only: true

  The version number of the ownership definition.
• sourceOwnershipDefinition: string
  Title: Source Ownership Definition

  Read Only: true

  Maximum Length: 30

  The name of the ownership definition used as the basis for creating the carried interest ownership definition.
• sourceOwnershipDefinitionDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the ownership definition used as the basis for creating the carried interest ownership definition.
• stakeholderGroup: string
  Title: Stakeholder Group

  Read Only: true

  Maximum Length: 30

  The name of the stakeholder group associated with the carried interest ownership definition.
• stakeholderGroupDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the stakeholder group associated with the carried interest ownership definition.
• totalPercentage: number
  Title: Total Percentage

  Read Only: true

  The sum of all percentages of ownership in the ownership definition.

{
    "type":"object",
    "properties":{
        "effectiveEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the effective date range of the ownership definition.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/jointVentures-ownershipDefinitions-attachments-item-response"
            }
        },
        "ownershipVersion":{
            "title":"Ownership Definition Version",
            "type":"integer",
            "description":"The version number of the ownership definition.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the ownership definition was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ownershipDefinitionShortName":{
            "title":"Ownership Definition",
            "maxLength":30,
            "type":"string",
            "description":"The short name of the ownership definition that is used as an identifier across effective dates for the joint venture.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ownershipDefinitionDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"A description of the ownership definition.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "jointVentureDescription":{
            "title":"Joint Venture Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "effectiveStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the effective date range of the ownership definition.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "sourceOwnershipDefinition":{
            "title":"Source Ownership Definition",
            "maxLength":30,
            "type":"string",
            "description":"The name of the ownership definition used as the basis for creating the carried interest ownership definition.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ownershipDefinitionId":{
            "title":"Ownership Definition ID",
            "type":"integer",
            "description":"The unique identifier of the ownership definition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "externalStakeholderExistsFlag":{
            "title":"External Stakeholder Exists",
            "type":"boolean",
            "description":"Indicates that the ownership definition has at least one external stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "totalPercentage":{
            "title":"Total Percentage",
            "type":"number",
            "description":"The sum of all percentages of ownership in the ownership definition.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "stakeholderGroup":{
            "title":"Stakeholder Group",
            "maxLength":30,
            "type":"string",
            "description":"The name of the stakeholder group associated with the carried interest ownership definition.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "activeFlag":{
            "title":"Invoicing Partner Active",
            "type":"boolean",
            "description":"Indicates whether the ownership definition is active or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the ownership definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ownershipDefinitionStatus":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "description":"The status of the ownership definition.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "agreement":{
            "title":"Agreement",
            "maxLength":30,
            "type":"string",
            "description":"The name of the carried interest agreement.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "defaultOwnershipDefinitionFlag":{
            "title":"Default Ownership Definition",
            "type":"boolean",
            "description":"Indicates that the ownership definition is the default ownership definition of the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "changeReason":{
            "title":"Change Reason",
            "maxLength":255,
            "type":"string",
            "description":"Indicates the reason for changing the effective dates on the ownership definition.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "LookupCode1"
                ]
            },
            "x-queryable":true
        },
        "stakeholderGroupDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the stakeholder group associated with the carried interest ownership definition.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "sourceOwnershipDefinitionDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the ownership definition used as the basis for creating the carried interest ownership definition.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "ownershipPercentages":{
            "title":"Ownership Percentages",
            "type":"array",
            "description":"The ownership percentages resource is used to view, create, update, or delete each stakeholder???s percentage of ownership in an ownership definition. The percentages must total 100 percent for all stakeholders in the ownership definition.",
            "items":{
                "$ref":"#/components/schemas/jointVentures-ownershipDefinitions-ownershipPercentages-item-response"
            }
        },
        "jointVentureName":{
            "title":"Joint Venture Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the joint venture.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time the ownership definition was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "distributionExist":{
            "title":"Distributions Exist",
            "type":"string",
            "description":"Indicates whether joint venture distributions exist for the ownership definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "changeReasonAdditionalText":{
            "title":"Change Reason Additional Information",
            "maxLength":240,
            "type":"string",
            "description":"Additional information describing the reason for changing the ownership definition.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the ownership definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ownershipDefinitionDFF":{
            "title":"Ownership Definition Descriptive Flexfields",
            "type":"array",
            "description":"The ownership definition descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership definition associated with a joint venture.",
            "items":{
                "$ref":"#/components/schemas/jointVentures-ownershipDefinitions-ownershipDefinitionDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ownershipChangeFlag":{
            "title":"Ownership Definition Changed",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the ownership definition has changed and the associated joint venture distributions need to be rebilled.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "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
        },
        "internalStakeholderExistsFlag":{
            "title":"Internal Stakeholder Exists",
            "type":"boolean",
            "description":"Indicates that the ownership definition has at least one internal stakeholder.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object jointVentures-ownershipDefinitions-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/jointVentures-ownershipDefinitions-attachments-item-response"
    }
}

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 Definition Descriptive Flexfields

Type: array

Title: Ownership Definition Descriptive Flexfields

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

Show Source

• Array of: object jointVentures-ownershipDefinitions-ownershipDefinitionDFF-item-response

{
    "title":"Ownership Definition Descriptive Flexfields",
    "type":"array",
    "description":"The ownership definition descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership definition associated with a joint venture.",
    "items":{
        "$ref":"#/components/schemas/jointVentures-ownershipDefinitions-ownershipDefinitionDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Ownership Percentages

Type: array

Title: Ownership Percentages

The ownership percentages resource is used to view, create, update, or delete each stakeholder???s percentage of ownership in an ownership definition. The percentages must total 100 percent for all stakeholders in the ownership definition.

Show Source

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

{
    "title":"Ownership Percentages",
    "type":"array",
    "description":"The ownership percentages resource is used to view, create, update, or delete each stakeholder???s percentage of ownership in an ownership definition. The percentages must total 100 percent for all stakeholders in the ownership definition.",
    "items":{
        "$ref":"#/components/schemas/jointVentures-ownershipDefinitions-ownershipPercentages-item-response"
    }
}

Nested Schema : jointVentures-ownershipDefinitions-attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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

Nested Schema : jointVentures-ownershipDefinitions-ownershipDefinitionDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 150

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

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

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

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OwnershipPercentageId":{
            "type":"integer",
            "description":"The unique identifier of the ownership definition.",
            "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 definition associated with the joint venture.",
            "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 definition associated with the joint venture.",
            "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"
    }
}

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

attachments

Operation: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/attachments

Parameters:

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

The attachments resource is used to view, create, and update attachments.

ownershipDefinitionDFF

Operation: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/ownershipDefinitionDFF

Parameters:

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

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

ownershipPercentages

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

Parameters:

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

The ownership percentages resource is used to view, create, update, or delete each stakeholder???s percentage of ownership in an ownership definition. The percentages must total 100 percent for all stakeholders in the ownership definition.

Back to Top

Examples

The following example shows how to update an ownership definition by submitting a PATCH request on the REST resource using cURL.

curl -i -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X PATCH -d @JVOwnershipDefinitionUpdate.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentures/300100184768422/child/ownershipDefinitions/300100185084421

Request Body Example

The following shows an example of the request body in JSON format.

{
  "effectiveEndDate" : "2010-12-31",
  "effectiveStartDate" : "2010-01-01",
  "ownershipDefinitionStatus" : "Inactive"
}

Response Body Example

The following shows an example of the response body in JSON format.

{
  "createdBy" : "username",
  "creationDate" : "2020-02-18T22:30:08+00:00",
  "effectiveEndDate" : "2010-12-31",
  "effectiveStartDate" : "2010-01-01",
  "lastUpdateDate" : "2020-02-18T22:37:24+00:00",
  "lastUpdatedBy" : "username",
  "ownershipDefinitionDescription" : "Ownership definition for the Apollo Basin North Project",
  "ownershipDefinitionShortName" : "APL_BASIN_NORTH_OD",
  "ownershipDefinitionId" : 300100185084421,
  "jointVentureDescription" : "Oklahoma panhandle project.\nLot32, Parcel 1TR5-A",
  "ownershipDefinitionStatus" : "Inactive",
  "jointVentureName" : "APOLLOBASIN",
  "defaultOwnershipDefinitionFlag" : false,
  "totalPercentage" : null,
  "internalStakeholderExistsFlag" : false,
  "externalStakeholderExistsFlag" : false,
  "activeFlag" : false,
}

Back to Top