GET api/Field/GetDTKSystemFields?projectId={projectId}

Get all fields based on project id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
projectId

integer

Required

Body Parameters

None.

Response Information

Resource Description

Get all fields based on project id

API_Data_ListOfFieldDef
NameDescriptionTypeAdditional information
Success

boolean

None.
Error

ErrorInfo

None.
Data

Collection of FieldDef

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": [
    {
      "Attributes": {
        "sample string 1": 2,
        "sample string 3": 4
      },
      "FieldID": 1,
      "DefaultName": "sample string 2",
      "FieldName": "sample string 3",
      "FieldTypeID": 4
    },
    {
      "Attributes": {
        "sample string 1": 2,
        "sample string 3": 4
      },
      "FieldID": 1,
      "DefaultName": "sample string 2",
      "FieldName": "sample string 3",
      "FieldTypeID": 4
    }
  ]
}

application/xml, text/xml

Sample: 
<API_Data_ArrayOfFieldDef xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
    <d2p1:FieldDef>
      <d2p1:Attributes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringint>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>2</d4p1:Value>
        </d4p1:KeyValueOfstringint>
        <d4p1:KeyValueOfstringint>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>4</d4p1:Value>
        </d4p1:KeyValueOfstringint>
      </d2p1:Attributes>
      <d2p1:DefaultName>sample string 2</d2p1:DefaultName>
      <d2p1:FieldID>1</d2p1:FieldID>
      <d2p1:FieldName>sample string 3</d2p1:FieldName>
      <d2p1:FieldTypeID>4</d2p1:FieldTypeID>
    </d2p1:FieldDef>
    <d2p1:FieldDef>
      <d2p1:Attributes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringint>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>2</d4p1:Value>
        </d4p1:KeyValueOfstringint>
        <d4p1:KeyValueOfstringint>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>4</d4p1:Value>
        </d4p1:KeyValueOfstringint>
      </d2p1:Attributes>
      <d2p1:DefaultName>sample string 2</d2p1:DefaultName>
      <d2p1:FieldID>1</d2p1:FieldID>
      <d2p1:FieldName>sample string 3</d2p1:FieldName>
      <d2p1:FieldTypeID>4</d2p1:FieldTypeID>
    </d2p1:FieldDef>
  </Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_ArrayOfFieldDef>