ConnectionProfiles

Queryable, Introduced in version 23.2

GET https://localhost:8001/sv/001.1/api/v1/Common/ConnectionProfiles

Represents a connection profile.

GUID

8C881937-8E3F-49C0-A55E-6B5E295C86DD

Required permission

Show connection

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the profile.
Number Int64 The number of the profile.

  • Unique
Description String The description of the profile.
TargetRole Int32 The transfer role of the profile.

  • ManufacturingCompany: 0
  • SalesCompany: 1
RemoteCompanyId Guid The remote company identifier of the profile.
RemoteCompanyNumber String The remote company number of the profile.

  • Max length is 10
RemoteCompanyName String The remote company name of the profile.

  • Max length is 80
RemoteDnsName String The remote dns name of the profile.

  • Max length is 253
RemotePort Int32 The remote TCP/IP port of the profile.
LocalDnsName String The local dns name of the profile.

  • Max length is 253
LocalPort Int32 The local TCP/IP port of the profile.

Example

{
  "Id": 0,
  "Number": 0,
  "Description": null,
  "TargetRole": 0,
  "RemoteCompanyId": "00000000-0000-0000-0000-000000000000",
  "RemoteCompanyNumber": null,
  "RemoteCompanyName": null,
  "RemoteDnsName": null,
  "RemotePort": 0,
  "LocalDnsName": null,
  "LocalPort": 0
}