Obtain a SNA application name

Use this operation to obtain a SNA application name from a resource pool that has a configured network resource pool.

HTTP method and URI path

POST /zosmf/resource-mgmt/rest/<version>/rdp/network/snaapplname/actions/obtain

In this request:

<version>: Is the URI path variable that identifies the version of the z/OSMF service. The following value is valid: 1.0.

Query parameters

None.

Description

This operation obtains a SNA application name from a resource pool with a configured network resource pool.

On successful completion, HTTP status code 200 (OK) is returned, indicating that the request resulted in a SNA application name being obtained.

Request content

The request content is expected to contain a JSON object that describes the SNA application name to be obtained. See Table 1.

Table 1. Request content for the obtain SNA application name request
Field name	Type	Required or optional	Description
template-uuid	String	Required	Unique identifier for the template that is associated with the resource pool. Derived from a workflow internal variable, ${_workflow-templateID}.
template-name	String	Required	Name of the template that is associated with the resource pool. Derived from a workflow internal variable, ${_workflow-templateName}.
tenant-id	String	Required	Name of the tenant that is associated with the resource pool. Derived from a workflow internal variable, ${_workflow-tenantID}.
network-parms	Array	Required	Network parameters for the request. See Table 2.

Table 2. Network parameters fields
Field	Type	Optional/Required	Description
name	String	Optional	Name, used in a panel for the Configuration Assistant task.
deployment-id	String	Optional	Workflow-defined string token.
sna-appl-name	String	Required	A name for the SNA application. Derived from the workflow internal variable ${_workflow-softwareServiceInstanceName}.

Authorization requirements

The user must be a consumer in the tenant, or a network administrator in the domain that the tenant is associated with.

For more information, see Authorization requirements.

HTTP status codes

On successful completion, HTTP status code 200 (OK) is returned, 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 3. HTTP error response codes for an obtain SNA application name request
HTTP error status code	Description
`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 request. See Table 4.

Table 4. Response from an obtain SNA application name request
Field	Type	Description
id	String	Identifier of the SNA application name. Needed for the release call, as the value for the appl-name-id property.
appl-name	String	Required. Application name from the network resource pool in the Configuration Assistant task.

Example HTTP interaction

In Figure 1, a request is submitted to obtain a SNA application name.

Figure 1. Sample request to obtain a SNA application name, with request body

POST https://localhost:4444/zosmf/resource-mgmt/rest/1.0/rdp/network/snaapplname/actions/obtain

{ 
   “template-uuid”:”F0F1A1C2”,  
   "template-name":"CICSBasic",  
   “tenant-id”:”IZU$0AA”, 
    “network-parms” : 
    { 
      "name":"CICSA APPLID", 
      “deployment-id”:”CICSBasic”, 
      "sna-appl-name":"CICSA001" 
     }
}

The following is the response body for the example obtain SNA application name request.

{
      "id":82346,
      "appl-name":"CICSC10"
 }