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

Gets the custom fields for a task. For custom list fields, if there is no selection, the custom field is not returned in the response.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Provide task id to get list of available custom fields.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of CustomFieldValue
NameDescriptionTypeAdditional information
Id

Id of custom field.

integer

Required

Name

Name of the custom field.

string

Read Only

Value

Represents the value of Custom Field

string

None.

ValueText

Represents the text value of the custom field. Example: If the field type is Existing List and the source is Employee (SourceId = 4) then ValueText will be the employee's name.

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "name": "sample string 2",
    "value": "sample string 3",
    "valueText": "sample string 4"
  },
  {
    "id": 1,
    "name": "sample string 2",
    "value": "sample string 3",
    "valueText": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfCustomFieldValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.V2.Core">
  <CustomFieldValue>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Value>sample string 3</Value>
    <ValueText>sample string 4</ValueText>
  </CustomFieldValue>
  <CustomFieldValue>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Value>sample string 3</Value>
    <ValueText>sample string 4</ValueText>
  </CustomFieldValue>
</ArrayOfCustomFieldValue>