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:
Show Source
object
-
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.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
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
Nested Schema : jointVentures-stakeholders-attachments-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
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.
Nested Schema : schema
Type:
Show Source
object
-
__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.
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:
Show Source
object
-
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.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : jointVentures-stakeholders-attachments-item-response
Type:
Show Source
object
-
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
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : jointVentures-stakeholders-stakeholderDFF-item-response
Type:
Show Source
object
-
__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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- attachments
-
Parameters:
- jointVentureId:
$request.path.jointVentureId
- stakeholderId:
$request.path.stakeholderId
The attachments resource is used to view, create, and update attachments. - jointVentureId:
- 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. - jointVentureId:
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, }