Get

The Get verb is to communicate to a business software component a request for an existing piece or pieces of information to be returned. The Get may be paired with most of the nouns defined in the OAGIS specification.The response to this request is the Show verb. The behavior of a BOD with a Get verb is quite predictable across the nouns it is paired with.The Get is designed to retrieval of information by using that information's primary retrieval field, or key field. The Get verb may also be used to request several documents at once. Selection Criteria:There are two types of selection capabilities for most BOD's that use the Get verb.1) The first selection capability is called Field-Based Selection. Within a Get-based Business Object Document, the first Data Type that occurs in a specific BOD structure is commonly used to provide the Field-Based Selection criteria. This is always defined within the specific BOD and is commonly the required fields for that specific Data type.The Field-Based Selection enables the requester to provide a value or values (in the case of multiple required Field Identifiers), in the required fields. Then the responding component uses those values to find and return the requested information to the originating business software component.2) The second type of selection capability for Get-based BODs is called Data Type Selection. Data Type selection enables the requester to identify which Data Types within the noun are requested to be returned in the response. The use of this capability is described for each corresponding Data Type for all BODs that use the Get verb. The Data Types are identified for retrieval within the Get instance of a BOD by including the name of the Data Type in the meta data but without any Field Identifiers or Segments identified within the Data Type. This will signify to the responding application that all of the data that corresponds to that Data Type is to be included in the response.If the Data Type is not requested, the Data Type identifier is not included in the Get request and this will signify to the responding component that the Data Type is not to be returned.

Element information

Namespace: http://www.openapplications.org/oagis/10

Schema document: Common.xsd

Type: GetType

Properties: Global, Qualified, ID: oagis-id-59db0fdd86fa4928be0f89f3750a2ad2

Content

from type RequestVerbType

Expression [1..*]

Attributes

Name	Occ	Type
uniqueIndicator	[0..1]	IndicatorType
maxItems	[0..1]	PositiveIntegerNumberType
recordSetSaveIndicator	[0..1]	IndicatorType
recordSetStartNumber	[0..1]	PositiveIntegerNumberType
recordSetReferenceID	[0..1]	IDType_B3F14E

Used in

Type GetActualLedgerDataAreaType (Element DataArea)
Type GetAllocateResourceDataAreaType (Element DataArea)
Type GetBOMDataAreaType (Element DataArea)
Type GetBatchCertificateOfAnalysisDataAreaType (Element DataArea)
Type GetBudgetLedgerDataAreaType (Element DataArea)
Type GetCarrierRouteDataAreaType (Element DataArea)
Type GetCatalogDataAreaType (Element DataArea)
Type GetChartOfAccountsDataAreaType (Element DataArea)
Type GetCommercialInvoiceDataAreaType (Element DataArea)
Type GetConfigurationDataAreaType (Element DataArea)
Type GetConfirmWIPDataAreaType (Element DataArea)
Type GetCostingActivityDataAreaType (Element DataArea)
Type GetCreditDataAreaType (Element DataArea)
Type GetCreditStatusDataAreaType (Element DataArea)
Type GetCreditTransferDataAreaType (Element DataArea)
Type GetCreditTransferISTDataAreaType (Element DataArea)
Type GetCurrencyExchangeRateDataAreaType (Element DataArea)
Type GetCustomerPartyMasterDataAreaType (Element DataArea)
Type GetDebitTransferDataAreaType (Element DataArea)
Type GetDebitTransferISTDataAreaType (Element DataArea)
Type GetDispatchListDataAreaType (Element DataArea)
Type GetEmployeeWorkScheduleDataAreaType (Element DataArea)
Type GetEmployeeWorkTimeDataAreaType (Element DataArea)
Type GetEngineeringChangeOrderDataAreaType (Element DataArea)
Type GetEngineeringWorkDocumentDataAreaType (Element DataArea)
Type GetFieldDataAreaType (Element DataArea)
Type GetFreightInvoiceDataAreaType (Element DataArea)
Type GetHazardousMaterialShipmentDocumentDataAreaType (Element DataArea)
Type GetInspectDeliveryDataAreaType (Element DataArea)
Type GetInventoryBalanceDataAreaType (Element DataArea)
Type GetInventoryConsumptionDataAreaType (Element DataArea)
Type GetInventoryCountDataAreaType (Element DataArea)
Type GetInvoiceDataAreaType (Element DataArea)
Type GetInvoiceLedgerEntryDataAreaType (Element DataArea)
Type GetIssueInventoryDataAreaType (Element DataArea)
Type GetItemCertificateOfAnalysisDataAreaType (Element DataArea)
Type GetItemMasterDataAreaType (Element DataArea)
Type GetItemNonconformanceDataAreaType (Element DataArea)
Type GetJournalEntryDataAreaType (Element DataArea)
Type GetLocationDataAreaType (Element DataArea)
Type GetLocationServiceDataAreaType (Element DataArea)
Type GetMaintenanceOrderDataAreaType (Element DataArea)
Type GetMatchDocumentDataAreaType (Element DataArea)
Type GetMergeWIPDataAreaType (Element DataArea)
Type GetMoveInventoryDataAreaType (Element DataArea)
Type GetMoveProductDataAreaType (Element DataArea)
Type GetMoveProductForecastDataAreaType (Element DataArea)
Type GetMoveWIPDataAreaType (Element DataArea)
Type GetOnlineOrderDataAreaType (Element DataArea)
Type GetOnlineSessionDataAreaType (Element DataArea)
Type GetOperationDataAreaType (Element DataArea)
Type GetOpportunityDataAreaType (Element DataArea)
Type GetPartyMasterDataAreaType (Element DataArea)
Type GetPartyScreenDataAreaType (Element DataArea)
Type GetPartyScreenResponseDataAreaType (Element DataArea)
Type GetPayableDataAreaType (Element DataArea)
Type GetPaymentStatusDataAreaType (Element DataArea)
Type GetPaymentStatusISTDataAreaType (Element DataArea)
Type GetPersonnelDataAreaType (Element DataArea)
Type GetPickListDataAreaType (Element DataArea)
Type GetPlanningScheduleDataAreaType (Element DataArea)
Type GetPriceListDataAreaType (Element DataArea)
Type GetProductAvailabilityDataAreaType (Element DataArea)
Type GetProductionOrderDataAreaType (Element DataArea)
Type GetProductionPerformanceDataAreaType (Element DataArea)
Type GetProductionScheduleDataAreaType (Element DataArea)
Type GetProjectAccountingDataAreaType (Element DataArea)
Type GetProjectMasterDataAreaType (Element DataArea)
Type GetPurchaseOrderDataAreaType (Element DataArea)
Type GetQuoteDataAreaType (Element DataArea)
Type GetRFQDataAreaType (Element DataArea)
Type GetReceivableDataAreaType (Element DataArea)
Type GetReceiveDeliveryDataAreaType (Element DataArea)
Type GetReceiveItemDataAreaType (Element DataArea)
Type GetRecoverWIPDataAreaType (Element DataArea)
Type GetRemittanceAdviceDataAreaType (Element DataArea)
Type GetRequireProductDataAreaType (Element DataArea)
Type GetRequisitionDataAreaType (Element DataArea)
Type GetRiskControlLibraryDataAreaType (Element DataArea)
Type GetRoutingDataAreaType (Element DataArea)
Type GetSalesLeadDataAreaType (Element DataArea)
Type GetSalesOrderDataAreaType (Element DataArea)
Type GetSequenceScheduleDataAreaType (Element DataArea)
Type GetShipmentDataAreaType (Element DataArea)
Type GetShipmentScheduleDataAreaType (Element DataArea)
Type GetShipmentUnitDataAreaType (Element DataArea)
Type GetShippersExportDeclarationDataAreaType (Element DataArea)
Type GetShippersLetterOfInstructionDataAreaType (Element DataArea)
Type GetSplitWIPDataAreaType (Element DataArea)
Type GetSupplierPartyMasterDataAreaType (Element DataArea)
Type GetTableDataAreaType (Element DataArea)
Type GetUOMGroupDataAreaType (Element DataArea)
Type GetWIPStatusDataAreaType (Element DataArea)
Type GetWarehouseShippingAdviceDataAreaType (Element DataArea)
Type GetWarehouseShippingOrderDataAreaType (Element DataArea)
Type GetWarrantyClaimDataAreaType (Element DataArea)

Sample instance

<Get>
   <Expression>token</Expression>
</Get>