Recommended Reading:
GetListItemMaster
In an effort to simpilify the usage of the verbs the GetListItemMaster BOD is being deprecated as of OAGIS 9.0, the GetListItemMaster will still be provided for the next three releases at which time it is scheduled to be removed from OAGIS. As such for all new development we recommend that you use the GetItemMaster BOD which may serve the same function of the GetListItemMaster BOD. The purpose of the GetListItemMaster is to enable a business application module to request summary information concerning an ItemMaster or ITEMs from another business application. This type of functionality is limited to the capabilities of the responding application and needs to be determined during the implementation project. The response to this request is the ListItemMaster. This BOD does not usually cause updates to occur.
See http://www.openapplications.org/oagis/9.
Element information
Namespace: http://www.openapplications.org/oagis/9
Schema document: org_openapplications_oagis/9_4_1/Developer/BODs/GetListItemMaster.xsd
Type: GetListItemMasterType
Properties: Global, Qualified
Content
- Sequence
[1..1]
- ApplicationArea [1..1] Provides the information that an application may need to know in order to communicate in an integration of two or more business applications. The ApplicationArea is used at the applications layer of communication. While the integration frameworks web services and middleware provide the communication layer that OAGIS operates on top of.
- DataArea [1..1] Is where the information that the BOD message carries is provided, in this case GetListItemMaster. The information consists of a Verb and one or more Nouns. The verb (GetList) indicates the action to be performed on the Noun (ItemMaster).
from type BusinessObjectDocumentType
Attributes
| Name | Occ | Type | Description | Notes |
|---|---|---|---|---|
| releaseID | [1..1] | NormalizedStringType | OAGIS Release this BOD Instances belongs or the OAGIS release that the derivative work is based on. | from type BusinessObjectDocumentType |
| versionID | [0..1] | NormalizedStringType | Indicates the version of the given BOD definition. | from type BusinessObjectDocumentType |
| systemEnvironmentCode | [0..1] | SystemEnvironmentCodeContentType | Indicates whether this BOD is being sent in a "Test" or a "Production" mode. If the BOD is being sent in a test mode, it's information should not affect the business operation. However, if the BOD is sent in "Production" mode it is assumed that all test has been complete and the contents of the BOD are to affect the operation of the receiving business application(s). | Default value is "Production". from type BusinessObjectDocumentType |
| languageCode | [0..1] | LanguageCodeContentType | Indicates the language that the contents of the BOD is in unless otherwise stated. | Default value is "en-US". from type BusinessObjectDocumentType |
Used in
- Type OAGIS9BODsType (Element OAGIS9BODs)
Sample instance
<GetListItemMaster releaseID="normalizedString"> <ApplicationArea> <Sender> <LogicalID>normalizedString</LogicalID> <ComponentID>normalizedString</ComponentID> <TaskID>normalizedString</TaskID> <ReferenceID>normalizedString</ReferenceID> <ConfirmationCode>Always</ConfirmationCode> <AuthorizationID>normalizedString</AuthorizationID> </Sender> <Receiver> <LogicalID>normalizedString</LogicalID> <ComponentID>normalizedString</ComponentID> <ID>normalizedString</ID> </Receiver> <CreationDateTime>2000-01-01</CreationDateTime> <Signature> <!--any element--> </Signature> <BODID>normalizedString</BODID> <UserArea> <!--any element--> </UserArea> </ApplicationArea> <DataArea> <GetList> <Expression>token</Expression> </GetList> <ItemMaster> <ItemMasterHeader>... </ItemMasterHeader> <ItemLocation>... </ItemLocation> </ItemMaster> </DataArea> </GetListItemMaster>