Messaging

Azure service bus is used to implement a queue of system events that can be subscribed to by external systems.

Get an Azure Service Bus connections

get

#Available from v.3.15.0

Authorizations

Path parameters

uidstring · uuidRequired

Uid of Azure Service Bus connection

Responses

200

OK

text/plainapplication/jsontext/json

404

Not Found

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

GET /v1/azureservicebusconnections/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Title": "text",
  "ServiceBusConnectionString": "text",
  "QueueName": "text",
  "BlobContainerConnectionString": "text",
  "BlobContainerName": "text",
  "Active": true,
  "EnabledEvents": [
    "text"
  ],
  "AdvancedSettings": {
    "ANY_ADDITIONAL_PROPERTY": {
      "EventSettingsType": "text"
    }
  }
}

Delete an Azure Service Bus connection

delete

Authorizations

Path parameters

uidstring · uuidRequired

Uid of Azure Service Bus connection to delete

Responses

200

OK

delete

HTTPcURLJavaScriptPython

DELETE /v1/azureservicebusconnections/{uid} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

No content

Get all Azure Service Bus connections

get

Authorizations

Responses

200

OK

text/plainapplication/jsontext/json

get

HTTPcURLJavaScriptPython

GET /v1/azureservicebusconnections HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "Title": "text",
    "ServiceBusConnectionString": "text",
    "QueueName": "text",
    "BlobContainerConnectionString": "text",
    "BlobContainerName": "text",
    "Active": true,
    "EnabledEvents": [
      "text"
    ],
    "AdvancedSettings": {
      "ANY_ADDITIONAL_PROPERTY": {
        "EventSettingsType": "text"
      }
    }
  }
]

Create a new Azure Service Bus connection

post

Authorizations

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Model representing a message queue connection

Uidstring · uuidOptional

Unique id of the message queue connection

Titlestring | nullableOptional

Title of message queue connection

ServiceBusConnectionStringstring | nullableOptional

Url for the message queue to request when triggered

QueueNamestring | nullableOptional

Queue name for the message queue

BlobContainerConnectionStringstring | nullableOptional

Url for the blob storage to request when triggered

BlobContainerNamestring | nullableOptional

ActivebooleanOptional

Activate / deactivate message queue connection

EnabledEventsstring[] | nullableOptional

Events this message queue shall act on

Responses

200

OK

post

HTTPcURLJavaScriptPython

POST /v1/azureservicebusconnections HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 271

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Title": "text",
  "ServiceBusConnectionString": "text",
  "QueueName": "text",
  "BlobContainerConnectionString": "text",
  "BlobContainerName": "text",
  "Active": true,
  "EnabledEvents": [
    "text"
  ],
  "AdvancedSettings": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Update an Azure Service Bus connection

put

Authorizations

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

Model representing a message queue connection

Uidstring · uuidOptional

Unique id of the message queue connection

Titlestring | nullableOptional

Title of message queue connection

ServiceBusConnectionStringstring | nullableOptional

Url for the message queue to request when triggered

QueueNamestring | nullableOptional

Queue name for the message queue

BlobContainerConnectionStringstring | nullableOptional

Url for the blob storage to request when triggered

BlobContainerNamestring | nullableOptional

ActivebooleanOptional

Activate / deactivate message queue connection

EnabledEventsstring[] | nullableOptional

Events this message queue shall act on

Responses

200

OK

put

HTTPcURLJavaScriptPython

PUT /v1/azureservicebusconnections HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 271

{
  "Uid": "123e4567-e89b-12d3-a456-426614174000",
  "Title": "text",
  "ServiceBusConnectionString": "text",
  "QueueName": "text",
  "BlobContainerConnectionString": "text",
  "BlobContainerName": "text",
  "Active": true,
  "EnabledEvents": [
    "text"
  ],
  "AdvancedSettings": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content