Interface APIMetadata

API Metadata object is used to describe both apiDataset and apiObject.

Deprecated

use apiMetadata

interface APIMetadata {
    fields: apiField[];
    navigation?: object;
    urls: MetadataUrls;
}

Index

Properties

fields navigation? urls

Properties

fields

fields: apiField[]

Field definitions describing the apiObject

Type Declaration

key: string
value: MetadataField

`Optional`navigation

navigation?: object

Navigation structure for the website.

urls

urls: MetadataUrls

URL relevant to the current object

Type Declaration

These URLs are related to the current object.

Optionalnew?: string

The URL to use to create a new object.

When not specified the value of self is used.
self: string

The URL to the current object.
Optionalsub_models?: object

Urls to any sub-models this object has where key is unique value and url is the value.