Get a note
get
/crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note/{NoteId}
Request
Path Parameters
-
NoteId(required): integer(int64)
The unique identifier of the note.
-
PartyNumber(required): string
The unique alternate identifier for the account party. You can update the value if the profile option HZ_GENERATE_PARTY_NUMBER is set to True. The default value is a concatenation of the value specified in the profile option ZCA_PUID_PREFIX and a unique system generated sequence number. Inactive records can't be updated.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
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 : accounts-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 associated with the account. 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. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the note 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. A list of valid values are 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. -
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
Read Only:
true
Maximum Length:320
The email address of the user who created the note. -
FormattedAddress: string
Read Only:
true
The address of the user who created the note. -
FormattedPhoneNumber: string
Read Only:
true
The phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the note 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 the note. -
NoteNumber: string
Maximum Length:
30
The alternate unique identifier of the note. A user key that's system generated or from an external system. -
NoteTitle: string
Title:
Title
Maximum Length:500
The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
This is the column which will store the actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
This is the note type code for categorization of note. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The unique identifier of the parent note. -
PartyId: integer
(int64)
Read Only:
true
The unique Identifier of the account to which the note is associated. One of PartyId, PartyNumber or PartySourceSystem and PartySourceSystemReferenceValue keys is required to uniquely identify the account record with which the address is associated. Inactive records can't be updated. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
The name of a account party. -
smartActions: array
Smart Actions
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
The source_object_code of the source object as defined in OBJECTS Metadata. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The unique identifier of the source object, such as Activities, Opportunities etc., as defined in the OBJECTS Metadata. -
SourceSystem: string
Title:
Source System
Maximum Length:30
This is the source object code for the source object as defined in OBJECTS Metadata. -
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
This is the attribute to specify the visibility level of the note.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Smart Actions
Type:
array
Title:
Smart Actions
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
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 : accounts-Note-smartActions-item-response
Type:
Show Source
object
-
ActionIntent: string
(byte)
Title:
Action Intent
JSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation Message
Maximum Length:4000
The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run. -
ContentType: string
Title:
Content Type
Maximum Length:50
The media type of the smart action REST operation. -
DisplayLabel: string
Title:
Action Name
Maximum Length:256
The display name of the smart action. -
Entity: string
Title:
Parent Entity
Maximum Length:150
The primary object the smart action is associated with. For example, if the smart action creates an appointment for a lead, lead is the primary object. -
Href: string
Title:
REST Endpoint
Maximum Length:1024
The relative path of the smart action REST resource. The path can include path parameters. -
IncludedInApplication: string
Title:
Included in Application
Maximum Length:512
The client applications that the smart action is associated with. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass Action
Maximum Length:1
Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP Method
Maximum Length:15
The HTTP method of the smart action REST operation. -
ObjectFunctionName: string
Title:
Object Function
Maximum Length:64
The object function associated with the smart action. -
PageType: string
Title:
Page Type
Maximum Length:256
The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart Suggest
Maximum Length:1
Indicates whether smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Indicates whether the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to Update
Maximum Length:512
The object attribute to be updated as a result of using a data entry form. It is used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object. -
UserActionId: integer
(int64)
Title:
User Action ID
The unique system assigned identifier of the smart action definition. -
UserActionName: string
Title:
Action Name
Maximum Length:256
The unique system assigned smart action name. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
Priority
The number defining the relative position of the smart action in the list of smart actions displayed in a client application. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. -
UserActionURLBinding: array
Smart Action REST Path Parameter Definitions
Title:
Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type:
array
Title:
Smart Action REST Payload Definitions
The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : Smart Action REST Path Parameter Definitions
Type:
array
Title:
Smart Action REST Path Parameter Definitions
The path parameter definitions resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
Show Source
Nested Schema : accounts-Note-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object
-
Binding: string
Title:
Payload Value Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
Mandatory
Maximum Length:1
Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined. -
RequestPayloadId: integer
(int64)
The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
-
RequestPayloadName: string
Title:
Request Payload Attribute Name
Maximum Length:256
The value assigned to the name property of a name-value pair. -
SmartSuggestPath: string
Title:
Smart Suggest Path
Maximum Length:2048
The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
Value: string
Title:
Request Payload Attribute Value
Maximum Length:1000
The value assigned to the value property of a name-value pair. -
ValueStruct: string
Title:
Payload Value Structure
Maximum Length:20
A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accounts-Note-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object
-
Binding: string
Title:
URL Binding Type
Maximum Length:64
The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System Action
Maximum Length:1
Default Value:false
The system assigned value indicating whether the smart action is seeded or custom. 'True' indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag. -
URLBindingId: integer
(int64)
The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
-
URLBindingName: string
Title:
URL Binding Parameter Name
Maximum Length:256
The value assigned to the name property of a name-value pair. -
Value: string
Title:
URL Binding Parameter Value
Maximum Length:1000
The value assigned to the value property of a name-value pair.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- NoteSourceTypeVA
-
Operation: /crmRestApi/resources/11.13.18.05/noteTypesParameters:
- finder:
NoteTypeFinder%3BBindSourceObjectCode%3D{SourceObjectCode}
The list of values indicating the classification of the note, such as Asset or Adjustment.
The following properties are defined on the LOV link relation:- Source Attribute: NoteTypeCode; Target Attribute: MappedLookupCode
- Display Attribute: Meaning
- finder:
- NoteVisibilityLookupVA
-
Parameters:
- finder:
LookupTypeFinder%3BBindLookupType%3DZMM_NOTE_VISIBILITY
The list of values that indicates the visibility 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
- finder:
- RatedCurrenciesVA
-
The list of values that indicates the currency code used in the note, such as USD or GBP.
The following properties are defined on the LOV link relation:- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode
- smartActions
-
Operation: /crmRestApi/resources/11.13.18.05/accounts/{PartyNumber}/child/Note/{NoteId}/child/smartActionsParameters:
- NoteId:
$request.path.NoteId
- PartyNumber:
$request.path.PartyNumber
The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action. - NoteId:
Examples
The following example shows how to get a note by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts/ CDRM_336853/child/Note/300100116346326
Example of Response Body
The following shows an example of the response body in JSON format.
{ "NoteId" : 300100116346326, "SourceObjectCode" : "SALES_PARTY", "SourceObjectId" : "300100046354520", "PartyName" : "Gabrielle Lee", "NoteTypeCode" : "GENERAL", "VisibilityCode" : "INTERNAL", "CreatorPartyId" : 100010025532672, "NoteAttributeCategory" : null, "NoteAttributeUid1" : null, ... }