Secure Messaging

GET /sm/describeTopic/{topic}

Changed on

Retrieve the details of the specified topic or data type.

Request

  • Base URL
    https://unifieddatalibrary.com
  • URL
    https://unifieddatalibrary.com/sm/describeTopic/{topic}
  • Auth
    none declared

Path parameters

topicstring required

The topic to be described.

Query parameters

firstResultinteger
maxResultsinteger

Response

OK

topicstring

The name of the topic in kafka.

minPosinteger

The minimum (oldest) kafka offset for this topic.

maxPosinteger

The maximum (latest) kafka offset for this topic.

udlOpenAPISchemastring

The UDL schema that the objects in this topic apply to.

descriptionstring

A description of the data content of this topic.

Changes

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the new optional query request parameter firstResult

    • info

      added the new optional query request parameter maxResults

Some revisions have not been checked yet.