REST API: SQL Primary Keys

Obtain a list of primary key columns associated with the data source. The SQL Primary Keys service implements the CA IDMS Server JDBC API method getPrimaryKeys within the class IdmsDatabaseMetaData.
HTTP Method and URI Path
The URI path has the following format:
GET
<base url>
/sql/primaryKeys/
<datasource>
?
<query parameters>
Where:
  • <base URL>
    Specifies the base URL address for the CA IDMS REST API service
  • <datasource>
    (required) Identifies the CA IDMS system where the API request is to be sent and is defined in the datasources.yml file
  • <query parameters>
    • schema --
      Identifies the name of the schema. If schema is not specified, the default schema is used (if one exists). This parameter is case-sensitive and must match the schema name exactly.
    • table --
      (required) Identifies the name of the table. This parameter is case-sensitive and must match the table name exactly.
Example:
Returns all primary
key columns that match the table and schema filter
https://zoshost.domain.com:10010/api/v1/sql/primaryKeys/SYSDEMO?schema=REL&table=ORG
Response:
{ "primaryKeys": [ { "tableCatalog": null, "tableSchema": "REL", "tableName": "ORG", "columnName": "EMP_ID", "keySequence": 3, "primaryKeyName": "ORG1" }, { "tableCatalog": null, "tableSchema": "REL", "tableName": "ORG", "columnName": "MGR_ID", "keySequence": 1, "primaryKeyName": "ORG1" }, { "tableCatalog": null, "tableSchema": "REL", "tableName": "ORG", "columnName": "START_DATE", "keySequence": 2, "primaryKeyName": "ORG1" } ], "errors": [] }