Versions Compared

Old Version 5

changes.mady.by.user Stonebranch

Saved on

compared with

New Version Current

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Panel
Table of Contents
maxlevel1

...

Formatting specifications for the web service, including details about parameter requirements, are provided.

Authorization to publish or push a Universal Event is assigned by the Universal Event Create permission, or by the ops_admin role.

Note
titleNote

When publishing or pushing Universal Events through the Web Service API, take into consideration both Universal Controller server and Database server sizings.

Anchor
Universal Event Publishing
Universal Event Publishing

...


Description
URIhttp://host_name/uc/resources/universalevent/publish
DescriptionPublsh Publish a global Universal Event.

HTTP Method

POST

Example URI

http://localhost:8080/uc/resources/universalevent/publish
AuthenticationHTTP Basic
Consumes Content-Typeapplication/xml, application/json
Produces Content-Typetext/plain
Example Responses

  • Status 200

    • Universal Event "{eventname}" published.

  • Status 400

    • Invalid Time To Live. Value must be non-negative or empty.

    • Universal Event attributes unknown for Universal Event Template "{eventname}".

    • Universal Event attribute name required.

    • Universal Event attribute "{attributename}" duplicated.

    • Universal Event attribute "{attributename}" unknown for Universal Event Template "{eventname}".

    • Universal Event attribute value "{attributevalue}" for attribute "{attributename}" is not a valid integer.

    • Universal Event attribute value "{attributevalue}" for attribute "{attributename}" is not a valid float.

  • Status 403

    • Operation prohibited due to security constraints.

  • Status 404

    • Universal Event Template "{eventname}" not found.A universal template with id "{templateid}" does not exist.

  • Status 500

    • Unexpected request failure. See log(s) for more details.

...


Description

URL

http://host_name/uc/resources/universalevent/push/${eventName}

HTTP Method

POST

Note

If you cannot use the POST HTTP Method, you can alternatively use the GET HTTP Method with the payload specified as a query parameter.


Description

Publish a global Universal Event.

Consumes Content-Type

application/xml, application/json, text/plain, text/xml

Produces Content-Type

text/plain

Example URI

http://localhost:8080/uc/resources/universalevent/push/MyUniversalEvent?ttl=0&businessService=A&businessService=B&query_parameter1=value1

Example Responses

  • Status 200

    • Universal Event "{eventname}" published.

  • Status 400

    • Invalid Time To Live. Value must be non-negative or empty.

    • Universal Event Template "{eventname}" not found.

  • Status 403

    • Operation prohibited due to security constraints.

  • Status 404

    • Universal Event Template "{eventname}" not found.

  • Status 500

    • Unexpected request failure. See log(s) for more details.

...