BazeField Services

<back to all web services

ObjectsByKeyGetRequest

Core API
Requires Authentication
The following routes are available for this service:
GET/api/objectsGet objects matching specified values for one specified attribute
ObjectsByKeyGetRequest Parameters:
NameParameterData TypeRequiredDescription
KeyquerystringYesName of attribute, e.g. shortName for a site or an asset
ValuesqueryList<string>YesValues for specified attribute( parameter: Key)

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/objects HTTP/1.1 
Host: mdn.bazefield.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ArrayOfDomainObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bazefield.Core.WebService.Entity">
  <DomainObject>
    <Attributes xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Attributes>
    <ObjectId>String</ObjectId>
  </DomainObject>
</ArrayOfDomainObject>