Create an objective
post
/crmRestApi/resources/11.13.18.05/salesObjectives
Request
Header Parameters
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccountId: integer
(int64)
Title:
Account
Account unique identifier. -
AccountName: string
Title:
Account
The name of the account. -
ActualValue: integer
Title:
Attainment
The actual attainment value for the objective. -
AttachmentsVO: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
BusinessPlanId: integer
(int64)
Title:
Business Plan ID
The unique identifier of the business plan. -
BusinessPlanNumber: string
Title:
Business Plan Number
Maximum Length:64
The alternate key identifier for the business plan. -
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. -
Description: string
Title:
Description
Maximum Length:2000
The description of the objective. -
EndDisplayPeriodName(required): 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
Geography unique identifier. -
GeographyKey: string
Geography public unique identifier.
-
GeographyName: string
Title:
Geography
Maximum Length:255
Name of the Geography. -
Name(required): 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. -
ObjectiveTypeCode(required): 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(required): 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. -
PeriodTypeCode(required): 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. -
ProductGroupId: integer
(int64)
Title:
Product Group
Product Group unique identifier. -
ProductGroupName: string
Title:
Product Group
Maximum Length:250
Name of the Product Group. -
ProductGroupReferenceNumber: string
Title:
Reference Number
Maximum Length:50
ProductGroup Reference Number. -
SalesObjectiveSplits: array
Objective Splits
Title:
Objective Splits
The objective splits resource is used to view, create, update, and delete objective splits. Objective splits represent a measureable target and the actual attainment for a given segment of the market restricted by one or more parameters. -
StartDisplayPeriodName(required): 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.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Objective Splits
Type:
array
Title:
Objective Splits
The objective splits resource is used to view, create, update, and delete objective splits. Objective splits represent a measureable target and the actual attainment for a given segment of the market restricted by one or more parameters.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment.
Nested Schema : salesObjectives-SalesObjectiveSplits-item-post-request
Type:
Show Source
object
-
AccountId: integer
(int64)
Title:
Account
The unique identifier of the account assigned to the objective. -
ActualValue: integer
(int64)
Title:
Attainment
Default Value:0
The actual attainment value for the objective split. -
DisplayPeriodName: string
Title:
Period
Maximum Length:15
The display name for the objective split period. -
GeographyId: integer
(int64)
Title:
Geography
The unique identifier for the geography. -
GeographyName: string
Title:
Geography
Maximum Length:255
The name of the geography, such as JAPAC, EMEA, or Americas. -
ObjectiveId: integer
(int64)
Title:
Objective
The unique identifier of the objective. -
ObjectiveSplitId: integer
(int64)
The unique identifier of the objective split.
-
PeriodType: string
Title:
Period Type Code
Maximum Length:30
The type of period for the objective split. -
ProductId: integer
(int64)
Title:
Product Group
The unique identifier for the product. -
TargetValue: integer
(int64)
Title:
Target
Default Value:0
The unique identifier for the target of the objective split.
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.
Root Schema : salesObjectives-item-response
Type:
Show Source
object
-
AccountId: integer
(int64)
Title:
Account
Account unique identifier. -
AccountName: string
Title:
Account
The name of the account. -
AccountNumber: string
Read Only:
true
Maximum Length:30
Puid for the Account. -
ActualValue: integer
Title:
Attainment
The actual attainment value for the objective. -
AttachmentsVO: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
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
Geography unique identifier. -
GeographyKey: string
Geography public unique identifier.
-
GeographyName: string
Title:
Geography
Maximum Length:255
Name of the Geography. -
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. -
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. -
PeriodEndDate: string
(date)
Title:
End Date
Read Only:true
Period End Date -
PeriodStartDate: string
(date)
Title:
Start Date
Read Only:true
Period Start Date -
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
Product Group unique identifier. -
ProductGroupName: string
Title:
Product Group
Maximum Length:250
Name of the Product Group. -
ProductGroupReferenceNumber: string
Title:
Reference Number
Maximum Length:50
ProductGroup Reference Number. -
SalesObjectiveSplits: array
Objective Splits
Title:
Objective Splits
The objective splits resource is used to view, create, update, and delete objective splits. Objective splits represent a measureable target and the actual attainment for a given segment of the market restricted by one or more parameters. -
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.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Objective Splits
Type:
array
Title:
Objective Splits
The objective splits resource is used to view, create, update, and delete objective splits. Objective splits represent a measureable target and the actual attainment for a given segment of the market restricted by one or more parameters.
Show Source
Nested Schema : salesObjectives-AttachmentsVO-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : salesObjectives-SalesObjectiveSplits-item-response
Type:
Show Source
object
-
AccountId: integer
(int64)
Title:
Account
The unique identifier of the account assigned to the objective. -
ActualValue: integer
(int64)
Title:
Attainment
Default Value:0
The actual attainment value for the objective split. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
DisplayPeriodName: string
Title:
Period
Maximum Length:15
The display name for the objective split period. -
GeographyId: integer
(int64)
Title:
Geography
The unique identifier for the geography. -
GeographyName: string
Title:
Geography
Maximum Length:255
The name of the geography, such as JAPAC, EMEA, or Americas. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date on which the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
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. -
ObjectiveId: integer
(int64)
Title:
Objective
The unique identifier of the objective. -
ObjectiveSplitId: integer
(int64)
The unique identifier of the objective split.
-
PartyUniqueName: string
Read Only:
true
Maximum Length:900
The name of the account. -
PeriodType: string
Title:
Period Type Code
Maximum Length:30
The type of period for the objective split. -
ProdGroupName: string
Title:
Product Group
Read Only:true
Maximum Length:250
The name of the product group. -
ProductId: integer
(int64)
Title:
Product Group
The unique identifier for the product. -
TargetValue: integer
(int64)
Title:
Target
Default Value:0
The unique identifier for the target of the objective split.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- AttachmentsVO
-
Parameters:
- ObjectiveId:
$request.path.ObjectiveId
The attachments resource is used to view, create, and update attachments. - ObjectiveId:
- LovSalesObjectiveTypeVO
-
Parameters:
- finder:
SalesObjectiveTypeFinder%3BBindObjectiveTypeCode%3D{ObjectiveTypeCode}
Sales Objective Types - finder:
- ProductGroupViewAccessor
-
Parameters:
- finder:
ProductGroupList
Name for Product Group detail base public view object. - finder:
- RatedCurrenciesVO
-
The rated currencies resource is used to view details of currency codes for CRM. It gives a list of accepted values that are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
- SalesGLEndPeriodPickTimeListToViewAccessor
-
Parameters:
- finder:
EndPeriodFinder%3BbindPeriodType%3D{PeriodTypeCode}
The End Period resource lets you view all end periods. - finder:
- SalesGLStartPeriodPickerTimeListViewAccessor
-
Parameters:
- finder:
StartPeriodFinder%3BbindPeriodType%3D{PeriodTypeCode}
The start period resource lets you view the start periods. - finder:
- SalesObjectiveGLPeriodTypeViewAccessor
-
The Period Type resource lets you view all available period types.
- SalesObjectiveSplits
-
Operation: /crmRestApi/resources/11.13.18.05/salesObjectives/{ObjectiveId}/child/SalesObjectiveSplitsParameters:
- ObjectiveId:
$request.path.ObjectiveId
The objective splits resource is used to view, create, update, and delete objective splits. Objective splits represent a measureable target and the actual attainment for a given segment of the market restricted by one or more parameters. - ObjectiveId:
Examples
The following example shows how to create an objective by submitting a post request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X POST https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives
Example of Request Body
The following shows an example of the request body in JSON format.
{ "ObjectiveTypeCode" : "Amount", "Name" : "Obj_REST", "StartDisplayPeriodName" : "2016", "EndDisplayPeriodName" : "2017", "PeriodTypeCode" : "YEAR" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "ActualValue": null, "BusinessPlanId": null, "CreatedBy": "SALES_ADMIN", "CreationDate": "2016-11-10T23:07:56-08:00", "CurrencyCode": "USD", "Description": null, "EndPeriodName": null, "LastUpdateDate": "2016-11-10T23:07:56-08:00", "LastUpdateLogin": "4101B34432126FE8E05392D0F00A4D46", "LastUpdatedBy": "SALES_ADMIN", "Name": "Obj_REST", "ObjectiveId": 300100091619347, "ObjectiveTypeCode": "Amount", "PeriodTypeCode": "YEAR", "StartPeriodName": null, "TargetValue": null, "ObjectiveNumber": "CDRM_12006", "OrigCreationDate": "2016-11-10T23:07:56-08:00", "UnitOfMeasureCode": "AMOUNT", "ObjectiveTypeName": "Amount", "UnitOfMeasureName": "Amount", "PeriodTypeName": "Year", "BusinessPlanName": null, "BusinessPlanNumber": null, "StartDisplayPeriodName": "2016", "EndDisplayPeriodName": "2017", "UpdateFlag": true, "DeleteFlag": true, "links":[ {"rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347",...}, {"rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347",…}, {"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/lov/LovSalesObjectiveTypeVO",...}, {"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/lov/SalesGLStartPeriodPickerTimeListViewAccessor",...}, {"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/lov/SalesObjectiveGLPeriodTypeViewAccessor",...}, {"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/lov/RatedCurrenciesVO",...}, {"rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/lov/SalesGLEndPeriodPickTimeListToViewAccessor",...}, {"rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/salesObjectives/300100091619347/child/SalesObjectiveSplits",...} ] }