1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Sourcing Programs

Get all sourcing programs

get

/fscmRestApi/resources/11.13.18.05/sourcingPrograms

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds a sourcing program with the specified primary key.
      Finder Variables
      • ProgramHeaderId; integer; Value that uniquely identifies a sourcing program.
    • ProgramsByNegotiationFinder Finds sourcing programs for the specified negotiation.
      Finder Variables
      • bindAuctionHeaderId; integer;
    • ProgramsByTeamMembersFinder Finds sourcing programs for the specified team member.
      Finder Variables
      • bindTeamMemberPersonIds; string;
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BaseLineNotAllocatedToObjective; number; Baseline amount that isn't allocated to objectives in a sourcing program.
    • CanDeleteFlag; boolean; Indicates whether the sourcing program can be deleted. Contains one of the following values: true or false. If true, then you can delete the sourcing program. If false, then you can't delete the sourcing program. This attribute doesn't have a default value.
    • CanEditFlag; boolean; Indicates whether the sourcing program can be edited. Contains one of the following values: true or false. If true, then you can edit the sourcing program. If false, then you can't edit the sourcing program. This attribute doesn't have a default value.
    • CanEditMonitorActionFlag; boolean; Indicates whether a user can edit the program by using actions on the monitor. Contains one of the following values: true or false. If true, then editing the monitor action is allowed. If false, then editing the monitor action isn't allowed. This attribute doesn't have a default value.
    • CanLaunchFlag; boolean; Indicates whether the sourcing program can be launched. Contains one of the following values: true or false. If true, then you can start the sourcing program. If false, then you can't start the sourcing program. This attribute doesn't have a default value.
    • CanMonitorFlag; boolean; Indicates whether the sourcing program can be monitored. Contains one of the following values: true or false. If true, then you can monitor the sourcing program. If false, then you can't monitor the sourcing program. This attribute doesn't have a default value.
    • CanUpdateObjectiveResultsFlag; boolean; Indicates whether objective results can be updated. Contains one of the following values: true or false. If true, then objective results can be updated. If false, then objective results can't be updated. This attribute doesn't have a default value.
    • CategoryId; integer; Indicates the unique identifier of category.
    • CategoryName; string; Category name of the program.
    • Comments; string; Comments provided while creating the program.
    • CurrencyCode; string; Base currency code in which the negotiation will be conducted.
    • CurrencyName; string; Base currency code in which the negotiation will be conducted.
    • CurrentSpend; number; Current spend for which the program is created.
    • DisplayPhase; string; Description of the program phase.
    • DisplayStatus; string; Description of the program status.
    • EndDate; string; The date when the program ends.
    • GlobalProgramFlag; boolean; Value that indicates if the program is global.
    • ListName; string; List name of the person in the program.
    • NegotiatedSavings; number; Amount saved through negotiation for the sourcing program.
    • NegotiatedSavingsPercent; number; Amount saved through negotiation for the sourcing program.
    • NegotiationSavingsGoal; number; Savings goal for the negotiation.
    • NegotiationSavingsGoalPercent; number; Savings goal for the negotiation.
    • PersonId; integer; Identifier of the person who created the program.
    • PersonNameId; integer; Unique identifier of the sourcing program owner.
    • PhaseDisplayOrder; integer; Sequence in which the program phase is displayed.
    • PlannedTargetSpend; number; Planned target spend for the sourcing program.
    • Precision; integer; Planned target spend for the sourcing program.
    • ProcurementBUId; integer; Unique identifier of the procurement business unit for which the program was created. It's populated only when the program isn't global.
    • ProgramHeaderId; integer; Value that uniquely identifies the program.
    • ProgramPhase; string; Determines phase of the program.
    • ProgramStatus; string; Determines status of the program.
    • PurchasingCatFlag; boolean; Indicates whether the category associated with the program is purchasing category.
    • RateDate; string; Conversion date for the selected rate type.
    • RateType; string; Rate type selected for the program.
    • RemainingTargetSpend; number; Remaining target spend for the sourcing program.
    • Savings; number; Savings amount that the program is trying to achieve.
    • SavingsDeviation; number; Difference between the actual savings and the planned savings for the sourcing program.
    • SavingsPercent; number; Savings percentage that the program is trying to achieve.
    • StartDate; string; Date when the program starts.
    • Synopsis; string; Program synopsis as defined by the user.
    • TargetSpend; number; Target spend that the program is trying to achieve.
    • Title; string; Program title defined by the user.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : sourcingPrograms
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : sourcingPrograms-item-response
Type: object
Show Source
Nested Schema : Sourcing Program Attachments
Type: array
Title: Sourcing Program Attachments
Attachments associated with a sourcing program objective.
Show Source
Nested Schema : DFF
Type: array
Show Source
Nested Schema : Sourcing Program Team Members
Type: array
Title: Sourcing Program Team Members
Details about an organization's sourcing program and its associated team members.
Show Source
Nested Schema : Sourcing Program Objectives
Type: array
Title: Sourcing Program Objectives
Details about an organization's sourcing program and its associated objectives.
Show Source
Nested Schema : sourcingPrograms-attachments-item-response
Type: object
Show Source
Nested Schema : sourcingPrograms-DFF-item-response
Type: object
Show Source
Nested Schema : sourcingPrograms-sourcingProgramMembers-item-response
Type: object
Show Source
Nested Schema : sourcingPrograms-sourcingProgramObjectives-item-response
Type: object
Show Source
Nested Schema : Sourcing Program Objectives Attachments
Type: array
Title: Sourcing Program Objectives Attachments
Attachments associated with a sourcing program objective.
Show Source
Nested Schema : Sourcing Program Objective Negotiations
Type: array
Title: Sourcing Program Objective Negotiations
Details about an organization's sourcing program and its associated negotiations.
Show Source
Nested Schema : sourcingPrograms-sourcingProgramObjectives-attachments-item-response
Type: object
Show Source
Nested Schema : sourcingPrograms-sourcingProgramObjectives-sourcingProgramNegotiations-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all sourcing programs.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/sourcingPrograms"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/sourcingPrograms"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
"items": [
{
"ProgramHeaderId": "300100201311057",
"ProgramPhase": "NOT_STARTED",
"Savings": null,
"SavingsPercent": null,
"StartDate": null,
"Synopsis": null,
"TargetSpend": null,
"Title": "SPG_RO_1579791786",
"RateType": "Corporate",
"RateDate": "2020-01-23",
"PurchasingCatFlag": null,
"ProgramStatus": null,
"ProcurementBUId": null,
"PersonId": "300100037430652",
"CurrencyCode": "USD",
"CurrentSpend": null,
"Comments": null,
"CategoryId": null,
"EndDate": null,
"GlobalProgramFlag": true,
"CategoryName": null,
"DisplayPhase": "Not started",
"DisplayStatus": null,
"ListName": "PRC PON00007",
"PersonNameId": "300100037430653",
"PhaseDisplayOrder": "1",
"@context": {
"key": "300100201311057",
"headers": {
"ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
},
"links": [
{
"rel": "self",
"href": "https://cptcmmvqy.fusionapps.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/sourcingPrograms/300100201311057",
"name": "sourcingPrograms",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://cptcmmvqy.fusionapps.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/sourcingPrograms/300100201311057",
"name": "sourcingPrograms",
"kind": "item"
},
{
"rel": "child",
"href": "https://cptcmmvqy.fusionapps.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/sourcingPrograms/300100201311057/child/sourcingProgramMembers",
"name": "sourcingProgramMembers",
"kind": "collection"
},
{
"rel": "child",
"href": "https://cptcmmvqy.fusionapps.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/sourcingPrograms/300100201311057/child/sourcingProgramObjectives",
"name": "sourcingProgramObjectives",
"kind": "collection"
}
]
}
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://cptcmmvqy.fusionapps.ocs.oc-test.com:443/fscmRestApi/resources/11.13.18.05/sourcingPrograms",
"name": "sourcingPrograms",
"kind": "collection"
}
]
}
Back to Top