# Enums

Deprecated (since maarg 4.4.0): Use admin/enums

## GET /enums

> list EnumerationAndType

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"tags":[{"name":"enums","description":"Deprecated (since maarg 4.4.0): Use admin/enums"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/available-to-promise"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"moqui.basic.EnumerationAndType":{"title":"Enumeration And Type","type":"object","properties":{"_entity":{"type":"string","default":"moqui.basic.EnumerationAndType"},"typeDescription":{"type":"string"},"enumId":{"type":"string"},"enumTypeId":{"type":"string"},"parentEnumId":{"type":"string"},"enumCode":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"description":{"type":"string"},"optionValue":{"type":"string"},"optionIndicator":{"type":"string"},"relatedEnumId":{"type":"string"},"relatedEnumTypeId":{"type":"string"},"statusFlowId":{"type":"string"},"enumName":{"type":"string"},"primaryEnumerationGroupId":{"type":"string"}}}}},"paths":{"/enums":{"get":{"tags":["enums"],"summary":"list EnumerationAndType","description":null,"parameters":[{"schema":{"type":"number","format":"int32"},"name":"pageIndex","in":"query","required":false,"description":"Page number to return, starting with zero"},{"schema":{"type":"number","format":"int32"},"name":"pageSize","in":"query","required":false,"description":"Number of records per page (default 100)"},{"schema":{"type":"string"},"name":"orderByField","in":"query","required":false,"description":"Field name to order by (or comma separated names)"},{"schema":{"type":"string"},"name":"pageNoLimit","in":"query","required":false,"description":"If true don't limit page size (no pagination)"},{"schema":{"type":"number","format":"int32"},"name":"dependentLevels","in":"query","required":false,"description":"Levels of dependent child records to include"},{"schema":{"type":"string","format":""},"name":"typeDescription","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"enumId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"enumTypeId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"parentEnumId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"enumCode","in":"query","required":false,"description":null},{"schema":{"type":"number","format":"int64"},"name":"sequenceNum","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"description","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"optionValue","in":"query","required":false,"description":"Usage depends on enum type such as an ID format/mask"},{"schema":{"type":"string","format":""},"name":"optionIndicator","in":"query","required":false,"description":"Indicator flag with meaning depending on enum type"},{"schema":{"type":"string","format":""},"name":"relatedEnumId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"relatedEnumTypeId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"statusFlowId","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"enumName","in":"query","required":false,"description":null},{"schema":{"type":"string","format":""},"name":"primaryEnumerationGroupId","in":"query","required":false,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/moqui.basic.EnumerationAndType"}}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```

## GET /enums/{enumId}

> one EnumerationAndType

```json
{"openapi":"3.1.1","info":{"title":"Commerce Available to Promise REST API","version":"3.2.0"},"tags":[{"name":"enums","description":"Deprecated (since maarg 4.4.0): Use admin/enums"}],"servers":[{"url":"https://dev-maarg.hotwax.io/rest/s1/available-to-promise"}],"security":[{"basicAuth":[]},{"api_key":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"api_key":{"type":"apiKey","name":"api_key","in":"header","description":"HTTP Header api_key"}},"schemas":{"moqui.basic.EnumerationAndType":{"title":"Enumeration And Type","type":"object","properties":{"_entity":{"type":"string","default":"moqui.basic.EnumerationAndType"},"typeDescription":{"type":"string"},"enumId":{"type":"string"},"enumTypeId":{"type":"string"},"parentEnumId":{"type":"string"},"enumCode":{"type":"string"},"sequenceNum":{"type":"number","format":"int64"},"description":{"type":"string"},"optionValue":{"type":"string"},"optionIndicator":{"type":"string"},"relatedEnumId":{"type":"string"},"relatedEnumTypeId":{"type":"string"},"statusFlowId":{"type":"string"},"enumName":{"type":"string"},"primaryEnumerationGroupId":{"type":"string"}}}}},"paths":{"/enums/{enumId}":{"get":{"tags":["enums"],"summary":"one EnumerationAndType","description":null,"parameters":[{"schema":{"type":"string"},"name":"enumId","in":"path","required":true,"description":null}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/moqui.basic.EnumerationAndType"}}}},"401":{"description":"Authentication required"},"403":{"description":"Access Forbidden (no authz)"},"404":{"description":"Value Not Found"},"429":{"description":"Too Many Requests (tarpit)"},"500":{"description":"General Error"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.hotwax.co/documents/integrate-with-hotwax/components/available-to-promise/enums.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.