Web Services Methods › REST HTTP Methods

REST HTTP Methods

The REST API supports the following HTTP methods to manipulate resources:

• POST (CREATE) creates a resource.
• GET (READ) returns a representation of a resource.
• PUT (UPDATE) updates an existing resource.
• DELETE deletes the resource.

Refer to this basic set of methods as CRUD. Each method works in the same manner on all CA SDM resources. You require an HTTP client library, available with most programming languages. Use the HTML client library to complete the following tasks:

• Access and modify associated (or related) resources using a multilevel URI path.
• Send an HTTP request to the server for the resource that you want to manipulate.
• Control the object attributes to be returned by using HTTP headers.

After you update Majic object definitions and recycle CA SDM, the product automatically regenerates and redeploys the corresponding Plain Old Java Objects (POJOs) into the REST Tomcat webapps directory.

Note: The pdm_rest_util command line utility lets you manually generate, compile, and deploy Java code that REST web services require.

Important! Requests for attributes that do not respond indicate a null attribute value. Modify your client code accordingly because REST does not display null attribute values in responses.

REST Web Services provide a scalable configuration and better flexibility to our users by letting you connect to a dedicated domsrvr on the local server. By default, CA SDM r12.9 provides the NX_REST_WEBSERVICE_DOMSRVR variable to domsrvr. You can edit NX.env to change this setting.

CA SDM disables the REST sample mobile user interface and exposes all Majic factories through REST Web Services by default.

Important! The REST API does not support Majic attributes of type DOUBLE.

The following table shows how the REST API uses HTTP methods on resources.