Get one item
get
/fscmRestApi/resources/11.13.18.05/cycleCountDefinitions/{CycleCountHeaderId}/child/countItems/{CycleCountItemId}
Request
Path Parameters
-
CycleCountHeaderId(required): integer(int64)
Value that uniquely identifies the cycle count definition.
-
CycleCountItemId(required): integer(int64)
Value that uniquely identifies the item that the cycle count definition references.
Query Parameters
-
dependency: string
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> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : cycleCountDefinitions-countItems-item-response
Type:
Show Source
object
-
AbcClass: string
Maximum Length:
40
Name of the ABC class that the item references. -
AbcClassId: integer
(int64)
Value that uniquely identifies the ABC class that the item references.
-
AdjustmentValueNegativeTolerance: number
Title:
Negative
Negative adjustment that the warehouse allows the value to vary for the item. -
AdjustmentValuePositiveTolerance: number
Title:
Positive
Positive adjustment that the warehouse allows the value to vary for the item. -
CountUOM: string
Read Only:
true
Maximum Length:25
Unit of measure for the current count. -
CountUOMCode: string
Read Only:
true
Maximum Length:3
Value that identifies the unit of measure for the current count. -
CycleCountItemId: integer
(int64)
Value that uniquely identifies the item that the cycle count definition references.
-
IncludeInSchedule: string
Maximum Length:
80
Value that determines whether or not to schedule this item. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC. -
IncludeInScheduleCode: integer
Default Value:
2
Value that indicates whether or not to schedule this item. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the item.
-
ItemDescription: string
Maximum Length:
240
Description of the item. -
ItemNumber: string
Maximum Length:
300
Number that identifies the item. -
LastScheduledDate: string
(date-time)
Title:
Last Scheduled Date
Value that indicates the most recent date that the warehouse scheduled this item for counting. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LotControlCode: integer
Read Only:
true
Identifies all the lot control items for a cycle count definition. -
PrimaryImageURL: string
Read Only:
true
Maximum Length:4000
Value that provides a reference to the image of the item for which the count sequence is generated. -
QuantityVarianceNegativePercentage: number
Title:
Negative
Negative percent that the warehouse allows the quantity to vary from the requested quantity for the item. -
QuantityVariancePositivePercentage: number
Title:
Positive
Positive percent that the warehouse allows the quantity to vary from the requested quantity for the item. -
SerialNumberControlCode: integer
Read Only:
true
Identifies all the serial control items for a cycle count definition.
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.
Examples
This example describes how to get one count item.
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/cycleCountDefinitions/value/child/countItems?q=InventoryItemId=value"
For example, the following command gets count item 100000012319248 in cycle count 100000012617301:
curl -u username:password "https://servername/fscmRestApi/resources/version/cycleCountDefinitions/100000012617301/child/countItems?q=InventoryItemId=100000012319248"
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "items": [ { "CycleCountItemId": 1475, "InventoryItemId": 100000012319248, "ItemNumber": "zBIA_CST_PlainItem18", "ItemDescription": "zBIA_CST_PlainItem18", "AbcClassId": 100000012306079, "AbcClass": "zBIA_ClassA", "IncludeInScheduleCode": 2, "IncludeInSchedule": "No", "AdjustmentValuePositiveTolerance": null, "AdjustmentValueNegativeTolerance": null, "QuantityVariancePositivePercentage": null, "QuantityVarianceNegativePercentage": null, "LastScheduledDate": null, "links": [ { "rel": "self", "href": "https://servername/logisticsApi/resources/version/cycleCountDefinitions/100000012617301/child/countItems/1475", "name": "countItems", "kind": "item" }, { "rel": "canonical", "href": "https://servername/logisticsApi/resources/version/cycleCountDefinitions/100000012617301/child/countItems/1475", "name": "countItems", "kind": "item" }, { "rel": "parent", "href": "https://servername/logisticsApi/resources/version/cycleCountDefinitions/100000012617301", "name": "cycleCountDefinitions", "kind": "item" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/logisticsApi/resources/version/cycleCountDefinitions/100000012617301/child/countItems", "name": "countItems", "kind": "collection" } ] }