Retrieve Object Metadata
Retrieve all metadata configured on a standard or custom Vault Object.
GET
/api/{version}/metadata/vobjects/{object_name}Headers
Section link for Headers| Name | Description |
|---|---|
Accept | application/json (default) or application/xml |
URI Path Parameters
Section link for URI Path Parameters| Name | Description |
|---|---|
{object_name} | The object name__v field value (product__v, country__v, custom_object__c, etc.). |
Query Parameters
Section link for Query Parameters| Name | Description |
|---|---|
loc | To retrieve localized (translated) strings, include the parameter loc=true. See the next request below for details. |
The response includes all metadata configured on the object.
Request
Section link for Requestcurl -X GET -H "Authorization: {SESSION_ID}" \
https://myvault.veevavault.com/api/v17.1/metadata/vobjects/product__vResponse
Section link for Response{
"responseStatus": "SUCCESS",
"object": {
"available_lifecycles": [],
"label_plural": "Products",
"help_content": null,
"prefix": "00P",
"in_menu": true,
"description": null,
"label": "Product",
"source": "standard",
"modified_date": "2015-07-30T20:55:16.000Z",
"created_by": 1,
"allow_attachments": false,
"dynamic_security": false,
"relationships": [
{
"relationship_name": "user_role_setup__cr",
"relationship_label": "User Role Setup",
"field": "product__c",
"relationship_type": "reference_inbound",
"relationship_deletion": "block",
"object": {
"url": "/api/v17.1/metadata/vobjects/user_role_setup__v",
"label": "User Role Setup",
"name": "user_role_setup__v",
"label_plural": "User Role Setup",
"prefix": "0MY"
}
}
],
"urls": {
"field": "/api/v17.1/metadata/vobjects/product__v/fields/{name}",
"record": "/api/v17.1/vobjects/product__v/{id}",
"list": "/api/v17.1/vobjects/product__v",
"metadata": "/api/v17.1/metadata/vobjects/product__v"
},
"role_overrides": false,
"auditable": true,
"name": "product__v",
"modified_by": 1,
"created_date": "2015-07-30T20:55:16.000Z",
"system_managed": false,
"fields": [
{
"help_content": null,
"editable": false,
"lookup_relationship_name": null,
"label": "ID",
"source": "standard",
"type": "ID",
"modified_date": "2015-07-30T20:55:16.000Z",
"created_by": 1,
"required": false,
"name": "id",
"list_column": false,
"modified_by": 1,
"created_date": "2015-07-30T20:55:16.000Z",
"lookup_source_field": null,
"status": [
"active__v"
],
"order": 0
},
{
"help_content": null,
"editable": true,
"lookup_relationship_name": null,
"start_number": null,
"label": "Product Name",
"source": "standard",
"type": "String",
"modified_date": "2015-07-30T20:55:16.000Z",
"created_by": 1,
"required": true,
"system_managed_name": false,
"value_format": null,
"unique": true,
"name": "name__v",
"list_column": true,
"modified_by": 1,
"created_date": "2015-07-30T20:55:16.000Z",
"lookup_source_field": null,
"status": [
"active__v"
],
"max_length": 128,
"order": 1
},
{
"help_content": null,
"multi_value": false,
"editable": true,
"lookup_relationship_name": null,
"picklist": "default_status__v",
"label": "Status",
"source": "standard",
"type": "Picklist",
"modified_date": "2015-07-30T20:55:16.000Z",
"created_by": 1,
"required": true,
"unique": false,
"name": "status__v",
"list_column": false,
"modified_by": 1,
"created_date": "2015-07-30T20:55:16.000Z",
"lookup_source_field": null,
"status": [
"active__v"
],
"order": 2
},
{
"help_content": null,
"editable": true,
"lookup_relationship_name": null,
"label": "Product Abbreviation",
"source": "sample",
"type": "String",
"modified_date": "2015-07-30T20:55:16.000Z",
"created_by": 1,
"required": false,
"unique": false,
"name": "abbreviation__c",
"list_column": true,
"modified_by": 1,
"created_date": "2015-07-30T20:55:16.000Z",
"lookup_source_field": null,
"status": [
"active__v"
],
"max_length": 10,
"order": 3
},
{
"help_content": null,
"editable": true,
"lookup_relationship_name": null,
"label": "Generic Name",
"source": "sample",
"type": "String",
"modified_date": "2015-07-30T20:55:16.000Z",
"created_by": 1,
"required": false,
"unique": false,
"name": "generic_name__c",
"list_column": true,
"modified_by": 1,
"created_date": "2015-07-30T20:55:16.000Z",
"lookup_source_field": null,
"status": [
"active__v"
],
"max_length": 100,
"order": 4
},
{
"help_content": null,
"editable": true,
"lookup_relationship_name": null,
"label": "Internal Name",
"source": "sample",
"type": "String",
"modified_date": "2015-07-30T20:55:16.000Z",
"created_by": 1,
"required": false,
"unique": false,
"name": "internal_name__c",
"list_column": false,
"modified_by": 1,
"created_date": "2015-07-30T20:55:16.000Z",
"lookup_source_field": null,
"status": [
"active__v"
],
"max_length": 100,
"order": 5
},
{
"help_content": null,
"editable": true,
"lookup_relationship_name": null,
"label": "Compound ID",
"source": "sample",
"type": "String",
"modified_date": "2015-07-30T20:55:16.000Z",
"created_by": 1,
"required": false,
"unique": false,
"name": "compound_id__c",
"list_column": false,
"modified_by": 1,
"created_date": "2015-07-30T20:55:16.000Z",
"lookup_source_field": null,
"status": [
"active__v"
],
"max_length": 100,
"order": 6
},
{
"help_content": null,
"editable": true,
"lookup_relationship_name": null,
"label": "INN",
"source": "sample",
"type": "String",
"modified_date": "2015-07-30T20:55:16.000Z",
"created_by": 1,
"required": false,
"unique": false,
"name": "inn__c",
"list_column": false,
"modified_by": 1,
"created_date": "2015-07-30T20:55:16.000Z",
"lookup_source_field": null,
"status": [
"active__v"
],
"max_length": 100,
"order": 7
},
{
"help_content": null,
"multi_value": false,
"editable": true,
"lookup_relationship_name": null,
"picklist": "therapeutic_area__c",
"label": "Therapeutic Area",
"source": "sample",
"type": "Picklist",
"modified_date": "2015-07-30T20:55:16.000Z",
"created_by": 1,
"required": false,
"unique": false,
"name": "therapeutic_area__c",
"list_column": true,
"modified_by": 1,
"created_date": "2015-07-30T20:55:16.000Z",
"lookup_source_field": null,
"status": [
"active__v"
],
"order": 8
},
{
"help_content": null,
"multi_value": true,
"editable": true,
"lookup_relationship_name": null,
"picklist": "product_family__c",
"label": "Product Family",
"source": "sample",
"type": "Picklist",
"modified_date": "2015-07-30T20:55:16.000Z",
"created_by": 1,
"required": false,
"unique": false,
"name": "product_family__c",
"list_column": true,
"modified_by": 1,
"created_date": "2015-07-30T20:55:16.000Z",
"lookup_source_field": null,
"status": [
"active__v"
],
"order": 9
},
{
"help_content": null,
"editable": true,
"lookup_relationship_name": null,
"label": "External ID",
"source": "standard",
"type": "String",
"modified_date": "2015-07-30T20:55:16.000Z",
"created_by": 1,
"required": false,
"unique": true,
"name": "external_id__v",
"list_column": false,
"modified_by": 1,
"created_date": "2015-07-30T20:55:16.000Z",
"lookup_source_field": null,
"status": [
"active__v"
],
"max_length": 50,
"order": 10
},
{
"help_content": null,
"editable": false,
"lookup_relationship_name": null,
"label": "Created By",
"source": "standard",
"type": "Object",
"modified_date": "2015-07-30T20:55:16.000Z",
"created_by": 1,
"required": false,
"relationship_type": "reference",
"unique": false,
"name": "created_by__v",
"list_column": false,
"modified_by": 1,
"created_date": "2015-07-30T20:55:16.000Z",
"lookup_source_field": null,
"status": [
"active__v"
],
"object": {
"name": "users"
},
"order": 11
},
{
"help_content": null,
"editable": false,
"lookup_relationship_name": null,
"label": "Created Date",
"source": "standard",
"type": "DateTime",
"modified_date": "2015-07-30T20:55:16.000Z",
"created_by": 1,
"required": false,
"name": "created_date__v",
"list_column": false,
"modified_by": 1,
"created_date": "2015-07-30T20:55:16.000Z",
"lookup_source_field": null,
"status": [
"active__v"
],
"order": 12
},
{
"help_content": null,
"editable": false,
"lookup_relationship_name": null,
"label": "Last Modified By",
"source": "standard",
"type": "Object",
"modified_date": "2015-07-30T20:55:16.000Z",
"created_by": 1,
"required": false,
"relationship_type": "reference",
"unique": false,
"name": "modified_by__v",
"list_column": false,
"modified_by": 1,
"created_date": "2015-07-30T20:55:16.000Z",
"lookup_source_field": null,
"status": [
"active__v"
],
"object": {
"name": "users"
},
"order": 13
},
{
"help_content": null,
"editable": false,
"lookup_relationship_name": null,
"label": "Last Modified Date",
"source": "standard",
"type": "DateTime",
"modified_date": "2015-07-30T20:55:16.000Z",
"created_by": 1,
"required": false,
"name": "modified_date__v",
"list_column": false,
"modified_by": 1,
"created_date": "2015-07-30T20:55:16.000Z",
"lookup_source_field": null,
"status": [
"active__v"
],
"order": 14
}
],
"object_class": "base",
"status": [
"active__v"
],
"order": 1
}
}