/policyengine/v1/applications/<deployment_name>/schema?action_id=<action_id>: GET

Gets the application schema for a specified application.

This endpoint returns the schema from the application registration message. The schema is used by the UI to dynamically generate policy creation views for the registered application. If the action ID is not specified as a query parameter, the endpoint returns the whole schema. For the specified action ID, a subset of the registration schema is returned.

The following table displays the roles that can access the REST API endpoint.
Table 1. Access by role
Data admin Data user Collection Admin Admin Service user
✓ ✓ ✓ Χ Χ

Synopsis of the request URL

curl -k -H 'Authorization: Bearer <token>' https://<spectrum_discover_host>/policyengine/v1/
applications/<deployment_name>/schema?action_id=<action_id>  -X GET -H ’Accept: application/json’

Supported request types and response formats

Supported request types:
  • GET
Supported response formats:
  • JSON

Examples

The following example returns the application schema for a specified application and a specified action ID that is registered on the system.

Issue the following request in one line:

curl -k -H 'Authorization: Bearer <token>' 
https://<spectrum_discover_host>/policyengine/v1/applications/ScaleILM/schema?action_id=MOVE -X GET -H ’Accept: application/json’
The following response is returned:
{
  "properties": {
    "destination_tier": {
      "description": "Tier name which can be a Spectrum Scale internal pool name or an external pool name like ‘tape-archive’ to tier the files to a LTFS Tape library configured on the Spectrum Scale cluster. Internal pool names are mentioned as-is, while the external pools are mentioned as ‘external:tape-archive:pool1@lib1’ or ‘external:cos’ (future use). External pool name ‘tape-archive’ is an IBM Spectrum Discover defined pool name for the LTFSEE Tape pool configured on the Spectrum Scale system.",
      "type": "string"
    },
    "source_connection": {
      "description": "Defines platform name of the source data connection.",
      "type": "string"
    }
  },
  "required": [
    "source_connection",
    "destination_tier"
  ],
  "type": "object"
}