App Message

App message queue entries

Find an existing Instance by identifier

get

Path parameters

idinteger · int64Required

Responses

200

successful operation

application/json

eventstringRequired

Event/Nachricht

eventTopicstringOptional

Event/Nachricht -Topic/Headline-

destinationOwnerstringOptional

owner (optional)

destinationQueuestringRequired

queue

userRefstringOptional

User-ID

idinteger · int64Read-onlyOptional

id

404

Resource with given ID was not found

application/json

get/cmn/system/app-message/{id}

HTTPcURLJavaScriptPython

GET /api/cmn/system/app-message/{id} HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

{
  "event": "text",
  "eventTopic": "text",
  "destinationOwner": "text",
  "destinationQueue": "text",
  "userRef": "text",
  "id": 1,
  "recipients": []
}

Update a Instance

put

Path parameters

idinteger · int64Required

Body

application/json

eventstringRequired

Event/Nachricht

eventTopicstringOptional

Event/Nachricht -Topic/Headline-

destinationOwnerstringOptional

owner (optional)

destinationQueuestringRequired

queue

userRefstringOptional

User-ID

Responses

200

successful operation

application/json

eventstringRequired

Event/Nachricht

eventTopicstringOptional

Event/Nachricht -Topic/Headline-

destinationOwnerstringOptional

owner (optional)

destinationQueuestringRequired

queue

userRefstringOptional

User-ID

idinteger · int64Read-onlyOptional

id

404

Resource with given ID was not found

application/json

put/cmn/system/app-message/{id}

HTTPcURLJavaScriptPython

PUT /api/cmn/system/app-message/{id} HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "event": "text",
  "eventTopic": "text",
  "destinationOwner": "text",
  "destinationQueue": "text",
  "userRef": "text"
}

{
  "event": "text",
  "eventTopic": "text",
  "destinationOwner": "text",
  "destinationQueue": "text",
  "userRef": "text",
  "id": 1,
  "recipients": []
}

put

Path parameters

entryIdinteger · int64Required

Entry-ID

appIdstring · uuidRequired

App-ID

Responses

200

OK

application/json

eventstringRequired

Event/Nachricht

eventTopicstringOptional

Event/Nachricht -Topic/Headline-

destinationOwnerstringOptional

owner (optional)

destinationQueuestringRequired

queue

userRefstringOptional

User-ID

idinteger · int64Read-onlyOptional

id

put/cmn/system/app-message/{entryId}/app/{appId}/deactivate

HTTPcURLJavaScriptPython

PUT /api/cmn/system/app-message/{entryId}/app/{appId}/deactivate HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

{
  "event": "text",
  "eventTopic": "text",
  "destinationOwner": "text",
  "destinationQueue": "text",
  "userRef": "text",
  "id": 1,
  "recipients": []
}

put

Path parameters

appIdstring · uuidRequired

App-ID

Responses

200

OK

No content

put/cmn/system/app-message/app/{appId}/deactivate

HTTPcURLJavaScriptPython

PUT /api/cmn/system/app-message/app/{appId}/deactivate HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

No content

register a webhook

post

Body

application/json

urlstringRequired

url des webhooks. üblicherweise http(s)://host:port/etc

destinationOwnerstringOptional

owner (optional)

destinationQueuestringRequired

queue

appIdentifierstring · uuidOptional

appIdentifier (registrar)

Responses

200

successful operation

No content

404

Resource with given ID was not found

application/json

post/cmn/system/app-message-webhook/register

HTTPcURLJavaScriptPython

POST /api/cmn/system/app-message-webhook/register HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "url": "text",
  "destinationOwner": "text",
  "destinationQueue": "text",
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

No content

deregister an existing webhook

post

Body

application/json

urlstringRequired

url des webhooks. üblicherweise http(s)://host:port/etc

destinationOwnerstringOptional

owner (optional)

destinationQueuestringRequired

queue

appIdentifierstring · uuidOptional

appIdentifier (registrar)

Responses

200

successful operation

No content

404

Resource with given ID was not found

application/json

post/cmn/system/app-message-webhook/deregister

HTTPcURLJavaScriptPython

POST /api/cmn/system/app-message-webhook/deregister HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "url": "text",
  "destinationOwner": "text",
  "destinationQueue": "text",
  "appIdentifier": "123e4567-e89b-12d3-a456-426614174000"
}

No content

Create a Instance

post

Body

application/json

eventstringRequired

Event/Nachricht

eventTopicstringOptional

Event/Nachricht -Topic/Headline-

destinationOwnerstringOptional

owner (optional)

destinationQueuestringRequired

queue

userRefstringOptional

User-ID

Responses

200

successful operation

application/json

eventstringRequired

Event/Nachricht

eventTopicstringOptional

Event/Nachricht -Topic/Headline-

destinationOwnerstringOptional

owner (optional)

destinationQueuestringRequired

queue

userRefstringOptional

User-ID

idinteger · int64Read-onlyOptional

id

422

Resource was unable to create

application/json

post/cmn/system/app-message

HTTPcURLJavaScriptPython

POST /api/cmn/system/app-message HTTP/1.1
Host: 10.102.24.218:32792
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "event": "text",
  "eventTopic": "text",
  "destinationOwner": "text",
  "destinationQueue": "text",
  "userRef": "text"
}

{
  "event": "text",
  "eventTopic": "text",
  "destinationOwner": "text",
  "destinationQueue": "text",
  "userRef": "text",
  "id": 1,
  "recipients": []
}

list all available webhook-queues

get

Responses

200

OK

application/json

ownerstringOptional

queuestringOptional

descriptionstringOptional

get/cmn/system/app-message-webhook/destinations

HTTPcURLJavaScriptPython

GET /api/cmn/system/app-message-webhook/destinations HTTP/1.1
Host: 10.102.24.218:32792
Accept: */*

200

OK

[]