Skip to main content
Get Connection

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

ErpConnectionId

GetConnection: Returns the specified connection.

ErpConnectionId
integer<int32>

Response

OK

Information about a connection to the ERP system. Carrier object for ErpConnection. Services for the ErpConnection Carrier is available from the ErpSync Agent.

ErpConnectionId
integer<int32>

Primary key

ErpConnectorId
integer<int32>

The connector that this connection should call

DisplayName
string

Connection name shown to user; multi-language support

DisplayDescription
string

Tooltip/description shown to user; multi-language support

Active
boolean

Is this connection currently active

ConnectionId
string

The GUID that uniquely identifies this connection; passed to the Connector in every call

MostRecentTimestamp
string

Datetime, transaction number or other identification of the point in time of the most-recently seen actor in the ERP system

ConfigFields
object

The config fields needed to establish a connection to the connector

Deleted
boolean

If true, the connection has been deleted and should not be shown to the users.

AllAccess
boolean

Is this connection accessible to everyone? If not, then the ErpConnectionAccess table tells us who can access it

UserGroupAccessIds
integer<int32>[]

Array of ids containing usergroups that will have access to this connection.

AssociateAccessIds
integer<int32>[]

Array of ids containing associates that will have access to this connection.

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.