REST API Reference

Back Next

JMS sources

When the source connection of the task source is JMS, you can include the following fields and key-value pairs in the config array of the source connection:

Key	Type	Required	Description
destinationType	String	Yes	Type of destination that the source service sends JMS messages to. Enter one of the following values: QUEUE . The JMS provider delivers messages to a single consumer who is registered for the queue. TOPIC . The JMS provider delivers messages to all active consumers that subscribe to the topic.
clientId	String	Yes	Unique ID of the JMS connection. You can enter a string of up to 255 characters.
sharedSubscription	String	Yes	Enables multiple consumers to access a single subscription. Applies to the TOPIC destination type. Enter one of the following values: True False
durableSubscription	String	Yes	When set to True, the JMS source service enables inactive subscribers to retain messages and then deliver them when the subscriber reconnects. Applies to the TOPIC destination type. Enter one of the following values: True False
subscriptionName	String	Yes	Name of the subscription. Applies to the TOPIC destination type, when the topic subscription type is shared, durable, or both.
JMS Destination	String	Yes	Name of the queue or topic that the JMS provider delivers messages to.

POST request example

To update a

streaming ingestion and replication

task with an JMS source and a flat file target, you might send a request similar to the following example:

POST <serverUrl>/sisvc/restapi/v1/UpdateEntity/Documents('<document ID>')
Content-Type: application/json
Accept: application/json
IDS-SESSION-ID: <SessionId>

{
  "name": "crud",
  "description": "JMS to FileToFile",
  "runtimeId": "01000025000000000003",
  "locationId": "5sJ0JDyJyWLlrosS5qJjsQ",
  "currentVersion": "2",
  "messageFormat": "binary",
  "nodes": [
    {
      "name": "crud_source",
      "type": "source",
      "connectionId": "012MGS0B000000000003",
      "transformationType": "",
      "config": [
        {
          "key": "destinationType",
          "value": "QUEUE"
        },
        {
          "key": "clientId",
          "value": ""
        },
        {
          "key": "JMS Destination",
          "value": "test"
        }
      ]
    },
    {
      "name": "crud_target",
      "type": "target",
      "connectionId": "012MGS0B00000000000H",
      "transformationType": "",
      "config": [
        {
          "key": "interimDirectory",
          "value": "/home/agent/test"
        },
        {
          "key": "rolloverSize",
          "value": 1024
        },
        {
          "key": "rolloverEvents",
          "value": 100
        },
        {
          "key": "rolloverTime",
          "value": 300000
        },
        {
          "key": "File Name",
          "value": "test"
        }
      ]
    }
  ],
  "edges": [
    {
      "from": "crud_source",
      "to": "crud_target"
    }
  ]
}

The response returns only the fields that you entered in the request. If the request is unsuccessful, the response includes a reason for the failure.

POST response example

If the request is successful, you might receive a response similar to the following example in a

Success

node:

{
  "Success": {
    "name": "crud",
    "description": "JMS to FileToFile",
    "runtimeId": "01000025000000000003",
    "locationId": "5sJ0JDyJyWLlrosS5qJjsQ",
    "currentVersion": "2",
    "messageFormat": "binary",
    "nodes": [
      {
        "name": "crud_source",
        "type": "source",
        "connectionId": "012MGS0B000000000003",
        "transformationType": "",
        "config": [
          {
            "key": "destinationType",
            "value": "QUEUE"
          },
          {
            "key": "clientId",
            "value": ""
          },
          {
            "key": "JMS Destination",
            "value": "test"
          }
        ]
      },
      {
        "name": "crud_target",
        "type": "target",
        "connectionId": "012MGS0B00000000000H",
        "transformationType": "",
        "config": [
          {
            "key": "interimDirectory",
            "value": "/home/agent/test"
          },
          {
            "key": "rolloverSize",
            "value": 1024
          },
          {
            "key": "rolloverEvents",
            "value": 100
          },
          {
            "key": "rolloverTime",
            "value": 300000
          },
          {
            "key": "File Name",
            "value": "test"
          }
        ]
      }
    ],
    "edges": [
      {
        "from": "crud_source",
        "to": "crud_target"
      }
    ]
  }
}

Rename Saved Search

Table of Contents

REST API Reference

REST API Reference

JMS sources

JMS sources

POST request example

POST response example