Reading a Data Connector

Reading a Data Connector

The operation of reading Data Connectors through the RESTful API allows you to get information about your existing Data Connectors programmatically.

You can read Data Connectors in the following ways:

Read All

This operation returns an object containing all existing Data Connectors objects.

Request:
    GET https://api.everlive.com/v1/Metadata/Applications/your-app-id/DataLinks
Headers:
    Authorization: Masterkey your-master-key-here

Response:
    Status: 200 OK
    Content-Type: application/json
Body:
    {
        "Count": 10,
        "Result":
            [
                {
                    "Name": "MyDb",
                    ...
                },
                ...
            ]
    }

Read by ID

This operation returns a single Data Connectors object.

Request:
    GET https://api.everlive.com/v1/Metadata/Applications/your-app-id/DataLinks/data-link-id-here
Headers:
    Authorization: Masterkey your-master-key-here

Response:
    Status: 200 OK
    Content-Type: application/json
Body:
    {
        "Count": 1,
        "Result": {
            "Name": "MyDb",
            ...
        }
    }

Read by Filter

This operation returns an object containing one or more Data Connectors objects that match the specified filtering criteria.

Request:
    GET https://api.everlive.com/v1/Metadata/Applications/your-app-id/DataLinks
Headers:
    Authorization: Masterkey your-master-key-here
    X-Everlive-Filter: { "Name" : "MyDb" }
Response:
    Status: 200 OK
    Content-Type: application/json
Body:
    {
        "Count": 1,
        "Result": {
            "Name": "MyDb",
            ...
        }
    }

The Type and ConnectionString of the Data Connector are kept on the Data Link Server. Consequently, making queries (i.e. filtering, sorting, etc.) involving those two fields is not supported.

See Also


Start a free trial Request a demo
Contact us: +1-888-365-2779
sales@telerik.com
Copyright © 2016-2017, Progress Software Corporation and/or its subsidiaries or affiliates. All rights reserved.