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

Get all business plans

get

/crmRestApi/resources/11.13.18.05/businessPlans

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • AllBusinessPlansFinder: Finds all business plans a user has access to.
      Finder Variables:
      • MyBusinessPlansFinder: Finds a business plan owner with the primary key information.
        Finder Variables:
        • BusinessPlanOwnerId; string; The unique identifier of the owner of the business plan.
      • PrimaryKey: Finds a business plan with the primary key information.
        Finder Variables:
        • BusinessPlanId; integer; The unique identifier of the business plan.
    • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
    • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

      Example:
      self,canonical
    • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
    • The resource item payload will be filtered in order to contain only data (no links section, for example).
    • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
    • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

      Format: ?q=expression1;expression2

      You can use these queryable attributes to filter this collection resource using the q query parameter:
      • BusinessPlanClassCode; string; A code indicating the class of a business plan. A list of valid values is defined in the lookup BusinessPlanClassVA.
      • BusinessPlanId; integer; The unique identifier of the business plan.
      • BusinessPlanNumber; string; The alternate key identifier of a business plan.
      • BusinessPlanOwnerNumber; string; Alternate key corresponding to BusinessPlanOwnerId.
      • BusinessPlanTypeCode; string; The code indicating the type of business plan. A list of valid values is defined in the lookup BusinessPlanTypeVA.
      • CreatedBy; string; The user who created the record.
      • CreationDate; string; The date when the record was created.
      • CustomerId; integer; The unique identifier of the business plan account.
      • CustomerNumber; string; Alternate Key corresponding to CustomerId.
      • CustomerPartyType; string; 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.
      • Description; string; The description of the business plan.
      • LastUpdateDate; string; The date when the record was last updated.
      • LastUpdatedBy; string; The user who last updated the record.
      • Name; string; The name of the business plan.
      • OrigCreationDate; string; The date when the business plan was first created.
      • OwnerResourceName; string; The name of the business plan owner.
      • PartnerNumber; string; Alternate Key corresponding to PartnerId.
      • PartnerPartyDisplayName; string; The display name of the partner for the business plan.
      • PeriodEndDate; string; Period End Date
      • PeriodEndName; string; The internal name for the end of the business plan period.
      • PeriodRangeDisplayName; string; The display name of the business period range.
      • PeriodStartDate; string; Period Start Date
      • PeriodStartName; string; The internal name for the start of the business plan period.
      • PeriodTypeCode; string; The code indicating the period of the business plan. A list of valid values is defined in the lookup SalesObjectiveGLPeriodTypeViewAccessor.
      • SourceType; string; The source type to be used for retrieving the Activities of the Business Plan.
      • StatusCode; string; The code indicating the status of the business plan. A list of valid values is defined in the lookup BusinessPlanStatusVA.
    • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
    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.

    There's no request body for this operation.

    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
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested 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 : 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: object
    Show Source
    Nested Schema : businessPlans-BusinessPlanResource-item-response
    Type: object
    Show Source
    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.
    • Title: Primary Email
      Read Only: true
      Maximum Length: 320
      The email address of the user who created the note.
    • Title: Primary Address
      Read Only: true
      The address of the user who created the note.
    • Title: Primary Phone
      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.
    • Title: Party ID
      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.
    • 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: 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 : businessPlans-Swot-item-response
    Type: object
    Show Source
    Back to Top

    Examples

    The following example shows how to get all business plans by submitting a GET 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 Response Body

    The following example shows the contents of the response body in JSON format.

    {
"items": [
  {
"BusinessPlanClassCode": "PARTNER",
"BusinessPlanId": 300100089695451,
"Name": "AUTOBPNAME_c7577740946",
"BusinessPlanNumber": "CDRM_7008",
"BusinessPlanOwnerId": 100010038017849,
"BusinessPlanTypeCode": null,
"CreatedBy": "CHANNEL_SALES_MGR",
"CreationDate": "2016-06-03T11:15:48-07:00",
"Description": null,
"LastUpdateDate": "2016-06-03T11:15:51-07:00",
"LastUpdateLogin": "3462E43397E9A13FE0532AB0F20AD2A5",
"LastUpdatedBy": "CHANNEL_SALES_MGR",
"PartnerId": 300100089683791,
"PeriodTypeCode": "YEAR",
"PeriodSetName": "Accounting12",
"PeriodStartName": "01-15",
"PeriodEndName": "12-15",
"StatusCode": "ORA_DRAFT",
"OwnerResourceName": "Channel_Sales_Mgr_ENT2 CSM",
"PartnerName": "OrgName_13873809212",
"PeriodStartDisplayName": "2015",
"PeriodEndDisplayName": "2015",
"PeriodRangeDisplayName": "2015",
"OrigCreationDate": "2016-06-03T11:15:48-07:00",
"PartnerPartyDisplayName": "OrgName_13873809212",
"UpdateFlag": true,
"DeleteFlag": true,
"SourceType": "SALES_BUSINESS_PLAN",
...
},
  {
"BusinessPlanClassCode": "PARTNER",
"BusinessPlanId": 300100089800166,
"Name": "AUTOBPNAME_f2554956076",
"BusinessPlanNumber": "CDRM_10008",
"BusinessPlanOwnerId": 100010038017849,
"BusinessPlanTypeCode": null,
"CreatedBy": "CHANNEL_SALES_MGR",
"CreationDate": "2016-06-05T12:29:22-07:00",
"Description": null,
"LastUpdateDate": "2016-06-05T12:29:25-07:00",
"LastUpdateLogin": "348C468C90248AAFE0532AB0F20A7F7C",
"LastUpdatedBy": "CHANNEL_SALES_MGR",
"PartnerId": 300100089785026,
"PeriodTypeCode": "YEAR",
"PeriodSetName": "Accounting12",
"PeriodStartName": "01-15",
"PeriodEndName": "12-15",
"StatusCode": "ORA_DRAFT",
"OwnerResourceName": "Channel_Sales_Mgr_ENT2 CSM",
"PartnerName": "RESTORG_57451230678",
"PeriodStartDisplayName": "2015",
"PeriodEndDisplayName": "2015",
"PeriodRangeDisplayName": "2015",
"OrigCreationDate": "2016-06-05T12:29:22-07:00",
"PartnerPartyDisplayName": "RESTORG_57451230678",
"UpdateFlag": true,
"DeleteFlag": true,
"SourceType": "SALES_BUSINESS_PLAN",
...
},
...
    Back to Top