Update one Kanban card
patch
/fscmRestApi/resources/11.13.18.05/kanbanCards/{KanbanCardId}
Request
Path Parameters
-
KanbanCardId(required): integer(int64)
Unique application-generated identifier of the Kanban card.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
CardStatus: string
Title:
Card StatusMaximum Length:30Status of the Kanban card. -
InactiveDate: string
(date)
Title:
Cancellation DateDate after which the temporary Kanban card will be cancelled. -
KanbanCardActivity: array
Kanban Card Activity
Title:
Kanban Card ActivityThe history of Kanban card activities. -
KanbanCardDFF: array
Flexfields for Kanban Cards
Title:
Flexfields for Kanban CardsThe flexfields for the Kanban cards resources. -
KanbanSize: number
Title:
Kanban SizeQuantity in the Kanban bin. -
Locator: string
Maximum Length:
255Name of the destination locator of the item in the Kanban card. -
MaximumReplenishments: integer
Title:
Maximum ReplenishmentsMaximum replenishments allowed for the Kanban card. -
SupplyStatus: string
Title:
Supply StatusMaximum Length:30Supply status of the Kanban card.
Nested Schema : Kanban Card Activity
Type:
arrayTitle:
Kanban Card ActivityThe history of Kanban card activities.
Show Source
Nested Schema : Flexfields for Kanban Cards
Type:
arrayTitle:
Flexfields for Kanban CardsThe flexfields for the Kanban cards resources.
Show Source
Nested Schema : kanbanCards-KanbanCardDFF-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:80Descriptive flexfield context name for Kanban card. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for Kanban card.
Response
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 StatusMaximum Length:30Status of the Kanban card. -
CardStatusMeaning: string
Title:
Card StatusRead Only:trueMaximum Length:255Meaning of the Kanban card status. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the Kanban card. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate and time when the user created the Kanban card. -
CurrentReplenishmentCycle: integer
Title:
Cycle NumberRead Only:trueCurrent replenishment cycle number of the Kanban card. -
CurrentReplenishmentCycleId: integer
(int64)
Read Only:
trueIdentifier of the current replenishment cycle. -
DocumentNumber: string
Title:
Document NumberRead Only:trueMaximum Length:255Document number of the Kanban card -
DocumentTypeMeaning: string
Title:
Document TypeRead Only:trueMaximum Length:255Meaning of the document type of the Kanban card. -
InactiveDate: string
(date)
Title:
Cancellation DateDate after which the temporary Kanban card will be cancelled. -
InventoryItemId: integer
(int64)
Title:
ItemUnique identifier of the item defined in the Kanban card. -
ItemDescription: string
Title:
Item DescriptionRead Only:trueMaximum Length:240Description of the item in the Kanban card. -
ItemNumber: string
Title:
ItemMaximum Length:300Item number in the Kanban card. -
KanbanCardActivity: array
Kanban Card Activity
Title:
Kanban Card ActivityThe history of Kanban card activities. -
KanbanCardDFF: array
Flexfields for Kanban Cards
Title:
Flexfields for Kanban CardsThe flexfields for the Kanban cards resources. -
KanbanCardId: integer
(int64)
Read Only:
trueUnique application-generated identifier of the Kanban card. -
KanbanCardNumber: string
Title:
Card NumberRead Only:trueMaximum Length:200User identifier of the Kanban card. Its value is generated from a document sequence. -
KanbanCardType: string
Title:
Card TypeRead Only:trueMaximum Length:30Type of the Kanban card. Valid values are 1 and 2. -
KanbanCardTypeMeaning: string
Read Only:
trueMaximum Length:255Meaning of the Kanban card type. Valid values are Replenishable and Nonreplenishable. -
KanbanSize: number
Title:
Kanban SizeQuantity in the Kanban bin. -
LastUpdateDate: string
(date-time)
Title:
Last UpdatedRead Only:trueDate and time when the user most recently updated the Kanban card. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the Kanban card. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Locator: string
Maximum Length:
255Name of the destination locator of the item in the Kanban card. -
LocatorId: integer
(int64)
Title:
Destination LocatorIdentifier of the destination locator of the item in the Kanban card. -
MaximumReplenishments: integer
Title:
Maximum ReplenishmentsMaximum replenishments allowed for the Kanban card. -
OrganizationCode: string
Maximum Length:
18Code of the inventory organization to which this Kanban card belongs. -
OrganizationId: integer
(int64)
Title:
OrganizationIdentifier of the inventory organization to which this Kanban card belongs. -
OrganizationName: string
Read Only:
trueMaximum Length:240Organization name to which this Kanban card belongs. -
ProductionLineId: integer
(int64)
Read Only:
trueIdentifier of the production line from which the item is sourced. -
ProductionLineName: string
Read Only:
trueMaximum Length:120Name 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:
trueMaximum Length:255Name of the item locator from which the item is sourced. -
SourceLocatorId: integer
(int64)
Title:
Source LocatorRead Only:trueIdentifier of the item locator from which the item is sourced. -
SourceOrganizationCode: string
Read Only:
trueMaximum Length:18Code of the inventory organization from which the item is sourced. -
SourceOrganizationId: integer
(int64)
Title:
Source OrganizationRead Only:trueIdentifier of the inventory organization from which the item is sourced. -
SourceOrganizationName: string
Read Only:
trueMaximum Length:240Name of the inventory organization from which the item is sourced. -
SourceSubinventoryCode: string
Title:
Source SubinventoryRead Only:trueMaximum Length:10Name of the subinventory from which the item is sourced. -
SourceType: string
Title:
Source TypeRead Only:trueMaximum Length:30Identifier of the source type. -
SourceTypeMeaning: string
Title:
Source TypeRead Only:trueMaximum Length:255Source type of the Kanban card. -
SubinventoryCode: string
Title:
Destination SubinventoryMaximum Length:10Name of the destination subinventory of the item in the Kanban card. -
SupplierId: integer
(int64)
Title:
SupplierRead Only:trueIdentifier of the supplier from which the item is sourced. -
SupplierName: string
Read Only:
trueMaximum Length:255Name of the supplier from which the item is sourced. -
SupplierSiteCode: string
Read Only:
trueMaximum Length:255Name of the supplier site from which the item is sourced. -
SupplierSiteId: integer
(int64)
Title:
Supplier SiteRead Only:trueIdentifier of the supplier site from which the item is sourced. -
SupplyStatus: string
Title:
Supply StatusMaximum Length:30Supply status of the Kanban card. -
SupplyStatusMeaning: string
Title:
Supply StatusRead Only:trueMaximum Length:255Meaning of the supply status.
Nested Schema : Kanban Card Activity
Type:
arrayTitle:
Kanban Card ActivityThe history of Kanban card activities.
Show Source
Nested Schema : Flexfields for Kanban Cards
Type:
arrayTitle:
Flexfields for Kanban CardsThe flexfields for the Kanban cards resources.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : kanbanCards-KanbanCardActivity-item-response
Type:
Show Source
object-
CardStatus: string
Read Only:
trueMaximum Length:30Status of the Kanban card. -
CardStatusMeaning: string
Title:
Card StatusRead Only:trueMaximum Length:255Meaning of the Kanban card status. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the Kanban card. -
CreationDate: string
(date-time)
Read Only:
trueDate and time when the user created the Kanban card. -
DocumentNumber: string
Title:
Document NumberRead Only:trueMaximum Length:255Document number of the Kanban card -
DocumentReference1: integer
(int64)
Read Only:
trueForeign key reference of the document number of the Kanban card. -
DocumentReference2: integer
(int64)
Read Only:
trueForeign key reference of the document number of the Kanban card. -
DocumentReference3: integer
(int64)
Read Only:
trueForeign key reference of the document number of the Kanban card. -
DocumentType: string
Title:
Document TypeRead Only:trueMaximum Length:30Document type of the Kanban card. -
DocumentTypeMeaning: string
Title:
Document TypeRead Only:trueMaximum Length:255Meaning of the document type of the Kanban card. -
FromSupplyStatus: string
Read Only:
trueMaximum Length:30From-supply status of the Kanban card. -
FromSupplyStatusMeaning: string
Read Only:
trueMaximum Length:255Meaning of the from-supply status. -
KanbanActivityId: integer
(int64)
Read Only:
trueIdentifier of the Kanban card activity. -
KanbanCardId: integer
(int64)
Read Only:
trueUnique identifier of the Kanban card. Its value is an application-generated unique ID. -
LastUpdateDate: string
(date-time)
Title:
Last UpdatedRead Only:trueUser who most recently updated the Kanban card. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Date and time when the user most recently updated the Kanban card. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ReplenishmentCycle: string
Title:
Cycle NumberRead Only:trueReplenishment cycle of the Kanban card. -
ReplenishmentCycleId: integer
(int64)
Read Only:
trueIdentifier for the replenishment cycle. -
ToSupplyStatus: string
Title:
Supply StatusRead Only:trueMaximum Length:30To-supply status of the Kanban card. -
ToSupplyStatusMeaning: string
Title:
Supply StatusRead Only:trueMaximum Length:255Meaning of the to-supply status.
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 : kanbanCards-KanbanCardDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:80Descriptive flexfield context name for Kanban card. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentDescriptive flexfield context display value for Kanban card. -
KanbanCardId: integer
(int64)
Unique identifier of the Kanban card.
-
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
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 update a Kanban card.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/kanbanCards/KanbanCardId"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{
"CardStatus": "2",
"SupplyStatus": "2"
}
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": "Active",
"CurrentReplenishmentCycleId": "-1",
"SupplyStatus": "2",
"SupplyStatusMeaning": "In process",
"DocumentTypeMeaning": "Movement request",
"DocumentNumber": "5597029.2",
"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"
}
]
}
}