1. REST API for Oracle Fusion Cloud Procurement
  2. Tasks
  3. Mass Replacement Organizations

Get all organizations

get

/fscmRestApi/resources/11.13.18.05/massReplacementOrgs

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 Find replacement organizations according to the primary key.
      Finder Variables
      • OrganizationId; integer; Value that uniquely identifies the organization.
      • RequisitioningBUId; integer; Value that uniquely identifies the requisitioning business unit entity.
    • findByItemAndProcurementBU Find replacement organizations according to the primary item and procurement business unit.
      Finder Variables
      • bindItemId; integer;
      • bindMPN; string;
      • bindPrcBuId; integer;
      • bindReplacementId; integer;
      • bindVendorId; integer;
      • bindVendorSiteId; integer;
  • 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:
    • AlternateItem; string; Attribute that indicates the values of the substitute master item and the corresponding item description for the disrupted item in an impacted inventory organization.
    • AlternateItemCount; integer; Count of alternate internal items for an inventory organization.
    • AlternateMPN; string; Attribute that indicates the values of the alternate manufacturer part number (MPN) and the corresponding manufacturer part description for the disrupted MPN in an impacted inventory organization.
    • AlternateMPNCount; integer; Count of alternate manufacturer part numbers for an inventory organization.
    • AlternateSupplier; string; Attribute that indicates the values of the alternate supplier and the corresponding supplier site for the disrupted item or manufacturer part number (MPN) in an impacted inventory organization.
    • AlternateSupplierCount; integer; Count of alternate suppliers for an inventory organization.
    • ErrorFlag; boolean; Attribute indicating that an exception occurred during the execution of the mass replacement process for a replacement organization.
    • GroupId; integer; Attribute that indicates the unique identifier for the grouping done on the impacted organizations for an item replacement task.
    • GroupedOrgIds; string; Unique identifier for a set of grouped organizations.
    • GroupedRequisitioningBUIds; string; Unique identifier for a set of grouped requisitioning business units.
    • OrganizationCode; string; Abbreviation that identifies the master organization with which the primary item is associated.
    • OrganizationId; integer; Value that uniquely identifies the inventory organization.
    • OrganizationName; string; Name of the inventory organization.
    • PrimarySourceDetails; string; Value that represents the source agreement details for the disrupted item.
    • PurchaseOrderLinesCount; integer; Count of purchase order lines that can possibly undergo replacement.
    • ReinstateDate; string; Date on which the reinstate action is initiated and the replacement period ends.
    • ReplacementDate; string; Date on which the replacement action is initiated and the replacement period begins.
    • ReplacementDetailId; integer; Value that uniquely identifies the replacement line.
    • ReplacementMethod; string; Value that indicates the replacement method selected, whether alternate supplier or alternate item.
    • RequisitioningBUId; integer; Value that uniquely identifies the requisitioning business unit.
    • RequisitioningBUName; string; Name of the requisitioning business unit.
    • SearchOrganizationCode; string; Organization code attribute used as a search criteria to get the impacted organizations for an item-replacement task.
    • SelectedReplacement; string; Value of the replacement option selected. When the replacement method is alternate supplier, this value is populated with the supplier name. If the replacement method is alternate item, this value is populated with MPN or internal item number depending on the item number type selected while defining the replacement.
    • Status; string; Status of replacement at the organization level.
    • StatusCode; string; Lookup value code of the replacement status at the organization level.
  • 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 : massReplacementOrgs
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : massReplacementOrgs-item-response
Type: object
Show Source
  • Read Only: true
    Attribute that indicates the values of the substitute master item and the corresponding item description for the disrupted item in an impacted inventory organization.
  • Read Only: true
    Count of alternate internal items for an inventory organization.
  • Read Only: true
    Attribute that indicates the values of the alternate manufacturer part number (MPN) and the corresponding manufacturer part description for the disrupted MPN in an impacted inventory organization.
  • Read Only: true
    Count of alternate manufacturer part numbers for an inventory organization.
  • Read Only: true
    Attribute that indicates the values of the alternate supplier and the corresponding supplier site for the disrupted item or manufacturer part number (MPN) in an impacted inventory organization.
  • Read Only: true
    Count of alternate suppliers for an inventory organization.
  • Read Only: true
    Attribute indicating that an exception occurred during the execution of the mass replacement process for a replacement organization.
  • Read Only: true
    Maximum Length: 255
    Unique identifier for a set of grouped organizations.
  • Read Only: true
    Maximum Length: 255
    Unique identifier for a set of grouped requisitioning business units.
  • Read Only: true
    Attribute that indicates the unique identifier for the grouping done on the impacted organizations for an item replacement task.
  • Links
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the master organization with which the primary item is associated.
  • Read Only: true
    Value that uniquely identifies the inventory organization.
  • Read Only: true
    Maximum Length: 240
    Name of the inventory organization.
  • Read Only: true
    Maximum Length: 255
    Value that represents the source agreement details for the disrupted item.
  • Read Only: true
    Count of purchase order lines that can possibly undergo replacement.
  • Read Only: true
    Date on which the reinstate action is initiated and the replacement period ends.
  • Read Only: true
    Date on which the replacement action is initiated and the replacement period begins.
  • Read Only: true
    Value that uniquely identifies the replacement line.
  • Read Only: true
    Value that indicates the replacement method selected, whether alternate supplier or alternate item.
  • Read Only: true
    Value that uniquely identifies the requisitioning business unit.
  • Read Only: true
    Maximum Length: 240
    Name of the requisitioning business unit.
  • Read Only: true
    Maximum Length: 255
    Organization code attribute used as a search criteria to get the impacted organizations for an item-replacement task.
  • Read Only: true
    Value of the replacement option selected. When the replacement method is alternate supplier, this value is populated with the supplier name. If the replacement method is alternate item, this value is populated with MPN or internal item number depending on the item number type selected while defining the replacement.
  • Read Only: true
    Status of replacement at the organization level.
  • Read Only: true
    Lookup value code of the replacement status at the organization level.
Back to Top

Examples

This example describes how to get all organizations.

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/massReplacementOrgs"

For example, here's how you get one or more organizations for an item replacement task using the findByItemAndProcurementBU finder..

curl -u username:password "https://servername/fscmRestApi/resources/version/massReplacementOrgs?finder=findByItemAndProcurementBU;bindItemId=300100545303414,bindPrcBuId=300100200125593,bindVendorId=6134,bindVendorSiteId=300100203539381,bindReplacementId=300100550388630,bindMPN=MFG2020"

Example Response Body

The following example includes the contents of the response body in JSON format:
"{
  "items" : [ {
    "AlternateItemCount" : 0,
    "AlternateMPNCount" : 2,
    "AlternateSupplierCount" : 1,
    "ErrorFlag" : "false",
    "OrganizationCode" : "HC01",
    "OrganizationId" : 300100200296143,
    "OrganizationName" : "Vision General Hospital",
    "PurchaseOrderLinesCount" : 0,
    "ReinstateDate" : null,
    "ReplacementDate" : null,
    "ReplacementDetailId" : null,
    "ReplacementMethod" : null,
    "RequisitioningBUId" : 300100200125593,
    "RequisitioningBUName" : "Vision Healthcare USA",
    "SelectedReplacement" : null,
    "Status" : "Pending replacement",
    "StatusCode" : "ORA_SCH_PR_PENDING_REPLACE",
    "@context" : {
      "key" : "300100200296143,300100200125593",
      "links" : [ {
        "rel" : "self",
        "href" : "https://servername/fscmRestApi/resources/version/massReplacementOrgs/300100200296143%2C300100200125593",
        "name" : "massReplacementOrgs",
        "kind" : "item"
      }, {
        "rel" : "canonical",
        "href" : "https://servername/fscmRestApi/resources/version/massReplacementOrgs/300100200296143%2C300100200125593",
        "name" : "massReplacementOrgs",
        "kind" : "item"
      } ]
    }
  }, {
    "AlternateItemCount" : 0,
    "AlternateMPNCount" : 2,
    "AlternateSupplierCount" : 1,
    "ErrorFlag" : "false",
    "OrganizationCode" : "HC03",
    "OrganizationId" : 300100544481597,
    "OrganizationName" : "Vision Health Distribution Centre",
    "PurchaseOrderLinesCount" : 0,
    "ReinstateDate" : null,
    "ReplacementDate" : null,
    "ReplacementDetailId" : null,
    "ReplacementMethod" : null,
    "RequisitioningBUId" : 300100544473723,
    "RequisitioningBUName" : "Vision Healthcare Logistics",
    "SelectedReplacement" : null,
    "Status" : "Pending replacement",
    "StatusCode" : "ORA_SCH_PR_PENDING_REPLACE",
    "@context" : {
      "key" : "300100544481597,300100544473723",
      "links" : [ {
        "rel" : "self",
        "href" : "https://servername/fscmRestApi/resources/version/massReplacementOrgs/300100544481597%2C300100544473723",
        "name" : "massReplacementOrgs",
        "kind" : "item"
      }, {
        "rel" : "canonical",
        "href" : "https://servername/fscmRestApi/resources/version/massReplacementOrgs/300100544481597%2C300100544473723",
        "name" : "massReplacementOrgs",
        "kind" : "item"
      } ]
    }
  } ],
  "totalResults" : 2,
  "count" : 2,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
  "links" : [ {
    "rel" : "self",
    "href" : "https://servername/fscmRestApi/resources/version/massReplacementOrgs",
    "name" : "massReplacementOrgs",
    "kind" : "collection"
  } ]
}"
Back to Top