Add Custom Field

This api can be used to add a new custom field to the system with the provided attributes

Endpoints

post /dcapi/customColumn/addCustomColumn

Copy full URL

Request URL

https://{serverurl}/dcapi/customColumn/addCustomColumn

Scope

DesktopCentralCloud.CustomField.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/addCustomColumnStatus.v1+jsonCopied!

Content-TypestringMandatory

application/customColumnDetails.v1+jsonCopied!

- Request Body

application/json

JSON Object

Hide Sub-Attributes

tableNamestringMandatory

The table name can be any of the names provided in the list below
1.ManagedComputerCustomFields-if customfield created in computer view
2.InvSWCustomFields-if customfield created in software view.

columnNamestringMandatory

Name of the custom field to be created

dataTypestringMandatory

The data type of a custom field can be one of the following: 1.CHAR
2.INTEGER
3.BOOLEAN
4.FILE < br>A custom data type can also be specified as the field’s data type, which can be created using the API. /dcapi/customColumn/customDataType

sizestringMandatory

maximum character allowed for custom field value

defaultValuestringOptional

Value to be used if none is provided

descriptionstringMandatory

metadata for the field

isPIIbooleanMandatory

Indicates whether the field contains sensitive/PII data (true/false)

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomains/dcapi/customColumn/addCustomColumn \
  --header 'Accept: application/addCustomColumnStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/customColumnDetails.v1+json' \
  --data '{"size":50,"dataType":"CHAR","description":"Custom Column to Store Sample data","isPII":true,"tableName":"MspCustomerCustomFields","columnName":"OS Type"}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomains/dcapi/customColumn/addCustomColumn"))
        .header("Content-Type", "application/customColumnDetails.v1+json")
        .header("Accept", "application/addCustomColumnStatus.v1+json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"size\":50,\"dataType\":\"CHAR\",\"description\":\"Custom Column to Store Sample data\",\"isPII\":true,\"tableName\":\"MspCustomerCustomFields\",\"columnName\":\"OS Type\"}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomains")

payload = "{\"size\":50,\"dataType\":\"CHAR\",\"description\":\"Custom Column to Store Sample data\",\"isPII\":true,\"tableName\":\"MspCustomerCustomFields\",\"columnName\":\"OS Type\"}"

headers = {
    'Content-Type': "application/customColumnDetails.v1+json",
    'Accept': "application/addCustomColumnStatus.v1+json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/dcapi/customColumn/addCustomColumn", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/addCustomColumnStatus.v1+json");
    headersMap.put("Content-Type", "application/customColumnDetails.v1+json");

    data=Map();
    data.put("size","value");
    data.put("dataType","value");
    data.put("description","value");
    data.put("isPII",true);
    data.put("tableName","value");
    data.put("columnName","value");

    response = invokeUrl
    [
        url: "https://appDomains/dcapi/customColumn/addCustomColumn"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/customColumnDetails.v1+json")
$headers.Add("Accept", "application/addCustomColumnStatus.v1+json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/dcapi/customColumn/addCustomColumn' -Method POST -Headers $headers -ContentType 'application/customColumnDetails.v1+json' -Body '{"size":50,"dataType":"CHAR","description":"Custom Column to Store Sample data","isPII":true,"tableName":"MspCustomerCustomFields","columnName":"OS Type"}'

Sample Request Body

Copied!

  {
    "size": 50,
    "defaultValue": "Mac",
    "dataType": "CHAR",
    "description": "Custom Column to Store Sample data",
    "isPII": true,
    "tableName": "MspCustomerCustomFields",
    "columnName": "OS Type"
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

statusstring

Indicates the result of the operation

messagestring

Confirmation message of the operation performed

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!

  {
    "message": "Field <b> OS Type </b> has been added successfully",
    "status": "SUCCESS"
  }

▼ Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.