BazeField Services

<back to all web services

ObjectListGetRequest

Core API
Requires Authentication
The following routes are available for this service:
GET, POST/api/objects/listGet objects by object ids, return list
GET, POST/api/objects/{ObjectIds}/listObsolete
ObjectListGetRequest Parameters:
NameParameterData TypeRequiredDescription
ObjectIdspathList<string>No
AttributesbodyList<string>No
ObjectListGetResponse Parameters:
NameParameterData TypeRequiredDescription
ObjectsformList<DomainObject>No
DomainObject Parameters:
NameParameterData TypeRequiredDescription
ObjectIdformstringNo
mdmidformstringNo
DomainObjectAttributes Parameters:
NameParameterData TypeRequiredDescription
AttributesformDictionary<string, string>No

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.

POST /api/objects/list HTTP/1.1 
Host: mdn.bazefield.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ObjectListGetRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bazefield.Core.WebService.Request">
  <Attributes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Attributes>
  <ObjectIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </ObjectIds>
</ObjectListGetRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

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