Database property names for web service input devices

Some parts of the system and messages about web service input devices refer to properties by their database names. If a property is specific to REST web service input devices, its database property name begins with REST. Properties whose names begin with WebService apply to both REST and SOAP web service input devices.

Some of the values that you see in drop-down lists in the user interface are not the same as the values that Ricoh ProcessDirector uses internally. When you set the value of a property in an overrides file or an external program, use the internal value. The Internal values column lists the internal values for those properties.

In the Editable column:

  • Yes means that you can change the value after the input device has been created.
  • No means that you cannot change the value.

Web service input device properties

Database name Notebook tab: field name Brief description Internal values Editable
RESTWebService.AuthRequestHeader Authentication: Authentication request header Specifies the HTTP header field the web service input device uses to authenticate to another application.   Yes
RESTWebService.AuthRequestParams Authentication: Authentication request parameters Specifies the parameters the web service input device sends to an external application and receives the authentication back. Examples of these parameters are the user ID and password.   Yes
RESTWebService.AuthResponseContentType Authentication: Authentication response content type Specifies the response format the web service input device receives for authentication.
  • JSON
  • XML
Yes
RESTWebService.RequestHeader Request: Request header Specifies the HTTP header field the web service input device uses to request data for another application.   Yes
RESTWebService.RequestParams Request: Request parameters Specifies the parameters the web service input device sends to an external application.   Yes
RESTWebService.ResponseContentType Request: Response content type Specifies the response format the web service input device receives data in.
  • JSON
  • XML
Yes
WebService.AuthRequestMethod Authentication: Authentication request method Specifies the method type the web service input device calls for authentication.
  • GET
  • POST
Yes
WebService.AuthRequestPayload Authentication: Authentication request payload Specifies the payload to be passed to the specified web service.   Yes
WebService.AuthRequestPwd Authentication: Authentication request password A password that is used to get a single-use credential for a session. You reference the password in the Authentication request payload property as a symbol. The web site returns a token when authentication is successful.   Yes
WebService.AuthRequestURL Authentication: Authentication request URL Specifies the URL that Ricoh ProcessDirector uses to authenticate with a web site or application.   Yes
WebService.AuthResponseAttribute Authentication: Authentication response attribute Specifies the XPath or JSONPath to the element in the response to the authentication request that contains the credential for the session. This value is stored as the Static credential for the session.   Yes
WebService.LastSuccessRequestTime Status: Time of last successful request Shows the date and time when the web service input device last successfully requested a response from a web service for an external application.   No
WebService.RequestMethod Request: Request method Specifies the method type the web service input device calls for processing.
  • GET
  • POST
Yes
WebService.RequestPayload Request: Request payload Specifies the payload the web service passes to an external application.   Yes
WebService.RequestURL Request: Request URL Specifies the URL of the web service that the web service input device communicates with.   Yes
WebService.StaticCredential Authentication: Static credential The authorization code that Ricoh ProcessDirector uses to connect to an external application that requires multiple-use authentication.   Yes
WebService.UseProxy Request: Use proxy Specifies whether the web service input device communicates through a proxy server.
  • Yes
  • No
Yes
 
Copyright © 2016, 2018