Jump to

• Request
• Response

Create one cycle count locator

post

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

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

• CountsPerYear: integer (int32)
  Number of times this locator should be counted in a year.
• IncludeInCount: string
  Maximum Length: 255

  Value that determines whether to include the locator when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• IncludeInCountCode: integer (int32)
  Value that indicates whether to include the locator when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• Locator: string
  Maximum Length: 255

  Name of the locator.
• LocatorId: integer (int64)
  Value that uniquely identifies the locator.
• Notes: string
  Maximum Length: 240

  Notes pertaining to the cycle count locator.
• Subinventory: string
  Maximum Length: 10

  Name of the subinventory that the warehouse includes in this count definition.
• WeeklyCountFrequency: string
  Maximum Length: 255

  Value that indicates how often the locator is scheduled to be counted weekly. Possible values are Every Week, Every 2 Weeks, Every 3 Weeks, and Every 4 Weeks.
• WeeklyCountFrequencyCode: integer (int32)
  Value that indicates how often the locator is scheduled to be counted weekly. Possible values are 1, 2, 3, and 4.

{
    "type":"object",
    "properties":{
        "CountsPerYear":{
            "type":"integer",
            "description":"Number of times this locator should be counted in a year.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            }
        },
        "IncludeInCount":{
            "maxLength":255,
            "type":"string",
            "description":"Value that determines whether to include the locator when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":true,
            "x-queryable":false
        },
        "IncludeInCountCode":{
            "type":"integer",
            "description":"Value that indicates whether to include the locator when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":1
            }
        },
        "Locator":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the locator.",
            "nullable":true
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Notes":{
            "maxLength":240,
            "type":"string",
            "description":"Notes pertaining to the cycle count locator.",
            "nullable":true
        },
        "Subinventory":{
            "maxLength":10,
            "type":"string",
            "description":"Name of the subinventory that the warehouse includes in this count definition.",
            "nullable":false
        },
        "WeeklyCountFrequency":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates how often the locator is scheduled to be counted weekly. Possible values are Every Week, Every 2 Weeks, Every 3 Weeks, and Every 4 Weeks.",
            "nullable":true
        },
        "WeeklyCountFrequencyCode":{
            "type":"integer",
            "description":"Value that indicates how often the locator is scheduled to be counted weekly. Possible values are 1, 2, 3, and 4.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            }
        }
    }
}

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

Type: object

Show Source

• CountsPerYear: integer (int32)
  Number of times this locator should be counted in a year.
• Description: string
  Read Only: true

  Maximum Length: 255

  Description of the locator.
• IncludeInCount: string
  Maximum Length: 255

  Value that determines whether to include the locator when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• IncludeInCountCode: integer (int32)
  Value that indicates whether to include the locator when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.
• LastScheduleDate: string (date)
  Read Only: true

  Date on which the locator was last scheduled for counting.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Locator: string
  Maximum Length: 255

  Name of the locator.
• LocatorId: integer (int64)
  Value that uniquely identifies the locator.
• NextScheduleDate: string (date)
  Read Only: true

  Date on which the locator is next scheduled for counting.
• Notes: string
  Maximum Length: 240

  Notes pertaining to the cycle count locator.
• Subinventory: string
  Maximum Length: 10

  Name of the subinventory that the warehouse includes in this count definition.
• WeeklyCountFrequency: string
  Maximum Length: 255

  Value that indicates how often the locator is scheduled to be counted weekly. Possible values are Every Week, Every 2 Weeks, Every 3 Weeks, and Every 4 Weeks.
• WeeklyCountFrequencyCode: integer (int32)
  Value that indicates how often the locator is scheduled to be counted weekly. Possible values are 1, 2, 3, and 4.

{
    "type":"object",
    "properties":{
        "CountsPerYear":{
            "type":"integer",
            "description":"Number of times this locator should be counted in a year.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "Description":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the locator.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeInCount":{
            "maxLength":255,
            "type":"string",
            "description":"Value that determines whether to include the locator when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "nullable":true,
            "x-queryable":false
        },
        "IncludeInCountCode":{
            "type":"integer",
            "description":"Value that indicates whether to include the locator when counting. A list of accepted values is defined in the lookup type INV_YES_NO_NUMERIC.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "LastScheduleDate":{
            "type":"string",
            "description":"Date on which the locator was last scheduled for counting.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Locator":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the locator.",
            "nullable":true,
            "x-queryable":true
        },
        "LocatorId":{
            "type":"integer",
            "description":"Value that uniquely identifies the locator.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NextScheduleDate":{
            "type":"string",
            "description":"Date on which the locator is next scheduled for counting.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Notes":{
            "maxLength":240,
            "type":"string",
            "description":"Notes pertaining to the cycle count locator.",
            "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
        },
        "WeeklyCountFrequency":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates how often the locator is scheduled to be counted weekly. Possible values are Every Week, Every 2 Weeks, Every 3 Weeks, and Every 4 Weeks.",
            "nullable":true,
            "x-queryable":true
        },
        "WeeklyCountFrequencyCode":{
            "type":"integer",
            "description":"Value that indicates how often the locator is scheduled to be counted weekly. Possible values are 1, 2, 3, and 4.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":1
            },
            "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