Get Variant By Env
GET/apps/get_variant_by_env
Retrieve the app variant based on the provided app_id and environment.
Args: app_id (str): The ID of the app to retrieve the variant for. environment (str): The environment of the app variant to retrieve. stoken_session (SessionContainer, optional): The session token container. Defaults to Depends(verify_session()).
Raises: HTTPException: If the app variant is not found (status_code=500), or if a ValueError is raised (status_code=400), or if any other exception is raised (status_code=500).
Returns: AppVariantResponse: The retrieved app variant.
Request
Query Parameters
app_id App Idrequired
environment Environmentrequired
Responses
- 200
- 422
Successful Response
- application/json
- Schema
- Example (from schema)
Schema
app_id App Id (string)required
app_name App Name (string)required
variant_id Variant Id (string)required
variant_name Variant Name (string)required
parameters object
previous_variant_name Previous Variant Name (string)
user_id User Id (string)required
base_name Base Name (string)required
base_id Base Id (string)required
config_name Config Name (string)required
uri Uri (string)
revision Revision (integer)required
organization_id Organization Id (string)
workspace_id Workspace Id (string)
{
  "app_id": "string",
  "app_name": "string",
  "variant_id": "string",
  "variant_name": "string",
  "parameters": {},
  "previous_variant_name": "string",
  "user_id": "string",
  "base_name": "string",
  "base_id": "string",
  "config_name": "string",
  "uri": "string",
  "revision": 0,
  "organization_id": "string",
  "workspace_id": "string"
}
Validation Error
- application/json
- Schema
- Example (from schema)
Schema
- Array [ 
- Array [ 
- MOD1
- MOD2
- ] 
- ] 
detail
object[]
loc
object[]
required
anyOf
string
integer
msg Message (string)required
type Error Type (string)required
{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}
Loading...