Jump to

• Request
• Response

Update one subinventory

patch

/fscmRestApi/resources/11.13.18.05/cycleCountDefinitions/{CycleCountHeaderId}/child/countSubinventories/{countSubinventoriesUniqID}

Request

Path Parameters

• CycleCountHeaderId(required): integer(int64)
  Value that uniquely identifies the cycle count definition.
• countSubinventoriesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Subinventories resource and used to uniquely identify an instance of Subinventories. The client should not generate the hash key value. Instead, the client should query on the Subinventories collection resource in order to navigate to a specific instance of Subinventories to get the hash key.

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

• IncludeInCount: string
  Maximum Length: 255

  Value that determines whether or not to include the subinventory when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• IncludeInCountCode: integer (int64)
  Value that indicates whether or not to include the subinventory when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• Subinventory: string
  Maximum Length: 10

  Name of the subinventory that the warehouse includes in this count definition.

{
    "type":"object",
    "properties":{
        "IncludeInCountCode":{
            "type":"integer",
            "description":"Value that indicates whether or not to include the subinventory when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "IncludeInCount":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that determines whether or not to include the subinventory when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":true
        },
        "Subinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the subinventory that the warehouse includes in this count definition.",
            "nullable":false
        }
    }
}

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

Type: object

Show Source

• Description: string
  Read Only: true

  Maximum Length: 255

  Value that provides the description of the subinventory.
• IncludeInCount: string
  Maximum Length: 255

  Value that determines whether or not to include the subinventory when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• IncludeInCountCode: integer (int64)
  Value that indicates whether or not to include the subinventory when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Subinventory: string
  Maximum Length: 10

  Name of the subinventory that the warehouse includes in this count definition.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Description":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that provides the description of the subinventory.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeInCountCode":{
            "type":"integer",
            "description":"Value that indicates whether or not to include the subinventory when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IncludeInCount":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that determines whether or not to include the subinventory when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":true,
            "x-queryable":true
        },
        "Subinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the subinventory that the warehouse includes in this count definition.",
            "nullable":false,
            "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