10.0 Metadata APIs

WAS THIS PAGE HELPFUL? Leave Feedback

10.0 Metadata APIs

10.1 Query Metadata

Retrieve metadata files describing the REST services and the schema of the objects passed in the services. Two resources are provided:

  1. The Web Application Description Language (WADL) - WADL is a machine-readable XML description of HTTP-based web applications (typically REST web services). WADL models the resources provided by a service and the relationships between them. It is platform and language independent and aims to promote reuse of applications beyond the basic use in a web browser.
  2. The XML Schema (XSD) - XSD is a description of a type of XML document, typically expressed in terms of constraints on the structure and content of documents of that type, above and beyond the basic syntactical constraints imposed by XML.

The WADL file returns an XML document describing all services available in the Foundation REST services. The XSD file returns the schema definitions for all data transfer objects passed in the REST services.

10.1.1 Method: GET WADL Metadata

GET /api/meta/wadl

10.1.2 Method: GET XSD Schema Metadata

GET /api/meta/xsd