Note
Subcategories:
|
Resource Plural Label |
Note |
|
Resource Name |
Note |
Get all Survey Answer Notes
Request: GET
URI:
/crmRestApi/resources/<version>/__ORACO__SurAnswer_c/{Id}/child/Note
Request Path Parameters
There are no request path parameters for this task.
Request Query Parameters
There are no request query parameters for this task.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 Survey Answers Notes
Request: POST
URI:
/crmRestApi/resources/<version>/__ORACO__SurAnswer_c/{Id}/child/Note
Request Path Parameters
There are no request path parameters for this task.
Request Body
This table summarizes the supported request body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Sample Request
{
"__ORACO__Answer_c": "PEltYWdlX1NlbGVjdGVkPg==",
"__ORACO__Question_c": "cGhvdG8gcXVlc3Rpb24gMg==",
"__ORACO__SurveyQuestion_Id_c": 300100543086201,
"__ORACO__Survey_Id_c" : 300100543090189
}
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Get a Survey Answer Note
Request: GET
URI:
/crmRestApi/resources/<version>/__ORACO__SurAnswer_c/{Id}/child/Note/{Id}
Request Path Parameters
There are no request path parameters for this task.
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 |
Update a Survey Answer Note
Request: PATCH
URI:
/crmRestApi/resources/<version>/__ORACO__SurAnswer_c/{Id}/child/Note/{Id}
Request Path Parameters
There are no request path parameters for this task.
Request Body
There are no elements in the request body for this task.
Sample Request
{
"__ORACO__Answer_c": "PEltYWdlX1NlbGVjdGVkPg==",
"__ORACO__Question_c": "cGhvdG8gcXVlc3Rpb24gMg==",
"__ORACO__Survey_Id_c" : 300100543090192
}
Response Body
This table summarizes the supported response body content types:
|
Media Type |
application/vnd.oracle.adf.resourcecollection+json |
Replace a Survey Answer Note
Request: PUT
URI:
/crmRestApi/resources/<version>/__ORACO__SurAnswer_c/{Id}/child/Note/{Id}
Request Path Parameters
There are no request path parameters for this task.
Sample Request
{
"__ORACO__Answer_c": "PEltYWdlX1NlbGVjdGVkPg==",
"__ORACO__Question_c": "cGhvdG8gcXVlc3Rpb24gMg==",
"__ORACO__SurveyQuestion_Id_c": 300100543086285,
}
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 Survey Answer Note
Request: DELETE
URI:
/crmRestApi/resources/<version>/__ORACO__SurAnswer_c/{Id}/child/Note/{Id}
There are no request path parameters for this task.
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. This is the primary key of the notes table. UI Label: Note ID |
|
SourceObjectCode |
string |
This is the source object code for the source object as defined in OBJECTS Metadata. Properties: The maximum length is 30. UI Label: Related Object Type |
|
SourceObjectId |
string |
The unique identifier of the parent source object associated to the note. Properties: The maximum length is 64. UI Label: Related Object |
|
PartyName |
string |
The name of the party. Properties: The maximum length is 360. UI Label: Author |
|
NoteTxt |
attachment |
The column which stores the actual note text. UI Label: Note |
|
NoteTypeCode |
string |
The note type code for categorization of note. Properties: The maximum length is 30. UI Label: Type |
|
VisibilityCode |
string |
The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private. Properties: The maximum length is 30. UI Label: Private |
|
CreatorPartyId |
integer |
The unique identifier of the party. UI Label: Creator Party ID |
|
CreatedBy |
string |
The user who created the record. Properties: The maximum length is 64. UI Label: Created By |
|
CreationDate |
datetime |
The date when the record was created. UI Label: Creation Date |
|
LastUpdateDate |
datetime |
The date when the record was last updated. UI Label: Last Update Date |
|
PartyId |
integer |
The unique identifier of the party. UI Label: Party ID |
|
CorpCurrencyCode |
string |
The corporate currency code for extensibility. Properties: The maximum length is 15. UI Label: Corporate Currency Code |
|
CurcyConvRateType |
string |
The currency conversion rate type for extensibility. Properties: The maximum length is 30. UI Label: Currency Conversion Rate Type |
|
CurrencyCode |
string |
The currency code for extensibility. Properties: The maximum length is 15. UI Label: Currency |
|
ContactRelationshipId |
integer |
The relationship ID populated when the note is associated with a contact. UI Label: Contact Relationship ID |
|
ParentNoteId |
integer |
The unique identifier of the note. This is the primary key of the notes table. UI Label: Parent Note ID |
|
LastUpdatedBy |
string |
The unique identifier of the note. This is the primary key of the notes table. 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 Email |
|
FormattedAddress |
string |
The address of the user who created the note. UI Label: Primary Address |
|
FormattedPhoneNumber |
string |
The phone number of the user who created the note. UI Label: Primary Phone |
|
UpdateFlag |
boolean |
Indicates whether the user can update the note. UI Label: Update Indicator |
|
DeleteFlag |
boolean |
Indicates whether the user has access to delete the note. UI Label: Delete Indicator |
|
NoteNumber |
string |
The alternate unique identifier of the note. A user key that is system generated or from an external system. |
|
NoteTitle |
string |
The title of the note entered by the user. Properties: The maximum length is 500. UI Label: Title |