GET v2/tasks/types/{id}/custom-fields

Gets the custom field definitions for the task type id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Provide task type id to get list of available custom fields.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of CustomFieldMeta
NameDescriptionTypeAdditional information
Id

Custom field id

integer

None.

FieldName

Custom field name

string

None.

FieldType

Id and name of the field type

IdNamePair

None.

DisplayType

Id and name of the display type. If "None", then it is the default display type for the field type.

IdNamePair

None.

SourceId

Source id for lists

integer

None.

IsRequired

Indicates that this field is required

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "fieldName": "sample string 2",
    "fieldType": {
      "id": 1,
      "name": "sample string 2"
    },
    "displayType": {
      "id": 1,
      "name": "sample string 2"
    },
    "sourceId": 1,
    "isRequired": true
  },
  {
    "id": 1,
    "fieldName": "sample string 2",
    "fieldType": {
      "id": 1,
      "name": "sample string 2"
    },
    "displayType": {
      "id": 1,
      "name": "sample string 2"
    },
    "sourceId": 1,
    "isRequired": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfCustomFieldMeta xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.V2.Tasks">
  <CustomFieldMeta>
    <DisplayType xmlns:d3p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
      <d3p1:_x003C_Id_x003E_k__BackingField>1</d3p1:_x003C_Id_x003E_k__BackingField>
      <d3p1:_x003C_Name_x003E_k__BackingField>sample string 2</d3p1:_x003C_Name_x003E_k__BackingField>
    </DisplayType>
    <FieldName>sample string 2</FieldName>
    <FieldType xmlns:d3p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
      <d3p1:_x003C_Id_x003E_k__BackingField>1</d3p1:_x003C_Id_x003E_k__BackingField>
      <d3p1:_x003C_Name_x003E_k__BackingField>sample string 2</d3p1:_x003C_Name_x003E_k__BackingField>
    </FieldType>
    <Id>1</Id>
    <IsRequired>true</IsRequired>
    <SourceId>1</SourceId>
  </CustomFieldMeta>
  <CustomFieldMeta>
    <DisplayType xmlns:d3p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
      <d3p1:_x003C_Id_x003E_k__BackingField>1</d3p1:_x003C_Id_x003E_k__BackingField>
      <d3p1:_x003C_Name_x003E_k__BackingField>sample string 2</d3p1:_x003C_Name_x003E_k__BackingField>
    </DisplayType>
    <FieldName>sample string 2</FieldName>
    <FieldType xmlns:d3p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
      <d3p1:_x003C_Id_x003E_k__BackingField>1</d3p1:_x003C_Id_x003E_k__BackingField>
      <d3p1:_x003C_Name_x003E_k__BackingField>sample string 2</d3p1:_x003C_Name_x003E_k__BackingField>
    </FieldType>
    <Id>1</Id>
    <IsRequired>true</IsRequired>
    <SourceId>1</SourceId>
  </CustomFieldMeta>
</ArrayOfCustomFieldMeta>