Get one purchase order impacted by mass replacement
get
/fscmRestApi/resources/11.13.18.05/summaryOfMassReplacementPurchaseOrders/{PODetailId}
Request
Path Parameters
-
PODetailId(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:
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.
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 : summaryOfMassReplacementPurchaseOrders-item-response
Type:
Show Source
object
-
ChangeOrderStatus: string
Read Only:
true
Maximum Length:80
Status of the change order created on the purchase order during mass replacement. -
ChangeOrderStatusCode: string
Read Only:
true
Maximum Length:25
Status code of the change order created on the purchase order during mass replacement. -
ExceptionFlag: boolean
Read Only:
true
Maximum Length:5
Attribute indicating that an exception occurred during the execution of the mass replacement process for a purchase order detail. -
InlineReplacementFlag: boolean
Read Only:
true
Maximum Length:1
Attribute indicating whether the Replace action is taken on a purchase order detail that undergoes mass replacement. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalCurrencyCode: string
Read Only:
true
Maximum Length:15
Currency code of the original purchase order that undergoes mass replacement. -
OriginalPO: string
Read Only:
true
Maximum Length:153
Concatenated value of the original purchase order number, line number, schedule number, and distribution number that undergoes mass replacement. -
OriginalPODistributionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the original PO distribution that undergoes mass replacement. -
OriginalPOHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the original PO header that undergoes mass replacement. -
OriginalPOLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the original PO line that undergoes mass replacement. -
OriginalPOLineLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the original PO schedule that undergoes mass replacement. -
OriginalPrecision: integer
(int32)
Read Only:
true
Value that indicates the number of digits to which the unit price attribute in the original purchase order line must be rounded off. -
OriginalPurchasingUOM: string
Read Only:
true
Maximum Length:25
Name of the purchasing unit of measure for the original purchase order line that undergoes mass replacement. -
OriginalPurchasingUOMCode: string
Read Only:
true
Maximum Length:3
Purchasing UOM code for the original purchase order line that undergoes mass replacement. -
OriginalSPN: string
Read Only:
true
Maximum Length:300
Supplier part number on the original purchase order line that undergoes mass replacement. -
OriginalUnitPrice: number
Read Only:
true
Unit price on the original purchase order line that undergoes mass replacement. -
Phase: string
Read Only:
true
Maximum Length:30
Attribute indicating whether the purchase order distribution undergoes mass update for a replacement action or reinstate action. -
PODetailId: integer
(int64)
Read Only:
true
Value that uniquely identifies the PO detail for which replacement action is taken. -
POStatus: string
Read Only:
true
Maximum Length:30
Replacement status of the purchase order distribution that undergoes mass replacement. -
QuantityDue: number
Read Only:
true
Order quantity on the original purchase order distribution that undergoes mass replacement. -
ReplacementAction: string
Read Only:
true
Maximum Length:30
Type of the replacement action taken on the purchase order distribution that undergoes mass replacement. -
ReplacementActionCode: string
Read Only:
true
Maximum Length:17
Code of the replacement action taken on the purchase order distribution that undergoes mass replacement. -
ReplacementCurrencyCode: string
Read Only:
true
Maximum Length:15
Currency code of the replacement purchase order created by the mass replacement process. -
ReplacementDetailId: integer
(int64)
Read Only:
true
Value that uniquely identifies the replacement detail created for a replacement task. -
ReplacementId: integer
Read Only:
true
Value that uniquely identifies the replacement task. -
ReplacementNumber: integer
(int64)
Read Only:
true
Number of the replacement task. -
ReplacementPO: string
Read Only:
true
Maximum Length:153
Concatenated value of the replacement purchase order number, line number, schedule number, and distribution number created by the mass replacement process. -
ReplacementPODistributionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the replacement PO distribution created by the mass replacement process. -
ReplacementPOHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the replacement PO header created by the mass replacement process. -
ReplacementPOLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the replacement PO line created by the mass replacement process. -
ReplacementPOLineLocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the replacement PO schedule created by the mass replacement process. -
ReplacementPrecision: integer
(int32)
Read Only:
true
Value that indicates the number of digits to which the unit price attribute in the replacement purchase order line must be rounded off. -
ReplacementPurchasingUOM: string
Read Only:
true
Maximum Length:25
Name of the purchasing unit of measure for the replacement purchase order line derived by the mass replacement process. -
ReplacementPurchasingUOMCode: string
Read Only:
true
Maximum Length:3
Purchasing UOM code on the replacement purchase order line derived by the mass replacement process. -
ReplacementQuantityOrdered: number
Read Only:
true
Order quantity on the replacement purchase order distribution derived by the mass replacement process. -
ReplacementSPN: string
Read Only:
true
Maximum Length:300
Supplier part number on the replacement purchase order line derived by the mass replacement process. -
ReplacementUnitPrice: number
Read Only:
true
Unit price on the replacement purchase order line derived by the mass replacement process. -
ShipToOrganizationCode: string
Read Only:
true
Maximum Length:18
Code of the inventory organization to which the purchase order schedule undergoing mass replacement belongs. -
ShipToOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the ship to organization to which the purchase order schedule undergoing mass replacement belongs.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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.