Update a note
patch
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Note/{NoteId}
Request
Path Parameters
-
NoteId(required): integer(int64)
The unique identifier of a note for the opportunity.
-
OptyNumber(required): string
The unique alternate identifier for the opportunity.
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
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the relationship that is populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the note associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique party identifier for the note creator. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
NoteTitle: string
Title:
Title
Maximum Length:500
The user provided title for the note. -
NoteTxt: string
(byte)
Title:
Note
The column which stores the actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
The code used to classify a note, as asset or adjustment. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The unique identifier of the source object as defined in OBJECTS Metadata, such as activities, opportunities, and so on. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The code indicating the visibility level of the note, such as internal or external.
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 : opportunities-Note-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the relationship that is populated when the note is associated with a contact. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the note associated with the contact. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the note record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the note record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique party identifier for the note creator. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the note is to be deleted. If the value is Y, then the note has to be deleted. The default value is N. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email address of the user who created the note. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
The formatted address of the user who created the note. -
FormattedPhoneNumber: string
Title:
Primary Phone
Read Only:true
The formatted phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the note data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
The unique identifier of a note for the opportunity. -
NoteNumber: string
Maximum Length:
30
The system generated number. It can be generated from external system also (user key). -
NoteTitle: string
Title:
Title
Maximum Length:500
The user provided title for the note. -
NoteTxt: string
(byte)
Title:
Note
The column which stores the actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
The code used to classify a note, as asset or adjustment. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The identifier for the parent note. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique Identifier of the party to which the note is associated. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
The name of party associated with the opportunity. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
The code indicating the type of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, and so on. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The unique identifier of the source object as defined in OBJECTS Metadata, such as activities, opportunities, and so on. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the note can be updated. If the value is Y, then the note can be updated. The default value is N. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The code indicating the visibility level of the note, such as internal or external.
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.
Links
- NoteSourceTypeVA
-
Operation: /crmRestApi/resources/11.13.18.05/noteTypesParameters:
- finder:
NoteTypeFinder%3BBindSourceObjectCode%3D{SourceObjectCode}
The note types resource is used to view the note type. - finder:
- NoteVisibilityLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DZMM_NOTE_VISIBILITY
Visibility Code - finder:
- RatedCurrenciesVA
-
Currency
Examples
The following example shows how to update a note by submitting a patch request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X
PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/CDRM_332708/child/Note/300100111705708
Example of Request Body
The following shows an example of the request body in JSON format.
{ "CurrencyCode": "GBP" }
Example of Response Body
The following shows an example of the response body in JSON format.
{ NoteId: 300100111705708 SourceObjectCode: "OPPORTUNITY" SourceObjectId: "300100111705686" PartyName: "Gabrielle Lee" NoteTypeCode: "GENERAL" VisibilityCode: "EXTERNAL" CreatorPartyId: 100010025532672 CreatedBy: "SALES_ADMIN" CreationDate: "2015-06-04T04:14:12-07:00" LastUpdateDate: "2015-06-04T04:35:30-07:00" PartyId: 100010025532672 CorpCurrencyCode: "USD" CurcyConvRateType: "Corporate" CurrencyCode: "GBP" }