Enums

Deprecated (since maarg 4.4.0): Use admin/enums

list EnumerationAndType

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Query parameters

pageIndexnumber · int32Optional

Page number to return, starting with zero

pageSizenumber · int32Optional

Number of records per page (default 100)

orderByFieldstringOptional

Field name to order by (or comma separated names)

pageNoLimitstringOptional

If true don't limit page size (no pagination)

dependentLevelsnumber · int32Optional

Levels of dependent child records to include

typeDescriptionstringOptional

enumIdstringOptional

enumTypeIdstringOptional

parentEnumIdstringOptional

enumCodestringOptional

sequenceNumnumber · int64Optional

descriptionstringOptional

optionValuestringOptional

Usage depends on enum type such as an ID format/mask

optionIndicatorstringOptional

Indicator flag with meaning depending on enum type

relatedEnumIdstringOptional

relatedEnumTypeIdstringOptional

statusFlowIdstringOptional

enumNamestringOptional

primaryEnumerationGroupIdstringOptional

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/enums

HTTPcURLJavaScriptPython

GET /rest/s1/available-to-promise/enums HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

[
  {
    "_entity": "moqui.basic.EnumerationAndType",
    "typeDescription": "text",
    "enumId": "text",
    "enumTypeId": "text",
    "parentEnumId": "text",
    "enumCode": "text",
    "sequenceNum": 1,
    "description": "text",
    "optionValue": "text",
    "optionIndicator": "text",
    "relatedEnumId": "text",
    "relatedEnumTypeId": "text",
    "statusFlowId": "text",
    "enumName": "text",
    "primaryEnumerationGroupId": "text"
  }
]

one EnumerationAndType

get

Authorizations

basicAuthapi_key

AuthorizationstringRequired

Path parameters

enumIdstringRequired

Responses

200

Success

application/json

401

Authentication required

403

Access Forbidden (no authz)

404

Value Not Found

429

Too Many Requests (tarpit)

500

General Error

get

/enums/{enumId}

HTTPcURLJavaScriptPython

GET /rest/s1/available-to-promise/enums/{enumId} HTTP/1.1
Host: dev-maarg.hotwax.io
Authorization: Basic username:password
Accept: */*

{
  "_entity": "moqui.basic.EnumerationAndType",
  "typeDescription": "text",
  "enumId": "text",
  "enumTypeId": "text",
  "parentEnumId": "text",
  "enumCode": "text",
  "sequenceNum": 1,
  "description": "text",
  "optionValue": "text",
  "optionIndicator": "text",
  "relatedEnumId": "text",
  "relatedEnumTypeId": "text",
  "statusFlowId": "text",
  "enumName": "text",
  "primaryEnumerationGroupId": "text"
}