Objectives: Required Attributes and Path Parameters

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

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

Parent Level

Objectives

Child Resources

Objective Splits

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

Resource Attribute Attribute Description

Objectives

ObjectiveTypeCode

The code indicating how the objective is categorized. The list of codes is available in LovSalesObjectiveTypeVO.

Name

The name of the objective.

StartDisplayPeriodName

The display name of the start period for the objective. A list of valid values is defined in the lookup SalesGLStartPeriodPickerTimeListViewAccessor.

EndDisplayPeriodName

The display name of the end period for the objective. A list of valid values is defined in the lookup SalesGLEndPeriodPickTimeListToViewAccessor.

PeriodTypeCode

The code indicating the type of period for the objective. A list of valid values is defined in the lookup SalesObjectiveGLPeriodTypeViewAccessor.

The following table lists the attributes required for the POST method for Objectives child resource.

Resource Attribute Attribute Description

Objectives > Objective Splits

ActualValue

The actual attainment value for the objective split.

TargetValue

The unique identifier for the target of the objective split.

PeriodType

The code indicating the type of period for the objective split.

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

Resource Path Path Parameter

Objectives

/crmRestApi/resources/11.13.18.10/salesObjectives/{ObjectiveId}

ObjectiveId

The following table lists the path parameters required for the PATCH method for Objectives child resource.

Resource Path Path Parameter

Objectives > Objective Splits

/crmRestApi/resources/11.13.18.10/salesObjectives/{ObjectiveId}/child/SalesObjectiveSplits/{ObjectiveSplitId}

ObjectiveId

ObjectiveSplitId