Item_Get (Get)
- Last UpdatedNov 06, 2025
- 2 minute read
| Get | Item_Get |
Resource Path:/api/Item
| Name | Description | Data Type |
|---|---|---|
| itemId | The item ID. | string |
| itemDesc | The item description. | string |
| itemClassId | The item class ID. | string |
| maxRows | The maximum number of records to return. | integer |
| produced | An indication whether to include items that are marked as produced. The default is true. | boolean |
| consumed | boolean | |
| obsolete | An indication whether to include items that are marked as obsolete. The default is false. | boolean |
The response body is of type Array[Mes.WebApi.Models.Item].
To get the items that include peanuts in their ID, raw in their description, and roasted nuts in their item class, and to limit the returned number of records to 20:
api/item?itemId=peanuts&itemDesc=raw&itemClassId=roasted nuts&maxRows=20
To get all items that are marked as produced or produced and consumed:
api/item?produced=true
To get only items that are marked as produced but not produced and consumed:
api/item?produced=true&consumed=false
To get all items that are marked as obsolete (if the produced parameter is not set to null, it will be set to true by default and the call would include only produced items that are obsolete):
api/item?produced=null&obsolete=true
Examples: Work Tasks Lookups
To get items using the item ID, description, and class filters, and to limit the returned number of records:
api/item?itemId={itemId}&itemDesc={itemDesc}&itemClassId={itemClassId}&maxRows={maxRows}
To get items based on whether they are marked as produced, consumed, or obsolete:
api/item?produced={produced}&consumed={consumed}&obsolete={obsolete}