POST Metadata/UndefineItem

Removes an existing Custom Field. The caller must have Delete permission to the Metadata object specified in the ItemGuid in the request.

Requirements

Token scope: Configuration:Delete

Headers

Content type: Content-Type:application/json.
Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

Input parameters
Name	Description
ItemGuid	The GUID that identifies the Custom Field. Depending on your environment, the GUID may be expressed with or without curly braces {}. For example, {3d6b61d-1c71-4603-883f-25b8c2ceecdd}. To get the Custom Field GUID, use POST Metadata/GetItems.
RemoveData (Optional)	Boolean parameter indicating if written data should be deleted when the field is deleted. If RemoveData is not specified or false, and there are values written, the operation to remove the field will fail.

Returns

Response description
Name	Description
Locked	The status of the data: true: The Policy value, which applies to the Custom Field, is locked. false: The Custom Field value is capable of change.
Result	The reason for success or failure. For more information, see Metadata Result Codes.

Example: Delete Custom Field data

Request

POST https://tpp.venafi.example/vedsdk/Metadata/UndefineItem
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "ItemGuid": "{a80714f0-565c-4bc2-9026-787cf076d764}"
   "RemoveData": true
}

Response

HTTP/1.1 200 OK
{
   "Locked": true,
   "Result": 0
}