List channels

Get

/platform/api/preview/partners/{partnerId}/channels

Returns all channels of an integration partner.

Security

OAuth

OAuth2 client-credentials flow for machine-to-machine access. Exchange a client id/secret at /dw/register/oauth/token for a bearer token, then send it as Authorization: Bearer <access_token>. Client credentials are provisioned in the Lobster administration UI.

FlowClient Credentials

Token URL/dw/register/oauth/token

Refresh URL/dw/register/oauth/token

HTTP

Type bearer

Bearer token obtained from an authenticated browser or guest-user session.

Flow 1 — UI login: Log in via the Lobster web UI at /, then call GET /auth/sessionBearerToken to exchange the session cookie for a bearer token.

Flow 2 — Guest user login token: Append a GuestUser loginToken as a URL query parameter to the base URL to establish a password-free session:

GET <host>?loginToken=<GuestUser token>

Then call GET /auth/sessionBearerToken to obtain the bearer token.

Path parameters

partnerId

integer (int64) Required

Partner identifier.

Responses

400

The request was malformed or failed validation.

{
  "errorInfo": {
    "errorCode": "CORESYSTEM_validation_400",
    "errorLevel": 0,
    "errorText": "Invalid request payload."
  }
}

Expand All

object

Standard error envelope returned for all failed requests.

errorInfo

object

errorCode

string

Stable machine-readable error code for programmatic handling.

errorText

string

Human-readable, localized explanation of the error.

errorLevel

integer (int32)

Severity level of the error.

401

Authentication is required or the supplied credentials are invalid.

{
  "errorInfo": {
    "errorCode": "CORESYSTEM_AuthenticationManager_401",
    "errorLevel": 0,
    "errorText": "You are not logged in"
  }
}

Expand All

object

Standard error envelope returned for all failed requests.

errorInfo

object

errorCode

string

Stable machine-readable error code for programmatic handling.

errorText

string

Human-readable, localized explanation of the error.

errorLevel

integer (int32)

Severity level of the error.

403

The authenticated client is not permitted to perform this operation.

{
  "errorInfo": {
    "errorCode": "CORESYSTEM_permission_403",
    "errorLevel": 0,
    "errorText": "Access denied."
  }
}

Expand All

object

Standard error envelope returned for all failed requests.

errorInfo

object

errorCode

string

Stable machine-readable error code for programmatic handling.

errorText

string

Human-readable, localized explanation of the error.

errorLevel

integer (int32)

Severity level of the error.

404

The requested resource does not exist.

{
  "errorInfo": {
    "errorCode": "CORESYSTEM_notFound_404",
    "errorLevel": 0,
    "errorText": "Resource not found."
  }
}

Expand All

object

Standard error envelope returned for all failed requests.

errorInfo

object

errorCode

string

Stable machine-readable error code for programmatic handling.

errorText

string

Human-readable, localized explanation of the error.

errorLevel

integer (int32)

Severity level of the error.

500

An unexpected server error occurred.

{
  "errorInfo": {
    "errorCode": "CORESYSTEM_internalServerError_500",
    "errorLevel": 0,
    "errorText": "Server Error. See logs for more details."
  }
}

Expand All

object

Standard error envelope returned for all failed requests.

errorInfo

object

errorCode

string

Stable machine-readable error code for programmatic handling.

errorText

string

Human-readable, localized explanation of the error.

errorLevel

integer (int32)

Severity level of the error.

default

default response

Expand All

Array

core:IntegrationPartnerChannel

OneOf

IntegrationPartnerChannelIoT

object (IntegrationPartnerChannelIoT)

class

string

Valid values[ "core:IntegrationPartnerChannelIoT" ]

active

boolean

endpointUrl

string

integer (int64)

localCertificateId

string

name

string

opcSecurityPolicy

string

partner

object (IntegrationPartner)

core:IntegrationPartner

class

string

Valid values[ "core:IntegrationPartner" ]

integer (int64)

name

string

remoteCertificateId

string

IntegrationPartnerChannelHTTP

object (IntegrationPartnerChannelHTTP)

class

string

Valid values[ "core:IntegrationPartnerChannelHTTP" ]

active

boolean

groupName

string

integer (int64)

localCertificateId

string

name

string

partner

object (IntegrationPartner)

core:IntegrationPartner

class

string

Valid values[ "core:IntegrationPartner" ]

integer (int64)

name

string

remoteCertificateId

string

url

string

userRoles

Array of string

string

IntegrationPartnerChannelSMB

object (IntegrationPartnerChannelSMB)

class

string

Valid values[ "core:IntegrationPartnerChannelSMB" ]

active

boolean

host

string

integer (int64)

name

string

partner

object (IntegrationPartner)

core:IntegrationPartner

class

string

Valid values[ "core:IntegrationPartner" ]

integer (int64)

name

string

smbDomain

string

IntegrationPartnerChannelFTP

object (IntegrationPartnerChannelFTP)

class

string

Valid values[ "core:IntegrationPartnerChannelFTP" ]

active

boolean

host

string

integer (int64)

localCertificateId

string

name

string

partner

object (IntegrationPartner)

core:IntegrationPartner

class

string

Valid values[ "core:IntegrationPartner" ]

integer (int64)

name

string

port

integer (int32)

remoteCertificateId

string

remotePath

string

IntegrationPartnerChannelFax

object (IntegrationPartnerChannelFax)

class

string

Valid values[ "core:IntegrationPartnerChannelFax" ]

active

boolean

defaultSendHeadline

string

defaultSendStationID

string

expectedHeadline

string

expectedStationID

string

faxIncomingDirectory

string

faxOutgoingDirectory

string

integer (int64)

isdnLocalNumber

string

isdnRemoteNumber

string

name

string

partner

object (IntegrationPartner)

core:IntegrationPartner

class

string

Valid values[ "core:IntegrationPartner" ]

integer (int64)

name

string

IntegrationPartnerChannelSFTP

object (IntegrationPartnerChannelSFTP)

class

string

Valid values[ "core:IntegrationPartnerChannelSFTP" ]

active

boolean

host

string

integer (int64)

keyFingerprint

string

keyType

string

name

string

partner

object (IntegrationPartner)

core:IntegrationPartner

class

string

Valid values[ "core:IntegrationPartner" ]

integer (int64)

name

string

port

integer (int32)

privateKeyId

string

remotePath

string

IntegrationPartnerChannelMail

object (IntegrationPartnerChannelMail)

class

string

Valid values[ "core:IntegrationPartnerChannelMail" ]

active

boolean

integer (int64)

imapFolder

string

incomingMaxSize

integer (int64)

localCertificateId

string

name

string

partner

object (IntegrationPartner)

core:IntegrationPartner

class

string

Valid values[ "core:IntegrationPartner" ]

integer (int64)

name

string

remoteCertificateId

string

retrievalAuthMechanism

string

smtpAuthMechanism

string

smtpServerUrl

string

IntegrationPartnerChannelX400

object (IntegrationPartnerChannelX400)

class

string

Valid values[ "core:IntegrationPartnerChannelX400" ]

active

boolean

integer (int64)

localId

string

name

string

partner

object (IntegrationPartner)

core:IntegrationPartner

class

string

Valid values[ "core:IntegrationPartner" ]

integer (int64)

name

string

presentationSelector

string

remoteId

string

sessionSelector

string

transportAccessPoint

string

uafiConfigDirectory

string

uafiInDirectory

string

uafiOutDirectory

string

IntegrationPartnerChannelAS2

object (IntegrationPartnerChannelAS2)

class

string

Valid values[ "core:IntegrationPartnerChannelAS2" ]

active

boolean

as2Url

string

encryptionAlgorithm

string

integer (int64)

localCertificateId

string

mdnMode

integer (int32)

name

string

partner

object (IntegrationPartner)

core:IntegrationPartner

class

string

Valid values[ "core:IntegrationPartner" ]

integer (int64)

name

string

partnerAs2Id

string

remoteCertificateId

string

signingAlgorithm

string

stationId

string

IntegrationPartnerChannelOFTP

object (IntegrationPartnerChannelOFTP)

class

string

Valid values[ "core:IntegrationPartnerChannelOFTP" ]

active

boolean

endpointUrl

string

integer (int64)

localCertificateId

string

localSsid

string

name

string

partner

object (IntegrationPartner)

core:IntegrationPartner

class

string

Valid values[ "core:IntegrationPartner" ]

integer (int64)

name

string

remoteCertificateId

string

remoteSfid

string

IntegrationPartnerChannelAS4

object (IntegrationPartnerChannelAS4)

class

string

Valid values[ "core:IntegrationPartnerChannelAS4" ]

active

boolean

endpointUrl

string

integer (int64)

localCertificateId

string

name

string

partner

object (IntegrationPartner)

core:IntegrationPartner

class

string

Valid values[ "core:IntegrationPartner" ]

integer (int64)

name

string

remoteCertificateId

string

Was this article helpful?

Documentation Index

List channels