Notes
The note resource is used to capture comments, information, or instructions for a route inventory transaction.
|
Resource Plural Label |
Notes |
|
Resource Name |
Note |
Get all notes
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__RouteInvTransDSD_c/{Id}/child/Note
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
| Id | integer | The unique identifier of the route inventory transaction. |
Request Query Parameters
Use these finder parameters to query the resource:
| Finder Name | Description |
|---|---|
| Primary Key |
Finds a note with the specified primary key. Finder Variables:
|
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Create a Note
Request: POST
URI: /crmRestApi/resources/11.13.18.05/__ORACO__RouteInvTransDSD_c/{Id}/child/Note
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
| Id | integer | The unique identifier of the route inventory transaction. |
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Get a Note
Request: GET
URI: /crmRestApi/resources/11.13.18.05/__ORACO__RouteInvTransDSD_c/{Id}/child/Note/{NoteId}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
| Id | integer | The unique identifier of the route inventory transaction. |
| NoteId | integer | The unique identifier of the note. |
Request Body
There are no elements in the request body for this task.
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Update a Note
Request: PATCH
URI: /crmRestApi/resources/11.13.18.05/__ORACO__RouteInvTransDSD_c/{Id}/child/Note/{NoteId}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
| Id | integer | The unique identifier of the route inventory transaction. |
| NoteId | integer | The unique identifier of the note. |
Request Body
This table summarizes the request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Replace a Note
Request: PUT
URI: /crmRestApi/resources/11.13.18.05/__ORACO__RouteInvTransDSD_c/{Id}/child/Note/{NoteId}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
| Id | integer | The unique identifier of the route inventory transaction. |
| NoteId | integer | The unique identifier of the note. |
Request Body
This table summarizes the request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Delete a Note
Request: DELETE
URI: /crmRestApi/resources/11.13.18.05/__ORACO__RouteInvTransDSD_c/{Id}/child/Note/{NoteId}
Request Path Parameters
This table summarizes the request path parameters:
| Name | Type | Description |
|---|---|---|
| Id | integer | The unique identifier of the route inventory transaction. |
| NoteId | integer | The unique identifier of the note. |
Request Body
There are no elements in the request body for this task.
Response Body
There are no elements in the response body for this task.
List of Values
This table lists all the list of values of the resource.
| LOV Name | Source Attribute in LOV | Target Attribute in Resource |
|---|---|---|
|
NoteSourceTypeVA |
MappedLookupCode |
NoteTypeCode |
|
NoteVisibilityLookupVA |
LookupCode |
VisibilityCode |
|
RatedCurrenciesVA |
CurrencyCode |
CurrencyCode |
Resource Attributes
This table lists all the attributes of the resource.
| Attribute Name | Attribute Type | Description |
|---|---|---|
|
NoteId |
integer |
The unique identifier of the note. UI Label: Note Id |
|
SourceObjectCode |
string |
The code indicating the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, Sales Business Plan. Properties: The maximum length is 30. UI Label: Related Object Type |
|
SourceObjectId |
string |
The unique identifier of the source objects as defined in OBJECTS Metadata, such as activities and opportunities. Properties: The maximum length is 64. UI Label: Related Object |
|
PartyName |
string |
The name of the party associated with the resource. Properties: The maximum length is 360. UI Label: Author |
|
NoteTxt |
attachment |
The actual note text. Properties: The maximum length is 0. UI Label: Note Text |
|
NoteTypeCode |
string |
The code for categorization of the note type. A list of valid values is defined in the lookup NoteSourceTypeVA. Properties: The maximum length is 30. UI Label: Type |
|
VisibilityCode |
string |
The visibility level of the note like private, internal, or external. A list of valid values is defined in the lookup NoteVisibilityLookupVA. Properties: The maximum length is 30. UI Label: Visibility |
|
CreatorPartyId |
integer |
The unique identifier of the person who created the note. UI Label: Creator Party ID |
|
CreatedBy |
string |
The user who created the note. Properties: The maximum length is 64. UI Label: Created By |
|
CreationDate |
datetime |
The date and time when the note was created. UI Label: Creation Date |
|
LastUpdateDate |
datetime |
The date when the note data was last updated. UI Label: Last Update Date |
|
PartyId |
integer |
The unique Identifier of the party to which the note is associated. UI Label: Party ID |
|
CorpCurrencyCode |
string |
The corporate currency code of the note associated with the record. This attribute is used by CRM Extensibility framework. 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. Properties: The maximum length is 15. UI Label: Corporate Currency Code |
|
CurcyConvRateType |
string |
The currency conversion rate type associated with the note. This attribute is used by CRM Extensibility framework. 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. Properties: The maximum length is 30. UI Label: Currency Conversion Rate Type |
|
CurrencyCode |
string |
The currency code associated with the note. This attribute is used by CRM Extensibility framework. A list of accepted values is defined in the lookup RatedCurrenciesVA. Properties: The maximum length is 15. UI Label: Currency |
|
ContactRelationshipId |
integer |
The unique identifier of the relationship populated when the note is associated with a contact. UI Label: Contact Relationship ID |
|
ParentNoteId |
integer |
The unique identifier of the parent note. UI Label: Parent Note ID |
|
LastUpdatedBy |
string |
The user who last updated the note. Properties: The maximum length is 64. UI Label: Last Updated By |
|
LastUpdateLogin |
string |
The login of the user who last updated the record. Properties: The maximum length is 32. UI Label: Last Update Login |
|
EmailAddress |
string |
The email address of the user who created the note. Properties: The maximum length is 320. UI Label: Primary E-Mail |
|
FormattedAddress |
string |
The address of the user who created the note. Properties: The maximum length is 0. UI Label: Primary Address |
|
FormattedPhoneNumber |
string |
The phone number of the user who created the note. Properties: The maximum length is 0. UI Label: Primary Phone |
|
UpdateFlag |
boolean |
Indicates whether the note can be updated. Properties: The maximum length is 0. UI Label: Update Indicator |
|
DeleteFlag |
boolean |
Indicates whether the note can be deleted. Properties: The maximum length is 0. UI Label: Delete Indicator |