GetSchema Method

Retrieves the schema for a service.

Syntax

odata.getSchema([callback])

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for this method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This method will retrieve the schema (metadata document) of the service specified by ServiceRootURI.

Upon successful retrieval of the schema, you can set SchemaEntityIndex to retrieve the names of the entities contained within the schema along with their keys, properties, and navigation properties.

If you wish to retrieve additional details about the schema, they can be retrieved via XPath.