Get all part items
get
/fscmRestApi/resources/11.13.18.05/partItemsLOV
Request
Query Parameters
-
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 -
finder: string
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 items according to the specified primary key criteria.
Finder Variables:- ItemId; integer; Value that uniquely identifies the inventory item.
- findByItemsBOMForServiceRequest: Finds part items for the creating service request part requirements according to the service request product's service bill of material.
Finder Variables:- ItemId; string; Value that uniquely identifies the inventory item.
- ItemNumber; string; Number that identifies the item.
- OrganizationId; string; Value that uniquely identifies the inventory organization.
- ServiceActivityId; string; Value that uniquely identifies the service activity.
- findByItemsBOMForWorkOrder: Finds part items for the creating work order part requirements according to the work order asset item's service bill of material.
Finder Variables:- ItemId; string; Value that uniquely identifies the inventory item.
- ItemNumber; string; Number that identifies the item.
- OrganizationId; string; Value that uniquely identifies the inventory organization.
- findByItemsNonBOMForServiceRequest: Finds part items for creating service request part requirements.
Finder Variables:- ItemId; string; Value that uniquely identifies the inventory item.
- ItemNumber; string; Number that identifies the item.
- OrganizationId; string; Value that uniquely identifies the inventory organization.
- ServiceActivityId; string; Value that uniquely identifies the service activity.
- findByItemsNonBOMForWorkOrder: Finds part items for creating work order part requirements.
Finder Variables:- ItemId; string; Value that uniquely identifies the inventory item.
- ItemNumber; string; Number that identifies the item.
- OrganizationId; string; Value that uniquely identifies the inventory organization.
- PrimaryKey: Finds part items according to the specified primary key criteria.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- CustomerOrderFlag; boolean; Contains one of the following values: true, false, or null. If true, then the inventory item can be used to create a sales order. If false or null, then the inventory item can't be used to create a sales transfer order. This attribute does not have a default value.
- InternalOrderFlag; boolean; Contains one of the following values: true, false, or null. If true, then the inventory item can be used to create an inventory transfer order. If false or null, then the inventory item can't be used to create an inventory transfer order. This attribute does not have a default value.
- ItemDescription; string; Description of the item.
- ItemId; integer; Value that uniquely identifies the inventory item.
- ItemNumber; string; Number that identifies the item.
- OrganizationCode; string; Abbreviation that identifies the organization.
- OrganizationId; integer; Value that uniquely identifies the organization ID.
- ReturnableFlag; boolean; Contains one of the following values: true, false, or null. If true, then the inventory item is returnable. If false or null, then the inventory item is not returnable. This attribute does not have a default value.
- Revision; string; Value that describes the latest revision of the item.
- RevisionControlCode; number; Abbreviation that identifies whether the inventory item is revision controlled or not.
- UOMClass; string; Value that describes the unit of measure class.
- UOMCode; string; Abbreviation that identifies the unit of measure for the item.
- UnitOfMeasure; string; Meaning of the unit of measure.
-
totalResults: boolean
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
-
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:
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.
Root Schema : partItemsLOV
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partItemsLOV-item-response
Type:
Show Source
object
-
CustomerOrderFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true, false, or null. If true, then the inventory item can be used to create a sales order. If false or null, then the inventory item can't be used to create a sales transfer order. This attribute does not have a default value. -
InternalOrderFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true, false, or null. If true, then the inventory item can be used to create an inventory transfer order. If false or null, then the inventory item can't be used to create an inventory transfer order. This attribute does not have a default value. -
ItemDescription: string
Read Only:
true
Maximum Length:240
Description of the item. -
ItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory item. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Number that identifies the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that identifies the organization. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization ID. -
ReturnableFlag: boolean
Read Only:
true
Maximum Length:1
Contains one of the following values: true, false, or null. If true, then the inventory item is returnable. If false or null, then the inventory item is not returnable. This attribute does not have a default value. -
Revision: string
Read Only:
true
Maximum Length:72
Value that describes the latest revision of the item. -
RevisionControlCode: number
Read Only:
true
Abbreviation that identifies whether the inventory item is revision controlled or not. -
UnitOfMeasure: string
Read Only:
true
Maximum Length:25
Meaning of the unit of measure. -
UOMClass: string
Read Only:
true
Maximum Length:10
Value that describes the unit of measure class. -
UOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure for the item.
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.