Modify custom column value for the selected resources

This API can be used to update the values of custom fields for the given set of resources

Endpoints

put /dcapi/customColumn/modifyCustomColumnValue

Copy full URL

Request URL

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

Scope

DesktopCentralCloud.CustomField.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/modifyCustomColumn.v1+jsonCopied!

- Request Body

application/json

JSON Object

Hide Sub-Attributes

resourceNamestringMandatory

The resource can be one of the following, depending on the view in which the custom field is created:
RESOURCE_ID — if the custom field is created in the Computer view
SOFTWARE_ID — if the custom field is created in the Software view

selectedResourcesstringMandatory

Provide the ID based on the view where the custom field is created.
1.If the custom field is created under the Computer view, use the resource_id obtained from this API
2.If the custom field is created under the Software view, use the software_id obtained from this API

customColumnValuestringMandatory

The new value to be set for the custom field

actualColumnNamestringMandatory

The actual name of the custom field column for which the User Data Type length is required actualColumnName can be get from the columName key from the response of /dcapi/customFields/computers/{ID}

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.

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomains/dcapi/customColumn/modifyCustomColumnValue \
  --header 'Accept: application/modifyCustomColumn.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"actualColumnName":"COL301","customColumnValue":"3","resourceName":"RESOURCE_ID","selectedResources":"301","tableName":"ManagedComputerCustomFields"}'

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/modifyCustomColumnValue"))
        .header("content-type", "application/json")
        .header("Accept", "application/modifyCustomColumn.v1+json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"actualColumnName\":\"COL301\",\"customColumnValue\":\"3\",\"resourceName\":\"RESOURCE_ID\",\"selectedResources\":\"301\",\"tableName\":\"ManagedComputerCustomFields\"}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"actualColumnName\":\"COL301\",\"customColumnValue\":\"3\",\"resourceName\":\"RESOURCE_ID\",\"selectedResources\":\"301\",\"tableName\":\"ManagedComputerCustomFields\"}"

headers = {
    'content-type': "application/json",
    'Accept': "application/modifyCustomColumn.v1+json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/dcapi/customColumn/modifyCustomColumnValue", payload, headers)

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

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


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

    data=Map();
    data.put("actualColumnName","value");
    data.put("customColumnValue","value");
    data.put("resourceName","value");
    data.put("selectedResources","value");
    data.put("tableName","value");

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

    info response;

$headers=@{}
$headers.Add("content-type", "application/json")
$headers.Add("Accept", "application/modifyCustomColumn.v1+json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/dcapi/customColumn/modifyCustomColumnValue' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"actualColumnName":"COL301","customColumnValue":"3","resourceName":"RESOURCE_ID","selectedResources":"301","tableName":"ManagedComputerCustomFields"}'

Sample Request Body

Copied!

  {
    "actualColumnName": "COL301",
    "customColumnValue": "3",
    "resourceName": "RESOURCE_ID",
    "selectedResources": "301",
    "tableName": "ManagedComputerCustomFields"
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

statusstring

Indicates whether the custom column value update was successful

messagestring

Confirmation message of the custom column value update operation

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!

  {
    "message": "Custom column value has been updated 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.