1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Manufacturing
  4. Kanban Cards

Get all Kanban cards

get

/fscmRestApi/resources/11.13.18.05/kanbanCards

Request

Query Parameters
  • 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).
  • 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
  • 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: Finds a Kanban card according to the primary key.
      Finder Variables:
      • KanbanCardId; integer; Value that uniquely identifies a Kanban card.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • CardStatus; string; Status of the Kanban card.
    • CurrentReplenishmentCycleId; integer; Identifier of the current replenishment cycle.
    • InventoryItemId; integer; Unique identifier of the item defined in the Kanban card.
    • ItemDescription; string; Description of the item in the Kanban card.
    • ItemNumber; string; Item number in the Kanban card.
    • KanbanCardId; integer; Unique application-generated identifier of the Kanban card.
    • KanbanCardNumber; string; User identifier of the Kanban card. Its value is generated from a document sequence.
    • KanbanSize; number; Quantity in the Kanban bin.
    • Locator; string; Name of the destination locator of the item in the Kanban card.
    • LocatorId; integer; Identifier of the destination locator of the item in the Kanban card.
    • OrganizationCode; string; Code of the inventory organization to which this Kanban card belongs.
    • OrganizationId; integer; Identifier of the inventory organization to which this Kanban card belongs.
    • ProductionLineId; integer; Identifier of the production line from which the item is sourced.
    • ProductionLineName; string; Name of the production line from which the item is sourced.
    • PullSequenceId; integer; Unique application-generated identifier of the Kanban pull sequence.
    • SourceLocator; string; Name of the item locator from which the item is sourced.
    • SourceLocatorId; integer; Identifier of the item locator from which the item is sourced.
    • SourceOrganizationCode; string; Code of the inventory organization from which the item is sourced.
    • SourceOrganizationId; integer; Identifier of the inventory organization from which the item is sourced.
    • SourceOrganizationName; string; Name of the inventory organization from which the item is sourced.
    • SourceSubinventoryCode; string; Name of the subinventory from which the item is sourced.
    • SourceType; string; Identifier of the source type.
    • SubinventoryCode; string; Name of the destination subinventory of the item in the Kanban card.
    • SupplierId; integer; Identifier of the supplier from which the item is sourced.
    • SupplierName; string; Name of the supplier from which the item is sourced.
    • SupplierSiteCode; string; Name of the supplier site from which the item is sourced.
    • SupplierSiteId; integer; Identifier of the supplier site from which the item is sourced.
    • SupplyStatus; string; Supply status of the Kanban card.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : kanbanCards
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : kanbanCards-item-response
Type: object
Show Source
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 : kanbanCards-KanbanCardActivity-item-response
Type: object
Show Source
Nested Schema : kanbanCards-KanbanCardDFF-item-response
Type: object
Show Source
Links
printCards
Prints Kanban cards based on the pull sequence or Kanban card identifiers.
Back to Top

Examples

This example describes how to get all Kanban cards.

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"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "items": [
        {
            "KanbanCardId": "3003",
            "OrganizationCode": "M1",
            "OrganizationName": "Seattle Manufacturing",
            "KanbanCardNumber": "M1-3003",
            "ItemNumber": "DOS-BAT-Simple Buy",
            "ItemDescription": "SCO BAT Simple Buy Item",
            "OrganizationId": "207",
            "InventoryItemId": "300100052590853",
            "PullSequenceId": "300100613486787",
            "SourceType": "2",
            "SourceTypeMeaning": "Supplier",
            "SubinventoryCode": "Stores",
            "LocatorId": null,
            "Locator": null,
            "SourceSubinventoryCode": null,
            "SourceLocatorId": null,
            "SourceLocator": null,
            "SupplierId": "300100052570626",
            "SupplierName": "SCO_SUPPLIER",
            "SupplierSiteId": "300100052570638",
            "SupplierSiteCode": "SCO_SITE",
            "KanbanSize": "10",
            "CardStatus": "2",
            "CardStatusMeaning": "On hold",
            "CurrentReplenishmentCycleId": "20002",
            "SupplyStatus": "5",
            "SupplyStatusMeaning": "In process",
            "DocumentTypeMeaning": "Purchase order",
            "DocumentNumber": "1005363.1.1",
            "CurrentReplenishmentCycle": "1",
            "CreatedBy": "WHSE_MGR_ALL_INV_ORGS",
            "CreationDate": "2024-09-26T09:56:03+00:00",
            "LastUpdatedBy": "WHSE_MGR_ALL_INV_ORGS",
            "LastUpdateDate": "2024-09-26T09:56:03.001+00:00",
            "@context": {
                "key": "3003",
                "headers": {
                    "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478"
                },
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername/fscmRestApi/resources/version/kanbanCards/3003",
                        "name": "kanbanCards",
                        "kind": "item"
                    },
                    {
                        "rel": "canonical",
                        "href": "https://servername/fscmRestApi/resources/version/kanbanCards/3003",
                        "name": "kanbanCards",
                        "kind": "item"
                    },
                    {
                        "rel": "child",
                        "href": "https://servername/fscmRestApi/resources/version/kanbanCards/3003/child/KanbanCardActivity",
                        "name": "KanbanCardActivity",
                        "kind": "collection"
                    },
                    {
                        "rel": "child",
                        "href": "https://servername/fscmRestApi/resources/version/kanbanCards/3003/child/KanbanCardDFF",
                        "name": "KanbanCardDFF",
                        "kind": "collection"
                    }
                ]
            }
        },
        . . .

    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/kanbanCards",
            "name": "kanbanCards",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername/fscmRestApi/resources/version/kanbanCards/action/printCards",
            "name": "printCards",
            "kind": "other"
        }
    ]
}
Back to Top