Jump to

• Request
• Response

Create count category items

post

/fscmRestApi/resources/11.13.18.05/cycleCountDefinitions/{CycleCountHeaderId}/child/countCategoryItems

Request

Path Parameters

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

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdjustmentValueNegativeTolerance: number
  Title: Negative

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

  Positive adjustment that the warehouse allows the value to vary for the category item.
• CategoryDescription: string
  Maximum Length: 255

  Description of the count category that the category item references.
• CategoryId: integer (int64)
  Value that uniquely identifies the count category that the category item references.
• CategoryName: string
  Maximum Length: 255

  Name of the count category that the category item references.
• CountCategoryItemId: integer (int64)
  Value that uniquely identifies the category item that the cycle count definition references.
• IncludeInScheduleFlag: boolean
  Default Value: false

  Contains one of the following values: true or false. If true, then schedule this category item. If false, then don't schedule this category item. The default value is false.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the category item.
• ItemNumber: string
  Maximum Length: 255

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

  Date when the warehouse scheduled this category item for counting.
• QuantityVarianceNegativePercentage: number
  Title: Negative

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

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

{
    "type":"object",
    "properties":{
        "AdjustmentValueNegativeTolerance":{
            "title":"Negative",
            "type":"number",
            "description":"Negative adjustment that the warehouse allows the value to vary for the category item.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            }
        },
        "AdjustmentValuePositiveTolerance":{
            "title":"Positive",
            "type":"number",
            "description":"Positive adjustment that the warehouse allows the value to vary for the category item.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            }
        },
        "CategoryDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the count category that the category item references.",
            "nullable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the count category that the category item references.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CategoryName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the count category that the category item references.",
            "nullable":true
        },
        "CountCategoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category item that the cycle count definition references.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "IncludeInScheduleFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then schedule this category item. If false, then don't schedule this category item. The default value is false.",
            "nullable":false,
            "default":false
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the category item.",
            "nullable":true
        },
        "LastScheduledDate":{
            "title":"Last Scheduled Date",
            "type":"string",
            "description":"Date when the warehouse scheduled this category item for counting.",
            "format":"date-time",
            "nullable":true
        },
        "QuantityVarianceNegativePercentage":{
            "title":"Negative",
            "type":"number",
            "description":"Negative percent that the warehouse allows the quantity to vary from the requested quantity for the category item.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            }
        },
        "QuantityVariancePositivePercentage":{
            "title":"Positive",
            "type":"number",
            "description":"Positive percent that the warehouse allows the quantity to vary from the requested quantity for the category 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:
  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 : cycleCountDefinitions-countCategoryItems-item-response

Type: object

Show Source

• AdjustmentValueNegativeTolerance: number
  Title: Negative

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

  Positive adjustment that the warehouse allows the value to vary for the category item.
• CategoryDescription: string
  Maximum Length: 255

  Description of the count category that the category item references.
• CategoryId: integer (int64)
  Value that uniquely identifies the count category that the category item references.
• CategoryName: string
  Maximum Length: 255

  Name of the count category that the category item references.
• CountCategoryItemId: integer (int64)
  Value that uniquely identifies the category item that the cycle count definition references.
• CountUOM: string
  Read Only: true

  Maximum Length: 255

  Unit of measure for the current count.
• CountUOMCode: string
  Read Only: true

  Maximum Length: 255

  Value that identifies the unit of measure for the current count.
• DefaultingControl: string
  Read Only: true

  Maximum Length: 255

  Indicates how the conversion between primary and secondary units of measure is handled. Valid values are Default, Fixed, and No Default. The value of Defaulting Control depends on the Tracking Unit of Measure attribute. If the Tracking Unit of Measure is Primary and Secondary, then Defaulting Control can be specified. Otherwise, it can't be provided. A list of accepted values is defined in the lookup type EGP_DEFAULTING. Review the value for this attribute in the Setup and Maintenance work area, under the Manage Standard Lookups task. The default value is Fixed.
• DualUOMDeviationHigh: number
  Read Only: true

  Highest deviation allowed for a transaction on the secondary quantity, as derived from the default conversion factor.
• DualUOMDeviationLow: number
  Read Only: true

  Lowest deviation allowed for a transaction on the secondary quantity, as derived from the default conversion factor.
• IncludeInScheduleFlag: boolean
  Default Value: false

  Contains one of the following values: true or false. If true, then schedule this category item. If false, then don't schedule this category item. The default value is false.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the category item.
• ItemDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the category item.
• ItemNumber: string
  Maximum Length: 255

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

  Date when the warehouse scheduled this category item for counting.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LotControlCode: integer
  Read Only: true

  Identifies all lot-controlled items for a cycle count definition.
• PrimaryImageURL: string
  Read Only: true

  Maximum Length: 255

  Value that provides a reference to the image of the item for which the count sequence is generated.
• QuantityVarianceNegativePercentage: number
  Title: Negative

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

  Positive percent that the warehouse allows the quantity to vary from the requested quantity for the category item.
• RevisionQuantityControlFlag: boolean
  Read Only: true

  Indicates whether the item is enabled for revision control. It can have one of the following values: true or false. If true, the item is under revision control. If false, the item isn't under revision control. The default value is false.
• SecondaryUnitOfMeasure: string
  Read Only: true

  Maximum Length: 255

  Abbreviation that identifies the secondary unit of measure.
• SecondaryUnitOfMeasureName: string
  Read Only: true

  Maximum Length: 255

  Secondary unit of measure of the item.
• SerialNumberControlCode: integer
  Read Only: true

  Identifies all serial-control items for a cycle count definition.
• TrackingUnitOfMeasure: string
  Read Only: true

  Maximum Length: 255

  Unit of measure of the item.

{
    "type":"object",
    "properties":{
        "AdjustmentValueNegativeTolerance":{
            "title":"Negative",
            "type":"number",
            "description":"Negative adjustment that the warehouse allows the value to vary for the category item.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            },
            "x-queryable":true
        },
        "AdjustmentValuePositiveTolerance":{
            "title":"Positive",
            "type":"number",
            "description":"Positive adjustment that the warehouse allows the value to vary for the category item.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            },
            "x-queryable":true
        },
        "CategoryDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the count category that the category item references.",
            "nullable":true,
            "x-queryable":true
        },
        "CategoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the count category that the category item references.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CategoryName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the count category that the category item references.",
            "nullable":true,
            "x-queryable":true
        },
        "CountCategoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category item that the cycle count definition references.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CountUOM":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure for the current count.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CountUOMCode":{
            "maxLength":255,
            "type":"string",
            "description":"Value that identifies the unit of measure for the current count.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultingControl":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates how the conversion between primary and secondary units of measure is handled.\nValid values are Default, Fixed, and No Default. The value of Defaulting Control depends on the Tracking Unit of Measure attribute. If the Tracking Unit of Measure is Primary and Secondary, then Defaulting Control can be specified. Otherwise, it can't be provided.\n\nA list of accepted values is defined in the lookup type EGP_DEFAULTING. Review the value for this attribute in the Setup and Maintenance work area, under the Manage Standard Lookups task. The default value is Fixed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DualUOMDeviationHigh":{
            "type":"number",
            "description":"Highest deviation allowed for a transaction on the secondary quantity, as derived from the default conversion factor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DualUOMDeviationLow":{
            "type":"number",
            "description":"Lowest deviation allowed for a transaction on the secondary quantity, as derived from the default conversion factor.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeInScheduleFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then schedule this category item. If false, then don't schedule this category item. The default value is false.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the category item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the category item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Number that identifies the category item.",
            "nullable":true,
            "x-queryable":true
        },
        "LastScheduledDate":{
            "title":"Last Scheduled Date",
            "type":"string",
            "description":"Date when the warehouse scheduled this category item for counting.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LotControlCode":{
            "type":"integer",
            "description":"Identifies all lot-controlled items for a cycle count definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryImageURL":{
            "maxLength":255,
            "type":"string",
            "description":"Value that provides a reference to the image of the item for which the count sequence is generated.",
            "nullable":true,
            "readOnly":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 category item.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            },
            "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 category item.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            },
            "x-queryable":true
        },
        "RevisionQuantityControlFlag":{
            "type":"boolean",
            "description":"Indicates whether the item is enabled for revision control. It can have one of the following values: true or false. If true, the item is under revision control. If false, the item isn't under revision control. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUnitOfMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the secondary unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SecondaryUnitOfMeasureName":{
            "maxLength":255,
            "type":"string",
            "description":"Secondary unit of measure of the item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SerialNumberControlCode":{
            "type":"integer",
            "description":"Identifies all serial-control items for a cycle count definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TrackingUnitOfMeasure":{
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure of the item.",
            "nullable":true,
            "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