Data connection: Create

LOCKED.
This API is extremely reliable and will not be broken unless absolutely necessary.

Method

POST

Path

/qrs/dataconnection/

Description

Data connections enable you to select and load data from a data source and provide a way to save shortcuts to the data sources you commonly use such as databases, local files, or remote files.

Information that is returned from an API request may contain references to properties and values where the meaning of the value may not be self-evident, for example, status: 2 or architecture: 0. These values typically belong to an enumeration that is associated with the entity type specified in the API request; in these cases, it may be helpful to call the /qrs/about/api/enums API to get a complete list of the enumerations, which can give you insight into the meaning of these values. See About API: Get enums.

Body

{ "name": "ExcelTest", "connectionstring": "C:\\Users\\abc\\Downloads\\CreateSimpleApp_ExampleFiles\\", "type": "folder", "username": "", "privileges": null }

In this example, the connectionstring property points to a folder containing a data file.

Return value

{ "id": "2972ab89-c008-4fd4-8777-cb95e5483d5f", "createdDate": "2017-06-20T18:18:48.731Z", "modifiedDate": "2017-06-20T18:18:48.731Z", "modifiedByUserName": "INTERNAL\\sa_repository", "customProperties": [], "owner": { "id": "9709bf4f-5ccb-4e88-9374-963fcfedb82a", "userId": "sa_repository", "userDirectory": "INTERNAL", "name": "sa_repository", "privileges": null }, "name": "ExcelTest", "connectionstring": "C:\\Users\\abc\\Downloads\\CreateSimpleApp_ExampleFiles\\", "type": "folder", "engineObjectId": "", "username": "", "logOn": 0, "architecture": 0, "tags": [], "privileges": null, "impactSecurityAccess": false, "schemaPath": "DataConnection" }

Optional parameters

-

Did this information help you?

Can you tell us why it did not help you and how we can improve it?

Thanks for helping us improve!