REST API

Use the IDMS REST API to manage and monitor your IDMS Databases. With the REST API, you can use modern development tools to maintain your IDMS applications and leverage your mainframe investment.
As part of the Broadcom CA Database modernization strategy, APIs play a role in transforming the mainframe for hybrid IT by making the mainframe a more integrated, agile platform. The IDMS REST API can extend database applications and can automate database application maintenance and administration.
The API also addresses a skills challenge. By providing a familiar and flexible way to interact with the traditional mainframe platform, the API can help ease new DBAs and developers into mainframe roles by allowing them to work with familiar tools and environments.
Click the PDF icon to download a PDF of Using the REST API.
For instructions about how to install the IDMS REST API, see Install the REST API.
2
REST API Architecture
The IDMS REST API is built on the representational state transfer (REST) architecture except for some services that are based on Remote Procedure Call (RPC) protocol.
Use Cases
The IDMS REST API can be used in the following ways, depending on your role:
  • Developer
    • Enable client dashboards or applications to view system and performance data
    • Obtain flexibility to leverage modern, user-friendly tooling to improve the user experience
  • Database Administrator
    • Enable automated warnings and recommendations, to avoid critical system risks and outages
    • Use the REST API to integrate with other tools and products
REST API Methods
In the RESTful architectural style, data and functionality are considered resources, which are represented and accessed by URIs. These resources can be manipulated by a set of well-defined operations: Create, Read, Update, and Delete. To perform these operations on the resources, your client program uses the following HTTP methods:
  • GET       
    Reads resources
  • POST     
    Creates resources
  • PUT     
    Updates resources
  • DELETE      
    Removes resources
The method that is used for each request depends on the action that you want to perform.
URL Structure
The URL addresses for the REST API operations have the following structure:
<protocol>
://
<hostname>
:
<port>
/api/v1/
<idms_endpoint>
Where:
  • <protocol>
    Specifies whether http or https is enabled. Values are: http, https
  • <hostname>
    Specifies the host or server name, or the domain name where the service is deployed and running
  • <port>
    Specifies the port number that is defined on the web server
  • <idms_endpoint>
    Specifies the IDMS API endpoint that you want to obtain
Example:
The following example represents an IDMS REST API URL:
https://zoshost.domain.com:10010/api/v1/system
API Mediation Layer
The API Mediation Layer provides access to all services for managing your z/OS environment through a single base URL. To access the services through the API Mediation Layer, the URL address for the CA IDMS REST API operations must use the HTTPS protocol: https://
<hostname>
:
<port>
/api/v1/
<service_id>
/
<idms_endpoint>
Where:
  • <hostname>
    Specifies the host or server name, or the domain name where the service is deployed and running
  • <port>
    Specifies the port number that is defined on the web server
  • <service_id>
    Specifies the ID of the service that is provided to the discovery service. The default is caidms.
  • <idms_endpoint>
    Specifies the IDMS API endpoint that you want to obtain
Example:
The following example represents an IDMS REST API URL used with the Mediation Layer.
https://zoshost.domain.com:10080/api/v1/caidms/systems
Authentication
REST API communication is secured through the HTTP or HTTPS protocol. The REST API server authenticates using the Basic authentication type and the mainframe user name and password.
Troubleshoot Errors
For errors that occur during request processing, an HTTP status code is returned to the calling client. An error is indicated by a 4
nn
code or a 5
nn
code. For example, Status: 400 Bad Request.
In addition, some errors might include a JSON object/response that contains a message that describes the error. Use this information to diagnose the error or provide it to support staff, if necessary.
The following messages might be generated:
  • 200: OK
  • 400: Bad Request
  • 401: Authorization is required
  • 403: Forbidden
  • 404: The job name is not found
  • 500: Internal server error
  • 503: IDMSINFO address space is not available
  • 507: Insufficient storage
Swagger Documentation
This section contains the detailed API documentation in JSON format.
alpha
{ "swagger": "2.0", "info": { "description": "The CA IDMS REST API provides a variety of services to monitor and manage your CA IDMS systems. Press **Authorize** and use your mainframe credentials", "version": "1.0.1", "title": "CA IDMS REST API" }, "host": "localhost:10080", "basePath": "/api/v1", "tags": [ { "name": "Compilers", "description": "API to execute compiler commands to manage IDMS dictionary components" }, { "name": "DC Log", "description": "REST API to get CA IDMS DC log messages and information" }, { "name": "DCMT", "description": "API to execute DCMT commands to manage IDMS system operations" }, { "name": "DCUF", "description": "API to execute DCUF SHOW commands to query user and system default settings" }, { "name": "Data Sources", "description": "REST API to return a list of defined data sources" }, { "name": "Performance Metrics", "description": "REST API to get performance metrics and statistics" }, { "name": "SQL", "description": "REST API to execute freeform SQL statements and database metadata functions" }, { "name": "System Statistics", "description": "REST API to return real-time statistics for the IDMS system" } ], "paths": { "/bufferFiles/{jobname}/{bufferName}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns a list of buffer files identified by buffer name", "description": "Returns details about I/O activity for each file assigned to the buffer", "operationId": "getBufferFilesUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "bufferName", "in": "path", "description": "IDMS buffer name", "required": true, "type": "string", "x-example": "TOOLBUFF" }, { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Buffer" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/buffers/{jobname}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns a list of buffers", "description": "Returns buffer statistics for each buffer defined to the IDMS system", "operationId": "getBufferIOSummaryUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Buffer" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/communicationLines/{jobname}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns a list of communication lines", "description": "Returns detailed information for each of the communication lines defined to the IDMS system", "operationId": "getCommunicationLinesUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/CommunicationLine" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/databaseOverview/{jobname}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns database overview information", "description": "Provides a summary of database information since the start of the IDMS system", "operationId": "getDatabaseOverviewUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/DatabaseOverview" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/datasources": { "get": { "tags": [ "Data Sources" ], "summary": "Returns a list of IDMS data sources", "description": "Returns a list of IDMS data sources defined in the 'datasources.yml' file", "operationId": "getDatasourcesUsingGET", "produces": [ "*/*" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Datasource" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error" } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/datasources/{datasource}": { "get": { "tags": [ "Data Sources" ], "summary": "Returns the specified IDMS data source", "description": "Returns the IDMS data source identified by the data source name", "operationId": "getDatasourceUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "datasource", "in": "path", "description": "IDMS datasource name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Datasource" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error" } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/dcmt/help/{datasource}": { "get": { "tags": [ "DCMT" ], "summary": "Executes a DCMT HELP command", "description": "Returns a description of available DCMT commands or information about a specifc command", "operationId": "getDcmtHelpUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "args", "in": "query", "description": "DCMT HELP command type", "required": false, "type": "string", "allowEmptyValue": false, "x-example": "TASK" }, { "name": "broadcast", "in": "query", "description": "Optional broadcast parameters", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskCommand" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/TaskCommand" } }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/dcmt/quiesce/{datasource}": { "post": { "tags": [ "DCMT" ], "summary": "Executes a DCMT QUIESCE command for one or more target areas", "description": "A quiesce point can be forced by specifying the IMMEDIATE option or specifying a wait interval with the FORCE option", "operationId": "postDcmtQuiesceUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "args", "in": "query", "description": "DCMT QUIESCE command arguments", "required": true, "type": "string", "allowEmptyValue": false, "x-example": "dbname empdemo id 1" }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskCommand" } }, "201": { "description": "Created" }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/TaskCommand" } }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/dcmt/shutdown/{datasource}": { "post": { "tags": [ "DCMT" ], "summary": "Executes a DCMT SHUTDOWN command", "description": "DCMT SHUTDOWN terminates the DC/UCF system in an orderly fashion. NOPROMPT must be specified, IMMEDIATE is optional", "operationId": "postDcmtShutdownUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "args", "in": "query", "description": "DCMT SHUTDOWN command arguments", "required": true, "type": "string", "allowEmptyValue": false }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "RESTRICTED" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskCommand" } }, "201": { "description": "Created" }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/TaskCommand" } }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/dcmt/statistics/{datasource}": { "post": { "tags": [ "DCMT" ], "summary": "Executes a DCMT WRITE STATISTICS command", "description": "Writes current system statistics, line statistics, and histograms to the IDMS log file", "operationId": "postDcmtStatisticsUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "args", "in": "query", "description": "DCMT WRITE STATISTICS command arguments", "required": false, "type": "string", "allowEmptyValue": false, "x-example": "ROLL" }, { "name": "broadcast", "in": "query", "description": "Optional broadcast parameters", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskCommand" } }, "201": { "description": "Created" }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/TaskCommand" } }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/dcmt/test/{datasource}": { "post": { "tags": [ "DCMT" ], "summary": "Executes a DCMT TEST command to sets test options", "description": "DCMT TEST is used to obtain diagnostic information for Technical Support personnel", "operationId": "postDcmtTestUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "args", "in": "query", "description": "DCMT TEST command arguments", "required": true, "type": "string", "allowEmptyValue": false }, { "name": "broadcast", "in": "query", "description": "Optional broadcast parameters", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskCommand" } }, "201": { "description": "Created" }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/TaskCommand" } }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/dcmt/{datasource}": { "get": { "tags": [ "DCMT" ], "summary": "Executes a DCMT DISPLAY command", "description": "Returns information about system resources or the attributes of a specifc system resource", "operationId": "getDcmtDisplayUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "args", "in": "query", "description": "DCMT Display command arguments", "required": true, "type": "string", "allowEmptyValue": false, "x-example": "task send" }, { "name": "broadcast", "in": "query", "description": "Optional broadcast parameters", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskCommand" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/TaskCommand" } }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false }, "put": { "tags": [ "DCMT" ], "summary": "Executes a DCMT VARY command", "description": "Modifies the state of the system or the attributes of system resource", "operationId": "putDcmtVaryUsingPUT", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "name": "args", "in": "query", "description": "DCMT Vary command arguments", "required": true, "type": "string", "allowEmptyValue": false, "x-example": "task send resource interval off" }, { "name": "broadcast", "in": "query", "description": "Optional broadcast parameters", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskCommand" } }, "201": { "description": "Created" }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/TaskCommand" } }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/dcuf/help/{datasource}": { "get": { "tags": [ "DCUF" ], "summary": "Executes a DCUF HELP command", "description": "Returns a description of available DCUF commands ", "operationId": "getDcufHelpUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskCommand" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/TaskCommand" } }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/dcuf/{datasource}": { "get": { "tags": [ "DCUF" ], "summary": "Executes a DCUF SHOW command", "description": "Gets information for the system, session, and user attributes", "operationId": "getDcufShowUsingGET", "produces": [ "*/*" ], "parameters": [ { "name": "args", "in": "query", "description": "DCUF SHOW command arguments", "required": true, "type": "string", "allowEmptyValue": false, "x-example": "profile" }, { "name": "broadcast", "in": "query", "description": "Optional broadcast parameters for DCUF SHOW USERS", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskCommand" } }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/TaskCommand" } }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not found" }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/idd/{datasource}": { "post": { "tags": [ "Compilers" ], "summary": "Executes IDMS IDD commands", "description": "Executes the IDMS integrated data dictionary compiler with the commands provided, supplied as a list of strings in the request body", "operationId": "postIddUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "commands", "description": "IDD commands", "required": true, "schema": { "$ref": "#/definitions/CompilerInput" } }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskCommand" } }, "201": { "description": "Created" }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/TaskCommand" } }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error" } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/journals/{jobname}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns a list of journals", "description": "Returns the current status of all journals for the IDMS system", "operationId": "getJournalsUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Journal" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/ocf/{datasource}": { "post": { "tags": [ "Compilers" ], "summary": "Executes IDMS OCF commands", "description": "Executes the IDMS online command facility with the commands provided, supplied as a list of strings in the request body", "operationId": "postOcfUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "commands", "description": "OCF commands", "required": true, "schema": { "$ref": "#/definitions/CompilerInput" } }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskCommand" } }, "201": { "description": "Created" }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/TaskCommand" } }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error" } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/printLog/{datasource}": { "get": { "tags": [ "DC Log" ], "summary": "Returns a log report", "description": "Returns a list of log messages based on the search criteria provided", "operationId": "getLogRecordsUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" }, { "name": "endTime", "in": "query", "description": "Return log messages at or before specified time \nFormat: 'YYYY-MM-DD HH:mm:ss[.SSSSSS]' \nExamples: '2019-08-22 09:20:00', '2019-10-09 10:15:56.524673'", "required": true, "type": "string", "x-example": "2020-01-22 09:20:00" }, { "name": "messageIdentifier", "in": "query", "description": "Return log messages that contain the specified identifier(s) \nExamples: 'LTE0001,LTVTM011', 'DCSYSTEM', 'SYSTE160'", "required": false, "type": "string", "x-example": "LTE0001" }, { "name": "messageType", "in": "query", "description": "Return log messages with the type(s) specified \n- 1 - #WTL text line\n- 2 - User trace text or physical I/O trace text\n- 3 - User binary trace entries\n- 4 - Snap or dump text\n- 5 - Snap or dump binary entries\n\nExamples: '1,2', '1,4,5', '2'\nDefault: '1,2,3,4,5'", "required": false, "type": "string", "x-example": "1,2" }, { "name": "searchText", "in": "query", "description": "Return log messages that contain the text specified \nExamples: 'DB001108', 'any_text_that_might_exist_in_the_message'", "required": false, "type": "string", "x-example": "DB001108" }, { "name": "startTime", "in": "query", "description": "Return log messages at or after specified time \nFormat: 'YYYY-MM-DD HH:mm:ss[.SSSSSS]' \nExamples: '2019-07-22 09:20:00', '2019-10-09 10:15:56.413076'", "required": true, "type": "string", "x-example": "2020-01-22 09:20:00" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/LogReport" } }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/programPools/{jobname}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns a list of program pools ", "description": "Returns detailed information for each program pool in use by the IDMS system ", "operationId": "getProgramPoolsUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProgramPool" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/schema/{datasource}": { "post": { "tags": [ "Compilers" ], "summary": "Executes IDMS SCHEMA commands", "description": "Executes the IDMS schema compiler with the commands provided, supplied as a list of strings in the request body", "operationId": "postSchemaUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "commands", "description": "SCHEMA commands", "required": true, "schema": { "$ref": "#/definitions/CompilerInput" } }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskCommand" } }, "201": { "description": "Created" }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/TaskCommand" } }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error" } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/scratchManagerOverview/{jobname}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns scratch manager overview information", "description": "Provides a summary about the scratch utilization since the start of the IDMS system", "operationId": "getScratchManagerOverviewUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ScratchManagerOverview" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/sql/columns/{datasource}": { "get": { "tags": [ "SQL" ], "summary": "Returns a list of columns", "description": "Returns a list of columns associated with the data source", "operationId": "getColumnsUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "catalog", "in": "query", "description": "Catalog name filter (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "columnPattern", "in": "query", "description": "Column filter pattern (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false, "x-example": "FISCAL_YEAR" }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" }, { "name": "schemaPattern", "in": "query", "description": "Schema filter pattern (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false, "x-example": "DEMO%" }, { "name": "tablePattern", "in": "query", "description": "Table filter pattern (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false, "x-example": "BENEFITS" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ColumnsResponse" } }, "400": { "description": "Bad request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error" } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/sql/execute/{datasource}": { "post": { "tags": [ "SQL" ], "summary": "Executes SQL statements", "description": "Executes SQL statements, supplied as a list of strings in the request body", "operationId": "postSqlUsingPOST", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" }, { "in": "body", "name": "sqlInput", "description": "SQL statements", "required": true, "schema": { "$ref": "#/definitions/SqlInput" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SqlStatementResponse" } }, "201": { "description": "Created" }, "400": { "description": "Bad request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error" } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/sql/exportedKeys/{datasource}": { "get": { "tags": [ "SQL" ], "summary": "Returns a list of exported keys", "description": "Returns a list of exported keys associated with the data source", "operationId": "getExportedKeysUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "catalog", "in": "query", "description": "Catalog name filter (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" }, { "name": "schema", "in": "query", "description": "Schema name filter (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false, "x-example": "DEMOEMPL" }, { "name": "table", "in": "query", "description": "Table name filter (case-sensitive)", "required": true, "type": "string", "allowEmptyValue": false, "x-example": "EMPLOYEE" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ExportedKeysResponse" } }, "400": { "description": "Bad request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error" } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/sql/importedKeys/{datasource}": { "get": { "tags": [ "SQL" ], "summary": "Returns a list of imported keys", "description": "Returns a list of imported keys associated with the data source", "operationId": "getImportedKeysUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "catalog", "in": "query", "description": "Catalog name filter (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" }, { "name": "schema", "in": "query", "description": "Schema name filter (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false, "x-example": "DEMOEMPL" }, { "name": "table", "in": "query", "description": "Table name filter (case-sensitive)", "required": true, "type": "string", "allowEmptyValue": false, "x-example": "EMPLOYEE" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ImportedKeysResponse" } }, "400": { "description": "Bad request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error" } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/sql/primaryKeys/{datasource}": { "get": { "tags": [ "SQL" ], "summary": "Returns a list of primary key columns", "description": "Returns a list of primary key columns associated with the data source", "operationId": "getPrimaryKeysUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "catalog", "in": "query", "description": "Catalog name filter (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" }, { "name": "schema", "in": "query", "description": "Schema name filter (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false, "x-example": "REL" }, { "name": "table", "in": "query", "description": "Table name filter (case-sensitive)", "required": true, "type": "string", "allowEmptyValue": false, "x-example": "ORG" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/PrimaryKeysResponse" } }, "400": { "description": "Bad request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error" } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/sql/procedureColumns/{datasource}": { "get": { "tags": [ "SQL" ], "summary": "Returns a list of procedure columns", "description": "Returns a list of procedure columns associated with the data source", "operationId": "getProcedureColumnsUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "catalog", "in": "query", "description": "Catalog name filter (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "columnPattern", "in": "query", "description": "Column filter pattern (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false, "x-example": "EMP%" }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" }, { "name": "procedurePattern", "in": "query", "description": "Procedure filter pattern (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false, "x-example": "IDMS%" }, { "name": "schemaPattern", "in": "query", "description": "Schema filter pattern (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false, "x-example": "DEMO%" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProcedureColumnsResponse" } }, "400": { "description": "Bad request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error" } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/sql/procedures/{datasource}": { "get": { "tags": [ "SQL" ], "summary": "Returns a list of procedures", "description": "Returns a list of procedures associated with the data source", "operationId": "getProceduresUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "catalog", "in": "query", "description": "Catalog name filter (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" }, { "name": "procedurePattern", "in": "query", "description": "Procedure filter pattern (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false, "x-example": "IDMS%" }, { "name": "schemaPattern", "in": "query", "description": "Schema filter pattern (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false, "x-example": "DEMO%" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/ProceduresResponse" } }, "400": { "description": "Bad request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error" } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/sql/schemas/{datasource}": { "get": { "tags": [ "SQL" ], "summary": "Returns a list of schemas", "description": "Returns a list of schemas associated with the data source", "operationId": "getSchemasUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "catalog", "in": "query", "description": "Catalog name filter (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" }, { "name": "schemaPattern", "in": "query", "description": "Schema filter pattern (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false, "x-example": "DEMO%" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SchemasResponse" } }, "400": { "description": "Bad request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error" } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/sql/tables/{datasource}": { "get": { "tags": [ "SQL" ], "summary": "Returns a list of tables", "description": "Returns a list of tables associated with the data source", "operationId": "getTablesUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "catalog", "in": "query", "description": "Catalog name filter (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false, "x-example": "null" }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" }, { "name": "schemaPattern", "in": "query", "description": "Schema filter pattern (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false, "x-example": "DEMOEMPL%" }, { "name": "tablePattern", "in": "query", "description": "Table filter pattern (case-sensitive)", "required": false, "type": "string", "allowEmptyValue": false, "x-example": "EMP%" }, { "name": "types", "in": "query", "description": "TABLE, VIEW, or other types supported by the database", "required": false, "type": "array", "items": { "type": "string" }, "collectionFormat": "multi", "allowEmptyValue": false } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TablesResponse" } }, "400": { "description": "Bad request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error" } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/sqlOverview/{jobname}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns SQL overview information", "description": "Provides a summary of SQL activity since the start of the IDMS system", "operationId": "getSqlOverviewUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SqlOverview" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/sqlTransactions/{jobname}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns a list of active SQL transactions", "description": "Returns information about active SQL transactions running on the IDMS system", "operationId": "getSqlTransactionsUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SqlTransaction" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/ssc/{datasource}": { "post": { "tags": [ "Compilers" ], "summary": "Executes IDMS SSC commands", "description": "Executes the IDMS subschema compiler with the commands provided, supplied as a list of strings in the request body", "operationId": "postSscUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "commands", "description": "SSC commands", "required": true, "schema": { "$ref": "#/definitions/CompilerInput" } }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskCommand" } }, "201": { "description": "Created" }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/TaskCommand" } }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error" } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/storagePoolOverview/{jobname}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns storage pool overview information", "description": "Provides summary storage pool information since the start of the IDMS system", "operationId": "getStoragePoolOverviewUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StoragePoolOverview" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/storagePools/{jobname}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns a list of storage pools", "description": "Returns detailed information for each storage pool in use by the IDMS system", "operationId": "getStoragePoolsUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/StoragePool" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/sysgen/{datasource}": { "post": { "tags": [ "Compilers" ], "summary": "Executes IDMS SYSGEN commands", "description": "Executes the IDMS system generation compiler with the commands provided, supplied as a list of strings in the request body", "operationId": "postSysgenUsingPOST", "consumes": [ "application/json" ], "produces": [ "*/*" ], "parameters": [ { "in": "body", "name": "commands", "description": "SYSGEN commands", "required": true, "schema": { "$ref": "#/definitions/CompilerInput" } }, { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskCommand" } }, "201": { "description": "Created" }, "400": { "description": "Bad request", "schema": { "$ref": "#/definitions/TaskCommand" } }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error" } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/systemRunUnits/{jobname}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns a list of pre-allocated run units", "description": "Returns a list of pre-allocated run units for an IDMS system, including dynamically allocated (overflow) run units", "operationId": "getSystemRunUnitUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SystemRunUnit" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/systemStatistics/{datasource}": { "get": { "tags": [ "System Statistics" ], "summary": "Returns IDMS system statistics", "description": "Returns real-time statistics for an IDMS system identified by the data source name", "operationId": "getSystemStatisticsUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "datasource", "in": "path", "description": "Data source name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SystemStatistics" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error" } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/systemTasks/{jobname}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns a list of active system tasks", "description": "Returns a list of active system tasks for the IDMS system", "operationId": "getSystemTasksUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SystemTask" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/systems": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns a list of all active IDMS systems", "description": "Returns a list of active IDMS systems running on an LPAR", "operationId": "getCVsUsingGET", "produces": [ "application/json" ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdmsSystem" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Forbidden" }, "404": { "description": "Not Found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/systems/{jobname}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns the active IDMS system", "description": "Returns the active IDMS system identified by the job name", "operationId": "getOneCVUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/IdmsSystem" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/taskProgramPoolOverview/{jobname}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns an overview of task activity and program pool usage", "description": "Provides a summary of task activity and program pool usage since the start of the IDMS system", "operationId": "getTaskPgmPoolOverviewUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TaskProgramPoolOverview" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/terminals/{jobname}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns a list of active logical terminals", "description": "Returns a list of active logical terminals for the IDMS system", "operationId": "getTerminalsUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Terminal" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/transactionOverview/{jobname}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns transaction overview information", "description": "Provides a summary of transactions and external request units since the start of the IDMS system", "operationId": "getTransactionOverviewUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/TransactionOverview" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/transactions/{jobname}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns a list of active transaction statistics", "description": "Returns statistics about the active transactions running on the IDMS system", "operationId": "getTransactionsUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/Transaction" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } }, "/userTasks/{jobname}": { "get": { "tags": [ "Performance Metrics" ], "summary": "Returns a list of active user tasks", "description": "Returns a list of active user tasks for the IDMS system", "operationId": "getUserTasksUsingGET", "produces": [ "application/json" ], "parameters": [ { "name": "jobname", "in": "path", "description": "IDMS system job name", "required": true, "type": "string", "x-example": "SYSDEMO" } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/UserTask" } }, "400": { "description": "Bad Request" }, "401": { "description": "Authentication is required" }, "403": { "description": "Access is denied" }, "404": { "description": "The job name is not found" }, "500": { "description": "Internal server error" }, "503": { "description": "IDMSINFO address space is not available" }, "507": { "description": "Insufficient storage", "schema": { "$ref": "#/definitions/ApiMessage" } } }, "security": [ { "basicAuth": [] } ], "deprecated": false } } }, "securityDefinitions": { "basicAuth": { "type": "basic" } }, "definitions": { "ApiMessage": { "type": "object", "properties": { "messages": { "type": "array", "items": { "$ref": "#/definitions/Message" } } }, "title": "ApiMessage" }, "Buffer": { "type": "object", "properties": { "areaCount": { "type": "integer", "format": "int32", "example": 30, "description": "Number of areas in the buffer" }, "areaName": { "type": "string", "example": "EMPDEMO.EMP-REGION", "description": "Name of an area associated with the file" }, "bufferName": { "type": "string", "example": "LOG_BUFFER", "description": "Buffer name" }, "bufferPageSize": { "type": "integer", "format": "int32", "example": 4276, "description": "Buffer page size" }, "fileName": { "type": "string", "example": "EMPDEMO.EREGION", "description": "Name of a file associated with the buffer" }, "inBufferCount": { "type": "integer", "format": "int32", "example": 51738, "description": "Number of times the page was found in the buffer" }, "inCacheCount": { "type": "integer", "format": "int32", "example": 762, "description": "Number of times the page was found in cache" }, "inPreFetchCount": { "type": "integer", "format": "int32", "example": 65, "description": "Number of times the page was found in the prefetch buffer" }, "pageCount": { "type": "integer", "format": "int32", "example": 50, "description": "Number of pages in the buffer" }, "readCount": { "type": "integer", "format": "int32", "example": 24, "description": "Number of physical reads" }, "readsByWritesCount": { "type": "integer", "format": "int32", "example": 5, "description": "Number of reads forced by writes" }, "waitCount": { "type": "integer", "format": "int32", "example": 5, "description": "Number of times the system waited on the buffer" }, "writeCount": { "type": "integer", "format": "int32", "example": 12, "description": "Number of physical writes" } }, "title": "Buffer", "description": "IDMS system buffer object" }, "Column": { "type": "object", "properties": { "tableCatalog": { "type": "string", "example": "null", "description": "Catalog name" }, "tableSchema": { "type": "string", "example": "DEMOEMPL", "description": "Schema name" }, "tableName": { "type": "string", "example": "BENEFITS", "description": "Table name" }, "columnName": { "type": "string", "example": "FISCAL_YEAR", "description": "Column name" }, "dataType": { "type": "integer", "format": "int32", "example": 2, "description": "SQL data type number" }, "typeName": { "type": "string", "example": "UNSIGNED_NUMERIC", "description": "SQL data type name" }, "columnSize": { "type": "integer", "format": "int32", "example": 4, "description": "Maximum number of characters or digits the column may contain" }, "bufferLength": { "type": "integer", "format": "int32", "example": "null", "description": "Unused" }, "decimalDigits": { "type": "integer", "format": "int32", "example": 0, "description": "Number of fractional digits" }, "numericPrecisionRadix": { "type": "integer", "format": "int32", "example": 10, "description": "Numeric base. Typically base 10 or 2" }, "nullable": { "type": "integer", "format": "int32", "example": 0, "description": "Indicates if null values are allowed. Possible values are:\n- 0 - columnNoNulls - might not allow NULL values\n- 1 - columnNullable - allows NULL values\n- 2 - columnNullableUnknown - nullability unknown" }, "remarks": { "type": "string", "example": "null", "description": "Description of the column" }, "columnDefault": { "type": "string", "example": "null", "description": "Default value of the column" }, "sqlDataType": { "type": "integer", "format": "int32", "example": "null", "description": "Unused" }, "sqlDateTimeSubtype": { "type": "integer", "format": "int32", "example": "null", "description": "Unused" }, "characterOctetLength": { "type": "integer", "format": "int32", "example": 4, "description": "Size of the column in bytes" }, "ordinalPosition": { "type": "integer", "format": "int32", "example": 0, "description": "Position of the column in the table" }, "isNullable": { "type": "string", "example": "NO", "description": "Indicates if the column may contain nulls. Possible values are:\n- YES - the column may contain nulls\n- NO - the column may not contain nulls\n- empty string - column nullability unknown" }, "scopeCatalog": { "type": "string", "example": "null", "description": "Catalog of the table that is the scope of a reference attribute (null when DATA_TYPE is not REF)" }, "scopeSchema": { "type": "string", "example": "null", "description": "Schema of the table that is the scope of a reference attribute (null when DATA_TYPE is not REF)" }, "scopeTable": { "type": "string", "example": "null", "description": "Table name that is the scope of a reference attribute (null when DATA_TYPE is not REF)" }, "sourceDataType": { "type": "integer", "format": "int32", "example": "null", "description": "Source type of a distinct type or user-generated reference type (null when DATA_TYPE is not DISTINCT or REF)" }, "isAutoIncrement": { "type": "string", "example": "NO", "description": "Indicates if the column automatically increments. Possible values are:\n- YES - the column automatically increments\n- NO - the column does not automatically increment\n- empty string - it is unknown if the column automatically increments" } }, "title": "Column", "description": "Column object" }, "ColumnsResponse": { "type": "object", "properties": { "columns": { "type": "array", "description": "List of columns", "items": { "$ref": "#/definitions/Column" } }, "errors": { "type": "array", "example": [], "description": "Error message(s) generated from the execution of the getColumns call", "items": { "$ref": "#/definitions/SqlExceptionResponse" } } }, "title": "ColumnsResponse", "description": "ColumnsResponse object" }, "CommunicationLine": { "type": "object", "properties": { "acbName": { "type": "string", "example": "SYSR237", "description": "Name associated with either a VTAMLIST (ACB name) or an access method other than VTAM (DD name) " }, "bufferSize": { "type": "integer", "format": "int32", "example": 20, "description": "Size of the line buffer " }, "compactData": { "type": "string", "example": "N", "description": "Specifies whether repetitive data is condensed in output datastreams to remote 3270 terminals\nPossible values are:\n- Y - Yes\n- N - No" }, "errorCount": { "type": "integer", "format": "int32", "example": 3, "description": "Number of errors on the line " }, "lineName": { "type": "string", "example": "VTAMLIN", "description": "Line name assigned in SYSGEN using the LINE statement " }, "lineStatus": { "type": "string", "example": "INSRVC", "description": "Status of the line\nPossible statuses are:\n- INSRVC - In service\n- OUTSRV - Out of service\n- CLOSED - Has not been opened " }, "lineType": { "type": "string", "example": "WTO", "description": "Type of line specified by the LINE statement in SYSGEN\nPossible line types are:\n- WTO - Write to Operator console\n- DCAM - BS2K\n- VTAM 3270 - Virtual Telecommunications Access Method 3270\n- UCF - Utility Control Facility\n- Start STP - Start/Stop terminals asynchronous\n- VTAM SNA - VTAM/Systems Network Architecture Logical Units\n- APPC - Advanced Program-to-Program Communication\n- SYSOUT - SYSOUT printer\n- DDS CCI - Distributed Database System Common Client Interface\n- DDS VTAM - Distributed Database System Virtual Telecommunications Access Method\n- SYSN/OUT - SYSIN/SYSOUT devices\n- LOC 3270 - Local 3270\n- SIM 3270 - Simulated 3270\n- LOC 3280 - Local 3280 printer\n- TCAM - Telecommunications Access Method\n- BSC NONSW - Binary Synchronous Non-Switched Point-to-Point\n- BSC SW - Binary Synchronous Switched Point-to-Point\n- BSC MP - Binary Synchronous Multi-Point\n- SOCKET - TCP/IP network socket\n- UNDEFINED - Undefined line type " }, "readCount": { "type": "integer", "format": "int32", "example": 595, "description": "Number of reads on the line since startup " }, "readErrorCount": { "type": "integer", "format": "int32", "example": 1, "description": "Number of errors encountered while attempting to retrieve data from a device assigned to the line " }, "rplGen": { "type": "integer", "format": "int32", "example": 10, "description": "Number of request parameter lists generated in SYSGEN " }, "rplRequestCount": { "type": "integer", "format": "int32", "example": 287, "description": "Number of times a request parameter list had to be assigned to allow communications to take place " }, "rplWaitCount": { "type": "integer", "format": "int32", "example": 0, "description": "Number of waits for a VTAM request parameter list " }, "terminalCount": { "type": "integer", "format": "int32", "example": 10, "description": "Number of terminals on the line " }, "writeCount": { "type": "integer", "format": "int32", "example": 561, "description": "Number of writes on the line since startup " }, "writeErrorCount": { "type": "integer", "format": "int32", "example": 2, "description": "Number of errors encountered while attempting to write to a device assigned to the line " } }, "title": "CommunicationLine", "description": "IDMS system communication line object" }, "CompilerInput": { "type": "object", "properties": { "commands": { "type": "array", "example": [ "first command statement", "second command statement", "last command statement" ], "description": "List of compiler commands", "items": { "type": "string" } } }, "title": "CompilerInput", "description": "IDMS compiler input object" }, "DatabaseOverview": { "type": "object", "properties": { "calcRecordsWithOverflowCount": { "type": "integer", "format": "int32", "example": 133, "description": "Number of CALC records that were stored on a page other than the targeted page" }, "calcRecordsWithoutOverflowCount": { "type": "integer", "format": "int32", "example": 24, "description": "Number of CALC records that were stored on the targeted page" }, "databaseCallsCount": { "type": "integer", "format": "int32", "example": 51712, "description": "Number of database calls" }, "databaseServiceRequestsCount": { "type": "integer", "format": "int32", "example": 39507, "description": "Number of database service requests" }, "fragmentsStoredCount": { "type": "integer", "format": "int32", "example": 57, "description": "Number of fragments stored" }, "pagesReadCount": { "type": "integer", "format": "int32", "example": 1534, "description": "Number of database pages read" }, "pagesRequestedCount": { "type": "integer", "format": "int32", "example": 4641164, "description": "Number of database pages requested" }, "pagesWrittenCount": { "type": "integer", "format": "int32", "example": 1252, "description": "Number of database pages written" }, "recordsCurrentOfRunUnitCount": { "type": "integer", "format": "int32", "example": 7561, "description": "Number of records current of run unit" }, "recordsRelocatedCount": { "type": "integer", "format": "int32", "example": 122, "description": "Number of records relocated" }, "recordsRequestedCount": { "type": "integer", "format": "int32", "example": 9196, "description": "Number of records requested" }, "viaRecordsWithOverflowCount": { "type": "integer", "format": "int32", "example": 182, "description": "Number of VIA records that were stored on a page other than the targeted page" }, "viaRecordsWithoutOverflowCount": { "type": "integer", "format": "int32", "example": 19, "description": "Number of VIA records that were stored on the targeted page" } }, "title": "DatabaseOverview", "description": "IDMS system database overview object" }, "Datasource": { "type": "object", "properties": { "databaseName": { "type": "string", "example": "CASDB", "description": "Database to be accessed by the IDMS run unit" }, "datasourceName": { "type": "string", "example": "CASPROD", "description": "Name of the data source" }, "description": { "type": "string", "example": "Production CAS System", "description": "Description of the data source" } }, "title": "Datasource", "description": "IDMS datasource object" }, "ExportedKey": { "type": "object", "properties": { "primaryKeyTableCatalog": { "type": "string", "example": "null", "description": "Catalog name that contains the primary key table" }, "primaryKeyTableSchema": { "type": "string", "example": "DEMOEMPL", "description": "Schema name of the primary key table" }, "primaryKeyTableName": { "type": "string", "example": "EMPLOYEE", "description": "Name of the primary key table" }, "primaryKeyColumnName": { "type": "string", "example": "EMP_ID", "description": "Column name of the primary key" }, "foreignKeyTableCatalog": { "type": "string", "example": "null", "description": "Catalog name that contains the foreign key table being exported" }, "foreignKeyTableSchema": { "type": "string", "example": "DEMOEMPL", "description": "Schema name of the foreign key table being exported" }, "foreignKeyTableName": { "type": "string", "example": "BENEFITS", "description": "Name of the foreign key table being exported" }, "foreignKeyColumnName": { "type": "string", "example": "EMP_ID", "description": "Column name of the foreign key being exported" }, "keySequence": { "type": "integer", "format": "int32", "example": 1, "description": "Column sequence within primary key" }, "updateRule": { "type": "integer", "format": "int32", "example": 3, "description": "Action applied to the foreign key when the primary key is updated\nPossible values are:\n- 3 - importedKeyNoAction - do not allow update of primary key if it has been imported\n- 0 - importedKeyCascade - when the primary key is updated, update the imported key to match\n- 2 - importedKeySetNull - change imported key to NULL if its primary key has been updated\n- 4 - importedKeySetDefault - change imported key to a default value if its primary key has been updated\n- 1 - importedKeyRestrict - do not allow update of the primary key if imported as a foreign key in another table" }, "deleteRule": { "type": "integer", "format": "int32", "example": 3, "description": "Action applied to the foreign key when the primary key is deleted\nPossible values are:\n- 3 - importedKeyNoAction - do not allow delete of primary key if it has been imported\n\n- 0 - importedKeyCascade - when the primary key is deleted, delete the rows that import it\n- 2 - importedKeySetNull - change imported key to NULL if its primary key has been deleted\n- 4 - importedKeySetDefault - change imported key to a default value if its primary key has been deleted\n- 1 - importedKeyRestrict - do not allow delete of the primary key if imported as a foreign key in another table" }, "foreignKeyName": { "type": "string", "example": "EMP_BENEFITS", "description": "Name of the foreign key" }, "primaryKeyName": { "type": "string", "example": "CALC", "description": "Name of the primary key" }, "deferrability": { "type": "integer", "format": "int32", "example": 7, "description": "Indicates if the evaluation of the foreign key constraint can be deferred until a commit\nPossible values are:\n- 5 - importedKeyInitiallyDeferred\n- 6 - importedKeyInitiallyImmediate\n- 7 - importedKeyNotDeferrable" } }, "title": "ExportedKey", "description": "ExportedKey object" }, "ExportedKeysResponse": { "type": "object", "properties": { "exportedKeys": { "type": "array", "description": "List of exported keys", "items": { "$ref": "#/definitions/ExportedKey" } }, "errors": { "type": "array", "example": [], "description": "Error message(s) generated from the execution of the getExportedKeys call", "items": { "$ref": "#/definitions/SqlExceptionResponse" } } }, "title": "ExportedKeysResponse", "description": "ExportedKeysResponse object" }, "IEntryData": { "type": "object", "title": "IEntryData" }, "IdmsSystem": { "type": "object", "properties": { "ascbAddress": { "type": "string", "example": 16230656, "description": "Address of the ASCB for the IDMS system" }, "asid": { "type": "integer", "format": "int32", "example": 118, "description": "Address space ID associated with the IDMS system" }, "csaAddress": { "type": "string", "example": 873890, "description": "Address of the CSA for the IDMS system" }, "cvNumber": { "type": "integer", "format": "int32", "example": 60, "description": "CV number of the IDMS system, as defined in the SYSGEN" }, "eseAddress": { "type": "string", "example": 9433200, "description": "Address of the ESE for the IDMS system" }, "eseStatus": { "type": "integer", "format": "int32", "example": 216, "description": "The state of the IDMS system as indicated in the ESE. Bit values and their meanings are:\n- 8 = SVC supports SMF writes\n- 16 = CV is latest format\n- 32 = CV quiesce in progress\n- 64 = CV is accepting run-unit signons\n- 128 = CV is active" }, "jobId": { "type": "string", "example": "JOB08487", "description": "Job ID of the IDMS system" }, "jobName": { "type": "string", "example": "TECHDC60", "description": "Job name of the IDMS system" }, "pcToken": { "type": "string", "example": 1, "description": "PC token for the IDMS system" }, "programName": { "type": "string", "example": "RHDCOMVS", "description": "Name of the program used to start the IDMS system" }, "releaseNumber": { "type": "string", "example": "19.0.00", "description": "Software release number of the IDMS system" }, "storageKey": { "type": "integer", "format": "int32", "example": 4, "description": "Storage protection key in which the IDMS system is running" }, "svcNumber": { "type": "integer", "format": "int32", "example": 176, "description": "Number of the SVC used by the IDMS system" }, "systemFlag": { "type": "integer", "format": "int32", "example": 96, "description": "Various flag bits used by the IDMS system. Bit values and their meanings are:\n- 32 = CV is secured\n- 64 = CV is using the SVC\n- 128 = CV is swappable" }, "tapeVersion": { "type": "string", "example": "GJJ04I", "description": "Name of the installation image being used by the IDMS system" }, "userId": { "type": "string", "example": &