1. Home
  2. /
  3. API Services
  4. /
  5. API References
  6. /
  7. General
  8. /
  9. ip1FieldAttributes.get

ip1FieldAttributes.get

Description

ip1FieldAttributes.get retrieves field attributes like initial values, allow for add, allow for update and mandatory flags for a field. 

Input/Output parameters

Note:   This API is using group field “fieldGroupName “ as an input. Grouped fields are different database fields that are grouped under one ID e.g. IBR & WH as BRWH. All the generic field APIs must use the field group names, even if a field is a single field.  Please refer to Fields.xlsx for details of when to use Field name or Field group names in IP1 APIs.

JSON example

View JSON request and response examples

Request:

{
“IptorAPI”: “1.0”,
“method”: “ip1FieldAttributes.get”,
“params”: {
“file”: “DSCM00P”,
“function”: “”,
“fieldGroupName”: “warehouse”
},
“id”: “1234567890”
}

Response:

{
“IptorAPI”: “1.0”,
“data”: {
“initialValues”: [
“00”,
“01”
],
“allowForAdd”: “Y”,
“allowForUpdate”: “Y”,
“mandatory”: “Y”,
“status”: “”
},
“id”: “1234567890”
}

Response format

For standard response format for IP1 API methods, see Response format.

Related topics

ip1FieldValue.validate

ip1FieldValues.get