You know your JDBC connection information.
Your IDMS database has a defined SQL schema and the SQL is set up to use virtual foreign keys. The schema calls and uses the virtual foreign keys that are available in the database.
For more information about how to define a SQL schema for access to network data, see the CA IDMS Reference documentation.
You have installed the version of IDMS that 
Layer7 Live API Creator
 supports.
For more information about the versions of IDMS that 
Layer7 Live API Creator
 supports, see Installation Requirements and Supported Platforms.

(If you have not created your API yet) When you create your API.
For more information about how to create an API, see Creating APIs.
(If you have an existing API) By adding a connection to an IDMS data source.
For more information about how to add a connection to a data source, see Database Connectivity.

In API Creator, on the APIs page, click 
Create New API
.
The connection wizard opens.
Click 
Database First
.
The second step in the wizard appears.
Select 
CA IDMS
 as the data source type.
The third step in the wizard appears.
Complete the 
Host [optional Port]
 and 
Password
 fields, including the following fields, and then click 
Continue
:
Dictionary
 
Enter the name of the dictionary. 
Example:
 APPLDICT
Schema
 
The database-dependent name that points to your schema on the IDMS server.
Example:
 MYSCHEMA
Case Sensitive:
 Lowercase is equivalent to uppercase. For example, foo, Foo, and FOO are all equivalent and are converted to uppercase (FOO). If the value uses mixed case, enclose the name in double quotes ("), for example "Foo". You can enclose the value with the correct case and unusual characters using double-quotes (").
Username
 
The user name under which you access your database. You database administrator (DBA) assigns you a user name.
Example:
 DBADMIN
Case Sensitive:
 Lowercase is equivalent to uppercase. For example, foo, Foo, and FOO are all equivalent and are converted to uppercase (FOO). If the value uses mixed case, enclose the name in double quotes ("), for example "Foo". You can enclose the value with the correct case and unusual characters using double-quotes (").

<prefix>:myProcedure
<prefix>:myFunction

About how to test stored procedures and database functions using the REST Lab, see Test your API Using the REST Lab.
About how to call stored procedures using a POST call, see Manage Stored Procedures.

SELECT CAST(0 AS SMALLINT) AS SCOPE, 
  RTRIM(COLUMN_NAME) AS COLUMN_NAME, 
  DATA_TYPE, 
  RTRIM(TYPE_NAME) AS TYPE_NAME, 
  CAST(PRECISION AS INTEGER) AS COLUMN_SIZE,
  CAST(LENGTH AS INTEGER) AS BUFFER_LENGTH, 
  CAST(SCALE AS SMALLINT) AS DECIMAL_DIGITS, 
  CAST(1 AS SMALLINT) AS PSEUDO_COLUMN 
FROM @{SCHEMA}.MY_TABLE_PROC 
WHERE @{WHERE}
ORDER BY @{ORDER}

The JDBC driver for IDMS exposes the IDMS network database as tables and columns. For best results, expose primary keys and foreign keys by initializing the network database.
For more information about how to initialize network databases, see the CA IDMS Reference documentation.
When you insert a row into a child table, you must pass the parent ROWIDs into the virtual foreign key values.
Varying fields might not appear in lists of columns.
When your API is connected to an IDMS data source, you can use non-persistent attributes (NPAs) only in the following rules:
formula, parent copy, validation, commit validation, event, early event, commit event, pre-insert event, and managed parent
For more information about how to use NPAs in rules, see Manage Non-Persistent Attributes.
You cannot add comments (for example, using the –, /*, or // symbols) to the SQL for Free SQL resources.