---
title: "REST API Connections"
description: "REST API Connections"
keywords: "REST API Connections"
url: "https://www.myrapidi.com/wiki/rest_api_connections"
locale: "en"
published: "2018-09-17T17:11:32Z"
modified: "2023-04-06T09:23:02Z"
---

Connections are the databases or systems that you want to transfer data between. Read more about [Connections.](/wiki/Connections "Connections")

  

| **Field** | **Type** | **Notes** |
| --- | --- | --- |
| id | string | unique id for the record |
| type | string | always "connections" (only used with JSONAPI) |
| **Attributes** | | |
| code | string | mandatory - please set a unique code |
| description | string | mandatory - please provide a useful description |
| connection\_type | string |

ms\_dynamics\_nav

ms\_dynamics\_nav\_ws  
ms\_dynamics\_nav\_sql

ms\_dynamics\_nav\_odata  
ms\_dynamics\_ax

ms\_dynamics\_ax\_ws

ms\_dynamics\_ax\_odata  
ms\_dynamics\_gp\_sp  
ms\_dynamics\_gp\_sql

ms\_dynamics\_crm

ms\_dynamics\_c5  
salesforce\_com

ms\_sql

oracle

odbc

lotus\_notes  
e\_conomic  
ibm\_db2

mysql

xal

netsuite

navision\_356

nas\_connector

rest\_webservice

sqlite

odata

 |
| server\_connect | string | |
| --- | --- | --- |
| server\_name | string | MySQL |
| port | integer | MySQL |
| driver | string | NAV |
| network\_protocol | string | NAV |
| database | string | |
| database\_path | string | |
| database\_type | string | |
| company | string | AX |
| account | string | NAV, GP |
| use\_codeunits\_permissions | boolean | NAV |
| installation\_path | string | NAV |
| use\_windows\_authentication | string | |
| user\_id | string | |
| schema | string | |
| authentication\_type\_odata | string | |
| authentication\_type\_crm | string | |
| domain | string | AX odata |
| resource | string | AX odata |
| metadata | string | AX odata |
| use\_ssl | boolean | |
| service\_list | string | AX WS |
| installation\_path | string | |
| use\_ssl | boolean | |
| sandbox | boolean | |
| token | string | e-conomic |
| agreement\_number | string | e-conomic |
| organization\_name | string | CRM |
| sts\_urn | string | CRM |
| | | |

| **Related objects** | | |
| --- | --- | --- |
| rapidiconnector (fields: user\_id, password) | | |
| comments (fields: created\_by, created\_at) | | |

  

| **Query Parameter** | **Notes** |
| --- | --- |
| id | |

  

[Get Connections](https://www.myrapidi.com/wiki/get_connections.md)

[Get One Connection](https://www.myrapidi.com/wiki/get_one_connection.md)

[Create Connection](https://www.myrapidi.com/wiki/create_connection.md)

[Update Connection](https://www.myrapidi.com/wiki/update_connection.md)

[Delete Connection](https://www.myrapidi.com/wiki/delete_connection.md)

[Test Connection](https://www.myrapidi.com/wiki/test_connection.md)

[Read Design on Connection](https://www.myrapidi.com/wiki/read_design_on_connection.md)