Get one default purchase order schedule
get
/fscmRestApi/resources/11.13.18.05/tradeOperations/{TradeOperationId}/child/defaultPOSchedules/{TradeOperationDefaultPOScheduleId}
Request
Path Parameters
-
TradeOperationDefaultPOScheduleId(required): integer(int64)
Value that uniquely identifies the trade operation currency.
-
TradeOperationId(required): integer(int64)
Value that uniquely identifies the trade operation.
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(required):
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(required):
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 : tradeOperations-defaultPOSchedules-item-response
Type:
Show Source
object
-
ChargeBU: string
Title:
Charge BU
Read Only:true
Maximum Length:240
Value that indicates the requisitioning business unit that incurs the charge. -
ItemNumber: string
Title:
Item
Read Only:true
Maximum Length:300
Number that identifies the item on the purchase order schedule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
POCurrencyCode: string
Title:
PO Currency
Maximum Length:15
Value that identifies the currency on the purchase order. -
POLineLocationId: integer
(int64)
Title:
Purchase Order Line Location ID
Value that uniquely identifies the purchase order shipment schedule. -
POLineNumber: string
Title:
Purchase Order Line
Read Only:true
Maximum Length:40
Number that identifies the line in the purchase order. -
PONumber: string
Title:
PO Number
Read Only:true
Maximum Length:40
Number that identifies the purchase order. -
POPrimaryUOMCode: string
Title:
PO Primary UOM
Maximum Length:3
Value that identifies the primary unit of measure for the purchase order schedule quantity. -
POQuantityInPrimaryUOM: number
Title:
Ordered Quantity (Primary UOM)
Ordered quantity on the purchase order in the primary unit of measure. -
POQuantityInSecondaryUOM: number
Title:
Ordered Quantity (Secondary UOM)
Ordered quantity on the purchase order in the secondary unit of measure. -
POScheduleAmount: number
Title:
PO Schedule Amount
Read Only:true
Amount on the purchase order schedule line. -
POScheduleFuncCurrencyAmount: number
Title:
PO Schedule Functional Currency Amount
Read Only:true
Amount on the purchase order schedule line in the functional currency. -
POScheduleNumber: string
Title:
Purchase Order Schedule
Read Only:true
Maximum Length:40
Number that identifies the schedule of the material purchase order line used for the landed cost estimate. -
POSecondaryUOMCode: string
Title:
PO Secondary UOM
Maximum Length:3
Value that identifies the secondary unit of measure for the purchase order schedule quantity. -
TradeOperationDefaultPOScheduleId: integer
(int64)
Title:
Trade Operation Default PO Schedule ID
Value that uniquely identifies the trade operation currency. -
TradeOperationId: integer
(int64)
Title:
Trade Operation ID
Value that uniquely identifies the trade operation. -
UnitOfMeasure: string
Title:
Unit of Measure
Read Only:true
Maximum Length:25
Unit of measure for the purchase order schedule quantity.
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.
Examples
This example describes how to get one default purchase order schedule.
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/tradeOperations/TradeOperationId/child/defaultPOSchedules/TradeOperationDefaultPOScheduleId"
For example, the following command gets one default purchase order schedule:
curl -u username:password "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/defaultPOSchedules/300100085591707"
Example Response Body
The following shows an example of the response body in JSON format.
{ "ChargeBU": "Vision Operations", "ItemNumber": "ZCML-Plain-Asset1", "POCurrencyCode": "USD", "POLineLocationId": 76166, "POLineNumber": "3", "PONumber": "VFC1003648", "POPrimaryUOMCode": "Ea", "POQuantityInPrimaryUOM": 110, "POQuantityInSecondaryUOM": 0, "POScheduleAmount": 12.34, "POScheduleFuncCurrencyAmount": 12.34, "POScheduleNumber": "1", "POSecondaryUOMCode": null, "TradeOperationDefaultPOScheduleId": 300100085591707, "TradeOperationId": 300100085591704, "UnitOfMeasure": "Each", "links": [{ "rel": "self", "href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/defaultPOSchedules/300100085591707", "name": "defaultPOSchedules", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704/child/defaultPOSchedules/300100085591707", "name": "defaultPOSchedules", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/tradeOperations/300100085591704", "name": "tradeOperations", "kind": "item" }] }