GET api/UdfDataTypes/{id}

Returns a specific user-defined field data type

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The ID of the user-defined field data type

integer

Required

Body Parameters

None.

Response Information

Resource Description

UdfDataType
NameDescriptionTypeAdditional information
UdfDataTypeId

integer

None.

OrganizationId

integer

None.

Description

string

None.

IsActive

boolean

None.

IsSystemDefined

boolean

None.

Links

Collection of Link

None.

Response Formats

application/json, text/json

Sample:
{
  "UdfDataTypeId": 1,
  "OrganizationId": 2,
  "Description": "sample string 3",
  "IsActive": true,
  "IsSystemDefined": true,
  "Links": [
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "Title": "sample string 3",
      "Type": "sample string 4"
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "Title": "sample string 3",
      "Type": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:
<UdfDataType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProClassApi.Web.Api.Models">
  <Description>sample string 3</Description>
  <IsActive>true</IsActive>
  <IsSystemDefined>true</IsSystemDefined>
  <Links>
    <Link>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
      <Title>sample string 3</Title>
      <Type>sample string 4</Type>
    </Link>
    <Link>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
      <Title>sample string 3</Title>
      <Type>sample string 4</Type>
    </Link>
  </Links>
  <OrganizationId>2</OrganizationId>
  <UdfDataTypeId>1</UdfDataTypeId>
</UdfDataType>