POST api/relations/query

Query relations across multiple entities

Request Information

URI Parameters

None.

Body Parameters

WorkPoint365.WebAPI.Model.Relations.QueryRelationsByEntitiesParameter

Name	Description	Type	Additional information
RelationTypeIDs	Optional filter for relation types.	Collection of integer	None.
ShowAll	If false, only active relations are returned based on start/end dates.	boolean	None.
ResponsibleUserId	Optional filter for responsible user id.	integer	None.
LCID	Optional LCID for localized relation type titles.	integer	None.
Entities	The entities to query relations for.	Collection of WorkPoint365.WebAPI.Model.Relations.EntityRef	None.

Request Formats

application/json, text/json

Sample:

{
  "RelationTypeIDs": [
    1,
    2
  ],
  "ShowAll": true,
  "ResponsibleUserId": 1,
  "LCID": 1,
  "Entities": [
    {
      "List": "2e2bb60d-9309-49ce-9348-c144175a2c2b",
      "ID": 2
    },
    {
      "List": "2e2bb60d-9309-49ce-9348-c144175a2c2b",
      "ID": 2
    }
  ]
}

application/xml, text/xml

Sample:

<QueryRelationsByEntitiesParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model.Relations">
  <Entities>
    <EntityRef>
      <ID>2</ID>
      <List>2e2bb60d-9309-49ce-9348-c144175a2c2b</List>
    </EntityRef>
    <EntityRef>
      <ID>2</ID>
      <List>2e2bb60d-9309-49ce-9348-c144175a2c2b</List>
    </EntityRef>
  </Entities>
  <LCID>1</LCID>
  <RelationTypeIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </RelationTypeIDs>
  <ResponsibleUserId>1</ResponsibleUserId>
  <ShowAll>true</ShowAll>
</QueryRelationsByEntitiesParameter>

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

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

Sample:

Sample not available.