Defining a Web Service Provider (REST)

Defining this object establishes the required objects when providing a REST Service to be made available for consumers.

If you haven't already created this object, see Creating a Web Service Provider.
This task assumes you have selected REST as the Web Consumer type.

  1. Under Settings, the Service Name is populated with the actual name you provided when the Web Service Provider object was first created.
  2. The Business Process is also pre-populated.
    Clarify automatically creates a corresponding package containing a Business Process, which is preconfigured with the Web Service Provider object just defined in this task. The Business Process contains two tasks: SendRestReply, which sends the response message to a consumer, and SetExitStatus, which sets the Business Process’s Exit Status to true. All task parameters are pre-populated. Additional configuration is required.
    Note: Any additional tasks will need to be added and defined to the Business Process. For example, some additional tasks might include determining the requested purchase order number (using GetProperty), gathering the data, and generating an e-mail (SendEmail).
  3. To configure HTTP Basic Authentication Validation for this Web Service Provider, select Basic from the Authorization Type drop-down.

    Basic Authentication must be enabled through Access Control. Once the object has been configured (and deployed), basic authentication must be enabled through the Access Control View in the Admin Console. To do so, create or edit a user profile so that it contains the Authorize Web Services Provider Connections security permission. Only users with a specific Access Control permission (Add/Modify/Delete Users, Roles, and LDAP Profiles) can do this.

    Note: For added security, do not assign the Web Services permission to the existing admin or superuser roles.
  4. Under the Default Response HTTP Headers section, include any additional Header information required as part of the consumer request.
    HTTP header fields are components of the message header of requests and responses used in HTTP. They define additional information about the request to and response from the Service provider. This additional information may be sent with the status codes. This may include required authentication info, such as user name and password, or just additional information about the requester. They can be used to override common headers, or create custom ones. Examples of common header fields include cookie, ETag, Location, HTTP referer, DNT, and X-Forwarded-For.