Jump to

• Request
• Response

Retrieve Environment

get

/mobile/tools/1.0/environment

Returns the environment's metadata.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The environment's metadata.

Body ()

The environment representation for GET requests.

Root Schema : environment

Type: object

The environment representation for GET requests.

Show Source

• baseUri(optional): string
  The public facing OHS URI (if present) or the core server's direct URI for the environment.
• displayName(optional): string
  The environment display name.
• envId(optional): string
  The environment ID.
• oauthServer(optional): string
  OAuth server endpoint URL.
• serviceName(optional): string
  The name of the service in the SIM that is hosting the environment.

{
    "description":"The environment representation for GET requests.",
    "type":"object",
    "properties":{
        "oauthServer":{
            "description":"OAuth server endpoint URL.",
            "type":"string"
        },
        "displayName":{
            "description":"The environment display name.",
            "type":"string"
        },
        "baseUri":{
            "description":"The public facing OHS URI (if present) or the core server's direct URI for the environment.",
            "type":"string"
        },
        "envId":{
            "description":"The environment ID.",
            "type":"string"
        },
        "serviceName":{
            "description":"The name of the service in the SIM that is hosting the environment.",
            "type":"string"
        }
    },
    "required":[
        "name",
        "links",
        "id",
        "published",
        "version"
    ]
}

Back to Top