REST API for Oracle Fusion Cloud Financials

Update a joint venture stakeholder

patch

/fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders/{stakeholderId}

Request

Path Parameters

jointVentureId(required): integer(int64)

The unique identifier of the joint venture.
stakeholderId(required): integer(int64)

The unique identifier for joint venture stakeholder.

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

Root Schema : schema

Type: object

Show Source

attachments: array Attachments

Title: Attachments

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

Title: Classification

Indicates the classification of a stakeholder as an operator or a nonoperator.
costCenterSegmentValue: string

Title: Cost Center

Maximum Length: 25

The cost center segment value associated with the joint venture stakeholder.
distributionOnlyFlag: boolean

Title: Distribution Only

Maximum Length: 1

The flag that indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced.
internalStakeholderFlag: boolean

Title: Stakeholder Type

Maximum Length: 1

The flag that indicates whether the joint venture stakeholder is internal or external.
invoicingPartnerName: string

Title: Invoicing Partner

Maximum Length: 255

The invoicing partner name associated with the joint venture stakeholder.
jibOutputFormat: string

Title: Joint Interest Billing Report Output Format

The format of the Joint Interest Billing report output associated with the stakeholder.
jibTemplateName: string

Title: Joint Interest Billing Report Template

Maximum Length: 100

The name of the Joint Interest Billing report template associated with the stakeholder.
partyAddress: string

Title: Party Address

Maximum Length: 960

The address of the party.
partyEmail: string

Title: Party Email

Maximum Length: 255

The email address of the party.
partyName: string

Title: Contact Person

Maximum Length: 255

The name of the party.
partyNumber: string

Title: Party Number

Maximum Length: 255

The party number.
partyPhone: string

Title: Party Phone

The phone number of the party.
preferredCurrencyCode: string

Title: Preferred Currency

Maximum Length: 15

The preferred currency code defined for the stakeholder to use when creating joint venture invoices.
stakeholderDescription: string

Title: Description

Maximum Length: 240

The description of the joint venture stakeholder.
stakeholderDFF: array Stakeholder Descriptive Flexfields

Title: Stakeholder Descriptive Flexfields

The stakeholder descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture stakeholder.
stakeholderShortName: string

Title: Stakeholder

Maximum Length: 30

The short name of the joint venture stakeholder.
stakeholderStatus: string

Title: Status

Maximum Length: 255

The status of the joint venture stakeholder.
stakeholderTypeCode: string

Title: Stakeholder Category

Maximum Length: 255

The joint venture stakeholder type.

{
    "type":"object",
    "properties":{
        "invoicingPartnerName":{
            "title":"Invoicing Partner",
            "maxLength":255,
            "type":"string",
            "description":"The invoicing partner name associated with the joint venture stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "invoicingPartnerShortName"
                ]
            }
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/jointVentures-stakeholders-attachments-item-patch-request"
            }
        },
        "stakeholderDFF":{
            "title":"Stakeholder Descriptive Flexfields",
            "type":"array",
            "description":"The stakeholder descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture stakeholder.",
            "items":{
                "$ref":"#/components/schemas/jointVentures-stakeholders-stakeholderDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "stakeholderDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the joint venture stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "classification":{
            "title":"Classification",
            "type":"string",
            "description":"Indicates the classification of a stakeholder as an operator or a nonoperator.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCodeClassification"
                ]
            }
        },
        "stakeholderShortName":{
            "title":"Stakeholder",
            "maxLength":30,
            "type":"string",
            "description":"The short name of the joint venture stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "jibOutputFormat":{
            "title":"Joint Interest Billing Report Output Format",
            "type":"string",
            "description":"The format of the Joint Interest Billing report output associated with the stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "reportOutputFormatLookupCode"
                ]
            }
        },
        "stakeholderStatus":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "description":"The status of the joint venture stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCode"
                ]
            }
        },
        "partyPhone":{
            "title":"Party Phone",
            "type":"string",
            "description":"The phone number of the party.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "partyEmail":{
            "title":"Party Email",
            "maxLength":255,
            "type":"string",
            "description":"The email address of the party.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "internalStakeholderFlag":{
            "title":"Stakeholder Type",
            "maxLength":1,
            "type":"boolean",
            "description":"The flag that indicates whether the joint venture stakeholder is internal or external.",
            "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"
            }
        },
        "partyName":{
            "title":"Contact Person",
            "maxLength":255,
            "type":"string",
            "description":"The name of the party.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "costCenterSegmentValue":{
            "title":"Cost Center",
            "maxLength":25,
            "type":"string",
            "description":"The cost center segment value associated with the joint venture stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "partyAddress":{
            "title":"Party Address",
            "maxLength":960,
            "type":"string",
            "description":"The address of the party.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "stakeholderTypeCode":{
            "title":"Stakeholder Category",
            "maxLength":255,
            "type":"string",
            "description":"The joint venture stakeholder type.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCode1"
                ]
            }
        },
        "partyNumber":{
            "title":"Party Number",
            "maxLength":255,
            "type":"string",
            "description":"The party number.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "partyNumber1"
                ]
            }
        },
        "preferredCurrencyCode":{
            "title":"Preferred Currency",
            "maxLength":15,
            "type":"string",
            "description":"The preferred currency code defined for the stakeholder to use when creating joint venture invoices.",
            "nullable":true
        },
        "jibTemplateName":{
            "title":"Joint Interest Billing Report Template",
            "maxLength":100,
            "type":"string",
            "description":"The name of the Joint Interest Billing report template associated with the stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "distributionOnlyFlag":{
            "title":"Distribution Only",
            "maxLength":1,
            "type":"boolean",
            "description":"The flag that indicates whether the joint venture stakeholder is only participating in the transaction distribution and 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 : Attachments

Type: array

Title: Attachments

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

Show Source

Array of: object jointVentures-stakeholders-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-stakeholders-attachments-item-patch-request"
    }
}

Nested Schema : Stakeholder Descriptive Flexfields

Type: array

Title: Stakeholder Descriptive Flexfields

The stakeholder descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture stakeholder.

Show Source

Array of: object schema

{
    "title":"Stakeholder Descriptive Flexfields",
    "type":"array",
    "description":"The stakeholder descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture stakeholder.",
    "items":{
        "$ref":"#/components/schemas/jointVentures-stakeholders-stakeholderDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : jointVentures-stakeholders-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 joint venture stakeholder.
__FLEX_Context_DisplayValue: string

Title: Context Segment

The descriptive flexfield context display value for the joint venture stakeholder.

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

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.

Root Schema : jointVentures-stakeholders-item-response

Type: object

Show Source

attachments: array Attachments

Title: Attachments

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

Title: Classification

Indicates the classification of a stakeholder as an operator or a nonoperator.
costCenterSegmentValue: string

Title: Cost Center

Maximum Length: 25

The cost center segment value associated with the joint venture stakeholder.
createdBy: string

Title: Created By

Read Only: true

Maximum Length: 64

The user who created the joint venture stakeholder.
creationDate: string (date-time)

Title: Creation Date

Read Only: true

The data and time the joint venture stakeholder was created.
distributionOnlyFlag: boolean

Title: Distribution Only

Maximum Length: 1

The flag that indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced.
internalStakeholderFlag: boolean

Title: Stakeholder Type

Maximum Length: 1

The flag that indicates whether the joint venture stakeholder is internal or external.
invoicingPartnerName: string

Title: Invoicing Partner

Maximum Length: 255

The invoicing partner name associated with the joint venture stakeholder.
jibOutputFormat: string

Title: Joint Interest Billing Report Output Format

The format of the Joint Interest Billing report output associated with the stakeholder.
jibTemplateName: string

Title: Joint Interest Billing Report Template

Maximum Length: 100

The name of the Joint Interest Billing report template associated with the stakeholder.
lastUpdateDate: string (date-time)

Title: Last Updated Date

Read Only: true

The date and time the joint venture stakeholder was last updated.
lastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

The user who last updated the joint venture stakeholder.
links: array Links

Title: Links

The link relations associated with the resource instance.
partyAddress: string

Title: Party Address

Maximum Length: 960

The address of the party.
partyEmail: string

Title: Party Email

Maximum Length: 255

The email address of the party.
partyName: string

Title: Contact Person

Maximum Length: 255

The name of the party.
partyNumber: string

Title: Party Number

Maximum Length: 255

The party number.
partyPhone: string

Title: Party Phone

The phone number of the party.
preferredCurrencyCode: string

Title: Preferred Currency

Maximum Length: 15

The preferred currency code defined for the stakeholder to use when creating joint venture invoices.
stakeholderDescription: string

Title: Description

Maximum Length: 240

The description of the joint venture stakeholder.
stakeholderDFF: array Stakeholder Descriptive Flexfields

Title: Stakeholder Descriptive Flexfields

The stakeholder descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture stakeholder.
stakeholderId: integer (int64)

Title: Stakeholder ID

Read Only: true

The unique identifier for joint venture stakeholder.
stakeholderShortName: string

Title: Stakeholder

Maximum Length: 30

The short name of the joint venture stakeholder.
stakeholderStatus: string

Title: Status

Maximum Length: 255

The status of the joint venture stakeholder.
stakeholderTypeCode: string

Title: Stakeholder Category

Maximum Length: 255

The joint venture stakeholder type.

{
    "type":"object",
    "properties":{
        "invoicingPartnerName":{
            "title":"Invoicing Partner",
            "maxLength":255,
            "type":"string",
            "description":"The invoicing partner name associated with the joint venture stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "invoicingPartnerShortName"
                ]
            },
            "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-stakeholders-attachments-item-response"
            }
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time the joint venture stakeholder was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "stakeholderDFF":{
            "title":"Stakeholder Descriptive Flexfields",
            "type":"array",
            "description":"The stakeholder descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture stakeholder.",
            "items":{
                "$ref":"#/components/schemas/jointVentures-stakeholders-stakeholderDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "stakeholderShortName":{
            "title":"Stakeholder",
            "maxLength":30,
            "type":"string",
            "description":"The short name of the joint venture stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "partyPhone":{
            "title":"Party Phone",
            "type":"string",
            "description":"The phone number of the party.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "internalStakeholderFlag":{
            "title":"Stakeholder Type",
            "maxLength":1,
            "type":"boolean",
            "description":"The flag that indicates whether the joint venture stakeholder is internal or external.",
            "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
        },
        "partyName":{
            "title":"Contact Person",
            "maxLength":255,
            "type":"string",
            "description":"The name of the party.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "costCenterSegmentValue":{
            "title":"Cost Center",
            "maxLength":25,
            "type":"string",
            "description":"The cost center segment value associated with the joint venture stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "preferredCurrencyCode":{
            "title":"Preferred Currency",
            "maxLength":15,
            "type":"string",
            "description":"The preferred currency code defined for the stakeholder to use when creating joint venture invoices.",
            "nullable":true,
            "x-queryable":true
        },
        "jibTemplateName":{
            "title":"Joint Interest Billing Report Template",
            "maxLength":100,
            "type":"string",
            "description":"The name of the Joint Interest Billing report template associated with the stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "stakeholderId":{
            "title":"Stakeholder ID",
            "type":"integer",
            "description":"The unique identifier for joint venture stakeholder.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the joint venture stakeholder.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The data and time the joint venture stakeholder 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,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "classification":{
            "title":"Classification",
            "type":"string",
            "description":"Indicates the classification of a stakeholder as an operator or a nonoperator.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCodeClassification"
                ]
            },
            "x-queryable":true
        },
        "jibOutputFormat":{
            "title":"Joint Interest Billing Report Output Format",
            "type":"string",
            "description":"The format of the Joint Interest Billing report output associated with the stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "reportOutputFormatLookupCode"
                ]
            },
            "x-queryable":true
        },
        "stakeholderStatus":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "description":"The status of the joint venture stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCode"
                ]
            },
            "x-queryable":true
        },
        "partyEmail":{
            "title":"Party Email",
            "maxLength":255,
            "type":"string",
            "description":"The email address of the party.",
            "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 joint venture stakeholder.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "partyAddress":{
            "title":"Party Address",
            "maxLength":960,
            "type":"string",
            "description":"The address of the party.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "stakeholderTypeCode":{
            "title":"Stakeholder Category",
            "maxLength":255,
            "type":"string",
            "description":"The joint venture stakeholder type.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "lookupCode1"
                ]
            },
            "x-queryable":true
        },
        "partyNumber":{
            "title":"Party Number",
            "maxLength":255,
            "type":"string",
            "description":"The party number.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "partyNumber1"
                ]
            },
            "x-queryable":true
        },
        "distributionOnlyFlag":{
            "title":"Distribution Only",
            "maxLength":1,
            "type":"boolean",
            "description":"The flag that indicates whether the joint venture stakeholder is only participating in the transaction distribution and 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 : Attachments

Type: array

Title: Attachments

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

Show Source

Array of: object jointVentures-stakeholders-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/jointVentures-stakeholders-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 : Stakeholder Descriptive Flexfields

Type: array

Title: Stakeholder Descriptive Flexfields

The stakeholder descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture stakeholder.

Show Source

Array of: object jointVentures-stakeholders-stakeholderDFF-item-response

{
    "title":"Stakeholder Descriptive Flexfields",
    "type":"array",
    "description":"The stakeholder descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture stakeholder.",
    "items":{
        "$ref":"#/components/schemas/jointVentures-stakeholders-stakeholderDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : jointVentures-stakeholders-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-stakeholders-stakeholderDFF-item-response

Type: object

Show Source

__FLEX_Context: string

Title: Context Segment

Maximum Length: 150

The descriptive flexfield context name for the joint venture stakeholder.
__FLEX_Context_DisplayValue: string

Title: Context Segment

The descriptive flexfield context display value for the joint venture stakeholder.
links: array Links

Title: Links

The link relations associated with the resource instance.
StakeholderId: integer (int64)

The unique identifier of the joint venture stakeholder.

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

Parameters:

jointVentureId: $request.path.jointVentureId
stakeholderId: $request.path.stakeholderId

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

stakeholderDFF

Operation: /fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders/{stakeholderId}/child/stakeholderDFF

Parameters:

jointVentureId: $request.path.jointVentureId
stakeholderId: $request.path.stakeholderId

The stakeholder descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture stakeholder.

Examples

The following example shows how to update a stakeholder 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 @JVUpdateJVStakeholder.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentures/300100184768422/child/stakeholders/300100185158414

Request Body Example

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

 {
    "stakeholderStatus" : "Inactive",
    "distributionOnlyFlag" : true
 }

Response Body Example

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

{
  "costCenterSegmentValue" : "120",
  "invoicingPartnerName" : null,
  "createdBy" : "username",
  "creationDate" : "2020-02-20T16:12:04+00:00",
  "internalStakeholderFlag" : true,
  "lastUpdateDate" : "2020-02-20T18:06:08+00:00",
  "lastUpdatedBy" : "username",
  "stakeholderDescription" : "Apollo Drilling Service",
  "stakeholderId" : 300100185158414,
  "stakeholderShortName" : "APOLLODRILLING",
  "stakeholderStatus" : "Inactive",
  "stakeholderTypeCode" : null,
  "partyNumber" : null,
  "distributionOnlyFlag" : true,
  "partyAddress" : null,
  "partyEmail" : null,
  "partyPhone" : null,
  "partyName" : null,
}