POST api/GetForeignKeyRelations

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Fields	string	None.
SeqNo	integer	None.
QueryTableRelationId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Fields": "sample string 1",
  "SeqNo": 2,
  "QueryTableRelationId": 3
}

application/xml, text/xml

Sample:

<DefaultJoinsparams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Goaa.iPro.Data.Admin.CustomClasses">
  <Fields>sample string 1</Fields>
  <QueryTableRelationId>3</QueryTableRelationId>
  <SeqNo>2</SeqNo>
</DefaultJoinsparams>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ForeignKeyRelations

Name	Description	Type	Additional information
FieldID		DataTable	None.
RelationJoins		Collection of ForeignKeyRelationJoins	None.

Response Formats

application/json, text/json

Sample:

{
  "FieldID": null,
  "RelationJoins": [
    {
      "QueryTableRelationId": 1,
      "MainTableID": "sample string 2",
      "JoinTableID": "sample string 3",
      "JoinID": 4,
      "JoinOperator": 5,
      "MainFieldID": 6,
      "JoinFieldID": 7,
      "AndOR": "sample string 8",
      "AndORText": true,
      "SeqNo": 10,
      "ParentId": 11,
      "JoinType": "sample string 12",
      "JoinGroupID": 13,
      "LookupGroup": "sample string 14",
      "Category": "sample string 15"
    },
    {
      "QueryTableRelationId": 1,
      "MainTableID": "sample string 2",
      "JoinTableID": "sample string 3",
      "JoinID": 4,
      "JoinOperator": 5,
      "MainFieldID": 6,
      "JoinFieldID": 7,
      "AndOR": "sample string 8",
      "AndORText": true,
      "SeqNo": 10,
      "ParentId": 11,
      "JoinType": "sample string 12",
      "JoinGroupID": 13,
      "LookupGroup": "sample string 14",
      "Category": "sample string 15"
    }
  ]
}

application/xml, text/xml

Sample:

<ForeignKeyRelations xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Goaa.iPro.Data.Admin.CustomClasses">
  <FieldID i:nil="true" />
  <RelationJoins>
    <ForeignKeyRelationJoins>
      <AndOR>sample string 8</AndOR>
      <AndORText>true</AndORText>
      <Category>sample string 15</Category>
      <JoinFieldID>7</JoinFieldID>
      <JoinGroupID>13</JoinGroupID>
      <JoinID>4</JoinID>
      <JoinOperator>5</JoinOperator>
      <JoinTableID>sample string 3</JoinTableID>
      <JoinType>sample string 12</JoinType>
      <LookupGroup>sample string 14</LookupGroup>
      <MainFieldID>6</MainFieldID>
      <MainTableID>sample string 2</MainTableID>
      <ParentId>11</ParentId>
      <QueryTableRelationId>1</QueryTableRelationId>
      <SeqNo>10</SeqNo>
    </ForeignKeyRelationJoins>
    <ForeignKeyRelationJoins>
      <AndOR>sample string 8</AndOR>
      <AndORText>true</AndORText>
      <Category>sample string 15</Category>
      <JoinFieldID>7</JoinFieldID>
      <JoinGroupID>13</JoinGroupID>
      <JoinID>4</JoinID>
      <JoinOperator>5</JoinOperator>
      <JoinTableID>sample string 3</JoinTableID>
      <JoinType>sample string 12</JoinType>
      <LookupGroup>sample string 14</LookupGroup>
      <MainFieldID>6</MainFieldID>
      <MainTableID>sample string 2</MainTableID>
      <ParentId>11</ParentId>
      <QueryTableRelationId>1</QueryTableRelationId>
      <SeqNo>10</SeqNo>
    </ForeignKeyRelationJoins>
  </RelationJoins>
</ForeignKeyRelations>