GET Requests (Single Reads and Queries)

As with any OData Service, BDEx Connect obeys the OData Standard conventions of supporting HTTP Requests with the following types: Create, Read, Update, Delete and Query.

However while this is theoretically true, at present only Queries, Reads and one very specific Update Request are currently supported.

We fully expect BDEx Connect to expand with new Entities, EntitySets and Navigation properties in future as and when the need arises to do so.

Queries and Single Reads are two forms of GET Requests.

Typically they take the form of specifying an Entity key or providing Select-Option values to be used as part of a ‘Filter’.

Here are some notable examples:

• READ – All of the Notes for a specific Master Data Object reference, e.g. a Business Partner:
  MasterDataObjectSet(ObjectID=‘ISU0001’,ObjectKey=’[BP Number]’)/ToNotesFromMDObj?

• READ – The Invoice History for a specific Master Data Object reference, e.g. a Business Partner:
  MasterDataObjectSet(ObjectID=‘ISU0001’,ObjectKey=’[BP Number]’)/ToInvHistFromMDObj?

• READ – All of the Estimated Meter Readings (Entities) for a given Invoice (where the Estimated property is ‘True’):
  InvoiceSet(‘[Invoice Document Number]’)/ToEstimatedReadsFromInvoice?

• QUERY – All open BPEMs for a specific Business Partner:
  BusinessPartnerSet(‘[BP Number]’)/ToWorkRequests?&$filter=ClassID eq ‘ISU_BPEM’

• QUERY – Find Contract Accounts that have an old Legacy Account reference
  ContractAccountSet?&$filter=LegacyNumber eq ‘OLDACC101’

• QUERY – Find Standard Addresses for a specific Business Partner:
  BusinessPartnerSet(‘[BP Number]’)/ToAddressesFromBP?&$filter=StandardAddress eq true

• QUERY – Find Standard Telephone Numbers for a specific Business Partner:
  BusinessPartnerSet(‘[BP Number]’)/ToCommDetailsFromBP?&$filter=CommunicationType eq ‘TEL’ and StandardIndicator eq true