IBM Business Process Manager, V8.0.1, All platforms > Reference > Commands and scripts > Commands (wsadmin scripting)

registerRESTServiceEndpoint command

Use the registerRESTServiceEndpoint command to register configured and enabled Representational State Transfer (REST) endpoints so that your team can use IBM Business Process Manager widgets.

This command registers the REST service endpoints so that Business Space is properly connected to widgets for your product. This command registers the endpoints of the REST services that are in the same cell as Business Space.

After using the command, save your changes to the master configuration using one of the following commands:

• For Jython:

  AdminConfig.save()
  

• For Jacl:

  $AdminConfig save
  

If the application server is not running, supply the -conntype NONE option when running this command.

Required parameters

-clusterName name_of_rest_services_cluster

A parameter that specifies the cluster name for the REST service. When registering REST services endpoints for a cluster, you must specify a clusterName.

-nodeName name_of_rest_services_node

A parameter that specifies the node name for the REST service. When registering REST services endpoints for a server, you must specify both a serverName and a nodeName.

-serverName name_of_rest_services_server

A parameter that specifies the server name for the REST service. When registering REST services endpoints for a server, you must specify both a serverName and a nodeName.

-businessSpaceClusterName name_of_business_space_cluster

The Business Space cluster name. If Business Space is configured on a cluster, you must specify a businessSpaceClusterName.

-businessSpaceNodeName name_of_business_space_node

The Business Space node name. If Business Space is configured on a server, you must specify both a businessSpaceServerName and a businessSpaceNodeName.

-businessSpaceServerName name_of_business_space_server

The Business Space server name. If Business Space is configured on a server, you must specify both a businessSpaceServerName and a businessSpaceNodeName.

Optional parameters

-appName name_of_provider_application

The application name of the REST service provider.

-name name_of_rest_service

The name of the REST service.

-type name_of_service_type

The type of the service. This parameter is optional. If this parameter is not specified, all unique REST service endpoints configured for a specified REST service provider on a specified deployment target are registered. If you want to specify a specific service endpoint, use the <tns:type> value that is in the endpoints file for a widget. The service endpoints files are located at install_root\BusinessSpace\registryData\product_name\endpoints directory.

For example, bpmAdministrationEndpoints.xml contains all service endpoint types that are used by Administration widgets. The value of the <tns:type> element is {com.ibm.bpm}SCA:

<tns:Endpoint>
    <tns:id>{com.ibm.bpm}SCA</tns:id>
    <tns:type>{com.ibm.bpm}SCA</tns:type>
    <tns:version>6.2.0.0</tns:version>
    <tns:url>/rest/sca/v1</tns:url>
    <tns:description>Location backend SCA REST Services
 for Module Administration widgets and Service Monitoring widget
</tns:description>
  </tns:Endpoint>

For Jacl, make sure to use double quotation marks around the value, for example: ... -type "{com.ibm.bpm}SCA" ....

-version name_of_version

The version of the REST service provider.

-webModuleName name_of_web_module

The web module name of the REST service provider.

Examples

The following example uses the registerRESTServiceEndpoint command. It registers all configured and enabled REST services on the cluster with Business Space.

• Jython example:

  AdminTask.registerRESTServiceEndpoint('[-clusterName
   name_of_rest_services_cluster -businessSpaceClusterName
   name_of_business_space_cluster]')
  

• Jacl example:

  $AdminTask registerRESTServiceEndpoint {-clusterName
   name_of_rest_services_cluster -businessSpaceClusterName
   name_of_business_space_cluster}
  

Parent topic: Commands (wsadmin scripting)

Related information:

Obtaining online help using wsadmin scripting
Administrative command invocation syntax using wsadmin scripting
Use the wsadmin scripting tool
Jython script library