GetListItemMaster schema, example, validation rules, validation stylesheet |
GetListItemMaster type: GetListItemMaster | |
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. |
GetListItemMaster extends: BusinessObjectDocument | |||||||
Structure: |
![]() |
||||||
Elements: |
|
GetListItemMasterDataArea extends: DataArea | ||||||||||
Structure: |
![]() |
|||||||||
Elements: |
|
GetListItemMaster Scenario Diagram |
GetList schema |
GetList type: GetList | |
The purpose of the GetList verb is to enable a business software component to request summary information for one or more occurrences of a specific noun from another business software component. The GetList may be paired with most of the nouns in the OAGIS specification.The response to this request is a BOD using the List verb. The GetList is designed to retrieve multiple occurrences of data such as all of the sales orders or all of the purchase orders within a requested range. It does not require an exact match of the key fields in order to retrieve information. It may use a range selection criteria with a "from" and "to" selection capability. This behavior is quite different from the Get verb, which is designed to retrieve a specific noun using a specific key field.The GetList verb also enables the retrieval of information across several documents by using selection fields. An example of this could be requesting all sales order lines for a specific item. This type of functionality is limited to the capabilities of the responding application and needs to be determined during the implementation project. More details on this capability will be described below. GetList attributes: o maxitems attribute is a number that indicates the number of maximum items to be returned. o rssave attribute is a Boolean flag that indicates whether the result set should be saved on the sending system if maxitems is exceeded. o rsstart attribute is a number of the starting record for the next section of the result set. If it is omitted, it is to be assumed the first of the maxitems. o rsref attribute is a string that represents the implementation-specific result set identifier for subsequent requests. Selection Criteria: There are two types of selection capabilities enabled by the BODs that use the GetList verb. 1) Field-Based Selection Allows the requesting system to ask for information that matches the data provided. It also allows the requestor to indicate the information that to be returned by specifying the ReturnCriteria indicated on the GetList Verb. 2) Range Selection Allows the requesting system to provide a range of values for known data. This is accomplished by providing two occurances of the Noun. The first occurance indicates the "From" the second occurance indicates the "To" occurance. Again the requestor can indicate the information that to be returned by specifying the ReturnCriteria indicated on the GetList Verb. |
GetList extends: RequestVerb | |||||||||||||||||||||||||
Structure: |
![]() |
||||||||||||||||||||||||
Attributes: |
|
ItemMaster schema |
ItemMaster type: ItemMaster | |
Represents any unique purchased part or manufactured product. Item, as used here, refers to the basic information about an item, including its attributes, cost, and locations. It does not include item quantities. Compare to the noun InventoryBalance, which includes all quantities and other location-specific information. Item is used as the Item Master. |
Header type: ItemHeader | |
Identifies everything know about an item. Information at the header level applies to all locations unless indicated differently at a given location. |
ItemLocation type: ItemLocation | |
Identifies the Item information that is specific to a location. For example a plant or site may keep different information about an item than the corporate office. |
Value type: ItemValue | |
Identifies the cost or value of the item. |
UnitPackaging type: Packaging | |
Identifies the packaging that the company generally references the Item in. Identifies the Packaging information for a given item. Note: The UPC here is the UPC of the packaging for a given item. |
AlternateUOM | ||||||||||||||||
Structure: |
![]() |
|||||||||||||||
Elements: |
|
ItemDetails | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Captures the common item information that is shared between the header and Item Location. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Structure: |
![]() |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Elements: |
|
ItemHeader extends: ItemDetails | ||||||||||||||||||||||||||||
Identifies everything know about an item. Information at the header level applies to all locations unless indicated differently at a given location. |
||||||||||||||||||||||||||||
Structure: |
![]() |
|||||||||||||||||||||||||||
Elements: |
|
ItemLocation extends: ItemDetails | ||||||||||
Identifies the Item information that is specific to a location. For example a plant or site may keep different information about an item than the corporate office. The ItemId in the ItemLocation is the Id by which the Item is referred to within this location, if applicable |
||||||||||
Structure: |
![]() |
|||||||||
Elements: |
|
ItemMaster extends: Noun | ||||||||||
Represents any unique purchased part or manufactured product. Item, as used here, refers to the basic information about an item, including its attributes, cost, and locations. It does not include item quantities. Compare to the noun InventoryBalance, which includes all quantities and other location-specific information. Item is used as the Item Master. |
||||||||||
Structure: |
![]() |
|||||||||
Elements: |
|
ItemValue | ||||||||||||||||||||||||||||||||||
Identifies the cost or value of an item. |
||||||||||||||||||||||||||||||||||
Structure: |
![]() |
|||||||||||||||||||||||||||||||||
Elements: |
|
SerialNumberSpecification restricts: xs:string | |
Verb Common Files |
Verb.xsd schema |
AcknowledgableVerb extends: ConfirmableVerb | |||||||||
Structure: |
![]() |
||||||||
Attributes: |
|
AcknowledgementType restricts: xs:NMTOKEN | |||||||
Enumerations: |
|
ConfirmableVerb extends: Verb | |||||||||
Structure: |
![]() |
||||||||
Attributes: |
|
ConfirmType restricts: xs:NMTOKEN | |||||||
Enumerations: |
|
Expression restricts: xs:string | |
ExpressionCriteria | |||||||||
Structure: |
![]() |
||||||||
Elements: |
|
||||||||
Attributes: |
|
RequestVerb extends: ConfirmableVerb | |||||||
Structure: |
![]() |
||||||
Elements: |
|
VerbBase.xsd schema |
Verb type: Verb | |
Verb | |
Structure: |
![]() |
Noun Common Files |