Package com.veeva.vault.sdk.api.data

Interface ObjectMetadataService

All Superinterfaces:

Service

public interface ObjectMetadataService
extends Service

Provides methods to retrieve object and object-field metadata.

Method Summary

Modifier and Type	Method	Description
ObjectField	getField(ObjectFieldRequest request)	Deprecated. as of 23R1.3, replaced by getObjectFieldMetadataCollection(ObjectFieldMetadataCollectionRequest)
ObjectFieldCollectionResponse	getFields(ObjectFieldCollectionRequest request)	Deprecated. as of 23R1.3, replaced by getObjectFieldMetadataCollection(ObjectFieldMetadataCollectionRequest)
ObjectMetadata	getObject(ObjectMetadataRequest request)	Retrieves a single ObjectMetadata.
ObjectFieldMetadataCollectionResponse	getObjectFieldMetadataCollection(ObjectFieldMetadataCollectionRequest request)	Retrieves multiple ObjectFieldMetadata.
ObjectPicklistDependencyResponse	getObjectPicklistDependencies(ObjectPicklistDependencyRequest request)	Retrieves multiple ObjectPicklistDependency.
ObjectTypeFieldMetadataCollectionResponse	getObjectTypeFields(ObjectTypeFieldMetadataCollectionRequest request)	Retrieves multiple ObjectTypeFieldMetadata.
ObjectTypeMetadataCollectionResponse	getObjectTypes(ObjectTypeMetadataCollectionRequest request)	Retrieves multiple ObjectTypeMetadata.
ObjectTypeValidationRuleMetadataResponse	getObjectTypeValidationRules(ObjectTypeValidationRuleMetadataRequest request)	Retrieves multiple ObjectTypeValidationRuleMetadata.
ObjectValidationRuleMetadataResponse	getObjectValidationRules(ObjectValidationRuleMetadataRequest request)	Retrieves multiple ObjectValidationRuleMetadata.
ObjectFieldCollectionRequest.Builder	newFieldCollectionRequestBuilder()	Deprecated. as of 23R1.3, replaced by newFieldCollectionRequestBuilder()
ObjectFieldRequest.Builder	newFieldRequestBuilder()	Deprecated. as of 23R1.3, replaced by newFieldCollectionRequestBuilder()
ObjectFieldMetadataCollectionRequest.Builder	newObjectFieldMetadataCollectionRequestBuilder()	Creates an ObjectFieldMetadataCollectionRequest.Builder.
ObjectPicklistDependencyRequest.Builder	newObjectPicklistDependencyRequestBuilder()	Creates an ObjectPicklistDependencyRequest.Builder.
ObjectMetadataRequest.Builder	newObjectRequestBuilder()	Creates an ObjectMetadataRequest.Builder.
ObjectTypeFieldMetadataCollectionRequest.Builder	newObjectTypeFieldMetadataCollectionRequestBuilder()	Creates an ObjectTypeFieldMetadataCollectionRequest.Builder.
ObjectTypeMetadataCollectionRequest.Builder	newObjectTypeMetadataCollectionRequestBuilder()	Creates an ObjectTypeMetadataCollectionRequest.Builder.
ObjectTypeValidationRuleMetadataRequest.Builder	newObjectTypeValidationRuleMetadataRequestBuilder()	Creates an ObjectTypeValidationRuleMetadataRequest.Builder.
ObjectValidationRuleMetadataRequest.Builder	newObjectValidationRuleMetadataRequestBuilder()	Creates an ObjectValidationRuleMetadataRequest.Builder.

Method Details

newObjectRequestBuilder

ObjectMetadataRequest.Builder newObjectRequestBuilder()

Creates an ObjectMetadataRequest.Builder.

Returns:

an ObjectMetadataRequest.Builder

getObject

ObjectMetadata getObject(ObjectMetadataRequest request)

Retrieves a single ObjectMetadata.

Parameters:

request - the ObjectMetadataRequest containing the information needed to retrieve the object metadata. Cannot be null or empty.

Returns:

a ObjectMetadata containing the metadata of the requested object

newFieldRequestBuilder

ObjectFieldRequest.Builder newFieldRequestBuilder()

Deprecated.

as of 23R1.3, replaced by newFieldCollectionRequestBuilder()

Creates an ObjectFieldRequest.Builder.

Returns:

an ObjectFieldRequest.Builder

getField

ObjectField getField(ObjectFieldRequest request)

Deprecated.

as of 23R1.3, replaced by getObjectFieldMetadataCollection(ObjectFieldMetadataCollectionRequest)

Retrieves a single ObjectField.

Parameters:

request - the ObjectFieldRequest containing the information needed to fetch the field metadata. Cannot be null or empty.

Returns:

a ObjectField containing the metadata of the requested field

newFieldCollectionRequestBuilder

ObjectFieldCollectionRequest.Builder newFieldCollectionRequestBuilder()

Deprecated.

as of 23R1.3, replaced by newFieldCollectionRequestBuilder()

Creates an ObjectFieldCollectionRequest.Builder.

Returns:

an ObjectFieldCollectionRequest.Builder

getFields

ObjectFieldCollectionResponse getFields(ObjectFieldCollectionRequest request)

Deprecated.

as of 23R1.3, replaced by getObjectFieldMetadataCollection(ObjectFieldMetadataCollectionRequest)

Retrieves multiple ObjectField.

Parameters:

request - the ObjectFieldCollectionRequest containing the information needed to fetch the bulk ObjectField. Cannot be null or empty.

Returns:

a List of ObjectField containing the metadata of the requested fields

newObjectFieldMetadataCollectionRequestBuilder

ObjectFieldMetadataCollectionRequest.Builder newObjectFieldMetadataCollectionRequestBuilder()

Creates an ObjectFieldMetadataCollectionRequest.Builder.

Returns:

an ObjectFieldMetadataCollectionRequest.Builder

getObjectFieldMetadataCollection

ObjectFieldMetadataCollectionResponse getObjectFieldMetadataCollection(ObjectFieldMetadataCollectionRequest request)

Retrieves multiple ObjectFieldMetadata.

Parameters:

request - the ObjectFieldMetadataCollectionRequest containing the information needed to fetch the bulk ObjectFieldMetadata. Cannot be null or empty.

Returns:

a List of ObjectFieldMetadata containing the metadata of the requested fields

getObjectTypes

ObjectTypeMetadataCollectionResponse getObjectTypes(ObjectTypeMetadataCollectionRequest request)

Retrieves multiple ObjectTypeMetadata.

If the authenticated user has Admin: Configuration: Objects: Read permission or Application: API: Metadata API permission, returns all object types. Otherwise, Vault checks individual object and object type permissions and returns only object types on which the authenticated user has Read permission.

Parameters:

request - the ObjectTypeMetadataCollectionRequest containing the information needed to fetch the bulk ObjectTypeMetadata. Cannot be null or empty.

Returns:

a List of ObjectTypeMetadata containing the metadata of the requested object types

newObjectTypeMetadataCollectionRequestBuilder

ObjectTypeMetadataCollectionRequest.Builder newObjectTypeMetadataCollectionRequestBuilder()

Creates an ObjectTypeMetadataCollectionRequest.Builder.

Returns:

an ObjectTypeMetadataCollectionRequest.Builder

getObjectTypeFields

ObjectTypeFieldMetadataCollectionResponse getObjectTypeFields(ObjectTypeFieldMetadataCollectionRequest request)

Retrieves multiple ObjectTypeFieldMetadata.

Parameters:

request - the ObjectTypeFieldMetadataCollectionRequest containing the information needed to fetch the bulk ObjectTypeFieldMetadata. Cannot be null or empty.

Returns:

a List of ObjectTypeFieldMetadata containing the metadata of the requested object type fields

newObjectTypeFieldMetadataCollectionRequestBuilder

ObjectTypeFieldMetadataCollectionRequest.Builder newObjectTypeFieldMetadataCollectionRequestBuilder()

Creates an ObjectTypeFieldMetadataCollectionRequest.Builder.

Returns:

an ObjectTypeFieldMetadataCollectionRequest.Builder

newObjectPicklistDependencyRequestBuilder

ObjectPicklistDependencyRequest.Builder newObjectPicklistDependencyRequestBuilder()

Creates an ObjectPicklistDependencyRequest.Builder.

Returns:

an ObjectPicklistDependencyRequest.Builder

getObjectPicklistDependencies

ObjectPicklistDependencyResponse getObjectPicklistDependencies(ObjectPicklistDependencyRequest request)

Retrieves multiple ObjectPicklistDependency.

Parameters:

request - the ObjectPicklistDependencyRequest containing the information needed to fetch the bulk ObjectPicklistDependency. Cannot be null or empty.

Returns:

a List of ObjectPicklistDependency containing the picklist dependencies of the requested object's picklist field

newObjectValidationRuleMetadataRequestBuilder

ObjectValidationRuleMetadataRequest.Builder newObjectValidationRuleMetadataRequestBuilder()

Creates an ObjectValidationRuleMetadataRequest.Builder.

Returns:

an ObjectValidationRuleMetadataRequest.Builder

newObjectTypeValidationRuleMetadataRequestBuilder

ObjectTypeValidationRuleMetadataRequest.Builder newObjectTypeValidationRuleMetadataRequestBuilder()

Creates an ObjectTypeValidationRuleMetadataRequest.Builder.

Returns:

an ObjectTypeValidationRuleMetadataRequest.Builder

getObjectValidationRules

ObjectValidationRuleMetadataResponse getObjectValidationRules(ObjectValidationRuleMetadataRequest request)

Retrieves multiple ObjectValidationRuleMetadata.

Parameters:

request - the ObjectValidationRuleMetadataResponse containing the information needed to retrieve the bulk ObjectValidationRuleMetadata. Cannot be null or empty.

Returns:

a List of ObjectValidationRuleMetadata containing the metadata of the requested object validation rules

getObjectTypeValidationRules

ObjectTypeValidationRuleMetadataResponse getObjectTypeValidationRules(ObjectTypeValidationRuleMetadataRequest request)

Retrieves multiple ObjectTypeValidationRuleMetadata.

Parameters:

request - the ObjectTypeValidationRuleMetadataResponse containing the information needed to retrieve the bulk ObjectTypeValidationRuleMetadata. Cannot be null or empty.

Returns:

a List of ObjectTypeValidationRuleMetadata containing the metadata of the requested object type validation rules