Model file syntax

The driver employs a Model file to map JSON responses to the relational model. Although the primary purpose of the Model file is to define endpoint and table mapping, it is also capable of configuring a number of driver behaviors, such as paging, custom authentication, and HTTP response code processing. This reference describes the syntax used to configure the features and functionality supported by the Model file.

The Model file is a simple text file that uses the file_name.rest naming convention. To configure the file, you will need to populate its contents. You can do this using a text editor or by generating a file using the Configuration Manager. For more information on using the Autonomous REST Composer to generate a Model file, see Generating a Model file with the Autonomous REST Composer.

The following is the basic structure of the Model file:

1 {
2    "#http":[<http_response_codes>],
3    
4    "#<oauth2_param>":"<oauth2_value>", 
5    
6    "#authentication":[<custom_auth>], 
7    "#reauthentication":[<custom_auth>],
8    
9    "<table_name1>":"<table_definition1>",
10   "<table_name2>":"<table_definition2>",
11   "<table_name3>":"<table_definition3>"
12 
13   "routines":["<function_definition1>", 
14               "<function_definition2>", 
15               "<function_definition3>"
16   ] 
17 }