Business Plans: Required Attributes and Path Parameters

This section lists the required attributes and path parameters for the request payloads of the Business Plans resource and its child resources.

The following table shows the relation between the parent resource and its child resources.

Parent Level	Business Plans
Child Resources	Business Plans Resources
	Notes
	SWOTs

The following table lists the attributes required for the POST method for Business Plans resource.

Resource	Attribute	Attribute Description
Business Plans	Name	The name of the business plan.
	PartnerId	The unique identifier of the business plan partner.
	PeriodTypeCode	The code indicating the period of the business plan. A list of valid values is defined in the lookup SalesObjectiveGLPeriodTypeViewAccessor.
	PeriodSetName	The name of the calendar for the business plan period.
	PeriodEndName	The internal name for the end of the business plan period.
	PeriodStartName	The internal name for the start of the business plan period.
	StatusCode	The code indicating the status of the business plan. A list of valid values is defined in the lookup BusinessPlanStatusVA.

The following table lists the attributes required for the POST method for Business Plans child resources.

Resource	Attribute	Attribute Description
Business Plans > Business Plans Resources	ResourceId	The unique identifier of the business plan.
Business Plans > Notes	VisibilityCode	This is the attribute to specify the visibility level of the note. A list of valid values is defined in the lookup NoteVisibilityLookupVA.
	NoteTypeCode	This is the note type code for categorization of note. A list of valid values is defined in the lookup NoteSourceTypeVA.
	NoteTxt	The actual note text.
Business Plans > SWOTs	SWOTTypeCode	The code indicating the type of business plan SWOT.
	Description	The description of the SWOT.

The following table lists the path parameters required for the PATCH method for Business Plans resource.

Resource	Path	Path Parameter
Business Plans	/crmRestApi/resources/11.13.18.10/businessPlans/{BusinessPlanId}	BusinessPlanId

The following table lists the path parameters required for the PATCH method for Business Plans child resources.

Resource	Path	Path Parameter
Business Plans > Business Plans Resources	/crmRestApi/resources/11.13.18.10/businessPlans/{BusinessPlanId}/child/BusinessPlanResource/{BusinessPlanResourceId}	BusinessPlanId BusinessPlanResourceId
Business Plans > Notes	/crmRestApi/resources/11.13.18.10/businessPlans/{BusinessPlanId}/child/Note/{NoteId}	BusinessPlanId NoteId
Business Plans > SWOTs	/crmRestApi/resources/11.13.18.10/businessPlans/{BusinessPlanId}/child/Swot/{SWOTId}	BusinessPlanId SWOTId