Jump to

• Request
• Response

Get a business plan goal

get

/crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Goals/{GoalNumber}

Request

Path Parameters

• BusinessPlanId(required): integer(int64)
  The unique identifier of the business plan.
• GoalNumber(required): string
  The identifier for the goal number.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  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).
• fields: string
  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
• links: string
  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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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

• 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.

Body ()

Root Schema : businessPlans-Goals-item-response

Type: object

Show Source

• BusinessPlanId: integer (int64)
  Title: Business Plan ID

  The unique identifier of business plan for which goal is created.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Lists who created the row of data.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date the row of data was created.
• EndDate: string (date)
  Title: End Date

  Read Only: true

  The last date the object is active.
• EndDisplayPeriodName: string
  Title: End Period Name

  Maximum Length: 60

  The objective end display period name.
• EndPeriodName: string
  Title: End Period Name

  Read Only: true

  Maximum Length: 15

  The last calendar period covered by the objective period.
• GoalDescription: string
  Title: Goal Description

  Maximum Length: 2000

  The detailed description to define attainable objectives.
• GoalId: integer (int64)
  Title: Goal ID

  The system generated identifier for the business plan goals.
• GoalName: string
  Title: Goal Name

  Maximum Length: 80

  The goal name of the business plan.
• GoalNumber: string
  Title: Goal Number

  Maximum Length: 30

  The identifier for the goal number.
• GoalOwnerId: integer (int64)
  Title: Goal Owner ID

  The business plan's goal owner.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The application displays the date that the record was last edited.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The application displays the identity of the user who last edited the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  System attribute that captures the session login information, such as user or account name, of the user who accesses an application.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OwnerPartyName: string
  Title: Owner

  Read Only: true

  Maximum Length: 360

  The business plan owner.
• OwnerPartyNumber: string
  Title: Owner Number

  The unique alternative identifier of the owner.
• PeriodTypeCode: string
  Title: Period Type Code

  Maximum Length: 15

  The type of period for the business plan goals.
• SalesObjectives: array Sales Objectives
  Title: Sales Objectives

  The sales objectives resource is used to view, create, update and delete sales objectives associated with business plan's goal.
• smartActions: array Smart Actions
  Title: Smart Actions

  This VO stores the endpoint and security details for every user action.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  The first date the object is active.
• StartDisplayPeriodName: string
  Title: Start Period Name

  Maximum Length: 60

  The objective start display period name.
• StartPeriodName: string
  Title: Start Period Name

  Read Only: true

  Maximum Length: 15

  The first calendar period covered by the objective's time period.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The application displays the identity of the user who last edited the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date the row of data was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Lists who created the row of data.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerPartyNumber":{
            "title":"Owner Number",
            "type":"string",
            "description":"The unique alternative identifier of the owner.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDisplayPeriodName":{
            "title":"Start Period Name",
            "maxLength":60,
            "type":"string",
            "description":"The objective start display period name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PeriodTypeCode"
                ]
            }
        },
        "OwnerPartyName":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The business plan owner.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalNumber":{
            "title":"Goal Number",
            "maxLength":30,
            "type":"string",
            "description":"The identifier for the goal number.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The last date the object is active.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"This VO stores the endpoint and security details for every user action.",
            "items":{
                "$ref":"#/components/schemas/businessPlans-Goals-smartActions-item-response"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The first date the object is active.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDisplayPeriodName":{
            "title":"End Period Name",
            "maxLength":60,
            "type":"string",
            "description":"The objective end display period name.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PeriodTypeCode"
                ]
            }
        },
        "StartPeriodName":{
            "title":"Start Period Name",
            "maxLength":15,
            "type":"string",
            "description":"The first calendar period covered by the objective's time period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalDescription":{
            "title":"Goal Description",
            "maxLength":2000,
            "type":"string",
            "description":"The detailed description to define attainable objectives.",
            "nullable":true,
            "x-queryable":true
        },
        "EndPeriodName":{
            "title":"End Period Name",
            "maxLength":15,
            "type":"string",
            "description":"The last calendar period covered by the objective period.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessPlanId":{
            "title":"Business Plan ID",
            "type":"integer",
            "description":"The unique identifier of business plan for which goal is created.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GoalOwnerId":{
            "title":"Goal Owner ID",
            "type":"integer",
            "description":"The business plan's goal owner.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PeriodTypeCode":{
            "title":"Period Type Code",
            "maxLength":15,
            "type":"string",
            "description":"The type of period for the business plan goals.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GoalName":{
            "title":"Goal Name",
            "maxLength":80,
            "type":"string",
            "description":"The goal name of the business plan.",
            "nullable":false,
            "x-queryable":true
        },
        "SalesObjectives":{
            "title":"Sales Objectives",
            "type":"array",
            "description":"The sales objectives resource is used to view, create, update and delete sales objectives associated with business plan's goal.",
            "items":{
                "$ref":"#/components/schemas/businessPlans-Goals-SalesObjectives-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The application displays the date that the record was last edited.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"System attribute that captures the session login information, such as user or account name, of the user who accesses an application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "title":"Goal ID",
            "type":"integer",
            "description":"The system generated identifier for the business plan goals.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object businessPlans-Goals-SalesObjectives-item-response

{
    "title":"Sales Objectives",
    "type":"array",
    "description":"The sales objectives resource is used to view, create, update and delete sales objectives associated with business plan's goal.",
    "items":{
        "$ref":"#/components/schemas/businessPlans-Goals-SalesObjectives-item-response"
    }
}

Nested Schema : Smart Actions

Type: array

Title: Smart Actions

This VO stores the endpoint and security details for every user action.

Show Source

• Array of: object businessPlans-Goals-smartActions-item-response

{
    "title":"Smart Actions",
    "type":"array",
    "description":"This VO stores the endpoint and security details for every user action.",
    "items":{
        "$ref":"#/components/schemas/businessPlans-Goals-smartActions-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : businessPlans-Goals-SalesObjectives-item-response

Type: object

Show Source

• AccountId: integer (int64)
  Title: Account

  The unique identifier of the account assigned to the objective.
• AccountName: string
  Title: Account

  The account name for a sales objective target.
• AccountNumber: string
  Read Only: true

  Maximum Length: 30

  Unique identifier of a party in the TCA registry.
• ActualValue: integer
  Title: Attainment

  The actual attainment value for the objective.
• BusinessPlanId: integer (int64)
  Title: Business Plan ID

  The unique identifier of the business plan.
• BusinessPlanName: string
  Title: Business Plan

  Read Only: true

  Maximum Length: 275

  The name of the business plan for the objective.
• BusinessPlanNumber: string
  Title: Business Plan Number

  Maximum Length: 64

  The alternate key identifier for the business plan.
• 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.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  The currency code associated with the objective. A list of valid values are defined in the lookup RatedCurrenciesVO.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the objective can be deleted. The default value is true.
• Description: string
  Title: Description

  Maximum Length: 2000

  The description of the objective.
• EndDisplayPeriodName: string
  Title: End Period Name

  Maximum Length: 60

  The display name of the end period for the objective. A list of valid values is defined in the lookup SalesGLEndPeriodPickTimeListToViewAccessor.
• EndPeriodName: string
  Title: Period End Internal Name

  Maximum Length: 15

  The internal name of the end period for the objective.
• GeographyId: integer (int64)
  Title: Geography

  The unique identifier for the geography.
• GeographyKey: string
  The geography key of the geography.
• GeographyName: string
  Title: Geography

  Maximum Length: 255

  The name of the geography, such as JAPAC, EMEA, or Americas.
• GoalId: integer (int64)
  Title: Goal ID

  The system generated identifier for the business plan goals.
• GoalNumber: string
  Title: Goal Number

  The unique alternative identifier of the goal.
• Initiatives: array Initiatives
  Title: Initiatives

  The initiatives resource is used to view, create, update and delete initiatives associated with business plan's sales objective.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date on which 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: 60

  The name of the objective.
• ObjectiveId: integer (int64)
  Title: Objective ID

  The unique identifier of the objective.
• ObjectiveNumber: string
  Title: Number

  Maximum Length: 30

  The alternate key identifier for the objective.
• ObjectiveOwnerId: integer (int64)
  Title: Owner ID

  The identification key for the resource who owns the sales objective.
• ObjectiveTypeCode: string
  Title: Objective Type Code

  Maximum Length: 30

  The code indicating how the objective is categorized. The list of codes is available in LovSalesObjectiveTypeVO.
• ObjectiveTypeName: string
  Title: Type

  Maximum Length: 60

  The type of the objective.
• OrigCreationDate: string (date-time)
  Title: Original Creation Date

  The date when the objective was originally created in an external system.
• OwnerPartyName: string
  Title: Owner

  Read Only: true

  Name of the owner of the sales objective.
• OwnerPartyNumber: string
  Title: Owner Number

  The unique alternative identifier of the owner.
• PeriodEndDate: string (date)
  Title: End Date

  Read Only: true

  The last date the object is active.
• PeriodStartDate: string (date)
  Title: Start Date

  Read Only: true

  The first date the object is active.
• PeriodTypeCode: string
  Title: Period Type Code

  Maximum Length: 30

  The code indicating the type of period for the objective. A list of valid values is defined in the lookup SalesObjectiveGLPeriodTypeViewAccessor.
• PeriodTypeName: string
  Title: Period

  Read Only: true

  Maximum Length: 80

  The name of the period type for the objective.
• ProductGroupId: integer (int64)
  Title: Product Group

  The unique identifier for the product group.
• ProductGroupName: string
  Title: Product Group

  Maximum Length: 250

  The name of the product group.
• ProductGroupReferenceNumber: string
  Title: Reference Number

  Maximum Length: 50

  The reference number for the product Group.
• StartDisplayPeriodName: string
  Title: Start Period Name

  Maximum Length: 60

  The display name of the start period for the objective. A list of valid values is defined in the lookup SalesGLStartPeriodPickerTimeListViewAccessor.
• StartPeriodName: string
  Title: Period Start Internal Name

  Maximum Length: 15

  The internal name of the start period for the objective.
• TargetValue: integer
  Title: Target

  The unique identifier for the target of the objective.
• UnitOfMeasureCode: string
  Title: Unit of Measure Code

  Read Only: true

  Maximum Length: 30

  The code indicating the unit of measure for the objective.
• UnitOfMeasureName: string
  Title: Unit of Measure

  Read Only: true

  Maximum Length: 80

  The unit of measure of the objective.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the objective can be updated. The default value is true.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasureCode":{
            "title":"Unit of Measure Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the unit of measure for the objective.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectiveId":{
            "title":"Objective ID",
            "type":"integer",
            "description":"The unique identifier of the objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccountId":{
            "title":"Account",
            "type":"integer",
            "description":"The unique identifier of the account assigned to the objective.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "GeographyId":{
            "title":"Geography",
            "type":"integer",
            "description":"The unique identifier for the geography.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerPartyNumber":{
            "title":"Owner Number",
            "type":"string",
            "description":"The unique alternative identifier of the owner.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDisplayPeriodName":{
            "title":"Start Period Name",
            "maxLength":60,
            "type":"string",
            "description":"The display name of the start period for the objective. A list of valid values is defined in the lookup SalesGLStartPeriodPickerTimeListViewAccessor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PeriodTypeCode"
                ]
            },
            "x-queryable":true
        },
        "BusinessPlanNumber":{
            "title":"Business Plan Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate key identifier for the business plan.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Product Group",
            "maxLength":250,
            "type":"string",
            "description":"The name of the product group.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The last date the object is active.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the objective.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The currency code associated with the objective. A list of valid values are defined in the lookup RatedCurrenciesVO.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDisplayPeriodName":{
            "title":"End Period Name",
            "maxLength":60,
            "type":"string",
            "description":"The display name of the end period for the objective. A list of valid values is defined in the lookup SalesGLEndPeriodPickTimeListToViewAccessor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "PeriodTypeCode"
                ]
            },
            "x-queryable":true
        },
        "GeographyKey":{
            "type":"string",
            "description":"The geography key of the geography.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessPlanName":{
            "title":"Business Plan",
            "maxLength":275,
            "type":"string",
            "description":"The name of the business plan for the objective.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the objective can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BusinessPlanId":{
            "title":"Business Plan ID",
            "type":"integer",
            "description":"The unique identifier of the business plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectiveNumber":{
            "title":"Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the objective.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrigCreationDate":{
            "title":"Original Creation Date",
            "type":"string",
            "description":"The date when the objective was originally created in an external system.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "GoalId":{
            "title":"Goal ID",
            "type":"integer",
            "description":"The system generated identifier for the business plan goals.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Initiatives":{
            "title":"Initiatives",
            "type":"array",
            "description":"The initiatives resource is used to view, create, update and delete initiatives associated with business plan's sales objective.",
            "items":{
                "$ref":"#/components/schemas/businessPlans-Goals-SalesObjectives-Initiatives-item-response"
            }
        },
        "ProductGroupId":{
            "title":"Product Group",
            "type":"integer",
            "description":"The unique identifier for the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductGroupReferenceNumber":{
            "title":"Reference Number",
            "maxLength":50,
            "type":"string",
            "description":"The reference number for the product Group.",
            "nullable":false,
            "x-queryable":true
        },
        "PeriodTypeName":{
            "title":"Period",
            "maxLength":80,
            "type":"string",
            "description":"The name of the period type for the objective.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetValue":{
            "title":"Target",
            "type":"integer",
            "description":"The unique identifier for the target of the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerPartyName":{
            "title":"Owner",
            "type":"string",
            "description":"Name of the owner of the sales objective.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "GoalNumber":{
            "title":"Goal Number",
            "type":"string",
            "description":"The unique alternative identifier of the goal.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectiveTypeName":{
            "title":"Type",
            "maxLength":60,
            "type":"string",
            "description":"The type of the objective.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "GeographyName":{
            "title":"Geography",
            "maxLength":255,
            "type":"string",
            "description":"The name of the geography, such as JAPAC, EMEA, or Americas.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ObjectiveOwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The identification key for the resource who owns the sales objective.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the objective can be deleted. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PeriodStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The first date the object is active.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier of a party in the TCA registry.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectiveTypeCode":{
            "title":"Objective Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating how the objective is categorized. The list of codes is available in LovSalesObjectiveTypeVO.",
            "nullable":false,
            "x-queryable":true
        },
        "StartPeriodName":{
            "title":"Period Start Internal Name",
            "maxLength":15,
            "type":"string",
            "description":"The internal name of the start period for the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "EndPeriodName":{
            "title":"Period End Internal Name",
            "maxLength":15,
            "type":"string",
            "description":"The internal name of the end period for the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "ActualValue":{
            "title":"Attainment",
            "type":"integer",
            "description":"The actual attainment value for the objective.",
            "nullable":true,
            "x-queryable":true
        },
        "PeriodTypeCode":{
            "title":"Period Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of period for the objective. A list of valid values is defined in the lookup SalesObjectiveGLPeriodTypeViewAccessor.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UnitOfMeasureName":{
            "title":"Unit of Measure",
            "maxLength":80,
            "type":"string",
            "description":"The unit of measure of the objective.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Account",
            "type":"string",
            "description":"The account name for a sales objective target.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "AccountId",
                    "TransientPartyType"
                ]
            },
            "x-queryable":true
        }
    }
}

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

• Array of: object businessPlans-Goals-SalesObjectives-Initiatives-item-response

{
    "title":"Initiatives",
    "type":"array",
    "description":"The initiatives resource is used to view, create, update and delete initiatives associated with business plan's sales objective.",
    "items":{
        "$ref":"#/components/schemas/businessPlans-Goals-SalesObjectives-Initiatives-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : businessPlans-Goals-SalesObjectives-Initiatives-item-response

Type: object

Show Source

• BusinessPlanId: integer (int64)
  Title: Business Plan ID

  The identification key for business plan.
• BusinessPlanNumber: string
  Title: Business Plan Number

  Read Only: true

  Maximum Length: 64

  The number of the business plan for which an initiative was created.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  Lists who created the row of data.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• CustomerId: integer (int64)
  Title: Customer ID

  Read Only: true

  The customer identifier that is associated with the business plan.
• GoalId: integer (int64)
  Title: Goal ID

  The system generated identifier for the business plan goals.
• InitiativeId: integer (int64)
  Title: Initiative ID

  The unique identifier for initiative.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date on which 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.
• LeadId: integer (int64)
  Title: Lead ID

  The unique identifier for the lead associated with the business plan.
• LeadNumber: string
  Title: Lead Number

  Unique identifier for lead.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectiveId: integer (int64)
  Title: Objective ID

  The unique identifier for objective.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier for the opportunity associated with the business plan.
• OptyNumber: string
  Title: Opportunity Number

  Unique identifier for opportunity.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Lists who created the row of data.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectiveId":{
            "title":"Objective ID",
            "type":"integer",
            "description":"The unique identifier for objective.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessPlanNumber":{
            "title":"Business Plan Number",
            "maxLength":64,
            "type":"string",
            "description":"The number of the business plan for which an initiative was created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LeadNumber":{
            "title":"Lead Number",
            "type":"string",
            "description":"Unique identifier for lead.",
            "nullable":false,
            "x-queryable":true
        },
        "CustomerId":{
            "title":"Customer ID",
            "type":"integer",
            "description":"The customer identifier that is associated with the business plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier for the opportunity associated with the business plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InitiativeId":{
            "title":"Initiative ID",
            "type":"integer",
            "description":"The unique identifier for initiative.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessPlanId":{
            "title":"Business Plan ID",
            "type":"integer",
            "description":"The identification key for business plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier for the lead associated with the business plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "type":"string",
            "description":"Unique identifier for opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "title":"Goal ID",
            "type":"integer",
            "description":"The system generated identifier for the business plan goals.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : businessPlans-Goals-smartActions-item-response

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  A message to seek confirmation for the action being performed.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The content type to use when invoking the REST endpoint.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  Consumer-friendly action name.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  REST Resources the action belongs to.
• Href: string
  Title: REST Endpoint

  Maximum Length: 1024

  The REST endpoint to perform the action.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  List of applications that this action can be used in.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  Boolean type indicating if this action can be mass processed.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  HTTP method to use with HREF.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function associated with the smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates if smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Boolean type indicating if the action is seeded or custom.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  Attributes to be updated when the Actions UI is launched.
• UserActionId: integer (int64)
  Title: User Action ID

  Uniquely identifies the action. For internal use.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  Uniquely identifies the action with a name. For internal use.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  Number to indicate priority of the action.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  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.
• UserActionURLBinding: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  Binding metadata for a variable in the URL.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"REST Resources the action belongs to.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The content type to use when invoking the REST endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/businessPlans-Goals-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if this action can be mass processed.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"List of applications that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/businessPlans-Goals-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":1024,
            "type":"string",
            "description":"The REST endpoint to perform the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"HTTP method to use with HREF.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"Consumer-friendly action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"Uniquely identifies the action with a name. For internal use.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"Uniquely identifies the action. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"Number to indicate priority of the action.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean type indicating if the action is seeded or custom.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":4000,
            "type":"string",
            "description":"A message to seek confirmation for the action being performed.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/businessPlans-Goals-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"Attributes to be updated when the Actions UI is launched.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function associated with the smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Show Source

• Array of: object businessPlans-Goals-smartActions-UserActionNavigation-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/businessPlans-Goals-smartActions-UserActionNavigation-item-response"
    }
}

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

• Array of: object businessPlans-Goals-smartActions-UserActionRequestPayload-item-response

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/businessPlans-Goals-smartActions-UserActionRequestPayload-item-response"
    }
}

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

• Array of: object businessPlans-Goals-smartActions-UserActionURLBinding-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/businessPlans-Goals-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : businessPlans-Goals-smartActions-UserActionNavigation-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value indicating if the action is seeded or custom.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  Application usage.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  Metadata of the navigation as needed for the specific usage.
• UserActionNavId: integer (int64)
  Title: Primary Key

  Primary key for the user action navigation.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  Provision for having multiple navigation flows for a given usage.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the action is seeded or custom.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"Primary key for the user action navigation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"Provision for having multiple navigation flows for a given usage.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"Metadata of the navigation as needed for the specific usage.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"Application usage.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : businessPlans-Goals-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  Indicates the binding type of the value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Boolean value indicating if the payload is mandatory.
• RequestPayloadId: integer (int64)
  Uniquely identifies the payload for smart actions. For internal use.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The key in the Key Value pair that forms the payload.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value in the Key Value pair that forms the payload.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  If the value in the Key Value pair isn't a single value, this would be set.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"Indicates the binding type of the value.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"If the value in the Key Value pair isn't a single value, this would be set.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value in the Key Value pair that forms the payload.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"Uniquely identifies the payload for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The key in the Key Value pair that forms the payload.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the payload is mandatory.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : businessPlans-Goals-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  This is a hint for processing the Url Binding runtime.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean indicator.
• URLBindingId: integer (int64)
  Uniquely identifies the URL Bind for smart actions. For internal use.
• URLBindingName: string
  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.
• Value: string
  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.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"This is a hint for processing the Url Binding runtime.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":1000,
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the value in the key value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"Uniquely identifies the URL Bind for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean indicator.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":256,
            "type":"string",
            "description":"For action REST endpoints that require runtime binding, this is the key in the key value pair.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

SalesGLEndPeriodPickTimeListToViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/salesGLEndPeriodTimesLOV

Parameters:

• finder: EndPeriodFinder%3BbindPeriodType%3D{PeriodTypeCode}

The following properties are defined on the LOV link relation:

• Source Attribute: EndDisplayPeriodName; Target Attribute: PeriodName
• Display Attribute: PeriodName

SalesGLStartPeriodPickerTimeListViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/salesGLStartPeriodTimesLOV

Parameters:

• finder: StartPeriodFinder%3BbindPeriodType%3D{PeriodTypeCode}

The following properties are defined on the LOV link relation:

• Source Attribute: StartDisplayPeriodName; Target Attribute: PeriodName
• Display Attribute: PeriodName

SalesObjectiveGLPeriodTypeViewAccessor

Operation: /crmRestApi/resources/11.13.18.05/salesGLPeriodTypes

The list of values indicating the type of the goal period.

The following properties are defined on the LOV link relation:

• Source Attribute: PeriodTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

SalesObjectives

Operation: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Goals/{GoalNumber}/child/SalesObjectives

Parameters:

• BusinessPlanId: $request.path.BusinessPlanId
• GoalNumber: $request.path.GoalNumber

The sales objectives resource is used to view, create, update and delete sales objectives associated with business plan's goal.

smartActions

Operation: /crmRestApi/resources/11.13.18.05/businessPlans/{BusinessPlanId}/child/Goals/{GoalNumber}/child/smartActions

Parameters:

• BusinessPlanId: $request.path.BusinessPlanId
• GoalNumber: $request.path.GoalNumber

This VO stores the endpoint and security details for every user action.

Back to Top