POST Metadata/LoadItem

Returns a Metadata Item with Custom Field details. The details describe where and how the Metadata object applies to certificates and/or devices in the Policy tree.

Requirements

Permissions: The caller must have Read permission to the Metadata that is referenced by its DN 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
Item	An array of Metadata Item settings that are present in the Distinguished Name (DN). If a setting is missing, the value is not set. Each array element describes a Custom Field.
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: Show metadata for a Custom Field

Request

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

Response

HTTP/1.1 200 OK
{
   "Item":{
      "AllowedValues":[

      ],
      "Classes":[
         "X509 Certificate"
      ],
      "ConfigAttribute":"{a80714f0-565c-4bc2-9026-787cf076d764}",
      "DN":"\\VED\\Metadata Root\\Hidden Object Name",
      "DefaultValues":[

      ],
      "ErrorMessage":"Error Message",
      "Guid":"{a80714f0-565c-4bc2-9026-787cf076d764}",
      "Help":"Help Text",
      "Label":"Cost Center",
      "Mandatory":true,
      "Name":"Hidden Object Name",
      "Policyable":true,
      "RegularExpression":"^[a-zA-Z0-9_\\.\\+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-\\.]+$",
      "RenderHidden":false,
      "RenderReadOnly":false,
      "Type":1
   },
   "Locked":false,
   "Result":0
}