Jump to

• Request
• Response

Update one Supplier Kanban Card

patch

/fscmRestApi/resources/11.13.18.05/kanbanCardsInSupplierPortal/{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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• SupplyStatus: string
  Title: Supply Status

  Maximum Length: 30

  Supply status of the Kanban card.

{
    "type":"object",
    "properties":{
        "SupplyStatus":{
            "title":"Supply Status",
            "maxLength":30,
            "type":"string",
            "description":"Supply status of the Kanban card.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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 : kanbanCardsInSupplierPortal-item-response

Type: object

Show Source

• InventoryItemId: integer (int64)
  Title: Item

  Read Only: true

  Unique identifier of the item defined in the Kanban card.
• ItemNumber: string
  Title: Item

  Read Only: true

  Maximum Length: 300

  Item number in the Kanban card.
• 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.
• KanbanSize: number
  Title: Kanban Size

  Read Only: true

  Quantity in 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 Kanban card.
• PurchaseOrder: string
  Title: Purchase Order

  Read Only: true

  Maximum Length: 30

  Purchase order number
• SubinventoryCode: string
  Title: Destination Subinventory

  Read Only: true

  Maximum Length: 10

  Name of the destination subinventory of the item in the Kanban card.
• SupplierId: integer (int64)
  Read Only: true

  Identifier of the supplier from which the item is sourced.
• SupplierItemNumber: string
  Title: Supplier Item

  Read Only: true

  Maximum Length: 255

  Supplier item number
• SupplierName: string
  Title: Supplier

  Read Only: true

  Maximum Length: 255

  Name of the supplier from which the item is sourced.
• SupplierSiteCode: string
  Title: Supplier Site

  Read Only: true

  Maximum Length: 255

  Name of the supplier site from which the item is sourced.
• SupplierSiteId: integer (int64)
  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.

{
    "type":"object",
    "properties":{
        "SupplierItemNumber":{
            "title":"Supplier Item",
            "maxLength":255,
            "type":"string",
            "description":"Supplier item number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "title":"Item",
            "type":"integer",
            "description":"Unique identifier of the item defined in the Kanban card.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "KanbanSize":{
            "title":"Kanban Size",
            "type":"number",
            "description":"Quantity in the Kanban bin.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubinventoryCode":{
            "title":"Destination Subinventory",
            "maxLength":10,
            "type":"string",
            "description":"Name of the destination subinventory of the item in the Kanban card.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplyStatusMeaning":{
            "title":"Supply Status",
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the supply status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "type":"integer",
            "description":"Identifier of the supplier from which the item is sourced.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierSiteCode":{
            "title":"Supplier Site",
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier site from which the item is sourced.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "KanbanCardNumber":{
            "title":"Card Number",
            "maxLength":200,
            "type":"string",
            "description":"User identifier of the Kanban card. Its value is generated from a document sequence.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Locator":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the destination locator of the item in the Kanban card.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "description":"Item number in the Kanban card.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierName":{
            "title":"Supplier",
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier from which the item is sourced.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierSiteId":{
            "type":"integer",
            "description":"Identifier of the supplier site from which the item is sourced.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplyStatus":{
            "title":"Supply Status",
            "maxLength":30,
            "type":"string",
            "description":"Supply status of the Kanban card.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "KanbanCardId":{
            "type":"integer",
            "description":"Unique application-generated identifier of the Kanban card.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PurchaseOrder":{
            "title":"Purchase Order",
            "maxLength":30,
            "type":"string",
            "description":"Purchase order number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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 : 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."
        }
    }
}

Back to Top