Jump to

• Request
• Response

Update one class

patch

/fscmRestApi/resources/11.13.18.05/cycleCountDefinitions/{CycleCountHeaderId}/child/countClasses/{CycleCountClassId}

Request

Path Parameters

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

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: 255

  Name of the ABC class that the cycle count includes.
• AbcClassId: integer (int64)
  Title: ABC Class

  Value that uniquely identifies the ABC class that the cycle count includes.
• AdjustmentValueNegativeTolerance: number
  Title: Negative

  Negative percent that the warehouse allows the value to vary for each item that resides in this class.
• AdjustmentValuePositiveTolerance: number
  Title: Positive

  Positive percent that the warehouse allows the value to vary for each item that resides in this class.
• CountsPerYear: integer (int64)
  Title: Counts per Year

  Number of counts for each year that this class includes.
• CycleCountClassId: integer (int64)
  Value that uniquely identifies the class of the cycle count.
• HitAndMissNegativePercentage: number
  Title: Negative

  Negative percent tolerance that the warehouse uses for hit or miss analysis for this count class.
• HitAndMissPostivePercentage: number
  Title: Positive

  Positive percent tolerance that the warehouse uses for hit or miss analysis for this count class.
• QuantityVarianceNegativePercentage: number
  Title: Negative

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

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

{
    "type":"object",
    "properties":{
        "QuantityVarianceNegativePercentage":{
            "title":"Negative",
            "type":"number",
            "description":"Negative percent that the warehouse allows the quantity to vary from the requested quantity for this class.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            }
        },
        "AdjustmentValuePositiveTolerance":{
            "title":"Positive",
            "type":"number",
            "description":"Positive percent that the warehouse allows the value to vary for each item that resides in this class.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            }
        },
        "HitAndMissNegativePercentage":{
            "title":"Negative",
            "type":"number",
            "description":"Negative percent tolerance that the warehouse uses for hit or miss analysis for this count class.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            }
        },
        "AbcClassId":{
            "title":"ABC Class",
            "type":"integer",
            "description":"Value that uniquely identifies the ABC class that the cycle count includes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AbcClass":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the ABC class that the cycle count includes.",
            "nullable":true
        },
        "QuantityVariancePositivePercentage":{
            "title":"Positive",
            "type":"number",
            "description":"Positive percent that the warehouse allows the quantity to vary from the requested quantity for this class.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            }
        },
        "HitAndMissPostivePercentage":{
            "title":"Positive",
            "type":"number",
            "description":"Positive percent tolerance that the warehouse uses for hit or miss analysis for this count class.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            }
        },
        "CycleCountClassId":{
            "type":"integer",
            "description":"Value that uniquely identifies the class of the cycle count.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "AdjustmentValueNegativeTolerance":{
            "title":"Negative",
            "type":"number",
            "description":"Negative percent that the warehouse allows the value to vary for each item that resides in this class.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            }
        },
        "CountsPerYear":{
            "title":"Counts per Year",
            "type":"integer",
            "description":"Number of counts for each year that this class includes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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-countClasses-item-response

Type: object

Show Source

• AbcClass: string
  Maximum Length: 255

  Name of the ABC class that the cycle count includes.
• AbcClassId: integer (int64)
  Title: ABC Class

  Value that uniquely identifies the ABC class that the cycle count includes.
• AdjustmentValueNegativeTolerance: number
  Title: Negative

  Negative percent that the warehouse allows the value to vary for each item that resides in this class.
• AdjustmentValuePositiveTolerance: number
  Title: Positive

  Positive percent that the warehouse allows the value to vary for each item that resides in this class.
• CountsPerYear: integer (int64)
  Title: Counts per Year

  Number of counts for each year that this class includes.
• CycleCountClassId: integer (int64)
  Value that uniquely identifies the class of the cycle count.
• HitAndMissNegativePercentage: number
  Title: Negative

  Negative percent tolerance that the warehouse uses for hit or miss analysis for this count class.
• HitAndMissPostivePercentage: number
  Title: Positive

  Positive percent tolerance that the warehouse uses for hit or miss analysis for this count class.
• 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 this class.
• QuantityVariancePositivePercentage: number
  Title: Positive

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

{
    "type":"object",
    "properties":{
        "QuantityVarianceNegativePercentage":{
            "title":"Negative",
            "type":"number",
            "description":"Negative percent that the warehouse allows the quantity to vary from the requested quantity for this class.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            },
            "x-queryable":true
        },
        "AdjustmentValuePositiveTolerance":{
            "title":"Positive",
            "type":"number",
            "description":"Positive percent that the warehouse allows the value to vary for each item that resides in this class.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            },
            "x-queryable":true
        },
        "HitAndMissNegativePercentage":{
            "title":"Negative",
            "type":"number",
            "description":"Negative percent tolerance that the warehouse uses for hit or miss analysis for this count class.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            },
            "x-queryable":true
        },
        "AbcClassId":{
            "title":"ABC Class",
            "type":"integer",
            "description":"Value that uniquely identifies the ABC class that the cycle count includes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AbcClass":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the ABC class that the cycle count includes.",
            "nullable":true,
            "x-queryable":true
        },
        "QuantityVariancePositivePercentage":{
            "title":"Positive",
            "type":"number",
            "description":"Positive percent that the warehouse allows the quantity to vary from the requested quantity for this class.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "HitAndMissPostivePercentage":{
            "title":"Positive",
            "type":"number",
            "description":"Positive percent tolerance that the warehouse uses for hit or miss analysis for this count class.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            },
            "x-queryable":true
        },
        "CycleCountClassId":{
            "type":"integer",
            "description":"Value that uniquely identifies the class of the cycle count.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AdjustmentValueNegativeTolerance":{
            "title":"Negative",
            "type":"number",
            "description":"Negative percent that the warehouse allows the value to vary for each item that resides in this class.",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "scale":5
            },
            "x-queryable":true
        },
        "CountsPerYear":{
            "title":"Counts per Year",
            "type":"integer",
            "description":"Number of counts for each year that this class includes.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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