Get one sourcing program objective
get
/fscmRestApi/resources/11.13.18.05/sourcingPrograms/{ProgramHeaderId}/child/sourcingProgramObjectives/{ObjectiveHeaderId}
Request
Path Parameters
-
ObjectiveHeaderId(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=
-
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=
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 TopResponse
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-
AssignedTo: string
Read Only:
trueMaximum Length:240User assigned to the sourcing program objective. -
attachments: array
Sourcing Program Objectives Attachments
Title:
Sourcing Program Objectives AttachmentsAttachments associated with a sourcing program objective. -
CategoryId: integer
(int64)
Unique identifier of the category.
-
CategoryNameDisplay: string
Read Only:
trueMaximum Length:2400Name of the category of the sourcing program objective. -
Comments: string
Maximum Length:
4000Unique 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. -
NegotiatedAwardAmount: number
Read Only:
trueName of the objective. -
NegotiatedSavings: number
Read Only:
trueNegotiated savings amount for the sourcing program objective. -
NegotiatedSavingsPercent: number
Read Only:
truePercentage of negotiated savings for the sourcing program objective. -
NegotiationCurrentSpend: number
Read Only:
trueCurrent spend defined in the sourcing program objective. -
NegotiationSavingsGoal: number
Read Only:
trueSavings goal for the negotiation. -
NegotiationSavingsGoalPercent: number
Read Only:
truePercentage savings goal for the negotiation. -
NegotiationTargetSpend: number
Read Only:
trueTarget spend defined in the sourcing program objective. -
ObjectiveDisplayStatus: string
Maximum Length:
255Display status of the objective. -
ObjectiveHeaderId: integer
(int64)
Value that uniquely identifies the objective.
-
ObjectiveType: string
Maximum Length:
30Description of the objective type. -
ObjectiveTypeDisplay: string
Read Only:
trueMaximum Length:255Type of the sourcing program objective. -
PersonId: integer
(int64)
Description of the objective type.
-
PlannedCurrentSpend: number
Read Only:
truePlanned current spend defined for the sourcing program objective. -
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.
-
SavingsDeviation: number
Read Only:
trueDifference between the target savings and the actual savings for the sourcing program objective. -
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 : Sourcing Program Objectives Attachments
Type:
arrayTitle:
Sourcing Program Objectives AttachmentsAttachments associated with a sourcing program objective.
Show Source
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 : sourcingPrograms-sourcingProgramObjectives-attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdUnique identifier of the asynchronous tracker. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdUnique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category name of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255Details about an organization's sourcing objectives and the associated negotiations. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueUser who created the attachment. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the attachment was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILECode that identifies the attachment data type. -
Description: string
Title:
DescriptionMaximum Length:255Details about an organization's sourcing objectives and the associated negotiations. -
DmDocumentId: string
Maximum Length:
255Unique identifier of the attachment document. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Folder path where the attachment is stored. -
DmVersionNumber: string
Maximum Length:
255Version number of the attachment. -
DownloadInfo: string
Title:
DownloadInfoInformation used to download the attachment. -
ErrorStatusCode: string
Title:
Error Status CodeCode that indicates the attachment error status. -
ErrorStatusMessage: string
Title:
Error Status MessageError message that indicates the attachment upload status. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe date when the attachment expires. -
FileContents: string
(byte)
Title:
File ContentsContents of the attachment file. -
FileName: string
Title:
File NameMaximum Length:2048Details about an organization's sourcing objectives and the associated negotiations. -
FileUrl: string
Title:
File UrlURL of the attachment file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueWeb image of the attachment file. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the attachment was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255Details about an organization's sourcing objectives and the associated negotiations. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueUser name used to update the attachment for the sourcing program objective. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionAction to be performed on the attachment after it's uploaded. -
Title: string
Title:
TitleDetails about an organization's sourcing objectives and the associated negotiations. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the uploaded file. -
UploadedFileLength: integer
Title:
File SizeFile size of the uploaded attachment. -
UploadedFileName: string
Title:
Uploaded File NameName of the uploaded file. -
UploadedText: string
Title:
Uploaded TextText of the uploaded attachment. -
Uri: string
Title:
UriMaximum Length:4000Uniform resource identifier of the attachment. -
Url: string
Title:
UrlMaximum Length:4000URL of the attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255User name associated with the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
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
Title:
Negotiated Award AmountAward 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.
-
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
- attachments
-
Parameters:
- ObjectiveHeaderId:
$request.path.ObjectiveHeaderId - ProgramHeaderId:
$request.path.ProgramHeaderId
Attachments associated with a sourcing program objective. - ObjectiveHeaderId:
- sourcingProgramNegotiations
-
Parameters:
- ObjectiveHeaderId:
$request.path.ObjectiveHeaderId - ProgramHeaderId:
$request.path.ProgramHeaderId
Details about an organization's sourcing program and its associated negotiations. - ObjectiveHeaderId: