SchemaKeys Property

The keys of a schema entity.

Syntax

 odata.getSchemaKeys(index, [callback])

Default Value

"0"

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 the getSchemaKeys([callback]) method is defined as:

function(err, data){ }

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

'data' is the value returned by the method.

The callback for the setSchemaKeys([callback]) 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 property is used to obtain the key(s) contained within an entity of a service schema and is populated after setting SchemaEntityIndex.

Note: A Key value maps to a property of the entity, details of which can be retrieved via SchemaProperty.

This property is read-only and not available at design time.

Data Type

String