1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Households
  4. Notes

Update a note

patch

/crmRestApi/resources/11.13.18.05/households/{PartyNumber}/child/Note/{NoteId}

Request

Path Parameters
  • The unique identifier of the note. This is the primary key of the notes table.
  • The unique primary identifier for the household party. The profile option HZ_GENERATE_PARTY_NUMBER controls whether the attribute value can be system generated or user-provided during create. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Profile Options task. Inactive records can't be updated.
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Contact Relationship ID
    The unique identifier of the relationship that is populated when the note is associated with a contact.
  • Title: Corporate Currency Code
    Maximum Length: 15
    The corporate currency code associated with the note. 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.
  • Title: Creator Party ID
    The unique identifier of the person who created the note.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type associated with the note. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Currency
    Maximum Length: 15
    The currency code attribute associated with the note. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Title
    Maximum Length: 500
    The title of the note entered by the user.
  • Title: Note
    The column which will store the actual note text.
  • Title: Type
    Maximum Length: 30
    The code used to classify a note, as asset or adjustment.
  • Smart Actions
    Title: Smart Actions
    This VO stores the endpoint and security details for every user action.
  • Title: Related Object
    Maximum Length: 64
    The unique identifier of the source object as defined in OBJECTS Metadata, such as activities, opportunities, etc.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    Specifies the visibility level of the note.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : households-Note-smartActions-item-patch-request
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : households-Note-smartActions-UserActionNavigation-item-patch-request
Type: object
Show Source
Nested Schema : households-Note-smartActions-UserActionRequestPayload-item-patch-request
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    Indicates the binding type of the value.
  • Title: Mandatory
    Maximum Length: 1
    Boolean value indicating if the payload is mandatory.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The key in the Key Value pair that forms the payload.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean value.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value in the Key Value pair that forms the payload.
  • Title: Payload Value Structure
    Maximum Length: 20
    If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : households-Note-smartActions-UserActionURLBinding-item-patch-request
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : households-Note-item-response
Type: object
Show Source
  • Title: Contact Relationship ID
    The unique identifier of the relationship that is populated when the note is associated with a contact.
  • Title: Corporate Currency Code
    Maximum Length: 15
    The corporate currency code associated with the note. 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.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Title: Creator Party ID
    The unique identifier of the person who created the note.
  • Title: Currency Conversion Rate Type
    Maximum Length: 30
    The currency conversion rate type associated with the note. A list of valid values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Currency
    Maximum Length: 15
    The currency code attribute associated with the note. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • 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.
  • Read Only: true
    Maximum Length: 320
    The email address of the user who created the note.
  • Read Only: true
    The address of the user who created the note.
  • Read Only: true
    The phone number of the user who created the note.
  • Title: Last Update Date
    Read Only: true
    The date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Note ID
    Read Only: true
    The unique identifier of the note. This is the primary key of the notes table.
  • Maximum Length: 30
    The alternate unique identifier of the note. A user key that's system generated or from an external system.
  • Title: Title
    Maximum Length: 500
    The title of the note entered by the user.
  • Title: Note
    The column which will store the actual note text.
  • Title: Type
    Maximum Length: 30
    The code used to classify a note, as asset or adjustment.
  • Title: Parent Note ID
    The unique identifier of the parent note.
  • Read Only: true
    The unique identifier for the party.
  • Title: Author
    Read Only: true
    Maximum Length: 360
    The name of the author of the note.
  • Smart Actions
    Title: Smart Actions
    This VO stores the endpoint and security details for every user action.
  • 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, etc.
  • Title: Related Object
    Maximum Length: 64
    The unique identifier of the source object as defined in OBJECTS Metadata, such as activities, opportunities, etc.
  • Title: Source System
    Maximum Length: 30
    This is the source object code for the source object as defined in OBJECTS Metadata.
  • 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.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    Specifies the visibility level of the note.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : households-Note-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : households-Note-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : households-Note-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : households-Note-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Links
NoteSourceTypeVA
Parameters:
  • finder: NoteTypeFinder%3BBindSourceObjectCode%3D{SourceObjectCode}
The list of values for the note type code for categorization of note, such as General or Official.

The following properties are defined on the LOV link relation:
  • Source Attribute: NoteTypeCode; Target Attribute: MappedLookupCode
  • Display Attribute: Meaning
NoteVisibilityLookupVA
Parameters:
  • finder: LookupTypeFinder%3BBindLookupType%3DZMM_NOTE_VISIBILITY
The list of values for the visibility level of the note, such as External or Internal.

The following properties are defined on the LOV link relation:
  • Source Attribute: VisibilityCode; Target Attribute: LookupCode
  • Display Attribute: Meaning
RatedCurrenciesVA
The list of values for the corporate currency code, such as US Dollar or Indian Rupee.

The following properties are defined on the LOV link relation:
  • Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
  • Display Attribute: CurrencyCode
smartActions
Parameters:
  • NoteId: $request.path.NoteId
  • PartyNumber: $request.path.PartyNumber
This VO stores the endpoint and security details for every user action.
Back to Top

Examples

cURL Command

The following example shows how to update a note by submitting a patch request on the REST resource using cURL.

curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/ households/CDRM_8034/child/Note/300100057743154

Example of Request Body

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

{
    "NoteTxt": "aabbbsVGVzdCBOb3RlIFVzaW5nIFJlc3QgMT",
    "VisibilityCode": "INTERNAL",
    "NoteTypeCode": "GENERAL",
    "CreatorPartyId": "100010025532672"
}

Example of Response Body

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

{
    "NoteId": "300100057743154",
    "VisibilityCode": "INTERNAL",
    "NoteTypeCode": "GENERAL",
    "CreatorPartyId": "100010025532672",
    "PartyName": "Gabrielle Lee",
    "SourceObjectCode": "SALES_PARTY",
    "SourceObjectId": "300100014465229",
    "PartyId": "100010025532672",
    ...
	}
Back to Top