Get one Kanban card
get
/fscmRestApi/resources/11.13.18.05/kanbanCards/{KanbanCardId}
Request
Path Parameters
-
KanbanCardId(required): integer(int64)
Unique application-generated identifier of the Kanban card.
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: 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 : kanbanCards-item-response
Type:
Show Source
object
-
CardStatus: string
Title:
Card Status
Maximum Length:30
Status of the Kanban card. -
CardStatusMeaning: string
Title:
Card Status
Read Only:true
Maximum Length:255
Meaning of the Kanban card status. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the Kanban card. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the user created the Kanban card. -
CurrentReplenishmentCycle: integer
Title:
Cycle Number
Read Only:true
Current replenishment cycle number of the Kanban card. -
CurrentReplenishmentCycleId: integer
(int64)
Read Only:
true
Identifier of the current replenishment cycle. -
DocumentNumber: string
Title:
Document Number
Read Only:true
Maximum Length:255
Document number of the Kanban card -
DocumentTypeMeaning: string
Title:
Document Type
Read Only:true
Maximum Length:255
Meaning of the document type of the Kanban card. -
InactiveDate: string
(date)
Title:
Cancellation Date
Date after which the temporary Kanban card will be cancelled. -
InventoryItemId: integer
(int64)
Title:
Item
Unique identifier of the item defined in the Kanban card. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item in the Kanban card. -
ItemNumber: string
Title:
Item
Maximum Length:300
Item number in the Kanban card. -
KanbanCardActivity: array
Kanban Card Activity
Title:
Kanban Card Activity
The history of Kanban card activities. -
KanbanCardDFF: array
Flexfields for Kanban Cards
Title:
Flexfields for Kanban Cards
The flexfields for the Kanban cards resources. -
KanbanCardId: integer
(int64)
Read Only:
true
Unique application-generated identifier of the Kanban card. -
KanbanCardNumber: string
Title:
Card Number
Read Only:true
Maximum Length:200
User identifier of the Kanban card. Its value is generated from a document sequence. -
KanbanCardType: string
Title:
Card Type
Read Only:true
Maximum Length:30
Type of the Kanban card. Valid values are 1 and 2. -
KanbanCardTypeMeaning: string
Read Only:
true
Maximum Length:255
Meaning of the Kanban card type. Valid values are Replenishable and Nonreplenishable. -
KanbanSize: number
Title:
Kanban Size
Quantity in the Kanban bin. -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
Date and time when the user most recently updated the Kanban card. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the Kanban card. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Locator: string
Maximum Length:
255
Name of the destination locator of the item in the Kanban card. -
LocatorId: integer
(int64)
Title:
Destination Locator
Identifier of the destination locator of the item in the Kanban card. -
MaximumReplenishments: integer
Title:
Maximum Replenishments
Maximum replenishments allowed for the Kanban card. -
OrganizationCode: string
Maximum Length:
18
Code of the inventory organization to which this Kanban card belongs. -
OrganizationId: integer
(int64)
Title:
Organization
Identifier of the inventory organization to which this Kanban card belongs. -
OrganizationName: string
Read Only:
true
Maximum Length:240
Organization name to which this Kanban card belongs. -
ProductionLineId: integer
(int64)
Read Only:
true
Identifier of the production line from which the item is sourced. -
ProductionLineName: string
Read Only:
true
Maximum Length:120
Name of the production line from which the item is sourced. -
PullSequenceId: integer
(int64)
Unique application-generated identifier of the Kanban pull sequence.
-
SourceLocator: string
Read Only:
true
Maximum Length:255
Name of the item locator from which the item is sourced. -
SourceLocatorId: integer
(int64)
Title:
Source Locator
Read Only:true
Identifier of the item locator from which the item is sourced. -
SourceOrganizationCode: string
Read Only:
true
Maximum Length:18
Code of the inventory organization from which the item is sourced. -
SourceOrganizationId: integer
(int64)
Title:
Source Organization
Read Only:true
Identifier of the inventory organization from which the item is sourced. -
SourceOrganizationName: string
Read Only:
true
Maximum Length:240
Name of the inventory organization from which the item is sourced. -
SourceSubinventoryCode: string
Title:
Source Subinventory
Read Only:true
Maximum Length:10
Name of the subinventory from which the item is sourced. -
SourceType: string
Title:
Source Type
Read Only:true
Maximum Length:30
Identifier of the source type. -
SourceTypeMeaning: string
Title:
Source Type
Read Only:true
Maximum Length:255
Source type of the Kanban card. -
SubinventoryCode: string
Title:
Destination Subinventory
Maximum Length:10
Name of the destination subinventory of the item in the Kanban card. -
SupplierId: integer
(int64)
Title:
Supplier
Read Only:true
Identifier of the supplier from which the item is sourced. -
SupplierName: string
Read Only:
true
Maximum Length:255
Name of the supplier from which the item is sourced. -
SupplierSiteCode: string
Read Only:
true
Maximum Length:255
Name of the supplier site from which the item is sourced. -
SupplierSiteId: integer
(int64)
Title:
Supplier Site
Read Only:true
Identifier of the supplier site from which the item is sourced. -
SupplyStatus: string
Title:
Supply Status
Maximum Length:30
Supply status of the Kanban card. -
SupplyStatusMeaning: string
Title:
Supply Status
Read Only:true
Maximum Length:255
Meaning of the supply status.
Nested Schema : Kanban Card Activity
Type:
array
Title:
Kanban Card Activity
The history of Kanban card activities.
Show Source
Nested Schema : Flexfields for Kanban Cards
Type:
array
Title:
Flexfields for Kanban Cards
The flexfields for the Kanban cards resources.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : kanbanCards-KanbanCardActivity-item-response
Type:
Show Source
object
-
CardStatus: string
Read Only:
true
Maximum Length:30
Status of the Kanban card. -
CardStatusMeaning: string
Title:
Card Status
Read Only:true
Maximum Length:255
Meaning of the Kanban card status. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the Kanban card. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the Kanban card. -
DocumentNumber: string
Title:
Document Number
Read Only:true
Maximum Length:255
Document number of the Kanban card -
DocumentReference1: integer
(int64)
Read Only:
true
Foreign key reference of the document number of the Kanban card. -
DocumentReference2: integer
(int64)
Read Only:
true
Foreign key reference of the document number of the Kanban card. -
DocumentReference3: integer
(int64)
Read Only:
true
Foreign key reference of the document number of the Kanban card. -
DocumentType: string
Title:
Document Type
Read Only:true
Maximum Length:30
Document type of the Kanban card. -
DocumentTypeMeaning: string
Title:
Document Type
Read Only:true
Maximum Length:255
Meaning of the document type of the Kanban card. -
FromSupplyStatus: string
Read Only:
true
Maximum Length:30
From-supply status of the Kanban card. -
FromSupplyStatusMeaning: string
Read Only:
true
Maximum Length:255
Meaning of the from-supply status. -
KanbanActivityId: integer
(int64)
Read Only:
true
Identifier of the Kanban card activity. -
KanbanCardId: integer
(int64)
Read Only:
true
Unique identifier of the Kanban card. Its value is an application-generated unique ID. -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
User who most recently updated the Kanban card. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Date and time when the user most recently updated the Kanban card. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReplenishmentCycle: string
Title:
Cycle Number
Read Only:true
Replenishment cycle of the Kanban card. -
ReplenishmentCycleId: integer
(int64)
Read Only:
true
Identifier for the replenishment cycle. -
ToSupplyStatus: string
Title:
Supply Status
Read Only:true
Maximum Length:30
To-supply status of the Kanban card. -
ToSupplyStatusMeaning: string
Title:
Supply Status
Read Only:true
Maximum Length:255
Meaning of the to-supply status.
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 : kanbanCards-KanbanCardDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for Kanban card. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for Kanban card. -
KanbanCardId: integer
(int64)
Unique identifier of the Kanban card.
-
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
Links
- KanbanCardActivity
-
Parameters:
- KanbanCardId:
$request.path.KanbanCardId
The history of Kanban card activities. - KanbanCardId:
- KanbanCardDFF
-
Parameters:
- KanbanCardId:
$request.path.KanbanCardId
The flexfields for the Kanban cards resources. - KanbanCardId:
Examples
This example describes how to get one Kanban card.
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/kanbanCards/KanbanCardId"
Example Response Body
The following example includes the contents of the response body
in JSON format:
{ "KanbanCardId": "1006", "OrganizationCode": "M1", "OrganizationName": "Seattle Manufacturing", "KanbanCardNumber": "M1-1006", "ItemNumber": "AS54888", "ItemDescription": "Standard Desktop", "OrganizationId": "207", "InventoryItemId": "149", "PullSequenceId": "300100613543592", "SourceType": "3", "SourceTypeMeaning": "Intraorganization", "SubinventoryCode": "ABCSUB01", "LocatorId": "3134", "Locator": "ABC1.1.1", "SourceSubinventoryCode": "Stores", "SourceLocatorId": null, "SourceLocator": null, "SupplierId": null, "SupplierName": null, "SupplierSiteId": null, "SupplierSiteCode": null, "KanbanSize": "10", "CardStatus": "2", "CardStatusMeaning": "On hold", "CurrentReplenishmentCycleId": "-1", "SupplyStatus": "2", "SupplyStatusMeaning": "Full", "DocumentTypeMeaning": null, "DocumentNumber": null, "CurrentReplenishmentCycle": "1", "CreatedBy": "WHSE_MGR_ALL_INV_ORGS", "CreationDate": "2024-11-11T06:50:47+00:00", "LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS", "LastUpdateDate": "2024-11-11T06:50:47.001+00:00", "@context": { "key": "1006", "headers": { "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478" }, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/kanbanCards/1006", "name": "kanbanCards", "kind": "item" }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/kanbanCards/1006", "name": "kanbanCards", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/kanbanCards/1006/child/KanbanCardActivity", "name": "KanbanCardActivity", "kind": "collection" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/kanbanCards/1006/child/KanbanCardDFF", "name": "KanbanCardDFF", "kind": "collection" } ] } }