Get fund vehicle custom field definitions

Endpoint to fetch details of custom added fields for mapping and identifying purposes

This API endpoint retrieves and returns detailed definitions for both standard and custom fields associated with fund vehicles. It is designed to complement other APIs that provide fund vehicle data by offering users an easy way to reference and understand the meaning of each field. Users can call this endpoint to gain insights into the specific fields used in fund vehicle records.

	Value
Description	Retrieve fund vehicle standard and custom fields definition.
Path	/api/field/fundvehicleentity
Method	GET
Request parameters	N/A
Request body	N/A
Responses	200 (OK): Array of fund vehicle field definitions
Reference	Link

Response body example

[
   {
      "companyId":1,
      "category":"fundvehicle",
      "fieldName":"name",
      "label":"Fund vehicle display name",
      "placeholder":"Display name",
      "type":"Autocomplete",
      "value":"",
      "groupId":"63311826a074af92b22c12e7",
      "group":"Fund vehicle information",
      "isRequired":true,
      "isDefault":true,
      "isDisabled":true,
      "optionItems":null,
      "allowNegative":false,
      "precision":0,
      "ordering":2
   },
   {
      "companyId":1,
      "category":"fundvehicle",
      "fieldName":"legalName",
      "label":"Legal name",
      "placeholder":"Legal name",
      "type":"Text",
      "value":"",
      "groupId":"63311826a074af92b22c12e7",
      "group":"Fund vehicle information",
      "isRequired":false,
      "isDefault":true,
      "isDisabled":false,
      "optionItems":null,
      "allowNegative":false,
      "precision":0,
      "ordering":14
   },
   {
      "companyId":1,
      "category":"fundvehicle",
      "fieldName":"custom_1714715509563",
      "label":"Public / Private",
      "placeholder":null,
      "type":"Dropdown",
      "value":null,
      "groupId":"63311826a074af92b22c12e7",
      "group":"Fund vehicle information",
      "isRequired":false,
      "isDefault":false,
      "isDisabled":false,
      "optionItems":[
         {
            "key":1714715499759,
            "value":"Public",
            "color":"#b6bbbf",
            "isDefault":false,
            "subValues":[
               
            ],
            "value2":null,
            "value3":null
         },
         {
            "key":1714715500063,
            "value":"Private",
            "color":"#b6bbbf",
            "isDefault":false,
            "subValues":[
               
            ],
            "value2":null,
            "value3":null
         }
      ],
      "allowNegative":true,
      "precision":2,
      "ordering":62
   }
}

Updated 2 months ago