Delete Custom Field

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Deletes the specified custom field and its associated data

Request URL

https://{server-hostname}:8383/dcapi/customColumn/removeCustomColumn

Scope

CustomField.DELETECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/deletedCustomColumnDetails.v1+jsonapplication/deletedCustomColumnDetails.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.

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}

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request DELETE \
  --url https://appdomain/dcapi/customColumn/removeCustomColumn \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/deletedCustomColumnDetails.v1+json' \
  --data '{"actualColumnName":"COL2","tableName":"ManagedComputerCustomFields"}'

Sample Request Body

Copied!
  {
    "actualColumnName": "COL2",
    "tableName": "ManagedComputerCustomFields"
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
statusstring

Indicates whether the custom field removal was successful

messagestring

Confirmation message indicating the custom field has been removed

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "message": "Custom field <b>COL2</b> has been removed 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.