Get all lines

get

/fscmRestApi/resources/11.13.18.05/supplierReturns/{SupplierReturnHeaderId}/child/lines

Request

Path Parameters
Query Parameters
  • 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>
  • 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 supplier return lines according to the primary key criteria.
      Finder Variables:
      • SupplierReturnLineId; integer; Value that uniquely identifies the supplier return 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:
    • AccountId; integer; Value that uniquely identifies the account associated with the return.
    • CreatedBy; string; User who created the supplier return line.
    • CreationDate; string; Date and time when the user created the supplier return line.
    • ErrorMessage; string; Text of the error message, in case of any errors during processing.
    • ItemId; integer; Value that uniquely identifies the inventory item.
    • ItemNumber; string; Number that identifies the inventory item.
    • LineStatus; string; Status of the supplier return line. A list of accepted values is defined in the lookup type ORA_RCV_SUPP_RET_LINE_STATUS.
    • LineStatusCode; string; Abbreviation the identifies the status of the supplier return line. A list of accepted values is defined in the lookup type ORA_RCV_SUPP_RET_LINE_STATUS.
    • LocatorId; integer; Value that uniquely identifies the locator where the item is located.
    • LotNumber; string; Number that identifies the lot.
    • PhysicalMaterialReturnRequiredFlag; boolean; Contains one of the following values: true or false. If true, then physical return of the material is required. If false, then physical return of the material is not required. The default value is true.
    • Reason; string; Reason for the inventory transaction.
    • ReasonId; integer; Value that uniquely identifies the inventory transaction reason.
    • RecallHeaderId; integer; Value that uniquely identifies the recall notice. This attribute is associated with a feature that requires opt in.
    • RecallLineId; integer; Value that uniquely identifies the recall notice line. This attribute is associated with a feature that requires opt in.
    • RecallNoticeLineNumber; integer; Number that identifies the recall notice line. This attribute is associated with a feature that requires opt in.
    • RecallNoticeNumber; string; Number that identifies the recall notice. This attribute is associated with a feature that requires opt in.
    • RequestedDate; string; Date when the user requested the supplier return line to be shipped.
    • ReturnedById; integer; Value that uniquely identifies the person who created the supplier return line.
    • ReturnedByName; string; Name of the person who created the supplier return line.
    • Subinventory; string; Name of the subinventory where the item is located.
    • SupplierItemNumber; string; Number that identifies the supplier item.
    • SupplierLotNumber; string; Number that identifies the supplier lot.
    • SupplierRMANumber; string; Number that identifies the supplier return material authorization (RMA) reference.
    • SupplierReturnLineId; integer; Value that uniquely identifies the supplier return line.
    • SupplierReturnLineNumber; integer; Number that identifies the supplier return line.
  • 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 : supplierReturns-lines
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : supplierReturns-lines-item-response
Type: object
Show Source
Nested Schema : Flexfields for Supplier Return Lines
Type: array
Title: Flexfields for Supplier Return Lines
The Flexfields for Supplier Return Lines resource manages additional details about supplier return lines.
Show Source
Nested Schema : Flexfields for Inventory Attributes
Type: array
Title: Flexfields for Inventory Attributes
The Flexfields for Inventory Attributes resource manages descriptive flexfields for inventory attributes. This resource is associated with a feature that requires opt in.
Show Source
Nested Schema : Manufacturer Parts
Type: array
Title: Manufacturer Parts
The Manufacturer Parts resource manages the manufacturer parts associated with a supplier return line.
Show Source
Nested Schema : Serial Numbers
Type: array
Title: Serial Numbers
The Serial Numbers resource manages the serial numbers associated with a supplier return line.
Show Source
Nested Schema : supplierReturns-lines-DFF-item-response
Type: object
Show Source
Nested Schema : supplierReturns-lines-inventoryAttributesDFF-item-response
Type: object
Show Source
  • Title: Context Segment
    Maximum Length: 40
    Descriptive flexfield context name of inventory attributes for supplier return lines. This attribute is associated with a feature that requires opt in.
  • Title: Context Segment
    Descriptive flexfield context display value of inventory attributes for supplier return lines. This attribute is associated with a feature that requires opt in.
  • Title: Country of Origin
    Maximum Length: 2
    Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt in.
  • Title: Country of Origin
    Name of the country of origin. This attribute is associated with a feature that requires opt in.
  • Links
  • Title: Project
    Value that uniquely identifies the project. This attribute is associated with a feature that requires opt in.
  • Title: Project
    Number that identifies the project. This attribute is associated with a feature that requires opt in.
  • Value that uniquely identifies the supplier return line. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Value that uniquely identifies the task. This attribute is associated with a feature that requires opt in.
  • Title: Task
    Number that identifies the task. This attribute is associated with a feature that requires opt in.
Nested Schema : supplierReturns-lines-manufacturerParts-item-response
Type: object
Show Source
Nested Schema : supplierReturns-lines-serials-item-response
Type: object
Show Source
  • Maximum Length: 80
    Number that indicates the starting serial in a range of serial numbers. This number is used to identify an item.
  • Links
  • Maximum Length: 80
    Number that indicates the last serial in a range of serial numbers. This number is used to identify an item.
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/supplierReturns/SupplierReturnHeaderId/child/lines"

Example Response Body

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

{
	"items": [
	{
		"SupplierReturnLineId": 300100191493354,
		"SupplierReturnLineNumber": 1,
		"CreationDate": "2020-05-14T23:16:49.078+00:00",
		"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
		"LastUpdateDate": "2020-05-14T23:16:49.279+00:00",
		"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
		"OrganizationId": 207,
		"OrganizationCode": "M1",
		"ItemId": 663907,
		"ItemNumber": "RCV-100",
		"ItemDescription": "Plain Item",
		"ItemRevision": null,
		"LineStatusCode": "INCOMPLETE",
		"LineStatus": "Incomplete",
		"Subinventory": "FloorStock",
		"LocatorId": null,
		"Locator": null,
		"PhysicalMaterialReturnRequiredFlag": true,
		"RequestedQuantity": 1,
		"FulfilledQuantity": null,
		"CanceledQuantity": null,
		"UOMCode": "BX5",
		"UnitOfMeasure": "Box of 5",
		"PrimaryRequestedQuantity": 5,
		"PrimaryUOMCode": "Ea",
		"PrimaryUnitOfMeasure": "Each",
		"RequestedDate": null,
		"ReturnedById": 25,
		"ReturnedByName": "Smith, Pat",
		"AccountId": null,
		"Account": null,
		"LotNumber": null,
		"SecondaryRequestedQuantity": null,
		"SecondaryFulfilledQuantity": null,
		"SecondaryCanceledQuantity": null,
		"SecondaryUOMCode": null,
		"SecondaryUnitOfMeasure": null,
		"SupplierLotNumber": null,
		"SupplierItemNumber": null,
		"SupplierRMANumber": null,
		"RecallHeaderId": null,
		"RecallNoticeNumber": null,
		"RecallLineId": null,
		"RecallNoticeLineNumber": null,
		"ReasonId": null,
		"Reason": null,
		"Comments": null,
		"ErrorMessageName": null,
		"ErrorMessage": null,
		"CancelFlag": null
	},
	{
		"SupplierReturnLineId": 300100191493355,
		"SupplierReturnLineNumber": 2,
		"CreationDate": "2020-05-14T23:16:49.131+00:00",
		"CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
		"LastUpdateDate": "2020-05-14T23:16:49.283+00:00",
		"LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
		"OrganizationId": 207,
		"OrganizationCode": "M1",
		"ItemId": 663997,
		"ItemNumber": "VC110",
		"ItemDescription": "VC-Lot Serial Revision",
		"ItemRevision": "A",
		"LineStatusCode": "INCOMPLETE",
		"LineStatus": "Incomplete",
		"Subinventory": "FloorStock",
		"LocatorId": null,
		"Locator": null,
		"PhysicalMaterialReturnRequiredFlag": false,
		"RequestedQuantity": 5,
		"FulfilledQuantity": null,
		"CanceledQuantity": null,
		"UOMCode": "Ea",
		"UnitOfMeasure": "Each",
		"PrimaryRequestedQuantity": 5,
		"PrimaryUOMCode": "Ea",
		"PrimaryUnitOfMeasure": "Each",
		"RequestedDate": null,
		"ReturnedById": 25,
		"ReturnedByName": "Smith, Pat",
		"AccountId": null,
		"Account": null,
		"LotNumber": "L1589498093",
		"SecondaryRequestedQuantity": null,
		"SecondaryFulfilledQuantity": null,
		"SecondaryCanceledQuantity": null,
		"SecondaryUOMCode": null,
		"SecondaryUnitOfMeasure": null,
		"SupplierLotNumber": null,
		"SupplierItemNumber": null,
		"SupplierRMANumber": null,
		"RecallHeaderId": null,
		"RecallNoticeNumber": null,
		"RecallLineId": null,
		"RecallNoticeLineNumber": null,
		"ReasonId": null,
		"Reason": null,
		"Comments": null,
		"ErrorMessageName": null,
		"ErrorMessage": null,
		"CancelFlag": null
	}
	],
	"count": 2,
	"hasMore": false,
	"limit": 25,
	"offset": 0,
	"links": [
	...
	]
}
Back to Top