POST Metadata/GetItems

Important! This page is no longer supported or being updated. It is left here for reference purposes. We encourage you to find corresponding information in our new API Reference documentation.

Returns an array the Custom Field attributes that apply to the specified object.

Requirements

Permissions: The caller must have View permission to the Distinguished Name (DN) of a certificate or device in the request.
Token scope: Any valid scope, such as Agent, Certificate, or SSH

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
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
Name	Description
Items	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 DN metadata

Request

POST https://tpp.venafi.example/vedsdk/Metadata/GetItems
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "DN":"\\VED\\Policy\\Certificates\\agent-pem-used-by-apache-3",
   "All":"true"
}

Response

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

         ],
         "Classes":[
            "X509 Certificate"
         ],
         "ConfigAttribute":"{69e06441-f8e8-482d-8a86-884f03c03d1b}",
         "DN":"\\VED\\Metadata Root\\MetaDataObject_110916001158115",
         "DefaultValues":[

         ],
         "ErrorMessage":"Value entered is not a valid Cost Center",
         "Guid":"{69e06441-f8e8-482d-8a86-884f03c03d1b}",
         "Help":"Cost Center is comprised of 3 letters followed by 3 numbers",
         "Label":"Cost Center 9596",
         "Name":"MetaDataObject_110916001158115",
         "Policyable":true,
         "RegularExpression":"[A-Za-z]{3}[0-9]{3}",
         "RenderHidden":false,
         "RenderReadOnly":false,
         "Type":1
      },
      {
         "AllowedValues":[

         ],
         "Classes":[
            "X509 Certificate",
            "Policy",
            "Device"
         ],
         "ConfigAttribute":"{c1ee77a0-21aa-419a-8022-5cd625b6cf82}",
         "DN":"\\VED\\Metadata Root\\MetaDataObject_11111600110827",
         "DefaultValues":[

         ],
         "Guid":"{c1ee77a0-21aa-419a-8022-5cd625b6cf82}",
         "Label":"MetaDataTest 11111600110827",
         "Name":"MetaDataObject_11111600110827",
         "Policyable":false,
         "RenderHidden":false,
         "RenderReadOnly":false,
         "Type":1
      },
      {
         "AllowedValues":[

         ],
         "Classes":[
            "X509 Certificate",
            "Policy",
            "Device"
         ],
         "ConfigAttribute":"{b841f258-1716-4d5e-a955-600a5ad7f0ef}",
         "DN":"\\VED\\Metadata Root\\MetaDataObject_111116191129592",
         "DefaultValues":[

         ],
         "Guid":"{b841f258-1716-4d5e-a955-600a5ad7f0ef}",
         "Label":"MetaDataTest 111116191129592",
         "Name":"MetaDataObject_111116191129592",
         "Policyable":false,
         "RenderHidden":false,
         "RenderReadOnly":false,
         "Type":1
      },
      {
         "AllowedValues":[

         ],
         "Classes":[
            "X509 Certificate"
         ],
         "ConfigAttribute":"{1e5e623e-06f6-4c2a-8129-04f7c5c99f6a}",
         "DN":"\\VED\\Metadata Root\\4c002215-a1e0-45aa-8cfb-f4093bd611c2",
         "DefaultValues":[

         ],
         "ErrorMessage":"",
         "Guid":"{1e5e623e-06f6-4c2a-8129-04f7c5c99f6a}",
         "Label":"dd",
         "Name":"4c002215-a1e0-45aa-8cfb-f4093bd611c2",
         "Policyable":false,
         "RegularExpression":"",
         "RenderHidden":false,
         "RenderReadOnly":false,
         "Type":1
      },
      {
         "AllowedValues":[

         ],
         "Classes":[
            "X509 Certificate",
            "Device"
         ],
         "ConfigAttribute":"{741e3b8c-cac5-4c8b-b5cf-ecd1d073f847}",
         "DN":"\\VED\\Metadata Root\\db0355d5-5756-436e-8673-7b1f970bf1e4",
         "DefaultValues":[

         ],
         "Guid":"{741e3b8c-cac5-4c8b-b5cf-ecd1d073f847}",
         "Label":"log_custom_filed",
         "Name":"db0355d5-5756-436e-8673-7b1f970bf1e4",
         "Policyable":false,
         "RenderHidden":false,
         "RenderReadOnly":false,
         "Type":1
      },
      {
         "AllowedValues":[

         ],
         "Classes":[
            "X509 Certificate"
         ],
         "ConfigAttribute":"{c4448f3a-20d3-45d7-8698-5008da918fba}",
         "DN":"\\VED\\Metadata Root\\961bf7a9-0dbc-4c0a-b28a-3af346b14ba3",
         "DefaultValues":[

         ],
         "Guid":"{c4448f3a-20d3-45d7-8698-5008da918fba}",
         "Label":"custom",
         "Name":"961bf7a9-0dbc-4c0a-b28a-3af346b14ba3",
         "Policyable":false,
         "RenderHidden":false,
         "RenderReadOnly":false,
         "Type":1
      },
      {
         "AllowedValues":[

         ],
         "Classes":[
            "X509 Certificate"
         ],
         "ConfigAttribute":"{4dea408d-af11-4061-a9d6-d233db421bca}",
         "DN":"\\VED\\Metadata Root\\21bcc8bf-184f-4b41-a342-43d12ffd6277",
         "DefaultValues":[

         ],
         "Guid":"{4dea408d-af11-4061-a9d6-d233db421bca}",
         "Label":"Server Names",
         "Name":"21bcc8bf-184f-4b41-a342-43d12ffd6277",
         "Policyable":false,
         "RenderHidden":false,
         "RenderReadOnly":false,
         "Type":1
      }
   ],
   "Locked":false,
   "Result":0
}