Versions Compared

Old Version 4

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 5

changes.mady.by.user Stonebranch

Saved on

Key

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

...


 Description

URI

http://host_name/uc/resources/webhook/assignexecutionuser


HTTP Method

POST

Description

Assigns an Execution User to the specified webhook.

Example URI

http://localhost:8080/uc/resources/webhook/assignexecutionuser?webhookid=

http://localhost:8080/uc/resources/webhook/assignExecutionUser?webhookname=

Authentication

HTTP Basic

Consumes Content-Type

application/xml, application/json

Produces Content-Type

N/A

Example Request

See Assign an Execution User to a Webhook: Request Properties.

Example Response

  • Status 200 /OK
    Successfully assigned execution user "test" to webhook "testWebhook".

  • Status 404 /Not Found
    Assign Execution User failed. You must provide an execution user.

...

Assign an Execution User to a Webhook: Payload Properties 

http://host_name/uc/resources/webhook/enable

http://localhost:8080/

 Description

URI

HTTP Method

POST

Description

Disables a webhook.

Example URI

Property

UI Field Name

Description

Specifications

Required

password

n/a

If the user executing this web service does not have the ops_admin role; Password of the Execution User.


Y

username

n/a

Name of the Execution User.

Wildcards are supported.

Y

Assign an Execution User to a Webhook: Example Request

XMLJSON


Expand
titleXML


Code Block
languagetext
<executionUser>
      <username>test</username>
      <password>pass1</password>
</executionUser>




Expand
titleJSON


Code Block
languagetext
{
 "username": "test",
 "password": "pass1" 
}



Disable a Webhook


 Description

URI

http://host_name/uc/resources/webhook/enable


HTTP Method

POST

Description

Disables a webhook.

Example URI

http://localhost:8080/uc/resources/webhook/disable

Authentication

HTTP Basic

Consumes Content-Type

N/A

Produces Content-Type

application/xml, application/json

Example Request

http://localhost:9090/uc/resources/webhook/disable?webhookname=

http://localhost:9090/uc/resources/webhook/disable?webhookid=

Example Response

See Enable/Disable a Webhook: XML and JSON Examples.

...


 Description

URI

http://host_name/uc/resources/webhook

HTTP Method

PUT

Description

Modify a webhook.

Example URI

http://localhost:8080/uc/resources/webhook

Authentication

HTTP Basic

Produces Content-Type

Application/XML

Application/JSON

Consumes Content-Type

Application/XML

Application/JSON

Example Responses

  • Status 200

    • Successfully updated the resourcename with id {uuid}.

  • Status 400

    • Error message.

  • Status 403

    • Operation prohibited due to security constraints.

  • Status 404

    • A resourcename with name “{name}” does not exist.

    • A resourcename with id "{uuid}" does not exist.

  • Status 500

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


Read a Webhook

...

 Description

...

URI


 Description

URI

http://host_name/uc/resources/webhook

HTTP Method

GET

Description

Read webhook registration.

Example URI

http://localhost:8080/uc/resources/webhook?webhookid=

http://host_namelocalhost:8080/uc/resources/webhook

HTTP Method

GET

Description

Read webhook registration.

Example URI

http://localhost:8080/uc/resources/webhook?webhookid=

http://localhost:8080/uc/resources/webhook?webhookname=

Authentication

HTTP Basic

Produces Content-Type

Consumes Content-Type

Example Responses

Read Webhook: XML and JSON Examples.?webhookname=

Authentication

HTTP Basic

Produces Content-Type


Consumes Content-Type


Example Responses

Read Webhook: XML and JSON Examples.

Anchor
query parameters
query parameters
Read a Webhook: Query Parameters 

Property

UI Field Name

Description

Specifications

Required

Mutually Exclusive With

webhookid


ID used within the Controller to identify this webhook.

String; URI parameter.

Y
(unless webhookname
is specified)

webhookname

webhookname

 Name

Name used within the Controller to identify this webhook.

String; URI parameter.

Y
(unless webhookid
is specified)

webhookid

Register a Webhook 


 Description

URI

http://host_name/uc/resources/webhook

HTTP Method

POST

Description

Register a webhook.

Example URI

http://localhost:8080/uc/resources/webhook

Authentication

HTTP Basic

Produces Content-Type

Application/XML

Application/JSON

Consumes Content-Type

Application/XML

Application/JSON

Example RequestSee Register a Webhook: Example Request

Example Responses

  • Status 200

    • Successfully created the webhook with id {uuid}.

  • Status 400

    • Error message.

  • Status 403

    • Operation prohibited due to security constraints.

  • Status 404

    • A webhook with name “{name}” does not exist.

    • A webhook with id "{uuid}" does not exist.

  • Status 500

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

...