Jump to

• Request
• Response

Get all kanban plan

get

/fscmRestApi/resources/11.13.18.05/kanbanPlans

Request

Query Parameters

• 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
• finder: string
  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 kanban plan
    Finder Variables
    • KanbanPlanId; integer; The unique identifier of a Kanban plan. Its value is an application generated unique identifier.
• limit: integer
  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.
• 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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • InputDesignator; string; Represents the external forecast designator or demand plan designator.
  • InputType; string; Represents the type of demand provided to the plan such as external forecast or actual production.
  • KanbanPlanCode; string; Represents the Kanban designator, which serves as a reference label to distinguish individual Kanban plans.
  • KanbanPlanDescription; string; The description of plan used in the Kanban planning process.
  • KanbanPlanId; integer; The unique identifier of a Kanban plan. Its value is an application generated unique identifier.
  • OrganizationCode; string; Code of the inventory organization to which this pull sequence belongs.
  • OrganizationId; integer; The organization identifier represents the manufacturing plant to which this Kanban plan belongs.
  • PlanCutoffDate; string; The plan cutoff date used in the Kanban planning process.
  • PlanDisableDate; string; The plan disable date used in the Kanban planning process.
  • PlanStartDate; string; The demand start date used in the Kanban planning process.
• totalResults: boolean
  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

• 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 Top

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.

Body ()

Root Schema : kanbanPlans

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/kanbanPlans-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "subgroup":"Manufacturing",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object kanbanPlans-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/kanbanPlans-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : kanbanPlans-item-response

Type: object

Show Source

• InputDesignator: string
  Title: External Forecast

  Maximum Length: 10

  Represents the external forecast designator or demand plan designator.
• InputType: string
  Title: Demand Type

  Maximum Length: 30

  Represents the type of demand provided to the plan such as external forecast or actual production.
• KanbanPlanCode: string
  Title: Plan Name

  Maximum Length: 10

  Represents the Kanban designator, which serves as a reference label to distinguish individual Kanban plans.
• KanbanPlanDescription: string
  Title: Plan Description

  Maximum Length: 240

  The description of plan used in the Kanban planning process.
• KanbanPlanId: integer (int64)
  The unique identifier of a Kanban plan. Its value is an application generated unique identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Maximum Length: 18

  Code of the inventory organization to which this pull sequence belongs.
• OrganizationId: integer (int64)
  The organization identifier represents the manufacturing plant to which this Kanban plan belongs.
• PlanCutoffDate: string (date)
  Title: Demand Cutoff Date

  Read Only: true

  The plan cutoff date used in the Kanban planning process.
• PlanDisableDate: string (date)
  Title: Inactive On

  The plan disable date used in the Kanban planning process.
• PlannedPullSequences: array Planned Kanban Pull Sequences
  Title: Planned Kanban Pull Sequences

  A Kanban pull sequence that belongs to a Kanban plan, identified by the Kanban plan ID.
• PlanStartDate: string (date)
  Title: Demand Start Date

  Read Only: true

  The demand start date used in the Kanban planning process.

{
    "type":"object",
    "properties":{
        "InputDesignator":{
            "title":"External Forecast",
            "maxLength":10,
            "type":"string",
            "description":"Represents the external forecast designator or demand plan designator.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InputType":{
            "title":"Demand Type",
            "maxLength":30,
            "type":"string",
            "description":"Represents the type of demand provided to the plan such as external forecast or actual production.",
            "nullable":false,
            "x-queryable":true
        },
        "KanbanPlanCode":{
            "title":"Plan Name",
            "maxLength":10,
            "type":"string",
            "description":"Represents the Kanban designator, which serves as a reference label to distinguish individual Kanban plans.",
            "nullable":false,
            "x-queryable":true
        },
        "KanbanPlanDescription":{
            "title":"Plan Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of plan used in the Kanban planning process.",
            "nullable":true,
            "x-queryable":true
        },
        "KanbanPlanId":{
            "type":"integer",
            "description":"The unique identifier of a Kanban plan. Its value is an application generated unique identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Code of the inventory organization to which this pull sequence belongs.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The organization identifier represents the manufacturing plant to which this Kanban plan belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "OrganizationCode"
                ]
            },
            "x-queryable":true
        },
        "PlanCutoffDate":{
            "title":"Demand Cutoff Date",
            "type":"string",
            "description":"The plan cutoff date used in the Kanban planning process.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanDisableDate":{
            "title":"Inactive On",
            "type":"string",
            "description":"The plan disable date used in the Kanban planning process.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PlanStartDate":{
            "title":"Demand Start Date",
            "type":"string",
            "description":"The demand start date used in the Kanban planning process.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlannedPullSequences":{
            "title":"Planned Kanban Pull Sequences",
            "type":"array",
            "description":"A Kanban pull sequence that belongs to a Kanban plan, identified by the Kanban plan ID.",
            "items":{
                "$ref":"#/components/schemas/kanbanPlans-PlannedPullSequences-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Planned Kanban Pull Sequences

Type: array

Title: Planned Kanban Pull Sequences

A Kanban pull sequence that belongs to a Kanban plan, identified by the Kanban plan ID.

Show Source

• Array of: object kanbanPlans-PlannedPullSequences-item-response

{
    "title":"Planned Kanban Pull Sequences",
    "type":"array",
    "description":"A Kanban pull sequence that belongs to a Kanban plan, identified by the Kanban plan ID.",
    "items":{
        "$ref":"#/components/schemas/kanbanPlans-PlannedPullSequences-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : kanbanPlans-PlannedPullSequences-item-response

Type: object

Show Source

• AverageDailyDemand: number
  Title: Average Daily Demand

  Average daily demand for the Kanban item, in the pull sequence unit of measure
• CalculatedCards: integer
  Title: Calculated Number of Cards

  Number of Kanban cards calculated by planning when the calculation method is to calculate cards
• CalculatedDifference: integer
  Title: Calculated Difference

  Read Only: true

  Difference between the current value and the planning-recommended value, either the number of Kanban cards or the Kanban size, based on the calculation method
• CalculatedSize: number
  Title: Calculated Card Size

  Kanban size calculated by planning when the calculation method is to calculate size, in the pull sequence unit of measure
• InventoryItemId: integer (int64)
  Title: Item

  Read Only: true

  The unique identifier of the item defined in the pull sequence.
• ItemNumber: string
  Title: Item

  Read Only: true

  Maximum Length: 300

  Item number in the pull sequence.
• KanbanCalculationMethod: string
  Title: Calculation

  Read Only: true

  Maximum Length: 30

  Default Value: DO_NOT_CALCULATE

  Indicates whether planning calculates the number of Kanban cards or the Kanban size for upcoming periods based on demand.
• KanbanPlanId: integer (int64)
  Read Only: true

  Default Value: -1

  The application generated unique identifier of a Kanban plan.
• KanbanSize: integer
  Title: Current Card Size

  Read Only: true

  Size of the Kanban bin.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Locator: string
  Read Only: true

  Maximum Length: 255

  Name of the destination locator of the item in the pull sequence.
• LocatorId: integer (int64)
  Title: Destination Locator

  Read Only: true

  Identifier of the destination locator of the item in the pull sequence.
• NumberOfCards: integer
  Title: Current Number of Cards

  Read Only: true

  Number of Kanban cards in the pull sequence.
• PullSequenceId: integer (int64)
  Read Only: true

  Unique identifier of the Kanban pull sequence. Its value is an application-generated unique ID.
• ReplenishmentLeadTime: number
  Title: Lead Time

  Time required to source the item.
• SafetyStockDays: number
  Title: Safety Stock

  Safety stock days for the pull sequence
• SubinventoryCode: string
  Title: Destination Subinventory

  Read Only: true

  Maximum Length: 10

  Name of the destination subinventory of the item in the pull sequence.
• SubinventoryNameMLS: string
  Read Only: true

  Maximum Length: 255

  Name of the destination subinventory (MLS) for the item in the kanban card.
• TemporaryCards: integer
  Title: Temporary Cards

  Read Only: true

  Planned Kanban Pull Sequences

{
    "type":"object",
    "properties":{
        "AverageDailyDemand":{
            "title":"Average Daily Demand",
            "type":"number",
            "description":"Average daily demand for the Kanban item, in the pull sequence unit of measure",
            "nullable":true,
            "x-queryable":true
        },
        "CalculatedCards":{
            "title":"Calculated Number of Cards",
            "type":"integer",
            "description":"Number of Kanban cards calculated by planning when the calculation method is to calculate cards",
            "nullable":false,
            "x-queryable":false
        },
        "CalculatedDifference":{
            "title":"Calculated Difference",
            "type":"integer",
            "description":"Difference between the current value and the planning-recommended value, either the number of Kanban cards or the Kanban size, based on the calculation method",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculatedSize":{
            "title":"Calculated Card Size",
            "type":"number",
            "description":"Kanban size calculated by planning when the calculation method is to calculate size, in the pull sequence unit of measure",
            "nullable":false,
            "x-queryable":false
        },
        "InventoryItemId":{
            "title":"Item",
            "type":"integer",
            "description":"The unique identifier of the item defined in the pull sequence.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "description":"Item number in the pull sequence.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KanbanCalculationMethod":{
            "title":"Calculation",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether planning calculates the number of Kanban cards or the Kanban size for upcoming periods based on demand.",
            "nullable":true,
            "readOnly":true,
            "default":"DO_NOT_CALCULATE",
            "x-queryable":true
        },
        "KanbanPlanId":{
            "type":"integer",
            "description":"The application generated unique identifier of a Kanban plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "default":-1,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "KanbanSize":{
            "title":"Current Card Size",
            "type":"integer",
            "description":"Size of the Kanban bin.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Locator":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the destination locator of the item in the pull sequence.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LocatorId":{
            "title":"Destination Locator",
            "type":"integer",
            "description":"Identifier of the destination locator of the item in the pull sequence.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NumberOfCards":{
            "title":"Current Number of Cards",
            "type":"integer",
            "description":"Number of Kanban cards in the pull sequence.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PullSequenceId":{
            "type":"integer",
            "description":"Unique identifier of the Kanban pull sequence. Its value is an application-generated unique ID.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ReplenishmentLeadTime":{
            "title":"Lead Time",
            "type":"number",
            "description":"Time required to source the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SafetyStockDays":{
            "title":"Safety Stock",
            "type":"number",
            "description":"Safety stock days for the pull sequence",
            "nullable":true,
            "x-queryable":true
        },
        "SubinventoryCode":{
            "title":"Destination Subinventory",
            "maxLength":10,
            "type":"string",
            "description":"Name of the destination subinventory of the item in the pull sequence.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubinventoryNameMLS":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the destination subinventory (MLS) for the item in the kanban card.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TemporaryCards":{
            "title":"Temporary Cards",
            "type":"integer",
            "description":"Planned Kanban Pull Sequences",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

recalculate

Operation: /fscmRestApi/resources/11.13.18.05/kanbanPlans/action/recalculate

Recalculates the Kanban size or the number of Kanban cards when the client sends the Pull Sequence ID along with additional parameters. Based on the calculation method defined for the pull sequence, the application returns either the Kanban size or the number of Kanban cards.

updateProduction

Operation: /fscmRestApi/resources/11.13.18.05/kanbanPlans/action/updateProduction

Updates to the production pull sequence occur when the client sends the Pull Sequence ID, and the application then updates the corresponding production pull sequence.

Back to Top