Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Kyvos Reporting supports REST calls for integrating data and functions into an application. These REST services enable you to log in , and then perform various administrative activities in Kyvos Reporting.

RESTful applications use HTTP requests to post data (create and/or update), read data (e.g., make queries), and delete data.

Response Code

The Kyvos Reporting API attempts to return appropriate status codes for every request.

Response Code

Response Message

200

         OK

OK

503

        

TIMEOUT OCCURED. LOGIN AGAIN.

401

        

UNAUTHORIZED ACCESS

404

        

RECORD NOT FOUND

412

        

PRECONDITION FAILED. PARAMETER MISSING

500

        

FAILED

Database Connection

URL

Action

Description

http://<host>:<port>/<webapp_name>/rest/dbConnection

GET

List of the DB connections

http://<host>:<port>/<webapp_name>/rest/dbConnection/{ connName}

GET

Return the object of the specified DB connection.

http://<host>:<port>/<webapp_name>/rest/dbConnection/{connName }

DELETE

Delete the specified DB connection.

http://<host>:<port>/<webapp_name>/rest/dbConnection/create

POST

Create a KYVOS connection using this API.