1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Maintenance
  4. Part Requirement Lines

Get all lines

get

/fscmRestApi/resources/11.13.18.05/partRequirementLines

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: Finds part requirement lines according to the specified primary key criteria.
      Finder Variables:
      • RequirementLineId; integer; Value that uniquely identifies the requirement line.
  • 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:
    • AssetId; integer; Value that uniquely identifies the part requirement line asset that is returned for repair or exchange.
    • AssetNumber; string; Number that identifies the part requirement line asset that is returned for repair or exchange.
    • BillToAccountId; integer; Value that uniquely identifies the bill-to customer account.
    • BillToAccountNumber; string; Number that identifies the bill-to customer account.
    • BillToAddress; string; Billing address of the customer.
    • BillToPartyId; integer; Value that uniquely identifies the bill-to customer party.
    • BillToPartyName; string; Name of the bill-to customer party.
    • BillToPartySiteId; integer; Value that uniquely identifies the bill-to party site address.
    • BusinessProcess; string; Abbreviation that identifies the business process associated with the service activity.
    • BusinessProcessCode; string; Value that identifies the business process associated with the service activity.
    • CreatedBy; string; Who column: indicates the user who created the row.
    • CreationDate; string; Who column: indicates the date and time row created.
    • DestinationOrganizationCode; string; Abbreviation that identifies the destination organization.
    • DestinationOrganizationId; integer; Value that uniquely identifies the destination organization.
    • DestinationOrganizationName; string; Name of the Destination organization.
    • DestinationSubinventory; string; Name of the destination subinventory.
    • InventoryItemDescription; string; Value that describes the inventory item description.
    • InventoryItemId; integer; Value that uniquely identifies the inventory item.
    • InventoryItemNumber; string; Number that identifies the inventory item.
    • ItemRevision; string; Value that indicates the revision of the item if the item is revision controlled.
    • LastUpdateDate; string; Who column: indicates the date and time of the last update of the row.
    • LastUpdateLogin; string; Who column: indicates the session login associated to the user who last updated the row.
    • LastUpdatedBy; string; Who column: indicates the user who last updated the row.
    • LineCategoryCode; string; Abbreviation that identifies the line category of the service activity.
    • LineCategoryMeaning; string; Value that defines name of the line category of the service activity.
    • MaterialBillable; string; Value that defines name of the billing type.
    • MaterialBillableCode; string; Abbreviation that identifies the billing type. Values include M, L, or E, where M indicates material, L indicates labor, and E indicates expense. A list of accepted values is defined in the lookup type EGP_MATERIAL_BILLABLE_TYPE.
    • NeedByDate; string; Date when the part is required.
    • OrderFlag; boolean; Indicates whether an order can be created or not for a part requirement.
    • OrderLineType; string; Value that describes the order line type.
    • ParentEntityCode; string; 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; Value that uniquely identifies the parent entity of the parts requirement line.
    • Quantity; number; Quantity of the item required.
    • RequirementHeaderId; integer; Value that uniquely identifies the parts requirement header.
    • RequirementLineId; integer; Value that uniquely identifies the requirement line.
    • RequirementLineLinkId; integer; 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; Value that identifies the return-from address.
    • ReturnFromPartyId; integer; Value that uniquely identifies the return from the customer party.
    • ReturnFromPartyName; string; Name of the return-from customer party.
    • ReturnFromPartySiteId; integer; Value that uniquely identifies the return-from party site address.
    • ReturnReason; string; Value that describes the reason for the return.
    • ReturnReasonCode; string; Abbreviation that identifies the return reason for the line.
    • RevisionControl; number; Abbreviation that identifies the item revision level.
    • ServiceActivity; string; Value that describes the service activity.
    • ServiceActivityCode; string; Abbreviation that identifies the service activity of the part requirement.
    • ServiceActivityId; integer; Value that uniquely identifies the service activity associated with the parts line.
    • ShipToAddress; string; Value that identifies the ship-to address.
    • ShipToAddressType; string; Type of address that the requirement will be shipped to. Values are Customer and Technician.
    • ShipToAddressTypeMeaning; string; Abbreviation that identifies the address type that the requirement will be shipped to.
    • ShipToContactId; integer; Value that uniquely identifies the ship-to account.
    • ShipToLocationId; integer; Value that uniquely identifies the ship-to party site address.
    • ShipToPartyId; integer; Value that uniquely identifies the ship-to customer party.
    • ShipToPartyName; string; Name of the ship-to party.
    • SourcingPolicy; string; Abbrevation of the sourcing policy.
    • SourcingPolicyCode; string; Value that indicates the sourcing policy of the inventory item.
    • UOMCode; string; Abbreviation that identifies the unit of measure for the item.
    • UnitOfMeasure; string; Meaning of the unit of measure.
    • ZeroChargeFlag; boolean; Mark that indicates if a charge line should be created with a zero value for the selected service activity.
  • 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 : partRequirementLines
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : partRequirementLines-item-response
Type: object
Show Source
Nested Schema : Part Requirement Line Details
Type: array
Title: Part Requirement Line Details
Records that contain additional details of a particular part or component. They help you view, create, or update sourcing information for a part requirement line.
Show Source
Nested Schema : Flexfields for Part Requirement Lines
Type: array
Title: Flexfields for Part Requirement Lines
Data used to manage the flexfields for a part requirement line.
Show Source
Nested Schema : Pricing Headers
Type: array
Title: Pricing Headers
Pricing-related information regarding a pricing segment, strategy, and currency applied to a part requirement line.
Show Source
Nested Schema : Service Charges
Type: array
Title: Service Charges
Charges levied for the components of a part requirement line, for example, for a party site or a customer.
Show Source
Nested Schema : partRequirementLines-lineDetails-item-response
Type: object
Show Source
Nested Schema : partRequirementLines-partRequirementLinesDFF-item-response
Type: object
Show Source
Nested Schema : partRequirementLines-pricingHeaders-item-response
Type: object
Show Source
Nested Schema : partRequirementLines-serviceCharges-item-response
Type: object
Show Source
Links
orderPartRequirements
Creates sales orders or transfer orders for part requirement lines based on the parent entity type.
refreshLines
Updates the part requirement lines with the transfer order details.
Back to Top

Examples

This example describes how to get all lines.

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

For example, the following command gets 20 existing part requirements created for the parent entity WO:

curl -u username:password "https://servername/fscmRestApi/resources/version/partRequirementLines?limit=20&q=ParentEntityCode=WO&onlyData=true" -H 'authorization: Basic c2Ntb3BlcmF0aW9uczpXZWxjb21lMQ==' -H 'cache-control: no-cache'

Example Response Body

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

{
    "items": [
        {
            "DestinationOrganizationId": 5702,
            "DestinationSubinventory": null,
            "InventoryItemId": 300100173354994,
            "NeedByDate": "2019-02-28T10:41:00+00:00",
            "ParentEntityCode": "WO",
            "ParentEntityId": 300100174295482,
            "Quantity": 1,
            "RequirementHeaderId": 300100186696976,
            "RequirementLineId": 300100186696981,
            "ReturnReasonCode": null,
            "ItemRevision": null,
            "ServiceActivityId": null,
            "ShipToAddressType": "CUSTOMER",
            "ShipToContactId": null,
            "ShipToLocationId": 300100126721683,
            "UOMCode": "Ea",
            "DestinationOrganizationCode": "FST",
            "UnitOfMeasure": "Each",
            "InventoryItemNumber": "RCL_FS54888"
        }
    ],
    "count": 1,
    "hasMore": true,
    "limit": 1,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/partRequirementLines",
            "name": "partRequirementLines",
            "kind": "collection"
        }
    ]
}
Back to Top