List registered classes

Get

/platform/api/profiles/preview/class-registry

Lists the classes of one kind that are registered with this instance and a profile member can name, with the label the editor shows, whether the class is deprecated, and a link to its documentation page. The lists are the ones the editor offers and are instance-wide. For POST_PARSER and ENVIRONMENT_CHECK they are what a profile write accepts for the member. A write also accepts a class the instance configures but this list hides because it is deprecated while deprecated classes are disabled (PRE_PARSER, INTEGRATION_UNIT, and RESPONSE for a plain custom unit), and, for POST_EXECUTER, a pro post-executer or any class that loads as a post-executer. RESPONSE is what a custom response unit's customClass must name (a pro unit takes the pro ones among them); CUSTOM_CLASS and FILE_FILTER are the editor's lists, which a profile write does not check against. Classes are ordered by simple name. The documentation links come from the documentation index the instance holds in memory, so they are null until that index is loaded and never delay the answer. Requires the right to create or change profiles.

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.

This is the client-credentials token endpoint of the Platform API. /oauth/token, the token_endpoint advertised at /.well-known/oauth-authorization-server, serves the authorization code flow of the OAuth2AuthorizationCode scheme.

FlowClient Credentials

Token URL/dw/register/oauth/token

Refresh URL/dw/register/oauth/token

OAuth

OAuth 2.1 authorization code flow with PKCE, for acting as a signed-in user. It works with Microsoft and other single sign-on providers: the provider only confirms the user's identity to the platform, which then issues its own token.

POST /oauth/register (no authentication) with the JSON body {"redirect_uris": ["<redirect URI>"]} returns a client_id. The user's browser has to reach the redirect URI.
Open /oauth/authorize in the user's browser with response_type=code, client_id, redirect_uri, state and a code_challenge with code_challenge_method=S256. state is a fresh unguessable value per request, and code_challenge is the S256 hash of a code_verifier freshly generated per request from a cryptographically secure random source (43 to 128 characters, RFC 7636). The user signs in on the platform's login page, and the browser is redirected to the redirect URI with code and state; a callback whose state differs from the one sent is to be rejected.
The code is valid for 30 seconds. Exchange it at POST /oauth/token, form-encoded, with grant_type=authorization_code, code, redirect_uri, code_verifier and client_id.
The answer carries access_token (valid 30 minutes), refresh_token (valid 48 hours) and expires_in in milliseconds. Refresh with grant_type=refresh_token, refresh_token and client_id.

FlowAuthorization Code

Authorization URL/oauth/authorize

Token URL/oauth/token

Refresh URL/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.

Query parameters

kind

stringRequired

The kind of class to list.

Valid values[ "PRE_PARSER", "POST_PARSER", "ENVIRONMENT_CHECK", "POST_EXECUTER", "INTEGRATION_UNIT", "RESPONSE", "CUSTOM_CLASS", "FILE_FILTER" ]

Responses

200

Classes returned.

Expand All

object

Standard Platform API success envelope. Every response carries exactly one of data (success) or error (failure) at top level.

data

object (core.ClassRegistry)

The classes of one kind registered with the instance. Read-only.

class

string

The type of this object, always core.ClassRegistry. Required where the member it is sent in accepts several types.

Valid values[ "core.ClassRegistry" ]

classes

Array of object (core.RegisteredClass)

The registered classes, ordered by simple class name.

object

A class registered with the instance. Read-only.

class

string

The type of this object, always core.RegisteredClass. Required where the member it is sent in accepts several types.

Valid values[ "core.RegisteredClass" ]

className

string

The fully qualified class name, the value for the profile member.

Examplecom.ebd.hub.datawizard.parser.stream.ChainPreParser

deprecated

boolean

Whether the class is marked deprecated; false where the kind has no such flag.

displayName

string

The label the editor shows for the class; the class name where the kind has no label. Not localised.

documentationUrl

string

The documentation page of the class if the documentation has one, else the documentation's base URL. null only when both are unavailable.

parameterHint

string

The hint for the class's parameter, as the administrator curated it (German only). Only preparsers have one; null otherwise.

documentationBaseUrl

string

The base URL of the Lobster documentation, from the documentation index the instance holds in memory. null while that index is unavailable or its URL is unusable.

kind

string

The kind the classes belong to.

Valid values[ "PRE_PARSER", "POST_PARSER", "ENVIRONMENT_CHECK", "POST_EXECUTER", "INTEGRATION_UNIT", "RESPONSE", "CUSTOM_CLASS", "FILE_FILTER" ]

400

kind is missing or not one of the listed values, or another query parameter was sent.

401

Authentication is required or the supplied credentials are invalid.

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required to access this resource."
  }
}

Expand All

object

Standard Platform API error envelope: every failed request carries a single error object. Every response carries exactly one of data (success) or error (failure) at top level.

error

object (Error)

What went wrong: branch on its code, show its message, and read details for one entry per failed member.

code

string

Stable machine-readable UPPER_SNAKE error code for programmatic handling, e.g. PARTNER_NOT_FOUND, VALIDATION_FAILED or FORBIDDEN. New codes may be added over time; treat an unknown code according to the HTTP status class. The HTTP status itself is carried by the status line only, never duplicated here.

message

string

Human-readable, non-localized explanation. Branch on code, never on this text.

details

Array of object (ErrorDetail)

Individual failures within the request, e.g. one entry per violated field.

object

A single failure within the request.

code

string

Stable machine-readable UPPER_SNAKE code of this individual failure, e.g. FIELD_REQUIRED, FIELD_INVALID or VALUE_OUT_OF_RANGE.

message

string

Human-readable, non-localized explanation of this individual failure.

target

string

What this failure refers to, e.g. the violated field.

403

The caller may neither create nor change profiles.

404

The requested resource does not exist. The code is resource-specific, e.g. PARTNER_NOT_FOUND, PROFILE_NOT_FOUND or CHANNEL_NOT_FOUND.

{
  "error": {
    "code": "PARTNER_NOT_FOUND",
    "message": "Partner not found: 42"
  }
}

Expand All

object

Standard Platform API error envelope: every failed request carries a single error object. Every response carries exactly one of data (success) or error (failure) at top level.

error

object (Error)

What went wrong: branch on its code, show its message, and read details for one entry per failed member.

code

string

message

string

Human-readable, non-localized explanation. Branch on code, never on this text.

details

Array of object (ErrorDetail)

Individual failures within the request, e.g. one entry per violated field.

object

A single failure within the request.

code

string

Stable machine-readable UPPER_SNAKE code of this individual failure, e.g. FIELD_REQUIRED, FIELD_INVALID or VALUE_OUT_OF_RANGE.

message

string

Human-readable, non-localized explanation of this individual failure.

target

string

What this failure refers to, e.g. the violated field.

500

An unexpected server error occurred.

{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "An unexpected error occurred."
  }
}

Expand All

object

Standard Platform API error envelope: every failed request carries a single error object. Every response carries exactly one of data (success) or error (failure) at top level.

error

object (Error)

What went wrong: branch on its code, show its message, and read details for one entry per failed member.

code

string

message

string

Human-readable, non-localized explanation. Branch on code, never on this text.

details

Array of object (ErrorDetail)

Individual failures within the request, e.g. one entry per violated field.

object

A single failure within the request.

code

string

Stable machine-readable UPPER_SNAKE code of this individual failure, e.g. FIELD_REQUIRED, FIELD_INVALID or VALUE_OUT_OF_RANGE.

message

string

Human-readable, non-localized explanation of this individual failure.

target

string

What this failure refers to, e.g. the violated field.

Was this article helpful?