Versions Compared

Old Version 2

changes.mady.by.user Former user

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.
Warning
titleThis integration has been sunset

It is replaced by Web Service Integration 

Panel

Table of Contents

Disclaimer

...

The Webservice Universal Task allows you to call a Webservice web service triggered from Universal Agent.

...

  • Universal Agent for Linux or Windows Version 7.0.0.0 or later is required.

  • Universal Agent needs to be installed with python option (--python yes).

...

  • Universal Controller 7.0.0.0 or later is required.

Key Features

  • Call a Webservice triggered from Universal Agent.

  • Support all common HTTP Methods for RESTful Services: Get, Post, Put, Patch and Delete.

  • Support for Basic Authentication.

  • Support for Form based query Parameters.

  • Support for Form and Script based HTTP Payload Parameters.

  • Provide HTTP Headers as Form Data: for example, key: Accept, Value: application/json.

  • Support Response Processing using either Output Type JSON or Text.

...

To use this downloadable Universal Template, you first must perform the following steps:

  1. This Universal Task requires the /wiki/spaces/UC71x/pages/5178443 Resolvable Credentials feature. Check that the/wiki/spaces/UC71x/pages/5177877 Resolvable Credentials Permitted system property has been set to true.
  2. Download the provided ZIP file.
  3. In the Universal Controller UI, select Administration >Configuration Configuration > Universal Templates to display the current list of Universal Templates.
  4. Click Import Template.

  5. Select the template ZIP file and Import.

...

Field

Description

protocol

[ HTTP(S)/REST | SOAP ]

Note
titleNote

The SOAP messaging protocol is not supported in this version.

HTTP Authentication

[ --None-- | Basic ]

If Basic HTTP Authentication is selected, the field credentials will be visible to enter Basic Authentication Credentials.

Credentials

Credentials for Basic Authentication

The field is only visible if HTTP Authentication Method “Basic” has been selected.

HTTP Method

[Get | Post | Put | Patch | Delete]

  • GET - retrieve data

  • POST - add new data

  • PUT - replace existing data

  • PATCH - update some existing data fields

  • DELETE - delete existing data

Timeout

REST request timeout in seconds.

If a value is entered, it will overwrite the default

timeout default for consuming the REST API.

URL

REST Service Endpoint

For example,

https://jsonplaceholder.typicode.com/posts

URL Query Parameters

Name & Value Array Field

Enter the URL Query Parameters in the Array Field.

For example, Name=ID, Value=10

Query parameters are a defined set of parameters attached to the end of a URL.

HTTP Payload Type

[ Raw | Form Data ]

If Raw is selected, the Payload needs to provided in the format set in the field MIME Type.

For example, MIME Type = application/json requires a JSON-formatted Payload.

The Payload can be provided as Payload Source Form or Script. The Script can be uploaded or created in the Universal Controller script library.

Note
titleNote

When Form is selected, only the MIME Type application/json is supported.

MIME Type

[application/javascript | Application/json | application/xml | application/x-www-form-urlencoded | test/html | test/plain | test/xml | Other]

Mime Type is the same as the Content-Type header and describes the format the body of your request is being sent as.

Form Data

Payload Form Data

Payload Source

[ Form | Script ]

The Payload can be provided as Payload Source Form or Script. The Script can be uploaded or created in the Universal Controller script library.

If Payload Script is selected, the field Payload appears to enter the payload in the format selected in the Field MIME Type.

Payload

Payload

The field is only visible if Payload Source is selected as Form.

The Payload: Enter the payload in the format selected in the Field MIME Type.

For example, MIME Type application/json.

Payload JSON format:

Code Block
{
"userId": 6,
"title": "Stonebranch",
"body": "Certified SAP Workload Scheduler"
}

Payload Script

Payload Script

The field is only visible if Payload Source is selected as Script.

Select or create a new Script saved in the Universal Controller script library.

Enter the Payload in the script in the format selected in the Field MIME Type.

HTTP Headers

HTTP Header array field.

Enter the HTTP Header as Name & Value Pairs.

For example,

HTTP Header Name= Accept , Value = application/json


Response Processing

[Print HTTP Response Code to STDOUT | Print HTTP Response Header to STDOUT | Print HTTP Response Body to STDOUT | Print HTTP Response Header to File | Print HTTP Response Body to File]

Output Type

[ Text | XML | JSON ]

Note
titleNote

XML currently is not supported

Path Expression

JSON Path Expression

The field is only visible if Output Type JSON is selected.

For example,

  • Output Type = JSON
  • Path Expression: 0.title

These match the Variable “title” in the following JSON:

Code Block
[
   {
      "userId":1,
      "id":2,
      "title":"qui est esse",
      "body":"Hello world"
   }
]


Response Output File

Full Path and file name of the Output File

The field is only visible if in the Response Processing field one of the following entries has been selected: [Print HTTP Response Header to File | Print HTTP Response Body to File]

The Response is written to an Output File on the File System.

For example, Output File = /home/stonebranch/demo/out/name.json

Response Exit Code Mapping

The Value that pattern match the Path Expression of the JSON output, will used in the Response Exit Code Mapping table to set the exit code of the Task.

Please refer to the Example See Response Exit Code Mapping Example.

Proxies

Proxy Server

https=https://proxyip:port

For example,

https=https://192.155.10.130:8080

Log level (default is Inherited)

Universal Task logging settings: [Inherited | Trace | Debug | Info | Warn | Error | Severe]

Anchor
Response Exit Code Mapping Example
Response Exit Code Mapping Example
Response Exit Code Mapping Example

The Value that pattern matched the Path Expression of the JSON output will be used in the Response Exit Code Mapping table to set the exit code of the Task.

...

  • Output Type = JSON

  • Path Expression: 0.title

These match the Variable “title” in the following JSON:

Code Block
[
   {
      "userId":1,
      "id":2,
      "title":"qui est esse",
      "body":"Hello world"
   }
]

...

Field

Description

protocol

[ HTTP(S)/REST | SOAP ]

Note
titleNote

The SOAP messaging protocol is not supported in this version.

HTTP Authentication

[ --None-- | Basic ]

If Basic HTTP Authentication is selected, the field credentials will be visible to enter Basic Authentication Credentials.

Credentials

Credentials for Basic Authentication

The field is only visible if HTTP Authentication Method “Basic” has been selected.

HTTP Method

[Get | Post | Put | Patch | Delete]

  • GET - retrieve data

  • POST - add new data

  • PUT - replace existing data

  • PATCH - update some existing data fields

  • DELETE - delete existing data

Timeout

REST request timeout in seconds.

If a value is entered, it will overwrite the default

timeout default for consuming the REST API.

URL

REST Service Endpoint

For example,

https://jsonplaceholder.typicode.com/posts

URL Query Parameters

Name & Value Array Field

Enter the URL Query Parameters in the Array Field.

For example, Name=ID, Value=10

Query parameters are a defined set of parameters attached to the end of a URL.

HTTP Payload Type

[ Raw | Form Data ]

If Raw is selected, the Payload needs to provided in the format set in the field MIME Type.

For example, MIME Type = application/json requires a JSON-formatted Payload.

The Payload can be provided as Payload Source Form or Script. The Script can be uploaded or created in the Universal Controller script library.

Note
titleNote

When Form is selected, only the MIME Type application/json is supported.

MIME Type

[application/javascript | Application/json | application/xml | application/x-www-form-urlencoded | test/html | test/plain | test/xml | Other]

Mime Type is the same as the Content-Type header and describes the format the body of your request is being sent as.

Form Data

Payload Form Data

Payload Source

[ Form | Script ]

The Payload can be provided as Payload Source Form or Script. The Script can be uploaded or created in the Universal Controller script library.

If Payload Script is selected, the field Payload appears to enter the payload in the format selected in the Field MIME Type.

Payload

Payload

The field is only visible if Payload Source is selected as Form.

The Payload: Enter the payload in the format selected in the Field MIME Type.

For example, MIME Type application/json.

Payload JSON format:

Code Block
{
"userId": 6,
"title": "Stonebranch",
"body": "Certified SAP Workload Scheduler"
}

Payload Script

Payload Script

The field is only visible if Payload Source is selected as Script.

Select or create a new Script saved in the Universal Controller script library.

Enter the Payload in the script in the format selected in the Field MIME Type.

HTTP Headers

HTTP Header array field.

Enter the HTTP Header as Name & Value Pairs.

For example,

HTTP Header Name= Accept , Value = application/json

Response Processing

[Print HTTP Response Code to STDOUT | Print HTTP Response Header to STDOUT | Print HTTP Response Body to STDOUT | Print HTTP Response Header to File | Print HTTP Response Body to File]

Output Type

[ Text | XML | JSON ]

Note
titleNote

XML currently is not supported

Path Expression

JSON Path Expression

The field is only visible if Output Type JSON is selected.

For example,

  • Output Type = JSON
  • Path Expression: 0.title

These match the Variable “title” in the following JSON:

Code Block
[
   {
      "userId":1,
      "id":2,
      "title":"qui est esse",
      "body":"Hello world"
   }
]


Response Output File

Full Path and file name of the Output File

The field is only visible if in the Response Processing field one of the following entries has been selected: [Print HTTP Response Header to File | Print HTTP Response Body to File]

The Response is written to an Output File on the File System.

For example, Output File = /home/stonebranch/demo/out/name.json

Response Exit Code Mapping

The Value that pattern match the Path Expression of the JSON output, will used in the Response Exit Code Mapping table to set the exit code of the Task.

Please refer to the Example See Response Exit Code Mapping Example.

Proxies

Proxy Server

https=https://proxyip:port

For example,

https=https://192.155.10.130:8080

Log level (default is Inherited)

Universal Task logging settings: [Inherited | Trace | Debug | Info | Warn | Error | Severe]

...

Field

Description

protocol

[ HTTP(S)/REST | SOAP ]

Note
titleNote

The SOAP messaging protocol is not supported in this version.

HTTP Authentication

[ --None-- | Basic ]

If Basic HTTP Authentication is selected, the field credentials will be visible to enter Basic Authentication Credentials.

Credentials

Credentials for Basic Authentication

The field is only visible if HTTP Authentication Method “Basic” has been selected.

HTTP Method

[Get | Post | Put | Patch | Delete]

  • GET - retrieve data

  • POST - add new data

  • PUT - replace existing data

  • PATCH - update some existing data fields

  • DELETE - delete existing data

Timeout

REST request timeout in seconds.

If a value is entered, it will overwrite the default

timeout default for consuming the REST API.

URL

REST Service Endpoint

For example,

https://jsonplaceholder.typicode.com/posts

URL Query Parameters

Name & Value Array Field

Enter the URL Query Parameters in the Array Field.

For example, Name=ID, Value=10

Query parameters are a defined set of parameters attached to the end of a URL.

HTTP Payload Type

[ Raw | Form Data ]

If Raw is selected, the Payload needs to provided in the format set in the field MIME Type.

For example, MIME Type = application/json requires a JSON-formatted Payload.

The Payload can be provided as Payload Source Form or Script. The Script can be uploaded or created in the Universal Controller script library.

Note
titleNote

When Form is selected, only the MIME Type application/json is supported.

MIME Type

[application/javascript | Application/json | application/xml | application/x-www-form-urlencoded | test/html | test/plain | test/xml | Other]

Mime Type is the same as the Content-Type header and describes the format the body of your request is being sent as.

Form Data

Payload Form Data

Payload Source

[ Form | Script ]

The Payload can be provided as Payload Source Form or Script. The Script can be uploaded or created in the Universal Controller script library.

If Payload Script is selected, the field Payload appears to enter the payload in the format selected in the Field MIME Type.

Payload

Payload

The field is only visible if Payload Source is selected as Form.

The Payload: Enter the payload in the format selected in the Field MIME Type.

For example, MIME Type application/json.

Payload JSON format:

Code Block
{
"userId": 6,
"title": "Stonebranch",
"body": "Certified SAP Workload Scheduler"
}

Payload Script

Payload Script

The field is only visible if Payload Source is selected as Script.

Select or create a new Script saved in the Universal Controller script library.

Enter the Payload in the script in the format selected in the Field MIME Type.

HTTP Headers

HTTP Header array field.

Enter the HTTP Header as Name & Value Pairs.

For example,

HTTP Header Name= Accept , Value = application/json

Response Processing

[Print HTTP Response Code to STDOUT | Print HTTP Response Header to STDOUT | Print HTTP Response Body to STDOUT | Print HTTP Response Header to File | Print HTTP Response Body to File]

Output Type

[ Text | XML | JSON ]

Note
titleNote

XML currently is not supported

Path Expression

JSON Path Expression

The field is only visible if Output Type JSON is selected.

For example,

  • Output Type = JSON
  • Path Expression: 0.title

These match the Variable “title” in the following JSON:

Code Block
[
   {
      "userId":1,
      "id":2,
      "title":"qui est esse",
      "body":"Hello world"
   }
]


Response Output File

Full Path and file name of the Output File

The field is only visible if in the Response Processing field one of the following entries has been selected: [Print HTTP Response Header to File | Print HTTP Response Body to File]

The Response is written to an Output File on the File System.

For example, Output File = /home/stonebranch/demo/out/name.json

Response Exit Code Mapping

The Value that pattern match the Path Expression of the JSON output, will used in the Response Exit Code Mapping table to set the exit code of the Task.

Please refer to the Example See Response Exit Code Mapping Example.

Proxies

Proxy Server

https=https://proxyip:port

For example,

https=https://192.155.10.130:8080

Log level (default is Inherited)

Universal Task logging settings: [Inherited | Trace | Debug | Info | Warn | Error | Severe]

...

Field

Description

protocol

[ HTTP(S)/REST | SOAP ]

Note
titleNote

The SOAP messaging protocol is not supported in this version.

HTTP Authentication

[ --None-- | Basic ]

If Basic HTTP Authentication is selected, the field credentials will be visible to enter Basic Authentication Credentials.

Credentials

Credentials for Basic Authentication

The field is only visible if HTTP Authentication Method “Basic” has been selected.

HTTP Method

[Get | Post | Put | Patch | Delete]

  • GET - retrieve data

  • POST - add new data

  • PUT - replace existing data

  • PATCH - update some existing data fields

  • DELETE - delete existing data

Timeout

REST request timeout in seconds.

If a value is entered, it will overwrite the default

timeout default for consuming the REST API.

URL

REST Service Endpoint

For example,

https://jsonplaceholder.typicode.com/posts

URL Query Parameters

Name & Value Array Field

Enter the URL Query Parameters in the Array Field.

For example, Name=ID, Value=10

Query parameters are a defined set of parameters attached to the end of a URL.

HTTP Payload Type

[ Raw | Form Data ]

If Raw is selected, the Payload needs to provided in the format set in the field MIME Type.

For example, MIME Type = application/json requires a JSON-formatted Payload.

The Payload can be provided as Payload Source Form or Script. The Script can be uploaded or created in the Universal Controller script library.

Note
titleNote

When Form is selected, only the MIME Type application/json is supported.

MIME Type

[application/javascript | Application/json | application/xml | application/x-www-form-urlencoded | test/html | test/plain | test/xml | Other]

Mime Type is the same as the Content-Type header and describes the format the body of your request is being sent as.

Form Data

Payload Form Data

Payload Source

[ Form | Script ]

The Payload can be provided as Payload Source Form or Script. The Script can be uploaded or created in the Universal Controller script library.

If Payload Script is selected, the field Payload appears to enter the payload in the format selected in the Field MIME Type.

Payload

Payload

The field is only visible if Payload Source is selected as Form.

The Payload: Enter the payload in the format selected in the Field MIME Type.

For example, MIME Type application/json.

Payload JSON format:

Code Block
{
"userId": 6,
"title": "Stonebranch",
"body": "Certified SAP Workload Scheduler"
}

Payload Script

Payload Script

The field is only visible if Payload Source is selected as Script.

Select or create a new Script saved in the Universal Controller script library.

Enter the Payload in the script in the format selected in the Field MIME Type.

HTTP Headers

HTTP Header array field.

Enter the HTTP Header as Name & Value Pairs.

For example,

HTTP Header Name= Accept , Value = application/json

Response Processing

[Print HTTP Response Code to STDOUT | Print HTTP Response Header to STDOUT | Print HTTP Response Body to STDOUT | Print HTTP Response Header to File | Print HTTP Response Body to File]

Output Type

[ Text | XML | JSON ]

Note
titleNote

XML currently is not supported

Path Expression

JSON Path Expression

The field is only visible if Output Type JSON is selected.

For example,

  • Output Type = JSON
  • Path Expression: 0.title

These match the Variable “title” in the following JSON:

Code Block
[
   {
      "userId":1,
      "id":2,
      "title":"qui est esse",
      "body":"Hello world"
   }
]


Response Output File

Full Path and file name of the Output File

The field is only visible if in the Response Processing field one of the following entries has been selected: [Print HTTP Response Header to File | Print HTTP Response Body to File]

The Response is written to an Output File on the File System.

For example, Output File = /home/stonebranch/demo/out/name.json

Response Exit Code Mapping

The Value that pattern match the Path Expression of the JSON output, will used in the Response Exit Code Mapping table to set the exit code of the Task.

Please refer to the Example See Response Exit Code Mapping Example.

Proxies

Proxy Server

https=https://proxyip:port

For example,

https=https://192.155.10.130:8080

Log level (default is Inherited)

Universal Task logging settings: [Inherited | Trace | Debug | Info | Warn | Error | Severe]

...

Field

Description

protocol

[ HTTP(S)/REST | SOAP ]

Note
titleNote

The SOAP messaging protocol is not supported in this version.

HTTP Authentication

[ --None-- | Basic ]

If Basic HTTP Authentication is selected, the field credentials will be visible to enter Basic Authentication Credentials.

Credentials

Credentials for Basic Authentication

The field is only visible if HTTP Authentication Method “Basic” has been selected.

HTTP Method

[Get | Post | Put | Patch | Delete]

  • GET - retrieve data

  • POST - add new data

  • PUT - replace existing data

  • PATCH - update some existing data fields

  • DELETE - delete existing data

Timeout

REST request timeout in seconds.

If a value is entered, it will overwrite the default

timeout default for consuming the REST API.

URL

REST Service Endpoint

For example,

https://jsonplaceholder.typicode.com/posts

URL Query Parameters

Name & Value Array Field

Enter the URL Query Parameters in the Array Field.

For example, Name=ID, Value=10

Query parameters are a defined set of parameters attached to the end of a URL.

HTTP Payload Type

[ Raw | Form Data ]

If Raw is selected, the Payload needs to provided in the format set in the field MIME Type.

For example, MIME Type = application/json requires a JSON-formatted Payload.

The Payload can be provided as Payload Source Form or Script. The Script can be uploaded or created in the Universal Controller script library.

Note
titleNote

When Form is selected, only the MIME Type application/json is supported.

MIME Type

[application/javascript | Application/json | application/xml | application/x-www-form-urlencoded | test/html | test/plain | test/xml | Other]

Mime Type is the same as the Content-Type header and describes the format the body of your request is being sent as.

Form Data

Payload Form Data

Payload Source

[ Form | Script ]

The Payload can be provided as Payload Source Form or Script. The Script can be uploaded or created in the Universal Controller script library.

If Payload Script is selected, the field Payload appears to enter the payload in the format selected in the Field MIME Type.

Payload

Payload

The field is only visible if Payload Source is selected as Form.

The Payload: Enter the payload in the format selected in the Field MIME Type.

For example, MIME Type application/json.

Payload JSON format:

Code Block
{
"userId": 6,
"title": "Stonebranch",
"body": "Certified SAP Workload Scheduler"
}

Payload Script

Payload Script

The field is only visible if Payload Source is selected as Script.

Select or create a new Script saved in the Universal Controller script library.

Enter the Payload in the script in the format selected in the Field MIME Type.

HTTP Headers

HTTP Header array field.

Enter the HTTP Header as Name & Value Pairs.

For example,

HTTP Header Name= Accept , Value = application/json

Response Processing

[Print HTTP Response Code to STDOUT | Print HTTP Response Header to STDOUT | Print HTTP Response Body to STDOUT | Print HTTP Response Header to File | Print HTTP Response Body to File]

Output Type

[ Text | XML | JSON ]

Note
titleNote

XML currently is not supported

Path Expression

JSON Path Expression

The field is only visible if Output Type JSON is selected.

For example,

  • Output Type = JSON
  • Path Expression: 0.title

These match the Variable “title” in the following JSON:

Code Block
[
   {
      "userId":1,
      "id":2,
      "title":"qui est esse",
      "body":"Hello world"
   }
]


Response Output File

Full Path and file name of the Output File

The field is only visible if in the Response Processing field one of the following entries has been selected: [Print HTTP Response Header to File | Print HTTP Response Body to File]

The Response is written to an Output File on the File System.

For example, Output File = /home/stonebranch/demo/out/name.json

Response Exit Code Mapping

The Value that pattern match the Path Expression of the JSON output, will used in the Response Exit Code Mapping table to set the exit code of the Task.

Please refer to the Example See Response Exit Code Mapping Example.

Proxies

Proxy Server

https=https://proxyip:port

For example,

https=https://192.155.10.130:8080

Log level (default is Inherited)

Universal Task logging settings: [Inherited | Trace | Debug | Info | Warn | Error | Severe]

...