Base class of Services.
A service represents a call-specific configuration. Any configuration set here is local to the currently executing call.
See Also:
FTPService, HTTPFormService, HTTPService, SOAPService
| Property | Description |
|---|---|
| URL: String | Returns the current URL, excluding any custom query parameters. |
configuration: ServiceConfig (read-only) | Returns the Service Configuration. |
| credentialID: String | Returns the ID of the currently associated Credential. |
| mock: Boolean | Returns the status of whether this service is executing in mock mode. |
requestData: Object (read-only) | Returns the property that stores the object returned by createRequest. |
response: Object (read-only) | Returns the property that stores the object returned by the service. |
| throwOnError: Boolean | Returns the status of whether this service will throw an error when encountering a problem. |
This class does not have a constructor, so you cannot create it directly.
| Method | Description |
|---|---|
| call(Object…) | Invokes the service. |
| getConfiguration() | Returns the Service Configuration. |
| getCredentialID() | Returns the ID of the currently associated Credential. |
| getRequestData() | Returns the property that stores the object returned by createRequest. |
| getResponse() | Returns the property that stores the object returned by the service. |
| getURL() | Returns the current URL, excluding any custom query parameters. |
| isMock() | Returns the status of whether this service is executing in mock mode. |
| isThrowOnError() | Returns the status of whether this service will throw an error when encountering a problem. |
| setCredentialID(String) | Override the Credential by the credential object with the given ID. |
| setMock() | Forces the mock mode to be enabled. |
| setThrowOnError() | Forces a Service to throw an error when there is a problem instead of returning a Result with non-OK status. |
| setURL(String) | Override the URL to the given value. |
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
Returns the current URL, excluding any custom query parameters.
(read-only)Returns the Service Configuration.
Returns the ID of the currently associated Credential.
Returns the status of whether this service is executing in mock mode.
(read-only)Returns the property that stores the object returned by createRequest.
(read-only)Returns the property that stores the object returned by the service.
This property is only useful after the service call(Object...) completes, and is the same as the object inside the Result.
Returns the status of whether this service will throw an error when encountering a problem.
Invokes the service.
Parameters:
1svc.call( [1,2,3] )1and is functionally equivalent to1svc.call( 1, 2, 3 )1This can be avoided by explicitly forming a [List](dw.util.List.md), enclosing the array in another array, or by sending a second argument. The following will all send the array as a List in the first argument.1svc.call( ArrayList([1,2,3]) )1svc.call( [[1,2,3]] )1svc.call( [1,2,3], "" )1Another option is to change the definition of the associated [ServiceCallback.createRequest(Service, Object...)](dw.svc.ServiceCallback.md#createrequestservice-object) to accept an object instead, and pass the array as a field of that object:1svc.call( { 'data': [1,2,3] } )1**Returns:**
2- Result of the service.Returns the Service Configuration.
Returns:
Returns the ID of the currently associated Credential.
Returns:
Returns the property that stores the object returned by createRequest.
Returns:
Returns the property that stores the object returned by the service.
This property is only useful after the service call(Object...) completes, and is the same as the object inside the Result.
Returns:
Returns the current URL, excluding any custom query parameters.
Returns:
Returns the status of whether this service is executing in mock mode.
Returns:
Returns the status of whether this service will throw an error when encountering a problem.
Returns:
Override the Credential by the credential object with the given ID.
If the URL is also overridden, that URL will continue to override the URL in this credential.
Parameters:
Returns:
Forces the mock mode to be enabled.
Returns:
Forces a Service to throw an error when there is a problem instead of returning a Result with non-OK status.
Returns:
Override the URL to the given value. Any query parameters (if applicable) will be appended to this URL.
Parameters:
Returns:
j