1 Introduction and Roadmap

This chapter describes the contents and organization of this guide—Administering Oracle WebLogic Server with RESTful Management Services.

Topics

Document Scope and Audience

This document describes how to use Oracle WebLogic Server RESTful management interfaces for administration, monitoring, deploying, and configuration tasks which are exposed for developing RESTful clients. The user communities for this documentation are administrators who might use cURL commands to invoke these resources in administration scripts, and software developers who will use this information when writing code, perhaps in Java, perhaps in other languages, that monitors and manages WLS domains.

Guide to this Document

This chapter, Introduction and Roadmap, describes the organization of this guide.
About the WLS RESTful Management Interface provides an introduction to the WLS RESTful management interface, useful background and mapping information, and the HTTP status codes returned by WLS REST resources.
Using the WLS RESTful Management Interface describes how to use the RESTful management services supported by WebLogic Server.
Domain Level REST API Examples contains example scripts for users in domain level roles that show how to use the WLS REST APIs to perform common domain and partition management and monitoring tasks
Partition Specific REST API Examples contains example scripts for users in partition level roles that show how to use the WLS REST APIs to perform common partition management and monitoring tasks.

Information Roadmap

WebLogic Server REST resources are based on WLS bean trees and organized according to their corresponding root resources. For more information, see Mapping the WLS Beans to REST.

The REST resources for managing WLS within specified partitions reside in separate manuals (MT reference guides). Each MT manual refers to resources accessible to partition user roles. Each non-MT manual refers to resources accessible to domain user roles. For more information about user roles in WebLogic Server Multitenant, see "Administrative Roles for Configuration and Management" in Using WebLogic Server Multitenant.

In the MT reference guides, REST resources:

Are running in a partition.
Must be accessed over a partitioned URL by a user defined in that partition's security realm.
Only can be used to manage that partition.
Cannot be used to manage all WLS MBeans. Many of the WLS MBeans are not available to partition users.

In the non-MT reference guides, REST resources:

Run at the domain level (versus in a partition).
Must be accessed over a non-partitioned URL by a user defined in the domain's default security realm.
Can be used to manage all partitions.
Can be used to manage all WLS MBeans.

See Table 1-1 for a complete listing of the WLS REST reference documents and descriptions of their use.

Table 1-1 WLS RESTful Management Interface Reference Documentation

Book Title	Use These REST Resources To...
RESTful Edit Reference for Oracle WebLogic Server	Edit the WLS configuration.
RESTful Domain Configuration Reference for Oracle WebLogic Server	View the last activated WLS configuration.
RESTful Domain Runtime Reference for Oracle WebLogic Server	Monitor the entire WLS domain.
RESTful Server Configuration Reference for Oracle WebLogic Server	View the WLS configuration that the Administration Server or Managed Server is currently running against.
RESTful Server Runtime Reference for Oracle WebLogic Server	Monitor the Administration Server or a Managed Server. You can monitor a Managed Server either by using the Administration Server's `domainRuntime/serverRuntimes/<managedServerName>/...` resources or the Managed Server's `serverRuntime/...` resources.
RESTful Edit Reference for Oracle WebLogic Server MT	Edit the WLS configuration in the specified domain partition.
RESTful Domain Configuration Reference for Oracle WebLogic Server MT	View the last activated WLS configuration in the specified domain partition.
RESTful Domain Runtime Reference for Oracle WebLogic Server MT	Monitor the specified WLS domain partition.
RESTful Server Configuration Reference for Oracle WebLogic Server MT	View the WLS configuration that the Administration Server is currently running against in the specified domain partition.
RESTful Server Runtime Reference for Oracle WebLogic Server MT	Monitor the Administration Server in the specified domain partition
RESTful Lifecycle Reference for Oracle WebLogic Server	Use WLS life cycle management REST resources.
RESTful Management Interface Reference for Oracle WebLogic Server	Legacy WLS RESTful management resources.

New and Changed Features In This Release

For a comprehensive listing of all the new WebLogic Server features introduced in this release, see What's New in Oracle WebLogic Server 12.2.1.2.0.