Access Metadata

Use the GET operation with the following URI to list the metadata catalog:

  • Core API: https://<instance_name>.etadirect.com/rest/ofscCore/v1/metadata-catalog
  • Metadata API: https://<instance_name>.etadirect.com/rest/ofscMetadata/v1/metadata-catalog

Requesting the metadata catalog returns the list of resources, both standard and custom objects, for example:


{
    "items": [
        {
            "name": "activities",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscCore/v1/metadata-catalog/activities"
                },
                {
                    "rel": "describes",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscCore/v1/metadata-catalog/activities",
                    "mediaType": "application/schema+json"
                }
            ]
        },
        {
            "name": "resources",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscCore/v1/metadata-catalog/resources"
                },
                {
                    "rel": "describes",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscCore/v1/metadata-catalog/resources",
                    "mediaType": "application/schema+json"
                }
            ]
        },
        {
            "name": "users",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscCore/v1/metadata-catalog/users"
                },
                {
                    "rel": "describes",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscCore/v1/metadata-catalog/users",
                    "mediaType": "application/schema+json"
                }
            ]
        },
        {
            "name": "inventories",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscCore/v1/metadata-catalog/inventories"
                },
                {
                    "rel": "describes",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscCore/v1/metadata-catalog/inventories",
                    "mediaType": "application/schema+json"
                }
            ]
        },
        {
            "name": "folders",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscCore/v1/metadata-catalog/folders"
                },
                {
                    "rel": "describes",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscCore/v1/metadata-catalog/folders",
                    "mediaType": "application/schema+json"
                }
            ]
        },
        {
            "name": "events",
            "links": [
                {
                    "rel": "canonical",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscCore/v1/metadata-catalog/events"
                },
                {
                    "rel": "describes",
                    "href": "https://<instance_name>.etadirect.com/rest/ofscCore/v1/metadata-catalog/events",
                    "mediaType": "application/schema+json"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "canonical",
            "href": "https://<instance_name>.etadirect.com/rest/ofscCore/v1/metadata-catalog"
        }
    ]
}

Retrieving Metadata for a Particular Resource

To retrieve metadata for a resource, use a GET request against its metadata-catalog resource with the following header:

Header Value

Accept

application/schema+json

For example, a GET request against activities with the following syntax and an Accept header:

https://<instance_name>.etadirect.com/rest/ofscCore/v1/metadata-catalog/activities

returns the following metadata about the activities resource:

{
    "name": "activities",
    "allOf": [
        {
            "$ref": "#/definitions/activity"
        }
    ],
    "definitions": {
        "activities": {
            "type": "object",
            "title": "Activities",
            "description": "Collection of activities",
            "allOf": [
                {
                    "properties": {
                        "items": {
                            "type": "array",
                            "title": "Items",
                            "description": "Items",
                            "items": {
                                "$ref": "#/definitions/activity"
                            }
                        }
                    }
                },
                
...
]