Get all count tasks
get
/fscmRestApi/resources/11.13.18.05/inventoryCountTasks
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: Find inventory count tasks according to the primary key.
Finder Variables:- InvCountTaskId; integer; Value that uniquely identifies the inventory count task.
- PrimaryKey: Find inventory count tasks according to the primary key.
-
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:- Account; string; Value that identifies the account.
- AccountAlias; string; Name of the account alias.
- AccountAliasId; integer; Value that uniquely identifies the account alias.
- AccountId; integer; Value that uniquely identifies the account.
- Comments; string; Comments that describe the current count.
- CostCenterCode; string; Abbreviation that identifies the organizational element of a chart of accounts typically used for assigning revenues and expenses.
- CostCenterDescription; string; Description of the organizational element of chart of accounts.
- CountDate; string; Date when the count was performed.
- CountQuantity; number; Count quantity for the count task.
- CountSecondaryUOMCode; string; Abbreviation that identifies the secondary unit of measure used by the current count.
- CountSecondaryUnitOfMeasure; string; Secondary unit of measure used by the current count.
- CountStatus; string; Current status of the count.
- CountStatusCode; string; Abbreviation that identifies the count status.
- CountTaskSourceHeaderId; integer; Value that identifies the count task source header.
- CountTaskSourceLineId; integer; Value that identifies the count task source line.
- CountTaskSourceLineType; string; Type of count task source line.
- CountTaskSourceLineTypeCode; string; Abbreviation that identifies the count task source line type. Valid values are ORA_EXPENSE, ORA_IN_STOCK, ORA_IN_TRANSIT, ORA_PAR, ORA_RECEIVING, and ORA_SOLD.
- CountUOMCode; string; Abbreviation that identifies the unit of measure for the current count.
- CountUnitOfMeasure; string; Unit of measure for the current count.
- CountedByEmployee; string; Name of the employee who performed the current count.
- CountedByEmployeeId; integer; Value that uniquely identifies the employee who performed the current count.
- DestinationLocator; string; Name of the destination locator.
- DestinationLocatorId; integer; Value that uniquely identifies the destination locator.
- DestinationSubinventory; string; Name of the destination subinventory.
- ErrorCode; string; Abbreviation that identifies the error, if any. Contains a value or is empty. A value indicates the error message name of the failed request. An empty value indicates the request succeeded.
- ErrorMessage; string; Text of the error message, if any. Contains a value or is empty. A value indicates the error explanation of the failed request. An empty value indicates the request succeeded.
- ExpectedQuantity; number; Expected quantity of the current count in the primary unit of measure used by the item.
- ExpectedUOMCode; string; Abbreviation that identifies the expected unit of measure for the current count.
- ExpectedUnitOfMeasure; string; Expected unit of measure for the current count.
- InvCountTaskId; integer; Value that uniquely identifies the inventory count task.
- InventoryItemId; integer; Value that uniquely identifies the inventory item.
- ItemDescription; string; Description of the inventory item.
- ItemNumber; string; Number that indicates the inventory item.
- LocationCode; string; Abbreviation that identifies the location.
- LocationId; integer; Value that uniquely identifies the location.
- LocationName; string; Name of the location.
- Locator; string; Name of the locator.
- LocatorId; integer; Value that uniquely identifies the locator.
- LotNumber; string; Number that identifies an item or group of items.
- ManufacturerPartNumber; string; Number that identifies the manufacturer part corresponding to an item or description-based item for which there is a product recall.
- OrganizationCode; string; Abbreviation that identifies the inventory organization.
- OrganizationId; integer; Value that uniquely identifies the inventory organization.
- OrganizationName; string; Name of the inventory organization.
- OwningEntityId; integer; Value that uniquely identifies the owning entity. If the item is consigned, then this attribute contains the vendor site identifier. If the item is owned, then this attribute contains the owning organization identifier.
- OwningParty; string; Name of the owning party.
- OwningPartySite; string; Name of the owning party site.
- OwningType; string; Type of owning entity. If the item is consigned, then this attribute contains the vendor site identifier. If the item is owned, then this attribute contains the owning organization identifier.
- OwningTypeCode; string; Contains one of the following values: 1 or 2. If 1, then the item is consigned. If 2, then the item is owned. The default value is 2.
- PickLocator; string; Name of the pick locator.
- PickLocatorId; integer; Value that uniquely identifies the pick locator.
- PickSubinventory; string; Name of the pick subinventory.
- ProcessingMode; string; Mode of processing.
- ProcurementBU; string; Business unit that manages and owns the purchasing document.
- RecallHeaderId; integer; Value that uniquely identifies the recall header.
- RecallHeaderNumber; string; Number that indicates the recall header.
- RecallLineId; integer; Value that uniquely identifies the recall line.
- RecallLineNumber; string; Number that indicates the recall line.
- RequesterId; integer; Value that uniquely identifies the person who requested the recall notice.
- RequesterName; string; Name of the person who requested the recall notice.
- Revision; string; Revision of the item.
- SecondaryExpectedQuantity; number; Expected quantity of the current count in the secondary unit of measure used by the item.
- SecondaryUOMQuantity; number; Quantity of the current count in the secondary unit of measure used by the item.
- SequenceNumber; integer; Number of the current count task sequence.
- SerialNumber; string; Number that indicates the serial to count.
- Subinventory; string; Name of the subinventory.
- TransactionDate; string; Date when the transaction occurred.
- TransactionReason; string; Name of the transaction reason.
- TransactionReasonId; integer; Value that uniquely identifies the transaction reason.
- UseItemCostFlag; boolean; Contains one of the following values: true or false. If true, then use the current item cost. If false, then do not use the current item cost. This attribute defaults from the use current item cost attribute for the inventory organization. This attribute is mandatory.
-
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(required):
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(required):
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 : inventoryCountTasks
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 : inventoryCountTasks-item-response
Type:
Show Source
object
-
Account: string
Maximum Length:
255
Value that identifies the account. -
AccountAlias: string
Maximum Length:
255
Name of the account alias. -
AccountAliasId: integer
(int64)
Value that uniquely identifies the account alias.
-
AccountId: integer
(int64)
Value that uniquely identifies the account.
-
Comments: string
Maximum Length:
240
Comments that describe the current count. -
CostCenterCode: string
Read Only:
true
Maximum Length:25
Abbreviation that identifies the organizational element of a chart of accounts typically used for assigning revenues and expenses. -
CostCenterDescription: string
Read Only:
true
Description of the organizational element of chart of accounts. -
costs: array
Costs
Title:
Costs
The Costs resource manages the costs associated with the count task. -
CountDate: string
(date)
Date when the count was performed.
-
CountedByEmployee: string
Maximum Length:
255
Name of the employee who performed the current count. -
CountedByEmployeeId: integer
(int64)
Value that uniquely identifies the employee who performed the current count.
-
CountQuantity: number
Count quantity for the count task.
-
CountSecondaryUnitOfMeasure: string
Read Only:
true
Maximum Length:255
Secondary unit of measure used by the current count. -
CountSecondaryUOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the secondary unit of measure used by the current count. -
CountStatus: string
Read Only:
true
Maximum Length:255
Current status of the count. -
CountStatusCode: string
Read Only:
true
Maximum Length:30
Default Value:ORA_OPEN
Abbreviation that identifies the count status. -
CountTaskSourceHeaderId: integer
(int64)
Read Only:
true
Value that identifies the count task source header. -
CountTaskSourceLineId: integer
(int64)
Read Only:
true
Value that identifies the count task source line. -
CountTaskSourceLineType: string
Read Only:
true
Maximum Length:255
Type of count task source line. -
CountTaskSourceLineTypeCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the count task source line type. Valid values are ORA_EXPENSE, ORA_IN_STOCK, ORA_IN_TRANSIT, ORA_PAR, ORA_RECEIVING, and ORA_SOLD. -
CountUnitOfMeasure: string
Maximum Length:
255
Unit of measure for the current count. -
CountUOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure for the current count. -
DestinationLocator: string
Read Only:
true
Maximum Length:255
Name of the destination locator. -
DestinationLocatorId: integer
(int64)
Read Only:
true
Value that uniquely identifies the destination locator. -
DestinationSubinventory: string
Read Only:
true
Maximum Length:10
Name of the destination subinventory. -
DFF: array
Flexfields for Inventory Count Tasks
Title:
Flexfields for Inventory Count Tasks
The Flexfields for Inventory Count Tasks resource manages the descriptive flexfields for the count task. -
ErrorCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the error, if any. Contains a value or is empty. A value indicates the error message name of the failed request. An empty value indicates the request succeeded. -
ErrorMessage: string
Read Only:
true
Maximum Length:1200
Text of the error message, if any. Contains a value or is empty. A value indicates the error explanation of the failed request. An empty value indicates the request succeeded. -
ExpectedQuantity: number
Expected quantity of the current count in the primary unit of measure used by the item.
-
ExpectedUnitOfMeasure: string
Read Only:
true
Expected unit of measure for the current count. -
ExpectedUOMCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the expected unit of measure for the current count. -
InvCountTaskId: integer
(int64)
Value that uniquely identifies the inventory count task.
-
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemDescription: string
Read Only:
true
Maximum Length:255
Description of the inventory item. -
ItemNumber: string
Maximum Length:
255
Number that indicates the inventory item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationCode: string
Read Only:
true
Maximum Length:255
Abbreviation that identifies the location. -
LocationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the location. -
LocationName: string
Read Only:
true
Maximum Length:255
Name of the location. -
Locator: string
Maximum Length:
255
Name of the locator. -
LocatorId: integer
(int64)
Value that uniquely identifies the locator.
-
LotNumber: string
Maximum Length:
80
Number that identifies an item or group of items. -
ManufacturerPartNumber: string
Read Only:
true
Maximum Length:700
Number that identifies the manufacturer part corresponding to an item or description-based item for which there is a product recall. -
OrganizationCode: string
Maximum Length:
255
Abbreviation that identifies the inventory organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
OrganizationName: string
Maximum Length:
255
Name of the inventory organization. -
OwningEntityId: integer
(int64)
Value that uniquely identifies the owning entity. If the item is consigned, then this attribute contains the vendor site identifier. If the item is owned, then this attribute contains the owning organization identifier.
-
OwningParty: string
Maximum Length:
255
Name of the owning party. -
OwningPartySite: string
Maximum Length:
255
Name of the owning party site. -
OwningType: string
Maximum Length:
255
Type of owning entity. If the item is consigned, then this attribute contains the vendor site identifier. If the item is owned, then this attribute contains the owning organization identifier. -
OwningTypeCode: string
Maximum Length:
30
Contains one of the following values: 1 or 2. If 1, then the item is consigned. If 2, then the item is owned. The default value is 2. -
PickLocator: string
Maximum Length:
255
Name of the pick locator. -
PickLocatorId: integer
(int64)
Value that uniquely identifies the pick locator.
-
PickSubinventory: string
Maximum Length:
10
Name of the pick subinventory. -
ProcessingMode: string
Mode of processing.
-
ProcessingModeCode: string
Abbreviation that identifies the mode in which the count is performed.
-
ProcurementBU: string
Maximum Length:
255
Business unit that manages and owns the purchasing document. -
RecallHeaderId: integer
(int64)
Value that uniquely identifies the recall header.
-
RecallHeaderNumber: string
Maximum Length:
255
Number that indicates the recall header. -
RecallLineId: integer
(int64)
Value that uniquely identifies the recall line.
-
RecallLineNumber: string
Maximum Length:
255
Number that indicates the recall line. -
recallLots: array
Recall Lots
Title:
Recall Lots
The Recall Lots gets the information about the lot details for each recall notice line. -
recallLotSerials: array
Recall Lot Serials
Title:
Recall Lot Serials
The Recall Lot Serials gets the information about the lot and serial details for each recall notice line. -
RequesterId: integer
(int64)
Read Only:
true
Value that uniquely identifies the person who requested the recall notice. -
RequesterName: string
Read Only:
true
Maximum Length:255
Name of the person who requested the recall notice. -
Revision: string
Maximum Length:
18
Revision of the item. -
SecondaryExpectedQuantity: number
Expected quantity of the current count in the secondary unit of measure used by the item.
-
SecondaryUOMQuantity: number
Quantity of the current count in the secondary unit of measure used by the item.
-
SequenceNumber: integer
(int64)
Read Only:
true
Number of the current count task sequence. -
SerialNumber: string
Maximum Length:
80
Number that indicates the serial to count. -
Subinventory: string
Maximum Length:
10
Name of the subinventory. -
TransactionDate: string
(date)
Read Only:
true
Date when the transaction occurred. -
TransactionReason: string
Maximum Length:
255
Name of the transaction reason. -
TransactionReasonId: integer
(int64)
Value that uniquely identifies the transaction reason.
-
UseItemCostFlag: boolean
Contains one of the following values: true or false. If true, then use the current item cost. If false, then do not use the current item cost. This attribute defaults from the use current item cost attribute for the inventory organization. This attribute is mandatory.
Nested Schema : Costs
Type:
array
Title:
Costs
The Costs resource manages the costs associated with the count task.
Show Source
Nested Schema : Flexfields for Inventory Count Tasks
Type:
array
Title:
Flexfields for Inventory Count Tasks
The Flexfields for Inventory Count Tasks resource manages the descriptive flexfields for the count task.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Recall Lots
Type:
array
Title:
Recall Lots
The Recall Lots gets the information about the lot details for each recall notice line.
Show Source
Nested Schema : Recall Lot Serials
Type:
array
Title:
Recall Lot Serials
The Recall Lot Serials gets the information about the lot and serial details for each recall notice line.
Show Source
Nested Schema : inventoryCountTasks-costs-item-response
Type:
Show Source
object
-
Cost: number
Cost of the item.
-
CostComponentCode: string
Maximum Length:
30
Abbreviation that identifies the cost component. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Nested Schema : inventoryCountTasks-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context
Maximum Length:30
Descriptive flexfield context name for the count task. -
__FLEX_Context_DisplayValue: string
Title:
Context
Descriptive flexfield context display value for the count task. -
InvCountTaskId: integer
(int64)
Value that uniquely identifies the inventory count task.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryCountTasks-recallLots-item-response
Type:
Show Source
object
-
ExpirationDate: string
(date)
Read Only:
true
Date when the recalled lot expired. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotId: integer
(int64)
Read Only:
true
Value that uniquely identifies the lot number of the recalled item. -
MfgDate: string
(date)
Read Only:
true
Date when the recalled lot was manufactured. -
MfgLotNumber: string
Title:
Manufacturer Lot Number
Read Only:true
Maximum Length:80
Number that indicates the lot specified by the manufacturer in the recall notice. -
ShelfLifeDays: number
Read Only:
true
Number of days of shelf life for the recalled lot.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : inventoryCountTasks-recallLotSerials-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MfgFromSerialNumber: string
Read Only:
true
Maximum Length:80
Number that indicates the starting serial as specified by the manufacturer in recall notice. -
MfgLotNumber: string
Title:
Manufacturer Lot Number
Read Only:true
Maximum Length:80
Number that indicates the lot specified by the manufacturer in the recall notice. -
MfgToSerialNumber: string
Read Only:
true
Maximum Length:80
Number that indicates the ending serial as specified by the manufacturer in recall notice. -
Quantity: number
Read Only:
true
Quantity of the recalled lot. -
SerialId: integer
(int64)
Read Only:
true
Value that uniquely identifies the serial number of the recalled item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all count tasks.
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/inventoryCountTasks"
Example Response Body
The following shows an example of the response body in JSON format.
{ "InvCountTaskId": 300100184764725, "RecallHeaderId": 300100184928127, "RecallHeaderNumber": "RC204101", "RecallLineId": 300100184928128, "RecallLineNumber": "1", "LocationId": 3248, "LocationCode": null, "LocationName": null, "CountTaskSourceHeaderId": 0, "CountTaskSourceLineId": 0, "CountTaskSourceLineTypeCode": "ORA_PAR", "CountTaskSourceLineType": null, "OrganizationId": 207, "OrganizationCode": "M1", "OrganizationName": null, "InventoryItemId": 663914, "ItemNumber": "INV-101", "ItemDescription": null, "Subinventory": "M1IPAR", "LocatorId": null, "Locator": null, "Revision": null, "LotNumber": "AVILOT1", "SerialNumber": null, "OwningTypeCode": "2", "OwningType": "Inventory organization", "OwningEntityId": 207, "OwningPartySite": null, "OwningParty": null, "ProcurementBU": null, "CountStatusCode": "ORA_OPEN", "CountStatus": "Pending count", "CountDate": "2020-03-13", "CountedByEmployeeId": 2159, "CountedByEmployee": "Jones, Sandra", "CountUOMCode": "BX5", "CountUnitOfMeasure": "Box of 5", "CountSecondaryUOMCode": null, "CountSecondaryUnitOfMeasure": null, "CountQuantity": 1, "SecondaryUOMQuantity": null, "ExpectedUOMCode": "Ea", "ExpectedUnitOfMeasure": "Each", "ExpectedQuantity": 200, "SecondaryExpectedQuantity": null, "ErrorCode": null, "ErrorMessage": null, "TransactionReasonId": null, "TransactionReason": null, "TransactionDate": null, "DestinationSubinventory": "RECALL", "DestinationLocatorId": null, "DestinationLocator": null, "PickSubinventory": "AASUB1", "PickLocatorId": null, "PickLocator": null, "Comments": "Test Case1", "AccountAliasId": null, "AccountAlias": null, "AccountId": 107724, "Account": "01-130-5800-0000-000", "SequenceNumber": 9, "RequesterId": null, "RequesterName": null, "UseItemCostFlag": "true", "ProcessingModeCode": null, "ProcessingMode": null, "links": [3] 0: {... ...} }