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

Get all mass replacement exceptions

get

/fscmRestApi/resources/11.13.18.05/massReplacementExceptions

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 mass replacement exception according to the primary key.
      Finder Variables
      • ExceptionId; integer; Value that uniquely identifies the exception entity.
      • OrganizationId; integer; Value that uniquely identifies the organization entity in which a purchase order has an exception during the mass replacement process.
      • PODetailId; integer; Value that uniquely identifies the purchase order detail entity that has an exception during the mass replacement process.
      • ReplacementDetailId; integer; Value that uniquely identifies the replacement line entity.
      • ReplacementId; integer; Value that uniquely identifies the replacement header entity.
  • 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:
    • ErrorMessage; string; Attribute that shows the error message for the exception that occurs during the mass replacement process.
    • ExceptionId; integer; Value that uniquely identifies the exception.
    • GroupId; integer; Attribute that indicates the unique identifier for the grouping done on the impacted organizations for an item replacement task.
    • OrderNumber; string; Number of the purchase order header that has any exception during the mass replacement process.
    • OrganizationCode; string; Abbreviation that identifies the organization in which purchase order has an exception during the mass replacement process.
    • OrganizationId; integer; Value that uniquely identifies the organization in which purchase order has an exception during the mass replacement process.
    • PODetailId; integer; Value that uniquely identifies the purchase order detail that has an exception during the mass replacement process.
    • POHeaderId; integer; Value that uniquely identifies the purchase order header that has an exception during the mass replacement process.
    • POLine; number; Number of the purchase order line that has any exception during the mass replacement process.
    • POLineId; integer; Value that uniquely identifies the PO line that has an exception during the mass replacement process.
    • POUpdateException; string; Attribute that indicates the action taken on the purchase order line for which there is an exception during the mass replacement process.
    • POUpdateExceptionCode; string; Abbreviation that indicates the action taken on the purchase order line for which there is an exception during the mass replacement process.
    • ReplacementDetailId; integer; Value that uniquely identifies the replacement line.
    • ReplacementId; integer; Value that uniquely identifies the replacement header.
    • ReplacementNumber; integer; Number that uniquely identifies the replacement header.
    • ReplacementOrderNumber; string; Number of the replacement purchase order created by the mass replacement process.
    • ReplacementPOHeaderId; integer; Value that uniquely identifies the replacement purchase order header that has been created by the mass replacement process.
    • ReplacementPOLine; number; Number of the replacement purchase order line created by the mass replacement process.
    • ReplacementPOLineId; integer; Value that uniquely identifies the replacement purchase order line that has been created by the mass replacement process.
  • 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 : massReplacementExceptions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : massReplacementExceptions-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 2000
    Attribute that shows the error message for the exception that occurs during the mass replacement process.
  • Read Only: true
    Value that uniquely identifies the exception.
  • Attribute that indicates the unique identifier for the grouping done on the impacted organizations for an item replacement task.
  • Links
  • Title: Order
    Read Only: true
    Maximum Length: 30
    Number of the purchase order header that has any exception during the mass replacement process.
  • Read Only: true
    Maximum Length: 18
    Abbreviation that identifies the organization in which purchase order has an exception during the mass replacement process.
  • Read Only: true
    Value that uniquely identifies the organization in which purchase order has an exception during the mass replacement process.
  • Read Only: true
    Value that uniquely identifies the purchase order detail that has an exception during the mass replacement process.
  • Read Only: true
    Value that uniquely identifies the purchase order header that has an exception during the mass replacement process.
  • Title: Line
    Read Only: true
    Number of the purchase order line that has any exception during the mass replacement process.
  • Read Only: true
    Value that uniquely identifies the PO line that has an exception during the mass replacement process.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Attribute that indicates the action taken on the purchase order line for which there is an exception during the mass replacement process.
  • Title: Lookup Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that indicates the action taken on the purchase order line for which there is an exception during the mass replacement process.
  • Value that uniquely identifies the replacement line.
  • Read Only: true
    Value that uniquely identifies the replacement header.
  • Read Only: true
    Number that uniquely identifies the replacement header.
  • Title: Order
    Read Only: true
    Maximum Length: 30
    Number of the replacement purchase order created by the mass replacement process.
  • Read Only: true
    Value that uniquely identifies the replacement purchase order header that has been created by the mass replacement process.
  • Title: Line
    Read Only: true
    Number of the replacement purchase order line created by the mass replacement process.
  • Read Only: true
    Value that uniquely identifies the replacement purchase order line that has been created by the mass replacement process.
Back to Top

Examples

This example describes how to get all mass replacement exceptions.

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

Example Response Body

The following shows an example of the response body in JSON format.
"{

  "ExceptionId": 30012345680,
  "ReplacementDetailId": 2107,
  "ReplacementId": 3217,
  "ReplacementNumber": 60102,
  "POHeaderId": 380025,
  "OrderNumber": "PSR-380025",
  "POLineId": 362935,
  "POLine": 1,
  "OrganizationId": 7067,
  "OrganizationCode": "IN3",
  "ErrorMessage": "Test Error Message",
  "POUpdateExceptionCode": "ORA_SCH_PR_PO_CANCEL",
  "POUpdateException": "Cancel PO lines",
  "PODetailId": 23457,
  "ReplacementPOHeaderId": 422168,
  "ReplacementOrderNumber": "1000071",
  "ReplacementPOLineId": 380101,
  "ReplacementPOLine": 1

}"
Back to Top