Jump to

• Request
• Response

Update one item

patch

/fscmRestApi/resources/11.13.18.05/cycleCountDefinitions/{CycleCountHeaderId}/child/countItems/{CycleCountItemId}

Request

Path Parameters

• CycleCountHeaderId(required): integer(int64)
  Value that uniquely identifies the cycle count definition.
• CycleCountItemId(required): integer(int64)
  Value that uniquely identifies the item that the cycle count definition references.

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AbcClass: string
  Maximum Length: 40

  Name of the ABC class that the item references.
• AbcClassId: integer (int64)
  Value that uniquely identifies the ABC class that the item references.
• AdjustmentValueNegativeTolerance: number
  Title: Negative

  Negative adjustment that the warehouse allows the value to vary for the item.
• AdjustmentValuePositiveTolerance: number
  Title: Positive

  Positive adjustment that the warehouse allows the value to vary for the item.
• CycleCountItemId: integer (int64)
  Value that uniquely identifies the item that the cycle count definition references.
• IncludeInSchedule: string
  Maximum Length: 80

  Value that determines whether or not to schedule this item. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• IncludeInScheduleCode: integer
  Default Value: 2

  Value that indicates whether or not to schedule this item. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the item.
• ItemDescription: string
  Maximum Length: 240

  Description of the item.
• ItemNumber: string
  Maximum Length: 300

  Number that identifies the item.
• LastScheduledDate: string (date-time)
  Title: Last Scheduled Date

  Value that indicates the most recent date that the warehouse scheduled this item for counting.
• QuantityVarianceNegativePercentage: number
  Title: Negative

  Negative percent that the warehouse allows the quantity to vary from the requested quantity for the item.
• QuantityVariancePositivePercentage: number
  Title: Positive

  Positive percent that the warehouse allows the quantity to vary from the requested quantity for the item.

{
    "type":"object",
    "properties":{
        "CycleCountItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item that the cycle count definition references.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "QuantityVarianceNegativePercentage":{
            "title":"Negative",
            "type":"number",
            "description":"Negative percent that the warehouse allows the quantity to vary from the requested quantity for the item.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "IncludeInSchedule":{
            "maxLength":80,
            "type":"string",
            "description":"Value that determines whether or not to schedule this item. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":false
        },
        "IncludeInScheduleCode":{
            "type":"integer",
            "description":"Value that indicates whether or not to schedule this item. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":false,
            "default":2
        },
        "QuantityVariancePositivePercentage":{
            "title":"Positive",
            "type":"number",
            "description":"Positive percent that the warehouse allows the quantity to vary from the requested quantity for the item.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            }
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true
        },
        "LastScheduledDate":{
            "title":"Last Scheduled Date",
            "type":"string",
            "description":"Value that indicates the most recent date that the warehouse scheduled this item for counting.",
            "format":"date-time",
            "nullable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true
        },
        "AdjustmentValuePositiveTolerance":{
            "title":"Positive",
            "type":"number",
            "description":"Positive adjustment that the warehouse allows the value to vary for the item.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            }
        },
        "AbcClassId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ABC class that the item references.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AbcClass":{
            "maxLength":40,
            "type":"string",
            "description":"Name of the ABC class that the item references.",
            "nullable":false
        },
        "AdjustmentValueNegativeTolerance":{
            "title":"Negative",
            "type":"number",
            "description":"Negative adjustment that the warehouse allows the value to vary for the item.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : cycleCountDefinitions-countItems-item-response

Type: object

Show Source

• AbcClass: string
  Maximum Length: 40

  Name of the ABC class that the item references.
• AbcClassId: integer (int64)
  Value that uniquely identifies the ABC class that the item references.
• AdjustmentValueNegativeTolerance: number
  Title: Negative

  Negative adjustment that the warehouse allows the value to vary for the item.
• AdjustmentValuePositiveTolerance: number
  Title: Positive

  Positive adjustment that the warehouse allows the value to vary for the item.
• CycleCountItemId: integer (int64)
  Value that uniquely identifies the item that the cycle count definition references.
• IncludeInSchedule: string
  Maximum Length: 80

  Value that determines whether or not to schedule this item. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• IncludeInScheduleCode: integer
  Default Value: 2

  Value that indicates whether or not to schedule this item. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the item.
• ItemDescription: string
  Maximum Length: 240

  Description of the item.
• ItemNumber: string
  Maximum Length: 300

  Number that identifies the item.
• LastScheduledDate: string (date-time)
  Title: Last Scheduled Date

  Value that indicates the most recent date that the warehouse scheduled this item for counting.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• QuantityVarianceNegativePercentage: number
  Title: Negative

  Negative percent that the warehouse allows the quantity to vary from the requested quantity for the item.
• QuantityVariancePositivePercentage: number
  Title: Positive

  Positive percent that the warehouse allows the quantity to vary from the requested quantity for the item.

{
    "type":"object",
    "properties":{
        "CycleCountItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item that the cycle count definition references.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "QuantityVarianceNegativePercentage":{
            "title":"Negative",
            "type":"number",
            "description":"Negative percent that the warehouse allows the quantity to vary from the requested quantity for the item.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IncludeInSchedule":{
            "maxLength":80,
            "type":"string",
            "description":"Value that determines whether or not to schedule this item. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":false,
            "x-queryable":true
        },
        "IncludeInScheduleCode":{
            "type":"integer",
            "description":"Value that indicates whether or not to schedule this item. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":false,
            "default":2,
            "x-queryable":true
        },
        "QuantityVariancePositivePercentage":{
            "title":"Positive",
            "type":"number",
            "description":"Positive percent that the warehouse allows the quantity to vary from the requested quantity for the item.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "LastScheduledDate":{
            "title":"Last Scheduled Date",
            "type":"string",
            "description":"Value that indicates the most recent date that the warehouse scheduled this item for counting.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentValuePositiveTolerance":{
            "title":"Positive",
            "type":"number",
            "description":"Positive adjustment that the warehouse allows the value to vary for the item.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            },
            "x-queryable":true
        },
        "AbcClassId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ABC class that the item references.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AbcClass":{
            "maxLength":40,
            "type":"string",
            "description":"Name of the ABC class that the item references.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AdjustmentValueNegativeTolerance":{
            "title":"Negative",
            "type":"number",
            "description":"Negative adjustment that the warehouse allows the value to vary for the item.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            },
            "x-queryable":true
        }
    }
}

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