retrieveUserDefinedFields (XAO120X1) – this operation retrieves user defined text which has been set up in IP1. User defined text can be created for items, customers etc. An entity specifies if its for an item or a customer and within the entity there are properties which are equivalent to fields. Entities could have keys containing multiple fields eg customer/item. For example if an entity is for item and it has 10 properties, then up to ten properties can be specified for a single item. The ’ keys’ array is for a single item, only.
User defined fields are set up by program XAM110 Work with properties and XAM120 work with entities in IP1.
Input parameters:
| Field ID | Description | Type | Length | Constraints |
| sessionID | Session ID for the logged in user. | String | Mandatory | |
| entity | Entity | String | 10 | Mandatory |
| properties | Properties
A list of properties belonging to the entity to be retrieved |
String | 10 | Mandatory |
| keys | Keys
The value of the key for the entity. If the entity is for an item, the key will be a single element in the array the item number. |
String | 10 | Mandatory |
Response:
| Field | Description | Type | Occurrence |
| userDefinedFields | User defined fields | userDefinedFields | 0..1 |
| messageSet | messageSetDataType structure is part of the output that holds the messages particularly error messages returned from the service call. This is the last element in the output of most services. | messageSetDataType | 0..1 |
retrieve UDF Sample
