Get one sequence
get
/fscmRestApi/resources/11.13.18.05/cycleCountSequenceDetails/{cycleCountSequenceDetailsUniqID}
Request
Path Parameters
-
cycleCountSequenceDetailsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- CycleCountEntryId, CycleCountHeaderId and OrganizationId ---for the Cycle Count Sequence Details resource and used to uniquely identify an instance of Cycle Count Sequence Details. The client should not generate the hash key value. Instead, the client should query on the Cycle Count Sequence Details collection resource with a filter on the primary key values in order to navigate to a specific instance of Cycle Count Sequence Details.
For example: cycleCountSequenceDetails?q=CycleCountEntryId=<value1>;CycleCountHeaderId=<value2>;OrganizationId=<value3>
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 : cycleCountSequenceDetails-item-response
Type:
Show Source
object
-
AdjustmentDate: string
(date)
Read Only:
true
Date when the warehouse posted the adjustment transaction. -
AdjustmentValue: number
Read Only:
true
Monetary value of the adjustment transaction. -
CategoryName: string
Read Only:
true
Maximum Length:255
The category associated with the cycle count sequence. -
ClassName: string
Read Only:
true
Maximum Length:255
The ABC class associated with the cycle count sequence. -
Comments: string
Title:
Comments
Maximum Length:240
Comments that describe the current count. -
CountDate: string
(date)
Date when the warehouse counted this sequence.
-
CountedBy: string
Maximum Length:
2000
Name of the employee who performed the current count. -
CountedByEmployeeId: integer
(int64)
Title:
Counted By
Value that uniquely identifies the employee who performed the current count. -
CountQuantity: number
Title:
Count Quantity
Count quantity for the count sequence. -
CountSequence: integer
(int64)
Title:
Count Sequence
Number of the cycle count sequence. -
CountSequenceStatus: string
Maximum Length:
80
Current status of the count sequence. A list of accepted values is defined in the lookup type INV_CC_ENTRY_STATUSES. -
CountSequenceStatusCode: string
Title:
Approval Status
Maximum Length:30
Value that indicates the current status of the count sequence. -
CountSequenceWithPrefix: string
Read Only:
true
Maximum Length:255
The cycle count sequence combined with the manual count prefix. -
CountType: string
Maximum Length:
80
Type of count. A list of accepted values is defined in the lookup type INV_CC_COUNT_TYPES. -
CountTypeCode: string
Maximum Length:
30
Value that identifies the type of count. A list of accepted values is defined in the lookup type INV_CC_COUNT_TYPES. -
CountUOM: string
Maximum Length:
25
Unit of measure for the current count. -
CountUOMCode: string
Title:
Primary Count UOM
Maximum Length:3
Value that identifies the unit of measure for the current count. -
CycleCountEntryId: integer
(int64)
Value that uniquely identifies the cycle count sequence.
-
CycleCountHeaderId: integer
(int64)
Title:
Count Name
Value that uniquely identifies the cycle count. -
CycleCountName: string
Maximum Length:
30
Name of the cycle count. -
DeviationPercentage: number
Read Only:
true
Percent deviation of the adjustment. -
DFF: array
Flexfields for Cycle Count Sequence Details
Title:
Flexfields for Cycle Count Sequence Details
The Flexfields for Cycle Count Sequence Details manages details of the descriptive flexfields that reference the cycle count sequence. -
ExportCode: integer
(int64)
Value that determines whether to export the count sequence to the interface.
-
Exported: string
Maximum Length:
80
Indicates whether the warehouse exported the count sequence to the interface. -
history: array
History
Title:
History
The History resource manages details for the history of cycle count sequences. -
inventoryAttributesDFF: array
Flexfields for Tracking Attributes
Title:
Flexfields for Tracking Attributes
The Flexfields for Tracking Attributes resource manages details of the descriptive flexfields that reference the cycle count sequence. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item.
-
ItemDescription: string
Maximum Length:
240
Description of the inventory item. -
ItemLotControlCode: string
Maximum Length:
30
Identifies all the lot control items for a cycle count definition. -
ItemNumber: string
Maximum Length:
300
Name of the inventory item. -
ItemPrimaryImageURL: string
Read Only:
true
Maximum Length:240
Value that provides reference to the image of the item for which the count sequence is generated. -
ItemSerialControlCode: string
Maximum Length:
30
Identifies all the serial control items for a cycle count definition. -
ItemUnitCost: number
Read Only:
true
Unit cost of the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Maximum Length:
4000
Name of the locator. -
LocatorId: integer
(int64)
Title:
Locator
Value that uniquely identifies the locator. -
LotNumber: string
Title:
Lot
Maximum Length:80
Number that identifies an item or group of items. -
ManualCountPrefix: string
Read Only:
true
Maximum Length:3
Value that indicates the manual count sequence prefix of the count sequence. -
OrganizationCode: string
Maximum Length:
18
Value that identifies the inventory organization. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
OrganizationName: string
Maximum Length:
240
Name of the inventory organization. -
OwningEntityId: integer
(int64)
Title:
Owning Party Site
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:
360
Name of the owning party. -
OwningPartySite: string
Maximum Length:
240
Name of the owning party site. -
OwningType: 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. -
OwningTypeCode: string
Maximum Length:
80
Name 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. -
PrimaryAdjustmentQuantity: number
Read Only:
true
Adjustment quantity that the warehouse requires to make the system quantity equal the count quantity. -
PrimarySuggestedQuantity: number
Read Only:
true
System quantity that existed during the current count. -
ProcessingFlag: boolean
Maximum Length:
255
Contains one of the following values: true or false. If true, then the request was processed. If false, then the request was not processed. The default value is false. -
ProcurementBU: string
Maximum Length:
255
Business unit that manages and owns the purchasing document. -
Reason: string
Maximum Length:
30
Reason for the adjustment transaction. -
ReasonId: integer
(int64)
Title:
Reason
Value that uniquely identifies the reason. -
Recounts: integer
Read Only:
true
Number of times that the warehouse counted this count sequence. -
ReviewDate: string
(date)
Date when the employee approved the adjustment.
-
ReviewedBy: string
Maximum Length:
2000
Name of the employee who approved the adjustment. -
ReviewedByEmployeeId: integer
(int64)
Title:
Reviewer
Value that uniquely identifies the employee who approved the adjustment. -
Revision: string
Maximum Length:
18
Revision of the item. -
SecondaryAdjustmentQuantity: number
Read Only:
true
Adjustment quantity that's required to make the secondary system quantity equal the secondary count quantity. -
SecondaryCountQuantity: number
Title:
Secondary Count Quantity
Quantity of the current count in the secondary unit of measure that the item uses. -
SecondaryCountUOM: string
Maximum Length:
25
Secondary unit of measure that the current count uses. -
SecondaryCountUOMCode: string
Title:
Secondary UOM
Maximum Length:3
Value that identifies the secondary unit of measure that the current count uses. -
SecondarySuggestedQuantity: number
Read Only:
true
Secondary system quantity that existed during the current count. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Serial number to count. -
serials: array
Serials
Title:
Serials
The Serials resource manages details for the serials of cycle count sequences. -
Subinventory: string
Maximum Length:
10
Name of the subinventory.
Nested Schema : Flexfields for Cycle Count Sequence Details
Type:
array
Title:
Flexfields for Cycle Count Sequence Details
The Flexfields for Cycle Count Sequence Details manages details of the descriptive flexfields that reference the cycle count sequence.
Show Source
Nested Schema : History
Type:
array
Title:
History
The History resource manages details for the history of cycle count sequences.
Show Source
Nested Schema : Flexfields for Tracking Attributes
Type:
array
Title:
Flexfields for Tracking Attributes
The Flexfields for Tracking Attributes resource manages details of the descriptive flexfields that reference the cycle count sequence.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Serials
Type:
array
Title:
Serials
The Serials resource manages details for the serials of cycle count sequences.
Show Source
Nested Schema : cycleCountSequenceDetails-DFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
Descriptive flexfield context name for cycle count sequence details. -
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
CycleCountEntryId: integer
(int64)
Value that uniquely identifies the cycle count sequence.
-
CycleCountHeaderId: integer
(int64)
Title:
Count Name
Value that uniquely identifies the cycle count. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
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 : cycleCountSequenceDetails-history-item-response
Type:
Show Source
object
-
Comments: string
Read Only:
true
Maximum Length:240
Comments that describe the current count. -
CountDate: string
(date-time)
Read Only:
true
Date when the warehouse counted this sequence. -
CountedBy: string
Read Only:
true
Maximum Length:255
Name of the employee who performed the current count. -
CountedByEmployeeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the employee who performed the current count. -
CountQuantity: number
Read Only:
true
Count quantity for the count sequence. -
CountUOM: string
Read Only:
true
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. -
CycleCountEntryId: integer
(int64)
Read Only:
true
Value that uniquely identifies the cycle count sequence. -
EntryHistoryId: integer
(int64)
Read Only:
true
Value that uniquely identifies the cycle count history sequence. -
historySerials: array
History Serials
Title:
History Serials
The History Serials resource manages details for the history serials of cycle count sequences. -
ItemUnitCost: number
Read Only:
true
Unit cost of the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PrimarySuggestedQuantity: number
Read Only:
true
System quantity that existed during the current count. -
PrimaryUOMQuantity: number
Read Only:
true
Quantity of the current count in the primary unit of measure that the item uses. -
Reason: string
Read Only:
true
Maximum Length:255
Reason for the adjustment transaction. -
ReasonId: integer
(int64)
Read Only:
true
Value that uniquely identifies the reason. -
ReviewDate: string
(date-time)
Read Only:
true
Date when the employee approved the adjustment. -
ReviewedBy: string
Read Only:
true
Maximum Length:255
Name of the employee who approved the adjustment. -
ReviewedByEmployeeId: integer
Read Only:
true
Value that uniquely identifies the employee who approved the adjustment. -
SecondaryCountUOM: string
Read Only:
true
Maximum Length:255
Secondary unit of measure that the current count uses. -
SecondaryCountUOMCode: string
Read Only:
true
Maximum Length:3
Value that identifies the secondary unit of measure that the current count uses. -
SecondarySuggestedQuantity: number
Read Only:
true
Secondary system quantity that existed during the current count. -
SecondaryUOMQuantity: number
Read Only:
true
Quantity of the current count in the secondary unit of measure that the item uses.
Nested Schema : History Serials
Type:
array
Title:
History Serials
The History Serials resource manages details for the history serials of cycle count sequences.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : cycleCountSequenceDetails-history-historySerials-item-response
Type:
Show Source
object
-
CycleCountEntryId: integer
(int64)
Read Only:
true
Value that uniquely identifies the cycle count sequence. -
EntryHistoryId: integer
(int64)
Read Only:
true
Value that uniquely identifies the cycle count history sequence. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RecordedInCountFlag: boolean
Read Only:
true
Contains one of the following values: true or false. If true, then the serial is counted in the current count sequence. If false, then the serial isn't counted in the current count sequence. This attribute doesn't have a default value. -
RecordedInSystemFlag: boolean
Read Only:
true
Contains one of the following values: true or false. If true, then the serial is present in the application. If false, then the serial isn't present in the application. This attribute doesn't have a default value. -
SerialNumber: string
Read Only:
true
Maximum Length:80
Serial number to count.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : cycleCountSequenceDetails-inventoryAttributesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:40
Descriptive flexfield context name for tracking attributes. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for tracking attributes. -
countryOfOriginCode: string
Title:
Country of Origin
Maximum Length:2
Abbreviation that identifies the country of origin. This attribute is associated with a feature that requires opt-in. -
countryOfOriginCode_Display: string
Title:
Country of Origin
Name of the country of origin. This attribute is associated with a feature that requires opt-in. -
CycleCountEntryId: integer
(int64)
Value that uniquely identifies the cycle count sequence.
-
CycleCountHeaderId: integer
(int64)
Title:
Count Name
Value that uniquely identifies the cycle count. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Value that uniquely identifies the inventory organization.
-
projectId: integer
(int64)
Title:
Project
Value that uniquely identifies the project. This attribute is associated with a feature that requires opt-in. -
projectId_Display: string
Title:
Project
Number that identifies the project. This attribute is associated with a feature that requires opt-in. -
taskId: integer
(int64)
Title:
Task
Value that uniquely identifies the task. This attribute is associated with a feature that requires opt-in. -
taskId_Display: string
Title:
Task
Number that identifies the task. This attribute is associated with a feature that requires opt-in.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : cycleCountSequenceDetails-serials-item-response
Type:
Show Source
object
-
CcSerialNumberId: integer
Value that uniquely identifies the serial number.
-
CycleCountEntryId: integer
(int64)
Value that uniquely identifies the cycle count serial entry.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RecordedInCountFlag: boolean
Contains one of the following values: true or false. If true, then the serial is counted in the current count sequence. If false, then the serial isn't counted in the current count sequence. This attribute doesn't have a default value.
-
RecordedInSystemFlag: boolean
Read Only:
true
Contains one of the following values: true or false. If true, then the serial is present in the application. If false, then the serial isn't present in the application. This attribute doesn't have a default value. -
SerialNumber: string
Title:
Serial Number
Maximum Length:80
Serial number to count.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- DFF
-
Parameters:
- cycleCountSequenceDetailsUniqID:
$request.path.cycleCountSequenceDetailsUniqID
The Flexfields for Cycle Count Sequence Details manages details of the descriptive flexfields that reference the cycle count sequence. - cycleCountSequenceDetailsUniqID:
- history
-
Parameters:
- cycleCountSequenceDetailsUniqID:
$request.path.cycleCountSequenceDetailsUniqID
The History resource manages details for the history of cycle count sequences. - cycleCountSequenceDetailsUniqID:
- inventoryAttributesDFF
-
Parameters:
- cycleCountSequenceDetailsUniqID:
$request.path.cycleCountSequenceDetailsUniqID
The Flexfields for Tracking Attributes resource manages details of the descriptive flexfields that reference the cycle count sequence. - cycleCountSequenceDetailsUniqID:
- serials
-
Parameters:
- cycleCountSequenceDetailsUniqID:
$request.path.cycleCountSequenceDetailsUniqID
The Serials resource manages details for the serials of cycle count sequences. - cycleCountSequenceDetailsUniqID:
Examples
This example describes how to get one cost adjustment.
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/receiptCosts/AdjustmentHeaderId"
For example, the following command gets cost adjustment where the adjustment header identifier is 4011:
curl -u username:password "https://servername/fscmRestApi/resources/version/costAdjustments/4011"
Example Response Body
The following shows an example of the response body in JSON format.