POST Metadata/LoadItemGuid

Returns an ItemGuid for a Custom Field. The caller must have Read permission to the Distinguished Name (DN) of a certificate or device in the request.

Requirements

  • Permissions:  The caller must have Read permission to the Distinguished Name (DN) of a certificate or device in the request.
  • Token scope:  Configuration

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

DN

The Distinguished Name (DN) of a Certificate or Device object that contains a Custom Field. If necessary, use the DN value from the GET Metadata/Items or POST Metadata/GetItemsForClass response.

Returns

Response description

Name

Description

ItemGuid

The globally unique identifier of the Custom Field with the requested DN. Depending on your environment, the GUID may be expressed with or without curly braces {}. For example, {3d6b61d-1c71-4603-883f-25b8c2ceecdd}.

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: Find a Custom Field GUID

Request

POST https://tpp.venafi.example/vedsdk/Metadata/LoadItemGuid
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "DN": "\\VED\\Metadata Root\\Hidden Object Name"
}
 

Response

HTTP/1.1 200 OK
{
   "ItemGuid": "{a80714f0-565c-4bc2-9026-787cf076d764}",
   "Locked": false,
   "Result": 0
}