POST api/relations/GetRelationsByEntity
Gets the relations for an item with the specified parameter.ItemID in the specified list parameter.ListID.
Request Information
URI Parameters
None.
Body Parameters
WorkPoint365.WebAPI.Model.RelationParameter| Name | Description | Type | Additional information |
|---|---|---|---|
| ListID |
Gets or sets the list identifier. |
string |
None. |
| ItemID |
Gets or sets the item identifier. |
integer |
None. |
| RelationTypeIDs |
Gets or sets the relation type i ds. |
Collection of integer |
None. |
| ShowAll |
Gets or sets a value indicating whether [show all]. |
boolean |
None. |
| ResponsibleUserId |
Gets or sets the responsible user identifier. |
integer |
None. |
| LCID |
Specifies the language to be used for the relation text |
integer |
None. |
Request Formats
application/json, text/json
Sample not available.
Response Information
Resource Description
Returns a list of relations.
Collection of WorkPoint365.WebAPI.Model.Relation| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Gets or sets the identifier. |
integer |
None. |
| RelationA |
Gets or sets the relation a. |
WorkPoint365.WebAPI.Model.RelationItem |
Required |
| RelationB |
Gets or sets the relation b. |
WorkPoint365.WebAPI.Model.RelationItem |
Required |
| Start |
Gets or sets the start. |
date |
None. |
| End |
Gets or sets the end. |
date |
None. |
| Description |
Gets or sets the description. |
string |
None. |
| Responsible |
Gets or sets the responsible. |
string |
None. |
| ResponsibleId |
Gets user id of the responsible user. |
integer |
None. |
Response Formats
application/json, text/json
[
{
"Id": 1,
"RelationA": {
"ListId": "7f0451a4-e35b-4658-9d77-732558a67b4b",
"ItemId": 2,
"Title": "sample string 3",
"Type": {
"Id": 1,
"Title": "sample string 2",
"TitleResources": [
{
"Language": 1,
"Localization": "sample string 2"
},
{
"Language": 1,
"Localization": "sample string 2"
}
]
}
},
"RelationB": {
"ListId": "7f0451a4-e35b-4658-9d77-732558a67b4b",
"ItemId": 2,
"Title": "sample string 3",
"Type": {
"Id": 1,
"Title": "sample string 2",
"TitleResources": [
{
"Language": 1,
"Localization": "sample string 2"
},
{
"Language": 1,
"Localization": "sample string 2"
}
]
}
},
"Start": "2024-12-27T19:38:48.0867736+00:00",
"End": "2024-12-27T19:38:48.0867736+00:00",
"Description": "sample string 2",
"Responsible": "sample string 3",
"ResponsibleId": 1
},
{
"Id": 1,
"RelationA": {
"ListId": "7f0451a4-e35b-4658-9d77-732558a67b4b",
"ItemId": 2,
"Title": "sample string 3",
"Type": {
"Id": 1,
"Title": "sample string 2",
"TitleResources": [
{
"Language": 1,
"Localization": "sample string 2"
},
{
"Language": 1,
"Localization": "sample string 2"
}
]
}
},
"RelationB": {
"ListId": "7f0451a4-e35b-4658-9d77-732558a67b4b",
"ItemId": 2,
"Title": "sample string 3",
"Type": {
"Id": 1,
"Title": "sample string 2",
"TitleResources": [
{
"Language": 1,
"Localization": "sample string 2"
},
{
"Language": 1,
"Localization": "sample string 2"
}
]
}
},
"Start": "2024-12-27T19:38:48.0867736+00:00",
"End": "2024-12-27T19:38:48.0867736+00:00",
"Description": "sample string 2",
"Responsible": "sample string 3",
"ResponsibleId": 1
}
]
application/xml, text/xml
<ArrayOfRelation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
<Relation>
<Description>sample string 2</Description>
<End>2024-12-27T19:38:48.0867736+00:00</End>
<Id>1</Id>
<RelationA>
<ItemId>2</ItemId>
<ListId>7f0451a4-e35b-4658-9d77-732558a67b4b</ListId>
<Title>sample string 3</Title>
<Type>
<Id>1</Id>
<Title>sample string 2</Title>
<TitleResources>
<LocalizationModel>
<Language>1</Language>
<Localization>sample string 2</Localization>
</LocalizationModel>
<LocalizationModel>
<Language>1</Language>
<Localization>sample string 2</Localization>
</LocalizationModel>
</TitleResources>
</Type>
</RelationA>
<RelationB>
<ItemId>2</ItemId>
<ListId>7f0451a4-e35b-4658-9d77-732558a67b4b</ListId>
<Title>sample string 3</Title>
<Type>
<Id>1</Id>
<Title>sample string 2</Title>
<TitleResources>
<LocalizationModel>
<Language>1</Language>
<Localization>sample string 2</Localization>
</LocalizationModel>
<LocalizationModel>
<Language>1</Language>
<Localization>sample string 2</Localization>
</LocalizationModel>
</TitleResources>
</Type>
</RelationB>
<Responsible>sample string 3</Responsible>
<ResponsibleId>1</ResponsibleId>
<Start>2024-12-27T19:38:48.0867736+00:00</Start>
</Relation>
<Relation>
<Description>sample string 2</Description>
<End>2024-12-27T19:38:48.0867736+00:00</End>
<Id>1</Id>
<RelationA>
<ItemId>2</ItemId>
<ListId>7f0451a4-e35b-4658-9d77-732558a67b4b</ListId>
<Title>sample string 3</Title>
<Type>
<Id>1</Id>
<Title>sample string 2</Title>
<TitleResources>
<LocalizationModel>
<Language>1</Language>
<Localization>sample string 2</Localization>
</LocalizationModel>
<LocalizationModel>
<Language>1</Language>
<Localization>sample string 2</Localization>
</LocalizationModel>
</TitleResources>
</Type>
</RelationA>
<RelationB>
<ItemId>2</ItemId>
<ListId>7f0451a4-e35b-4658-9d77-732558a67b4b</ListId>
<Title>sample string 3</Title>
<Type>
<Id>1</Id>
<Title>sample string 2</Title>
<TitleResources>
<LocalizationModel>
<Language>1</Language>
<Localization>sample string 2</Localization>
</LocalizationModel>
<LocalizationModel>
<Language>1</Language>
<Localization>sample string 2</Localization>
</LocalizationModel>
</TitleResources>
</Type>
</RelationB>
<Responsible>sample string 3</Responsible>
<ResponsibleId>1</ResponsibleId>
<Start>2024-12-27T19:38:48.0867736+00:00</Start>
</Relation>
</ArrayOfRelation>