Get an approval for a software services template

You can use this operation to retrieve an approval for a software services template.

HTTP method and URI path

GET /zosmf/provisioning/rest/<version>/scc/<object-id>/approvals/
<approval-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 software services template that the approval is associated with..
<approval-object-id>: Identifies the approval to retrieve.

Query parameters

None.

Description

This operation retrieves an approval for a software services template.

On successful completion, HTTP status code 200 (OK) is returned, indicating that the request resulted in an approval being retrieved. A response body is provided, as described in Response content

Request content

None.

Authorization requirements

The user's z/OS user ID must be defined as a landlord, domain administrator, domain approver, or template approver.

The user’s z/OS user ID must have READ access to the following resource profile in the ZMFAPLA class: <SAF-prefix>.ZOSMF.PROVISIONING.SOFTWARE_SERVICES.

See Authorization requirements.

HTTP status codes

On successful completion, HTTP status code 200 (OK) is returned.

Response content

On successful completion, the service returns a response body, which contains a JSON object with details about the approval. Table 1 lists the fields in the JSON object.

Table 1. Response from a get approval request
Field	Type	Description
status	String	Status of the approval for this object: pending, approved, or rejected.
comment	String	Comment that is associated with the change in status from pending to either approved or rejected.
description	String	Additional detail that is provided if the approval is for a workflow definition that is associated with the action definition.
user-ids	Array of strings	Each string in the array is a user ID that can approve the template, workflow step, or action. Any one of the user IDs in the array can approve or reject. The last action takes precedence.
status-update-by	String	User ID that performed the last approve or reject action for this approval object.
time-of-update	String	The last time this object was updated, in ISO 8601 format.
run-as-user	String	The runAsUser user ID that the approval object is for. This applies only to action_definition and step_definition types.
type	String	Type of approval object: general, domain, action_definition, or step_definition.
object-id	String	Unique object ID representing this approval object.
workflow-file	String	Workflow file definition that is associated with this runAsUser user ID.
variable-input-file	String	Specifies the variable input file that is associated with this runAsUser user ID.
step-name	String	Workflow file definition step that is associated with this runAsUser user ID.
called-by-step-name	String	Step in the parent workflow definition that called the workflow definition file that generated the approval object. Used if the definition file that generated the approval object is a callable workflow.
called-by-workflow-file	String	Workflow definition file that called the workflow definition file that generated the approval object. Used if the definition file that generated the approval object is a callable workflow.
actions-file	String	Actions definition file that is associated with this runAsUser user ID.
action-name	String	Action defined in the actions definition file that is associated with this runAsUser user ID.

Example HTTP interaction

In Figure 1, a request is submitted to get an approval record for a software services template.

Figure 1. Sample request to get an approval record for a software services template

GET https://localhost:4444/zosmf/provisioning/rest/1.0/scc/8abd70b5-ac74-4f4a-bc09-266bf7cf8270/
approvals/dacea656-ffbe-48ce-a193-575161ff9d43

The following is the response body for the request.

Figure 2. Sample response body

    {
      "status": "approved",
      "comment": "approved",
      "description": "General approval for all of the template contents.",
      "type": "general",
      "object-id": "dacea656-ffbe-48ce-a193-575161ff9d43",
      "user-ids": [
        "zosmfad"
      ],
      "status-update-by": "zosmfad",
      "time-of-update": "2016-11-18T19:13:00.435Z",
      "run-as-user": null,
      "workflow-file": null,
      "variable-input-file": null,
      "step-name": null,
      "called-by-step-name": null,
      "called-by-workflow-file": null,
      "actions-file": null,
      "action-name": null
    }