Get one line
get
/fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}
Request
Path Parameters
-
RequirementLineId(required): integer(int64)
Value that uniquely identifies the requirement line.
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 : partRequirementLines-item-response
Type:
Show Source
object
-
AssetId: integer
(int64)
Value that uniquely identifies the part requirement line asset that is returned for repair or exchange.
-
AssetNumber: string
Maximum Length:
80
Number that identifies the part requirement line asset that is returned for repair or exchange. -
BillToAccountId: integer
(int64)
Value that uniquely identifies the bill-to customer account.
-
BillToAccountNumber: string
Maximum Length:
30
Number that identifies the bill-to customer account. -
BillToAddress: string
Maximum Length:
4000
Billing address of the customer. -
BillToPartyId: integer
(int64)
Value that uniquely identifies the bill-to customer party.
-
BillToPartyName: string
Maximum Length:
360
Name of the bill-to customer party. -
BillToPartySiteId: integer
(int64)
Value that uniquely identifies the bill-to party site address.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Who column: indicates the user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Who column: indicates the date and time row created. -
DestinationOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the destination organization. -
DestinationOrganizationId: integer
(int64)
Title:
Destination Organization
Value that uniquely identifies the destination organization. -
DestinationOrganizationName: string
Read Only:
true
Maximum Length:240
Name of the Destination organization. -
DestinationSubinventory: string
Title:
Destination Subinventory
Maximum Length:10
Name of the destination subinventory. -
InventoryItemDescription: string
Read Only:
true
Maximum Length:240
Value that describes the inventory item description. -
InventoryItemId: integer
(int64)
Title:
Item
Value that uniquely identifies the inventory item. -
InventoryItemNumber: string
Maximum Length:
300
Number that identifies the inventory item. -
ItemRevision: string
Maximum Length:
18
Value that indicates the revision of the item if the item is revision controlled. -
LastUpdateDate: string
(date-time)
Read Only:
true
Who column: indicates the date and time of the last update of the row. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Who column: indicates the user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Who column: indicates the session login associated to the user who last updated the row. -
lineDetails: array
Part Requirement Line Details
Title:
Part Requirement Line Details
The Part Requirement Line Details resource is used to view, create, or update sourcing information for a part requirement line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NeedByDate: string
(date-time)
Title:
Need By
Date when the part is required. -
OrderFlag: boolean
Indicates whether an order can be created or not for a part requirement.
-
OrderLineType: string
Read Only:
true
Maximum Length:30
Value that describes the order line type. -
ParentEntityCode: string
Title:
Part Requirement Parent Code
Maximum Length:30
Abbreviation that identifies the parent entity of the parts requirement line. Valid values are SR: service request, WO: work order, and RH: requirement header. -
ParentEntityId: integer
(int64)
Title:
Part Requirement Parent ID
Value that uniquely identifies the parent entity of the parts requirement line. -
partRequirementLinesDFF: array
Flexfields for Part Requirement Lines
Title:
Flexfields for Part Requirement Lines
The Flexfields for Part Requirement Lines resource manages the flexfields for a part requirement line. -
Quantity: number
Title:
Quantity
Quantity of the item required. -
RequirementHeaderId: integer
(int64)
Title:
Part Requirement Header ID
Value that uniquely identifies the parts requirement header. -
RequirementLineId: integer
(int64)
Title:
Part Requirement Line ID
Value that uniquely identifies the requirement line. -
RequirementLineLinkId: integer
(int64)
Value that uniquely identifies the associated depot repair logistics and part exchange part requirements. For example, this attribute can link a depot repair return to its shipment.
-
ReturnFromAddress: string
Read Only:
true
Maximum Length:4000
Value that identifies the return-from address. -
ReturnFromPartyId: integer
(int64)
Value that uniquely identifies the return from the customer party.
-
ReturnFromPartyName: string
Read Only:
true
Maximum Length:360
Name of the return-from customer party. -
ReturnFromPartySiteId: integer
(int64)
Value that uniquely identifies the return-from party site address.
-
ReturnReason: string
Read Only:
true
Maximum Length:80
Value that describes the reason for the return. -
ReturnReasonCode: string
Title:
Return Reason
Maximum Length:30
Abbreviation that identifies the return reason for the line. -
RevisionControl: number
Read Only:
true
Abbreviation that identifies the item revision level. -
ServiceActivity: string
Read Only:
true
Maximum Length:120
Value that describes the service activity. -
ServiceActivityCode: string
Maximum Length:
30
Abbreviation that identifies the service activity of the part requirement. -
ServiceActivityId: integer
(int64)
Title:
Service Activity ID
Value that uniquely identifies the service activity associated with the parts line. -
serviceCharges: array
Service Charges
Title:
Service Charges
The Service Charges resource is used to view all the service charges for a part requirement line. -
ShipToAddress: string
Read Only:
true
Maximum Length:4000
Value that identifies the ship-to address. -
ShipToAddressType: string
Title:
Ship-to Address Type
Maximum Length:30
Type of address that the requirement will be shipped to. Values are Customer and Technician. -
ShipToContactId: integer
(int64)
Title:
Ship to Contact ID
Value that uniquely identifies the ship-to account. -
ShipToLocationId: integer
(int64)
Title:
Ship-to Address
Value that uniquely identifies the ship-to party site address. -
ShipToPartyId: integer
(int64)
Value that uniquely identifies the ship-to customer party.
-
ShipToPartyName: string
Read Only:
true
Maximum Length:360
Name of the ship-to party. -
UnitOfMeasure: string
Maximum Length:
25
Meaning of the unit of measure. -
UOMCode: string
Title:
UOM
Maximum Length:3
Abbreviation that identifies the unit of measure for the item.
Nested Schema : Part Requirement Line Details
Type:
array
Title:
Part Requirement Line Details
The Part Requirement Line Details resource is used to view, create, or update sourcing information for a part requirement line.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Part Requirement Lines
Type:
array
Title:
Flexfields for Part Requirement Lines
The Flexfields for Part Requirement Lines resource manages the flexfields for a part requirement line.
Show Source
Nested Schema : Service Charges
Type:
array
Title:
Service Charges
The Service Charges resource is used to view all the service charges for a part requirement line.
Show Source
Nested Schema : partRequirementLines-lineDetails-item-response
Type:
Show Source
object
-
ArrivalDate: string
(date-time)
Read Only:
true
Date when the item will arrive. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Indicates the date and time of the creation of the row. -
ErrorText: string
Maximum Length:
2000
Value that describes the error. -
ExpectedArrivalDate: string
(date-time)
Title:
Expected Arrival
Date when the item is expected to arrive. -
LastUpdateDate: string
(date-time)
Read Only:
true
Indicates the date and time of the last update of the row. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Indicates the user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Indicates the session login associated to the user who last updated the row. -
LineStatus: string
Read Only:
true
Value that describes the status of the Order. -
LineStatusCode: string
Read Only:
true
Abbreviation that identifies the status of the order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderNumber: string
Read Only:
true
Maximum Length:50
Value that identifies the Order. -
RequirementLineDetailId: integer
(int64)
Title:
Part Requirement Details ID
Value that uniquely identifies the request line details. -
RequirementLineId: integer
(int64)
Title:
Part Requirement Line ID
Value that uniquely identifies the requirement line of the parts requirement line. -
ShipMethodCode: string
Read Only:
true
Maximum Length:522
Value that describes the shipping method being used to ship the order which is a combination of carrier, mode of transport, and service level. -
SourceCarrierId: integer
(int64)
Title:
Carrier
Value that uniquely identifies the carrier for the possible source. -
SourceId: integer
(int64)
Title:
Parts Source Order ID
Value that uniquely identifies the source object. -
SourceModeOfTransport: string
Title:
Transportation Mode
Maximum Length:30
Mode of transport for the possible source. -
SourceOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the source organization. -
SourceOrganizationId: integer
(int64)
Title:
Source Organization ID
Value that uniquely identifies the source organization. -
SourceOrganizationName: string
Read Only:
true
Maximum Length:240
Name of the Source organization. -
SourceRequestDate: string
(date-time)
Title:
Part Sourcing Request Date
Date when the source search request was made. -
SourceServiceLevels: string
Title:
Delivery Service Level
Maximum Length:30
Value that indicates the service level for the possible source. -
SourceSubinventory: string
Title:
Source Subinventory
Maximum Length:10
Value that indicates the source subinventory. -
SourceType: string
Title:
Parts Source Order Type
Maximum Length:30
Abbreviation that identifies the source type. Valid values are SO for Sales Order and TO for Transfer Order.
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.
Nested Schema : partRequirementLines-partRequirementLinesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive flexfield context name for requirement lines. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RequirementLineId: integer
(int64)
Value that uniquely identifies the requirement line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partRequirementLines-serviceCharges-item-response
Type:
Show Source
object
-
Amount: number
Read Only:
true
Value of the extended amount in the charge currency. -
CanAdjustFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether manual adjustments can be performed or not. -
ChargeAppliesTo: string
Read Only:
true
Maximum Length:80
Name of the charge applies. -
ChargeAppliesToCode: string
Read Only:
true
Maximum Length:30
Value that indicates whether a charge is applied to shipment or return. -
ChargeCurrency: string
Read Only:
true
Maximum Length:25
Name of the charge currency. -
ChargeCurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the charge currency. -
ChargeDefinition: string
Read Only:
true
Maximum Length:80
Name of the charge definition. -
ChargeDefinitionCode: string
Read Only:
true
Maximum Length:30
Value that describes the charge code. -
ChargeSubtype: string
Read Only:
true
Maximum Length:80
Name of the charge subtype. -
ChargeSubtypeCode: string
Read Only:
true
Maximum Length:30
Value that identifies charge subtype. -
ChargeType: string
Read Only:
true
Maximum Length:80
Name of the charge type. -
ChargeTypeCode: string
Read Only:
true
Maximum Length:30
Value that identifies charge type. -
HeaderCurrency: string
Read Only:
true
Maximum Length:25
Name of the debrief header currency. -
HeaderCurrencyCode: string
Read Only:
true
Maximum Length:15
Abbreviation that identifies the debrief header currency. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PriceElement: string
Read Only:
true
Maximum Length:1000
Name of the pricing element. -
PriceElementCode: string
Read Only:
true
Maximum Length:30
Value that identifies the pricing element. -
PriceType: string
Read Only:
true
Maximum Length:80
Name of the price type. -
PriceTypeCode: string
Read Only:
true
Maximum Length:30
Value that identifies the price type. -
Quantity: number
Read Only:
true
Pricing quantity. -
QuantityUnitOfMeasure: string
Read Only:
true
Maximum Length:25
Meaning of the unit of measure of the pricing quantity. -
QuantityUOM: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure for the pricing quantity. -
SequenceNumber: integer
(int64)
Read Only:
true
Indicates the sequence for the charge. -
ServiceChargeComponentId: integer
(int64)
Read Only:
true
Unique identifier of the service charge component. -
ServiceChargeId: integer
Read Only:
true
Value that uniquely identifies Service charge. -
YourPrice: number
Read Only:
true
Unit price in charge line currency.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- calculateSourceAndPrice
-
Parameters:
- RequirementLineId:
$request.path.RequirementLineId
Finds the source for the requirement line and prices it. In the case of depot repair logistics and parts exchange flow, it creates the shipment line as well. - RequirementLineId:
- getPreferredSource
-
Parameters:
- RequirementLineId:
$request.path.RequirementLineId
Provides the suitable sourcing details for the requirement line. - RequirementLineId:
- lineDetails
-
Operation: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}/child/lineDetailsParameters:
- RequirementLineId:
$request.path.RequirementLineId
The Part Requirement Line Details resource is used to view, create, or update sourcing information for a part requirement line. - RequirementLineId:
- partRequirementLinesDFF
-
Parameters:
- RequirementLineId:
$request.path.RequirementLineId
The Flexfields for Part Requirement Lines resource manages the flexfields for a part requirement line. - RequirementLineId:
- serviceCharges
-
Operation: /fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}/child/serviceChargesParameters:
- RequirementLineId:
$request.path.RequirementLineId
The Service Charges resource is used to view all the service charges for a part requirement line. - RequirementLineId: