Difference between revisions of "Common:Web Service Configuration"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
(13 intermediate revisions by the same user not shown) | |||
Line 1: | Line 1: | ||
<noinclude>__NOINDEX__</noinclude> | |||
# In the Web Service Configuration form, configure the connection: | # In the Web Service Configuration form, configure the connection: | ||
#* '''Basic Parameters:''' | |||
* '''Basic Parameters:''' | #:* '''Title -''' Required. Give the service a name. (Displays in the '''Name''' column of the Services list.) | ||
:* '''Title -''' Required. Give the service a | #:* '''Operation''' | ||
:* '''Operation''' | #:*: Required for a SOAP service. Not present for REST. | ||
:*: Required for a SOAP service. Not present for REST. | #:*: Choose one of the operations defined in the WSDL file. | ||
:*: Choose one of the operations defined in the WSDL file. | #:* '''Version -''' Required. Enter text to identify the service version | ||
:* '''Version -''' Required. Enter text to identify the service version | #:* '''Pipeline Service''' | ||
:* '''Pipeline Service | #:*: Check this box for a service that provides values for use in other web services. | ||
:*: Check this box for a service that provides values for use in other web services. | #:*: Any outputs from it that are made available for mapping can be used as inputs to other web services. | ||
:*: Use it, for example, for a service that | #:*: Use it, for example, for APIs that be accessed only after logging in. You create a service that logs in and retrieves the cookie value or other access key required for subsequent requests. (That "two-step service chain" will be described in more detail, shortly.) | ||
: | #: | ||
* '''Service Parameters:''' | #:* '''Debug''' | ||
:* '''URL -''' Optional | #:*: Check this box to record successful executions of a Web Service in the [[Audit Log]], in addition to the standard recording of service errors. | ||
:* '''Use Basic Auth -''' Check this box when the destination URL requires a username and password to be included in the standard <tt>http</tt> header. | #: | ||
::* '''Username -''' Optional. Username required to use the service, when needed | #* '''Service Parameters:''' | ||
::* '''Password -''' Optional. Password required to use the service, when needed | #:* '''URL -''' Optional for SOAP (used to point to a destination other than one specified by the WSDL). Required for REST. | ||
: | #:* '''Use Basic Auth -''' Check this box when the destination URL requires a username and password to be included in the standard <tt>http</tt> header. | ||
:* '''Use a Pipeline Service -''' Check this box when the service request requires a prior | #::* '''Username -''' Optional. Username required to use the service, when needed | ||
:*: Select a pipeline Web Service defined earlier for use in a two-step service chain. | #::* '''Password -''' Optional. Password required to use the service, when needed | ||
: | #: | ||
:* '''TTL -''' Optional. The "Time to Live", in milliseconds. | #:* '''Use a Pipeline Service -''' Check this box when the service request requires information from a prior service. (For example, a session ID or other access key.) | ||
:*: | #:*: Select a pipeline Web Service defined earlier for use in a two-step service chain. | ||
#: | |||
#:* '''TTL -''' Optional. The "Time to Live", in milliseconds. | |||
#:*: The amount of time the platform waits before abandoning a request. |
Latest revision as of 23:35, 29 April 2014
- In the Web Service Configuration form, configure the connection:
- Basic Parameters:
- Title - Required. Give the service a name. (Displays in the Name column of the Services list.)
- Operation
- Required for a SOAP service. Not present for REST.
- Choose one of the operations defined in the WSDL file.
- Version - Required. Enter text to identify the service version
- Pipeline Service
- Check this box for a service that provides values for use in other web services.
- Any outputs from it that are made available for mapping can be used as inputs to other web services.
- Use it, for example, for APIs that be accessed only after logging in. You create a service that logs in and retrieves the cookie value or other access key required for subsequent requests. (That "two-step service chain" will be described in more detail, shortly.)
-
- Debug
- Check this box to record successful executions of a Web Service in the Audit Log, in addition to the standard recording of service errors.
- Debug
- Service Parameters:
- URL - Optional for SOAP (used to point to a destination other than one specified by the WSDL). Required for REST.
- Use Basic Auth - Check this box when the destination URL requires a username and password to be included in the standard http header.
- Username - Optional. Username required to use the service, when needed
- Password - Optional. Password required to use the service, when needed
-
- Use a Pipeline Service - Check this box when the service request requires information from a prior service. (For example, a session ID or other access key.)
- Select a pipeline Web Service defined earlier for use in a two-step service chain.
- Use a Pipeline Service - Check this box when the service request requires information from a prior service. (For example, a session ID or other access key.)
-
- TTL - Optional. The "Time to Live", in milliseconds.
- The amount of time the platform waits before abandoning a request.
- TTL - Optional. The "Time to Live", in milliseconds.