Get all ABC Classifications
get
/fscmRestApi/resources/11.13.18.05/abcClassifications
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 ABC classification according to the ABC classification identifier.
Finder Variables:- CompileId; integer; Value that uniquely identifies ABC classification.
- PrimaryKey: Finds ABC classification according to the ABC classification identifier.
-
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:- CompileDate; string; Indicates the date and time on which ABC Classification was compiled.
- CompileId; integer; Value that uniquely identifies ABC Classification.
- CompileItems; integer; Value that denotes the number of items in the classification set.
- CompileName; string; Indicates the name assigned to ABC Classification.
- CompileStatusCode; string; Indicates the code that denotes the status of ABC Classification.
- CompileTypeCode; string; Indicates the code corresponding to the type or criteria of the ABC Classification.
- ContentScope; string; Indicates the content scope for ABC classification.
- ContentScopeCode; string; Indicates the code of the content scope for ABC Classification.
- CreationDate; string; Indicates the date and time of the creation of the ABC Classification.
- CumulativeQuantity; number; Indicates the total quantity of all items within the ABC Classification.
- CumulativeValue; number; Indicates the total value of all items within this ABC Classification.
- Description; string; Indicates the description of the ABC Classification.
- EndDate; string; Indicates the end date for historical data analysis associated with the ABC classification.
- OrganizationCode; string; Indicates the code of the inventory organization.
- OrganizationId; integer; Value that uniquely identifies the inventory organization.
- SecondaryInventory; string; Indicates the name of the subinventory.
- StartDate; string; Indicates the start date for historical data analysis for the ABC classification.
- ValuationScopeCode; string; Indicates the code that denotes the scope of the ABC Classification whether all items are included or just those within the specified subinventory.
-
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: string
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: string
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 : abcClassifications
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:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : abcClassifications-item-response
Type:
Show Source
object-
abcClassificationSetItems: array
ABC Classification Set Items
Title:
ABC Classification Set ItemsThe abcClassifications is the child of abcClassifications.The abcClassificationSetItems resource is used to view and create ABC Classification Set Items. -
CompileDate: string
(date)
Title:
ABC Classification Set DateIndicates the date and time on which ABC Classification was compiled. -
CompileId: integer
(int64)
Value that uniquely identifies ABC Classification.
-
CompileItems: integer
(int64)
Title:
Total ItemsValue that denotes the number of items in the classification set. -
CompileName: string
Title:
NameMaximum Length:40Indicates the name assigned to ABC Classification. -
CompileStatus: string
Maximum Length:
255Indicates the status of ABC Classification. -
CompileStatusCode: string
Title:
StatusMaximum Length:30Default Value:1Indicates the code that denotes the status of ABC Classification. -
CompileType: string
Maximum Length:
255Indicates the type or criteria of ABC Classification. -
CompileTypeCode: string
Title:
CriteriaMaximum Length:30Indicates the code corresponding to the type or criteria of the ABC Classification. -
ContentScope: string
Maximum Length:
255Indicates the content scope for ABC classification. -
ContentScopeCode: string
Default Value:
1Indicates the code of the content scope for ABC Classification. -
CreationDate: string
(date-time)
Read Only:
trueIndicates the date and time of the creation of the ABC Classification. -
CumulativeQuantity: number
Title:
Total QuantityIndicates the total quantity of all items within the ABC Classification. -
CumulativeValue: number
Title:
Total ValueIndicates the total value of all items within this ABC Classification. -
Description: string
Title:
DescriptionMaximum Length:50Indicates the description of the ABC Classification. -
DFF: array
Descriptive Flex Fields
Title:
Descriptive Flex FieldsThe DFF is a child of abcClassifications.The DFF resource is used to view,create and delete the DFF attributes of ABC Classification. -
EndDate: string
(date)
Title:
End DateIndicates the end date for historical data analysis associated with the ABC classification. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrganizationCode: string
Maximum Length:
255Indicates the code of the inventory organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
SecondaryInventory: string
Maximum Length:
10Indicates the name of the subinventory. -
StartDate: string
(date)
Title:
Start DateIndicates the start date for historical data analysis for the ABC classification. -
ValuationScope: string
Maximum Length:
255Indicates the scope of the ABC Classification whether all items are included or just those within the specified subinventory. -
ValuationScopeCode: string
Title:
Valuation ScopeMaximum Length:30Indicates the code that denotes the scope of the ABC Classification whether all items are included or just those within the specified subinventory.
Nested Schema : ABC Classification Set Items
Type:
arrayTitle:
ABC Classification Set ItemsThe abcClassifications is the child of abcClassifications.The abcClassificationSetItems resource is used to view and create ABC Classification Set Items.
Show Source
Nested Schema : Descriptive Flex Fields
Type:
arrayTitle:
Descriptive Flex FieldsThe DFF is a child of abcClassifications.The DFF resource is used to view,create and delete the DFF attributes of ABC Classification.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : abcClassifications-abcClassificationSetItems-item-response
Type:
Show Source
object-
CompileId: integer
(int64)
Indicates the ABC Classification associated with ABC Classification Set Item.
-
CompileQuantity: number
Title:
ABC Classification Set QuantityIndicates the quantity of the ABC Classification Set Item. -
CompileValue: number
Title:
ABC Classification Set ValueIndicates the value of the ABC classification set items. -
CreationDate: string
(date-time)
Read Only:
trueIndicates the date and time of the creation of the ABC Classification set item. -
CumulativeQuantity: number
Title:
Cumulative QuantityIndicates the cumulative quantity of all items with the sequence less than or equal to the ABC Classification set item. -
CumulativeValue: number
Title:
Cumulative ValueIndicates the cumulative value of all items with the sequence less than or equal to the ABC Classification set item. -
InventoryItemId: integer
(int64)
Value that uniquely Identifies the inventory item of the ABC Classification set item.
-
ItemDescription: string
Maximum Length:
255Description of the item. -
ItemNumber: string
Maximum Length:
255Indicates the item of the ABC Classification set item. -
ItemUnitCost: number
Default Value:
0Indicates the unit cost of the item in the ABC Classification set item. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OrganizationCode: string
Maximum Length:
255Indicates the code of the inventory organization. -
OrganizationId: integer
(int64)
Value that identifies the inventory organization.
-
PrimaryUOMCode: string
Maximum Length:
3Primary unit of measure code of the item. -
PrimaryUOMName: string
Maximum Length:
255Primary unit of measure name of the item. -
SequenceNumber: integer
(int64)
Title:
SequenceIndicates the sequence number of the items in the ABC Classification set item.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : abcClassifications-DFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context ValueMaximum Length:30The context for the descriptive flexfield used in the ABC Classifcation. -
__FLEX_Context_DisplayValue: string
Title:
Context ValueThe display value of the context for the descriptive flexfield used in the ABC Classifcation. -
CompileId: integer
(int64)
Value that uniquely identifies ABC Classification.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source