Create a business plan note
post
/crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Note
Request
Path Parameters
-
BusinessPlanId(required): integer(int64)
The unique identifier of the business plan.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the relationshi, this value 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. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique identifier of the note creator's party. -
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. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the note. A list of accepted values is defined in the lookup RatedCurrenciesVA. -
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
The actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
This is the note type code for categorization of note. A list of valid values is defined in the lookup NoteSourceTypeVA. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The unique identifier of the parent note. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
The code indicating the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, Sales Business Plan. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The primary key identifier of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, Sales Business Plan. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
This is the attribute to specify the visibility level of the note. A list of valid values is defined in the lookup NoteVisibilityLookupVA.
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 : businessPlans-Note-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the relationshi, this value 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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique identifier of the note creator's party. -
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. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the note. A list of accepted values is defined in the lookup RatedCurrenciesVA. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the business plan note can be deleted. The default value is true. -
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 address of the user who created the note. -
FormattedPhoneNumber: string
Title:
Primary Phone
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 when the record 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 for the business plan. -
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
The actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
This is the note type code for categorization of note. A list of valid values is defined in the lookup NoteSourceTypeVA. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The unique identifier of the parent note. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique Identifier of the contact with whom the note is associated. In this case, same as CreatorPartyId. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
The name of party associated with the business plan. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
The code indicating the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, Sales Business Plan. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The primary key identifier of the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, Sales Business Plan. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the business plan note can be updated. The default value is true. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
This is the attribute to specify the visibility level of the note. A list of valid values is defined in the lookup NoteVisibilityLookupVA.
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 list of values for the code for categorization of the note type, such as General or Official.
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 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
- finder:
- RatedCurrenciesVA
-
The list of values for the currency conversion rate type associated with the note, 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
Examples
The following example shows how to create a business plan note by submitting a POST request on the REST resource using cURL.
cURL Command
- curl -u <username:password> \ -X http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/businessPlans/300100091979253/child/Note
Example of Request Body
The following shows an example of the request body in JSON format..
{ "VisibilityCode": "INTERNAL", "NoteTypeCode": "GENERAL", "NoteTxt": "This Business Plan is" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "NoteId": 300100091979264, "SourceObjectCode": "SALES_BUSINESS_PLAN", "SourceObjectId": "300100091979253", "PartyName": "Matt Hooper", "NoteTypeCode": "GENERAL", "VisibilityCode": "INTERNAL", "CreatorPartyId": 100010037456865, "CreatedBy": "MHoope", "CreationDate": "2016-12-12T03:44:33-08:00", "LastUpdateDate": "2016-12-12T03:44:33-08:00", "PartyId": 100010037456865, "CorpCurrencyCode": "USD", "CurcyConvRateType": "Corporate", "CurrencyCode": "USD", "ContactRelationshipId": null, "ParentNoteId": null, "LastUpdatedBy": "MHoope", "LastUpdateLogin": "4373F6AF02325539E05364C0F20A8DA6", ... }