POST api/v1/EntitiesByFilter

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
EntityTypeID	string	None.
EntityName	string	None.
EntityIDArr	Collection of string	None.
EmailAddressesArr	Collection of string	None.
IncludeAllChildren	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "EntityTypeID": "sample string 1",
  "EntityName": "sample string 2",
  "EntityIDArr": [
    "sample string 1",
    "sample string 2"
  ],
  "EmailAddressesArr": [
    "sample string 1",
    "sample string 2"
  ],
  "IncludeAllChildren": true
}

application/xml, text/xml

Sample:

<GetEntitiesByFilterParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPointEMM.API.Model">
  <EmailAddressesArr xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </EmailAddressesArr>
  <EntityIDArr xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </EntityIDArr>
  <EntityName>sample string 2</EntityName>
  <EntityTypeID>sample string 1</EntityTypeID>
  <IncludeAllChildren>true</IncludeAllChildren>
</GetEntitiesByFilterParameter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DataSet

Name	Type	Additional information
RemotingFormat	SerializationFormat	None.
SchemaSerializationMode	SchemaSerializationMode	None.
CaseSensitive	boolean	None.
DefaultViewManager	Collection of Object	None.
EnforceConstraints	boolean	None.
DataSetName	string	None.
Namespace	string	None.
Prefix	string	None.
ExtendedProperties	Dictionary of Object [key] and Object [value]	None.
HasErrors	boolean	None.
IsInitialized	boolean	None.
Locale	CultureInfo	None.
Site	ISite	None.
Relations	Collection of Object	None.
Tables	Collection of Object	None.
Container	IContainer	None.
DesignMode	boolean	None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.