Add one sourcing program objective
post
/fscmRestApi/resources/11.13.18.05/sourcingPrograms/{ProgramHeaderId}/child/sourcingProgramObjectives
Request
Path Parameters
-
ProgramHeaderId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
-
Upsert-Mode: string
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-
CategoryId: integer
(int64)
Unique identifier of the category.
-
CurrentSpend: number
Sum of the current Amount of all award completed negotiations within the objective.
-
Description: string
Maximum Length:
4000Description of the objective. -
EndDate: string
(date)
Date when the objective ends.
-
Name: string
Maximum Length:
80Name of the objective. -
ObjectiveHeaderId(required): integer
(int64)
Value that uniquely identifies the objective.
-
ObjectiveType: string
Maximum Length:
30Description of the objective type. -
ProgramHeaderId(required): integer
(int64)
Unique identifier for the program header in the program.
-
PurchasingCatFlag: boolean
Maximum Length:
1Value that indicates if the category associated with the program is purchasing category. -
RemainingTargetSpend: number
Value that indicates that target spend amount hasn't been allocated to the negotiation
-
RollUpFlag: boolean
Maximum Length:
1Value that indicates whether the savings and spend values of the objective's negotiations will be counted for program level spend and savings. -
Savings: number
Savings amount that the program is trying to achieve.
-
SavingsPercent: number
Savings percentage that the program is trying to achieve.
-
sourcingProgramNegotiations: array
Sourcing Program Objective Negotiations
Title:
Sourcing Program Objective NegotiationsDetails about an organization's sourcing program and its associated negotiations. -
StartDate: string
(date)
Date when the objective starts.
-
Status: string
Maximum Length:
30Description of the objective status. -
TargetSpend: number
Target spend that the program is trying to achieve.
-
TotalPlannedCurrentSpend: number
Sum of all the negotiation current amounts of objectives.
-
TotalPlannedSavingGoalPercent: number
Savings percentage that the program is trying to achieve.
-
TotalPlannedTargetSpend: number
Sum of Negotiation Target Spend for all the objectives.
Nested Schema : Sourcing Program Objective Negotiations
Type:
arrayTitle:
Sourcing Program Objective NegotiationsDetails about an organization's sourcing program and its associated negotiations.
Show Source
Nested Schema : schema
Type:
Show Source
object-
AuctionHeaderId: integer
(int64)
Value that uniquely identifies the negotiation.
-
AwardAmount: number
Award amount identified in the objective.
-
ObjectiveHeaderId: integer
(int64)
Value that uniquely identifies the objective.
-
ObjectiveNegotiationId: integer
(int64)
Value that uniquely identifies the objective negotiation mapping.
-
ObjectVersionNumber: integer
(int32)
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
OverrideFlag: boolean
Maximum Length:
1Value that indicates if the planned values are overridden manually. -
PlannedCurrentSpend: number
Sum of all the negotiation current amounts of objectives.
-
PlannedSavings: number
Savings amount that the program is trying to achieve.
-
PlannedSavingsPercent: number
Savings percentage that the program is trying to achieve.
-
PlannedTargetSpend: number
Sum of Negotiation Target Spend for all the objectives.
-
PlannedTitle: string
Maximum Length:
80Title for the manual contributions added to the objective. -
ProgramHeaderId: integer
(int64)
Unique identifier for the program header in the program.
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 : sourcingPrograms-sourcingProgramObjectives-item-response
Type:
Show Source
object-
CategoryId: integer
(int64)
Unique identifier of the category.
-
CreationDate: string
(date-time)
Read Only:
trueDate and time the objective row was created. -
CurrentSpend: number
Sum of the current Amount of all award completed negotiations within the objective.
-
Description: string
Maximum Length:
4000Description of the objective. -
EndDate: string
(date)
Date when the objective ends.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Maximum Length:
80Name of the objective. -
ObjectiveHeaderId: integer
(int64)
Value that uniquely identifies the objective.
-
ObjectiveType: string
Maximum Length:
30Description of the objective type. -
ProgramHeaderId: integer
(int64)
Unique identifier for the program header in the program.
-
PurchasingCatFlag: boolean
Maximum Length:
1Value that indicates if the category associated with the program is purchasing category. -
RemainingTargetSpend: number
Value that indicates that target spend amount hasn't been allocated to the negotiation
-
RollUpFlag: boolean
Maximum Length:
1Value that indicates whether the savings and spend values of the objective's negotiations will be counted for program level spend and savings. -
Savings: number
Savings amount that the program is trying to achieve.
-
SavingsPercent: number
Savings percentage that the program is trying to achieve.
-
sourcingProgramNegotiations: array
Sourcing Program Objective Negotiations
Title:
Sourcing Program Objective NegotiationsDetails about an organization's sourcing program and its associated negotiations. -
StartDate: string
(date)
Date when the objective starts.
-
Status: string
Maximum Length:
30Description of the objective status. -
TargetSpend: number
Target spend that the program is trying to achieve.
-
TotalPlannedCurrentSpend: number
Sum of all the negotiation current amounts of objectives.
-
TotalPlannedSavingGoal: number
Read Only:
truePlanned Savings Goal of all award completed negotiations within the objective. -
TotalPlannedSavingGoalPercent: number
Savings percentage that the program is trying to achieve.
-
TotalPlannedTargetSpend: number
Sum of Negotiation Target Spend for all the objectives.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Sourcing Program Objective Negotiations
Type:
arrayTitle:
Sourcing Program Objective NegotiationsDetails about an organization's sourcing program and its associated negotiations.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : sourcingPrograms-sourcingProgramObjectives-sourcingProgramNegotiations-item-response
Type:
Show Source
object-
AuctionHeaderId: integer
(int64)
Value that uniquely identifies the negotiation.
-
AwardAmount: number
Award amount identified in the objective.
-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the objective row. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectiveHeaderId: integer
(int64)
Value that uniquely identifies the objective.
-
ObjectiveNegotiationId: integer
(int64)
Value that uniquely identifies the objective negotiation mapping.
-
ObjectVersionNumber: integer
(int32)
Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
-
OverrideFlag: boolean
Maximum Length:
1Value that indicates if the planned values are overridden manually. -
PlannedCurrentSpend: number
Sum of all the negotiation current amounts of objectives.
-
PlannedSavings: number
Savings amount that the program is trying to achieve.
-
PlannedSavingsPercent: number
Savings percentage that the program is trying to achieve.
-
PlannedTargetSpend: number
Sum of Negotiation Target Spend for all the objectives.
-
PlannedTitle: string
Maximum Length:
80Title for the manual contributions added to the objective. -
ProgramHeaderId: integer
(int64)
Unique identifier for the program header in the program.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- sourcingProgramNegotiations
-
Parameters:
- ObjectiveHeaderId:
$request.path.ObjectiveHeaderId - ProgramHeaderId:
$request.path.ProgramHeaderId
Details about an organization's sourcing program and its associated negotiations. - ObjectiveHeaderId: