Create a business plan
post
/crmRestApi/resources/11.13.18.05/businessPlans
Request
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
-
BusinessPlanAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
BusinessPlanClassCode: string
Title:
Class
Maximum Length:20
Default Value:PARTNER
A code indicating the class of a business plan. A list of valid values is defined in the lookup BusinessPlanClassVA. -
BusinessPlanId: integer
(int64)
Title:
Business Plan ID
The unique identifier of the business plan. -
BusinessPlanNumber: string
Title:
Number
Maximum Length:64
The alternate key identifier of a business plan. -
BusinessPlanOwnerId: integer
(int64)
Title:
Owner ID
The unique identifier of the business plan owner. -
BusinessPlanResource: array
Business Plan Resources
Title:
Business Plan Resources
Business plan resources is used to view, create, update, and delete the team members associated with a business plan. -
BusinessPlanTypeCode: string
Title:
Type
Maximum Length:30
The code indicating the type of business plan. A list of valid values is defined in the lookup BusinessPlanTypeVA. -
CustomerId: integer
(int64)
Title:
Customer ID
The unique identifier of the business plan account. -
Description: string
Title:
Description
Maximum Length:3000
The description of the business plan. -
Name(required): string
Title:
Name
Maximum Length:275
The name of the business plan. -
Note: array
Notes
Title:
Notes
The notes resource is used to view, create, update, and delete notes associated with a business plan. A note captures comments, information, or instructions related to an business plan. -
OrigCreationDate: string
(date-time)
Title:
Original Creation Date
The date when the business plan was first created. -
OwnerResourceName: string
Title:
Owner
Maximum Length:360
The name of the business plan owner. -
PartnerId: integer
(int64)
Title:
Partner ID
The unique identifier of the business plan partner. -
PartnerNumber: string
Title:
Partner Number
Maximum Length:30
Alternate Key corresponding to PartnerId. -
PartnerPartyDisplayName: string
Title:
Partner
Maximum Length:360
The display name of the partner for the business plan. -
PeriodEndDisplayName: string
Title:
Period End Name
Maximum Length:30
The display name for the end of the business plan period. -
PeriodEndName: string
Title:
Period End Internal Name
Maximum Length:30
The internal name for the end of the business plan period. -
PeriodRangeDisplayName: string
Title:
Period
Maximum Length:80
The display name of the business period range. -
PeriodSetName: string
Maximum Length:
15
The name of the calendar for the business plan period. -
PeriodStartDisplayName: string
Title:
Period Start Name
Maximum Length:30
The display name for the start of the business plan period. -
PeriodStartName: string
Title:
Period Start Internal Name
Maximum Length:30
The internal name for the start of the business plan period. -
PeriodTypeCode(required): string
Title:
Period Type
Maximum Length:30
The code indicating the period of the business plan. A list of valid values is defined in the lookup SalesObjectiveGLPeriodTypeViewAccessor. -
StatusCode(required): string
Title:
Status
Maximum Length:30
The code indicating the status of the business plan. A list of valid values is defined in the lookup BusinessPlanStatusVA. -
Swot: array
SWOTs
Title:
SWOTs
The SWOTs resource is used to view, create, update, and delete a business plan's strengths, weaknesses, opportunities, and threats.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Business Plan Resources
Type:
array
Title:
Business Plan Resources
Business plan resources is used to view, create, update, and delete the team members associated with a business plan.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The notes resource is used to view, create, update, and delete notes associated with a business plan. A note captures comments, information, or instructions related to an business plan.
Show Source
Nested Schema : SWOTs
Type:
array
Title:
SWOTs
The SWOTs resource is used to view, create, update, and delete a business plan's strengths, weaknesses, opportunities, and threats.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment.
Nested Schema : businessPlans-BusinessPlanResource-item-post-request
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
The code indicating the access level of a team member. A list of valid values is defined in the lookup ORA_ZCA_BUS_PLAN_ACCESS_LEVEL. -
BusinessPlanId: integer
(int64)
Title:
Business Plan ID
The unique identifier of the business plan. -
BusinessPlanNumber: string
Title:
Number
Maximum Length:64
Parent puid. -
BusinessPlanResourceId: integer
(int64)
Title:
Business Plan Resource ID
The unique identifier of the business plan resource. -
BusinessPlanResourceNumber: string
Title:
Resource Number
Maximum Length:230
The alternate key identifier for business plan resource. -
MemberFunctionCode: string
Title:
Function
Maximum Length:30
The code indicating the function of a team member. A list of valid values is defined in the lookup MemberFunctionCodesVA. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the resource.
Nested 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.
Nested Schema : schema
Type:
Show Source
object
-
BusinessPlanId: integer
(int64)
Title:
Business Plan ID
The unique identifier of the business plan. -
BusinessPlanNumber: string
Title:
Business Plan Number
Maximum Length:64
Parent puid. -
Description: string
Title:
Description
Maximum Length:2000
The description of the SWOT. -
SWOTId: integer
(int64)
Title:
SWOT ID
The unique identifier of the business plan SWOT. -
SWOTNumber: string
Title:
Number
Maximum Length:64
The alternate key identifier for the business plan SWOT. -
SWOTTypeCode: string
Title:
Type Code
Maximum Length:30
The code indicating the type of business plan SWOT. A list of valid values is defined in the lookup ORA_ZCA_BUS_PLAN_SWOT. Possible values are Opportunity, Strength, Threat, or Weakmess.
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-item-response
Type:
Show Source
object
-
BusinessPlanAttachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
BusinessPlanClassCode: string
Title:
Class
Maximum Length:20
Default Value:PARTNER
A code indicating the class of a business plan. A list of valid values is defined in the lookup BusinessPlanClassVA. -
BusinessPlanId: integer
(int64)
Title:
Business Plan ID
The unique identifier of the business plan. -
BusinessPlanNumber: string
Title:
Number
Maximum Length:64
The alternate key identifier of a business plan. -
BusinessPlanOwnerId: integer
(int64)
Title:
Owner ID
The unique identifier of the business plan owner. -
BusinessPlanOwnerNumber: string
Title:
Owner Number
Read Only:true
Maximum Length:30
Alternate key corresponding to BusinessPlanOwnerId. -
BusinessPlanResource: array
Business Plan Resources
Title:
Business Plan Resources
Business plan resources is used to view, create, update, and delete the team members associated with a business plan. -
BusinessPlanTypeCode: string
Title:
Type
Maximum Length:30
The code indicating the type of business plan. A list of valid values is defined in the lookup BusinessPlanTypeVA. -
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. -
CustomerId: integer
(int64)
Title:
Customer ID
The unique identifier of the business plan account. -
CustomerNumber: string
Title:
Customer Number
Read Only:true
Maximum Length:30
Alternate Key corresponding to CustomerId. -
CustomerPartyType: string
Title:
Customer Type
Read Only:true
Maximum Length:30
The party type of the customer associated with the business plan. Alist of valid values is defined in the lookup CA_RECORD_TYPE. Possible values are Organisation, Group, or Person. -
DeleteFlag: boolean
Read Only:
true
Indicates whether the business plan can be deleted. -
Description: string
Title:
Description
Maximum Length:3000
The description of the business plan. -
LastUpdateDate: string
(date-time)
Title:
Last Updated 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. -
Name: string
Title:
Name
Maximum Length:275
The name of the business plan. -
Note: array
Notes
Title:
Notes
The notes resource is used to view, create, update, and delete notes associated with a business plan. A note captures comments, information, or instructions related to an business plan. -
OrigCreationDate: string
(date-time)
Title:
Original Creation Date
The date when the business plan was first created. -
OwnerResourceName: string
Title:
Owner
Maximum Length:360
The name of the business plan owner. -
PartnerId: integer
(int64)
Title:
Partner ID
The unique identifier of the business plan partner. -
PartnerName: string
Title:
Partner
Read Only:true
Maximum Length:80
The name of the partner associated with the business plan. -
PartnerNumber: string
Title:
Partner Number
Maximum Length:30
Alternate Key corresponding to PartnerId. -
PartnerPartyDisplayName: string
Title:
Partner
Maximum Length:360
The display name of the partner for the business plan. -
PeriodEndDate: string
(date)
Title:
End Date
Read Only:true
Period End Date -
PeriodEndDisplayName: string
Title:
Period End Name
Maximum Length:30
The display name for the end of the business plan period. -
PeriodEndName: string
Title:
Period End Internal Name
Maximum Length:30
The internal name for the end of the business plan period. -
PeriodRangeDisplayName: string
Title:
Period
Maximum Length:80
The display name of the business period range. -
PeriodSetName: string
Maximum Length:
15
The name of the calendar for the business plan period. -
PeriodStartDate: string
(date)
Title:
Start Date
Read Only:true
Period Start Date -
PeriodStartDisplayName: string
Title:
Period Start Name
Maximum Length:30
The display name for the start of the business plan period. -
PeriodStartName: string
Title:
Period Start Internal Name
Maximum Length:30
The internal name for the start of the business plan period. -
PeriodTypeCode: string
Title:
Period Type
Maximum Length:30
The code indicating the period of the business plan. A list of valid values is defined in the lookup SalesObjectiveGLPeriodTypeViewAccessor. -
SourceType: string
Read Only:
true
The source type to be used for retrieving the Activities of the Business Plan. -
StatusCode: string
Title:
Status
Maximum Length:30
The code indicating the status of the business plan. A list of valid values is defined in the lookup BusinessPlanStatusVA. -
Swot: array
SWOTs
Title:
SWOTs
The SWOTs resource is used to view, create, update, and delete a business plan's strengths, weaknesses, opportunities, and threats. -
UpdateFlag: boolean
Read Only:
true
Indicates whether the business plan can be updated. The default value is true.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Business Plan Resources
Type:
array
Title:
Business Plan Resources
Business plan resources is used to view, create, update, and delete the team members associated with a business plan.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The notes resource is used to view, create, update, and delete notes associated with a business plan. A note captures comments, information, or instructions related to an business plan.
Show Source
Nested Schema : SWOTs
Type:
array
Title:
SWOTs
The SWOTs resource is used to view, create, update, and delete a business plan's strengths, weaknesses, opportunities, and threats.
Show Source
Nested Schema : businessPlans-BusinessPlanAttachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
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:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
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.
Nested Schema : businessPlans-BusinessPlanResource-item-response
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
The code indicating the access level of a team member. A list of valid values is defined in the lookup ORA_ZCA_BUS_PLAN_ACCESS_LEVEL. -
BusinessPlanId: integer
(int64)
Title:
Business Plan ID
The unique identifier of the business plan. -
BusinessPlanNumber: string
Title:
Number
Maximum Length:64
Parent puid. -
BusinessPlanResourceId: integer
(int64)
Title:
Business Plan Resource ID
The unique identifier of the business plan resource. -
BusinessPlanResourceNumber: string
Title:
Resource Number
Maximum Length:230
The alternate key identifier for business plan resource. -
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. -
DenormMgrId: integer
(int64)
Read Only:
true
The unique identifier of the manager of the business plan team member. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The E-Mail address of the business plan team member. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the business plan team member. -
LastUpdateDate: string
(date-time)
Title:
Last Updated 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. -
ManagerName: string
Title:
Manager
Read Only:true
Maximum Length:360
The name of the manager of the business plan team member. -
MemberFunctionCode: string
Title:
Function
Maximum Length:30
The code indicating the function of a team member. A list of valid values is defined in the lookup MemberFunctionCodesVA. -
OrganizationName: string
Title:
Organization
Read Only:true
Maximum Length:240
The organization name of the business plan team member. -
OwnerFlag: boolean
Title:
Owner Indicator
Read Only:true
Indicates if the business plan team member is the owner of the business plan. If the value is True, then the business plan team member is also the owner of the business plan. The default value is False. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the resource. -
ResourceName: string
Read Only:
true
Maximum Length:360
The name of the team member. -
ResourceNumber: string
Read Only:
true
Maximum Length:30
Alternate key corresponding to ResourceId. -
RoleName: string
Title:
Role
Read Only:true
Maximum Length:60
The name of the role of the team member.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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 : businessPlans-Swot-item-response
Type:
Show Source
object
-
BusinessPlanId: integer
(int64)
Title:
Business Plan ID
The unique identifier of the business plan. -
BusinessPlanNumber: string
Title:
Business Plan Number
Maximum Length:64
Parent puid. -
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. -
Description: string
Title:
Description
Maximum Length:2000
The description of the SWOT. -
LastUpdateDate: string
(date-time)
Title:
Last Updated 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. -
SWOTId: integer
(int64)
Title:
SWOT ID
The unique identifier of the business plan SWOT. -
SWOTNumber: string
Title:
Number
Maximum Length:64
The alternate key identifier for the business plan SWOT. -
SWOTTypeCode: string
Title:
Type Code
Maximum Length:30
The code indicating the type of business plan SWOT. A list of valid values is defined in the lookup ORA_ZCA_BUS_PLAN_SWOT. Possible values are Opportunity, Strength, Threat, or Weakmess.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- BusinessPlanAttachments
-
Operation: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanAttachmentsParameters:
- BusinessPlanId:
$request.path.BusinessPlanId
The attachments resource is used to view, create, and update attachments. - BusinessPlanId:
- BusinessPlanClassVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_BUS_PLAN_CLASS
The list of values indicating the class of the business plan.
The following properties are defined on the LOV link relation:- Source Attribute: BusinessPlanClassCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- BusinessPlanResource
-
Operation: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/BusinessPlanResourceParameters:
- BusinessPlanId:
$request.path.BusinessPlanId
Business plan resources is used to view, create, update, and delete the team members associated with a business plan. - BusinessPlanId:
- BusinessPlanStatusVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_BUS_PLAN_STATUS%2CBindLookupCode%3D{StatusCode}
The list of values indicating the status of the business plan.
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- BusinessPlanTypeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_BUS_PLAN_TYPE%2CBindLookupCode%3D{BusinessPlanTypeCode}
The list of values indicating the type of the business plan.
The following properties are defined on the LOV link relation:- Source Attribute: BusinessPlanTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- Note
-
Parameters:
- BusinessPlanId:
$request.path.BusinessPlanId
The notes resource is used to view, create, update, and delete notes associated with a business plan. A note captures comments, information, or instructions related to an business plan. - BusinessPlanId:
- PartnerAccountResourcePVO
-
Operation: /crmRestApi/resources/11.13.18.05/resourcesThe list of values of the names of the business plan owners.
The following properties are defined on the LOV link relation:- Source Attribute: OwnerResourceName; Target Attribute: ResourceName
- Display Attribute: ResourceName
- PartnerPickerPVO
-
Parameters:
- finder:
ActivePartnersFinder
The list of values of the display names for the partners associated with the business plan.
The following properties are defined on the LOV link relation:- Source Attribute: PartnerPartyDisplayName; Target Attribute: PartyName
- Display Attribute: PartyName
- finder:
- SalesGLEndPeriodPickTimeListToViewAccessor
-
Parameters:
- finder:
EndPeriodFinder%3BbindPeriodType%3D{PeriodTypeCode}
The list of values of the display names for the business plan end period.
The following properties are defined on the LOV link relation:- Source Attribute: PeriodEndDisplayName; Target Attribute: PeriodName
- Display Attribute: PeriodName
- finder:
- SalesGLStartPeriodPickerTimeListViewAccessor
-
Parameters:
- finder:
StartPeriodFinder%3BbindPeriodType%3D{PeriodTypeCode}
The list of values of the display names for the business plan start period.
The following properties are defined on the LOV link relation:- Source Attribute: PeriodStartDisplayName; Target Attribute: PeriodName
- Display Attribute: PeriodName
- finder:
- SalesObjectiveGLPeriodTypeViewAccessor
-
The list of values indicating the type of the business plan period.
The following properties are defined on the LOV link relation:- Source Attribute: PeriodTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- Swot
-
Parameters:
- BusinessPlanId:
$request.path.BusinessPlanId
The SWOTs resource is used to view, create, update, and delete a business plan's strengths, weaknesses, opportunities, and threats. - BusinessPlanId:
Examples
The following example shows how to create a business plan 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/
Example of Request Body
The following shows an example of the request body in JSON format..
{ "Name": "Business Plan for FNC", "PartnerId": 100100006031746, "PeriodTypeCode": "YEAR", "PeriodSetName": "Accounting12", "PeriodEndName": "12-16", "PeriodStartName": "01-16", "StatusCode": "ORA_DRAFT" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "BusinessPlanClassCode": "PARTNER", "BusinessPlanId": 300100091979253, "Name": "Business Plan for FNC", "BusinessPlanNumber": "CDRM_24034", "BusinessPlanOwnerId": 100010037456865, "BusinessPlanTypeCode": null, "CreatedBy": "MHoope", "CreationDate": "2016-12-12T02:39:59-08:00", "Description": null, "LastUpdateDate": "2016-12-12T02:39:59-08:00", "LastUpdateLogin": "4373F6AF02325539E05364C0F20A8DA6", "LastUpdatedBy": "MHoope", "PartnerId": 100100006031746, "PeriodTypeCode": "YEAR", "PeriodSetName": "Accounting12", "PeriodStartName": "01-16", "PeriodEndName": "12-16", "StatusCode": "ORA_DRAFT", "OwnerResourceName": "Matt Hooper", "PartnerName": "17201319412525834151", "PeriodStartDisplayName": "2016", "PeriodEndDisplayName": "2016", "PeriodRangeDisplayName": "2016", "OrigCreationDate": "2016-12-12T02:39:59-08:00", "PartnerPartyDisplayName": "17201319412525834151", "UpdateFlag": true, "DeleteFlag": true, "SourceType": "SALES_BUSINESS_PLAN", ... }