Get all parts

get

/fscmRestApi/resources/11.13.18.05/servicePartReturns

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: Find parts to be returned according to the specified primary key criteria.
      Finder Variables:
      • ReturnId; integer; Value that uniquely identifies the parts to be returned.
  • 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:
    • CreatedBy; string; User who created the row.
    • CreationDate; string; Date and time when the user created the row.
    • DestinationOganizationCode; string; Abbreviation that identifies the organization where the part should be returned.
    • DestinationOrganizationId; integer; Value that uniquely identifies the organization where the part should be returned.
    • DestinationOrganizationName; string; Name of the organization where the part should be returned.
    • DestinationSubinventory; string; Subinventory where the part should be returned.
    • ItemDescription; string; Description of the part to be returned.
    • ItemId; integer; Value that uniquely identifies the inventory item of the part to be returned
    • ItemNumber; string; Number that identifies the inventory item of the part to be returned.
    • LastReceivedDate; string; Date when the part was last received at its current stocking location.
    • LastUpdateDate; string; Date and time when the user most recently updated the row.
    • LastUpdateLogin; string; Login that the user used when updating the row.
    • LastUpdatedBy; string; User who most recently updated the row.
    • OrganizationCode; string; Abbreviation that identifies the inventory organization where the parts are located.
    • OrganizationId; integer; Value that uniquely identifies the inventory organization where the parts are located.
    • OrganizationName; string; Name of the inventory organization where the parts are located.
    • OwningPartyId; integer; Value that uniquely identifies the field service technician assigned to this stocking location.
    • OwningPartyName; string; Name of the field service technician assigned to this stocking location.
    • Quantity; number; Quantity of the part to be returned.
    • RecoveredPartDispositionCode; string; Abbreviation that identifies the recovered part inventory item's disposition.
    • RecoveredPartsDisposition; string; Description of the recovered part disposition. Valid values are Fast return, Slow return, and No return.
    • ReturnAddress; string; Address of stocking location where the part should be returned.
    • ReturnId; integer; Value that uniquely identifies the parts to be returned.
    • ReturnType; string; Type of the return.
    • ReturnTypeCode; string; Abbreviation that identifies the reason why the part should be returned. Valid values are EXCESS or DEFECTIVE.
    • Revision; string; Revision of the inventory item of the part to be returned.
    • StockLocationId; integer; Value that uniquely identifies the stocking location to be searched for parts that need to be returned.
    • Subinventory; string; Subinventory where the parts are located.
    • UOMCode; string; Abbreviation that identifies the unit of measure of the inventory item of the part to be returned.
    • UnitOfMeasure; string; Unit of measure of the inventory item of the part to be returned.
  • 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 : servicePartReturns
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : servicePartReturns-item-response
Type: object
Show Source
Back to Top