Get a domain

Use this operation to retrieve a domain.

HTTP method and URI path

GET /zosmf/resource-mgmt/rest/<version>/domains/<object-id>

In this request:

<version>: Is the URI path variable that identifies the version of the z/OSMF software services template service. The following value is valid: 1.0.
<object-id>: Identifies the domain to be retrieved.

Query parameters

None.

Description

This operation retrieves a domain.

On successful completion, HTTP status code 200 (OK) is returned, indicating that the request resulted in a domain being retrieved.

Request content

None.

Authorization requirements

The user must be a landlord, domain administrator, or consumer in the domain.

For more information, see Resource management services.

HTTP status codes

On successful completion, HTTP status code 200 (OK) is returned, and with a response body. See Response content.

Otherwise, the following HTTP status codes are returned for the indicated errors. The response body is a standard error response body that provides the reason code that is indicated and associated error message.

Table 1. HTTP error response codes for a get domain request
HTTP error status code	Description
`HTTP 400 Bad request`	The request contains incorrect parameters.
`HTTP 404 Not found`	The requested domain does not exist.
`HTTP 500 Internal server error`	The server encountered an error. See the response body for a JSON object with information about the error.

Response content

On successful completion, the service returns a response body, which contains a JSON object with details about the domain. See Table 2.

Table 2. Response from a get domain request
Field	Type	Description
domain-id	String	The generated ID for the domain.
domain-name	String	Descriptive name for the domain.
domain-system-list	Array	Array describing the systems in the domain. See Table 3.
domain-administrator-list	String	List of user IDs for the domain administrators.
network-administrator-list	String	List of user IDs for the network administrators.
wlm-administrator-list	String	List of user IDs for the WLM administrators.
security-administrator	String	User ID of the security administrator.
security-job-statement	String	JOB statement JCL used in security jobs for the domain.
domain-approver-list	String	List of user IDs for the domain approvers.
object-uri	String	URI of the newly created object.
domain-description	String	Description of the domain.

Table 3. Response from a get request: Systems
Field	Type	Description
sysplex-name	String	Name of the sysplex. The name is the value specified for the SYSPLEX parameter of the cross-system coupling facility (XCF) couple data set format utility.
sysplex-node-name	String	Sysplex node name.
system-nickname	String	Unique name that is assigned to the system definition.

Example HTTP interaction

In Figure 1, a request is submitted to retrieve a domain.

Figure 1. Sample request to get a domain

GET https://localhost:4444/zosmf/resource-mgmt/rest/1.0/domains/<object-id>

The following is the response body for the example get domain request.

{
         "domain-id":"izu$0",
         "domain-name":"default",
         "domain-system-list":[{
             "sysplex-name":"DUMBPLEX",
             "sysplex-node-name":"DUMBNODE",
             "system-nickname":"DUMBNODE_001"},
         ...
         ],
         "domain-administrator-list":["ZOSMFT1", ... ],
         "network-administrator-list":["ZOSMFT1", ... ],
         "wlm-administrator-list":["ZOSMFT1", ... ],
         "security-administrator":"ZOSMFT1",
         "security-job-statement" : "//JOBCARD JOB(acct-info)",
         "domain-approver-list":["ZOSMFT1", ... ],
         "object-uri":"/zosmf/resource-mgmt/rest/1.0/domains/izu$0",
         "domain-description":"default domain"
     }