GET api/relations/{id}

Get a relation with the specified id.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The id of the relation

integer

Required

Body Parameters

None.

Response Information

Resource Description

Returns a relation.

WorkPoint365.WebAPI.Model.Relation
NameDescriptionTypeAdditional 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

Sample:
{
  "Id": 1,
  "RelationA": {
    "ListId": "6d953af5-d4da-4f95-8f18-920564f0be9d",
    "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": "6d953af5-d4da-4f95-8f18-920564f0be9d",
    "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-05-15T12:13:08.3770657+00:00",
  "End": "2024-05-15T12:13:08.3770657+00:00",
  "Description": "sample string 2",
  "Responsible": "sample string 3",
  "ResponsibleId": 1
}

application/xml, text/xml

Sample:
<Relation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
  <Description>sample string 2</Description>
  <End>2024-05-15T12:13:08.3770657+00:00</End>
  <Id>1</Id>
  <RelationA>
    <ItemId>2</ItemId>
    <ListId>6d953af5-d4da-4f95-8f18-920564f0be9d</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>6d953af5-d4da-4f95-8f18-920564f0be9d</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-05-15T12:13:08.3770657+00:00</Start>
</Relation>