1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Business Plans

Update a business plan

patch

/crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}

Request

Path Parameters
Header Parameters
  • 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".
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
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 : Goals
Type: array
Title: Goals
The goals resource is used to view, create, update and delete goals associated with 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 : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
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: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • 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.
  • Title: Resource Number
    Maximum Length: 230
    The alternate key identifier for business plan resource.
  • 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.
  • Smart Actions
    Title: Smart Actions
    This VO stores the endpoint and security details for every user action.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : businessPlans-BusinessPlanResource-smartActions-item-patch-request
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : businessPlans-BusinessPlanResource-smartActions-UserActionNavigation-item-patch-request
Type: object
Show Source
Nested Schema : businessPlans-BusinessPlanResource-smartActions-UserActionRequestPayload-item-patch-request
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    Indicates the binding type of the value.
  • Title: Mandatory
    Maximum Length: 1
    Boolean value indicating if the payload is mandatory.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The key in the Key Value pair that forms the payload.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean value.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value in the Key Value pair that forms the payload.
  • Title: Payload Value Structure
    Maximum Length: 20
    If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : businessPlans-BusinessPlanResource-smartActions-UserActionURLBinding-item-patch-request
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : schema
Type: object
Show Source
Nested Schema : Sales Objectives
Type: array
Title: Sales Objectives
The sales objectives resource is used to view, create, update and delete sales objectives associated with business plan's goal.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Initiatives
Type: array
Title: Initiatives
The initiatives resource is used to view, create, update and delete initiatives associated with business plan's sales objective.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : businessPlans-Goals-smartActions-UserActionNavigation-item-patch-request
Type: object
Show Source
Nested Schema : businessPlans-Goals-smartActions-UserActionRequestPayload-item-patch-request
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    Indicates the binding type of the value.
  • Title: Mandatory
    Maximum Length: 1
    Boolean value indicating if the payload is mandatory.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The key in the Key Value pair that forms the payload.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean value.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value in the Key Value pair that forms the payload.
  • Title: Payload Value Structure
    Maximum Length: 20
    If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : businessPlans-Goals-smartActions-UserActionURLBinding-item-patch-request
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : schema
Type: object
Show Source
  • Title: Contact Relationship ID
    The unique identifier of the relationshi, this value is populated when the note is associated with a contact.
  • 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.
  • Title: Creator Party ID
    The unique identifier of the note creator's party.
  • 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.
  • Title: Currency
    Maximum Length: 15
    The currency code associated with the note. A list of accepted values is defined in the lookup RatedCurrenciesVA.
  • Title: Title
    Maximum Length: 500
    The title of the note entered by the user.
  • Title: Note
    The actual note text.
  • 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.
  • Smart Actions
    Title: Smart Actions
    This VO stores the endpoint and security details for every user action.
  • 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.
  • 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 : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : businessPlans-Note-smartActions-UserActionNavigation-item-patch-request
Type: object
Show Source
Nested Schema : businessPlans-Note-smartActions-UserActionRequestPayload-item-patch-request
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    Indicates the binding type of the value.
  • Title: Mandatory
    Maximum Length: 1
    Boolean value indicating if the payload is mandatory.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The key in the Key Value pair that forms the payload.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean value.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value in the Key Value pair that forms the payload.
  • Title: Payload Value Structure
    Maximum Length: 20
    If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : businessPlans-Note-smartActions-UserActionURLBinding-item-patch-request
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : schema
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : businessPlans-smartActions-UserActionNavigation-item-patch-request
Type: object
Show Source
Nested Schema : businessPlans-smartActions-UserActionRequestPayload-item-patch-request
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    Indicates the binding type of the value.
  • Title: Mandatory
    Maximum Length: 1
    Boolean value indicating if the payload is mandatory.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The key in the Key Value pair that forms the payload.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean value.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value in the Key Value pair that forms the payload.
  • Title: Payload Value Structure
    Maximum Length: 20
    If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : businessPlans-smartActions-UserActionURLBinding-item-patch-request
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : schema
Type: object
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : businessPlans-Swot-smartActions-UserActionNavigation-item-patch-request
Type: object
Show Source
Nested Schema : businessPlans-Swot-smartActions-UserActionRequestPayload-item-patch-request
Type: object
Show Source
  • Title: Payload Value Binding Type
    Maximum Length: 64
    Indicates the binding type of the value.
  • Title: Mandatory
    Maximum Length: 1
    Boolean value indicating if the payload is mandatory.
  • Title: Request Payload Attribute Name
    Maximum Length: 256
    The key in the Key Value pair that forms the payload.
  • Title: Smart Suggest Path
    Maximum Length: 2048
    The path used for smart suggest.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean value.
  • Title: Request Payload Attribute Value
    Maximum Length: 1000
    The value in the Key Value pair that forms the payload.
  • Title: Payload Value Structure
    Maximum Length: 20
    If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : businessPlans-Swot-smartActions-UserActionURLBinding-item-patch-request
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : businessPlans-item-response
Type: object
Show Source
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 : Goals
Type: array
Title: Goals
The goals resource is used to view, create, update and delete goals associated with 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 : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
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: object
Show Source
Nested Schema : businessPlans-BusinessPlanResource-item-response
Type: object
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : businessPlans-BusinessPlanResource-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : businessPlans-BusinessPlanResource-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : businessPlans-BusinessPlanResource-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : businessPlans-BusinessPlanResource-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : businessPlans-Goals-item-response
Type: object
Show Source
Nested Schema : Sales Objectives
Type: array
Title: Sales Objectives
The sales objectives resource is used to view, create, update and delete sales objectives associated with business plan's goal.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : businessPlans-Goals-SalesObjectives-item-response
Type: object
Show Source
Nested Schema : Initiatives
Type: array
Title: Initiatives
The initiatives resource is used to view, create, update and delete initiatives associated with business plan's sales objective.
Show Source
Nested Schema : businessPlans-Goals-SalesObjectives-Initiatives-item-response
Type: object
Show Source
Nested Schema : businessPlans-Goals-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : businessPlans-Goals-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : businessPlans-Goals-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : businessPlans-Goals-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : businessPlans-Note-item-response
Type: object
Show Source
  • Title: Contact Relationship ID
    The unique identifier of the relationshi, this value is populated when the note is associated with a contact.
  • 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.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date when the record was created.
  • Title: Creator Party ID
    The unique identifier of the note creator's party.
  • 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.
  • Title: Currency
    Maximum Length: 15
    The currency code associated with the note. A list of accepted values is defined in the lookup RatedCurrenciesVA.
  • Title: Delete Indicator
    Read Only: true
    Indicates whether the business plan note can be deleted. The default value is true.
  • Read Only: true
    Maximum Length: 320
    The email address of the user who created the note.
  • Read Only: true
    The address of the user who created the note.
  • Read Only: true
    The phone number of the user who created the note.
  • Title: Last Update Date
    Read Only: true
    The date when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Note ID
    Read Only: true
    The unique identifier of the note for the business plan.
  • Maximum Length: 30
    The alternate unique identifier of the note. A user key that's system generated or from an external system.
  • Title: Title
    Maximum Length: 500
    The title of the note entered by the user.
  • Title: Note
    The actual note text.
  • 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.
  • Title: Parent Note ID
    The unique identifier of the parent note.
  • Read Only: true
    The unique Identifier of the contact with whom the note is associated. In this case, same as CreatorPartyId.
  • Title: Author
    Read Only: true
    Maximum Length: 360
    The name of party associated with the business plan.
  • Smart Actions
    Title: Smart Actions
    This VO stores the endpoint and security details for every user action.
  • 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.
  • 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.
  • Title: Source System
    Maximum Length: 30
    This is the source object code for the source object as defined in OBJECTS Metadata.
  • Title: Update Indicator
    Read Only: true
    Indicates whether the business plan note can be updated. The default value is true.
  • 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 : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : businessPlans-Note-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : businessPlans-Note-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : businessPlans-Note-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : businessPlans-Note-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : businessPlans-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : businessPlans-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : businessPlans-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : businessPlans-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : businessPlans-Swot-item-response
Type: object
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : businessPlans-Swot-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : businessPlans-Swot-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : businessPlans-Swot-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : businessPlans-Swot-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Links
BusinessPlanAttachments
Parameters:
  • BusinessPlanId: $request.path.BusinessPlanId
The attachments resource is used to view, create, and update attachments.
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
BusinessPlanResource
Parameters:
  • BusinessPlanId: $request.path.BusinessPlanId
Business plan resources is used to view, create, update, and delete the team members associated with a business plan.
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
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
Goals
Parameters:
  • BusinessPlanId: $request.path.BusinessPlanId
The goals resource is used to view, create, update and delete goals associated with business plan.
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.
PartnerAccountResourcePVO
The 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
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
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
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.
smartActions
Parameters:
  • BusinessPlanId: $request.path.BusinessPlanId
This VO stores the endpoint and security details for every user action.
Back to Top

Examples

The following example shows how to update a business plan by submitting a PATCH 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

Example of Request Body

The following shows an example of the request body in JSON format..

{
"Description":"New Description"
}

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": "New Description",
"LastUpdateDate": "2016-12-12T02:43:16-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",
...
}
Back to Top