GET /gui_app_framework/application_definitions/{application_definition_id}
Retrieve an application definition.
Retrieve an application definition.
Retrieved details include the application manifest and current status.
| MIME Type |
|---|
application/json |
| Parameter | Type | Optionality | Data Type | MIME Type | Description |
|---|---|---|---|---|---|
application_definition_id |
path |
Required |
Number (Integer) |
text/plain |
Required - The application definition identifier. |
fields |
query |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
| HTTP Response Code | Unique Code | Description |
|---|---|---|
200 |
The application definition was retrieved. |
|
404 |
33900 |
The application definition ID does not exist. |
409 |
33700 |
The application framework is currently disabled. |
500 |
1020 |
The request could not be completed. |
Response Description
Application details:
- application_definition_id - Long - Application Definition identifier.
- status - String
- CREATING - application definition is being created.
- UPGRADING - application definition is being upgraded.
- DELETING - application definition is being deleted.
- COMPLETED - application definition creation/upgrade completed successfully.
- CANCELLED - application definition has been cancelled.
- ERROR - application definition creation/upgrade did not complete successfully.
- error_messages - String - The last error that occurred during an async operation on the definition.
- error_messages_json - String - The last error that occurred during an async operation on the definition in json format.
- manifest - Object - The application definition's JSON manifest.
- image - String - The base image that will be used to build the app.
- created_by - String - The user that created the application definition.
- created_on - Long - A timestamp representing the created on date and time for the application definition
- user_role_ids - Array - The IDs of the associated user roles
Response Sample
{
"application_definition_id": 42,
"created_by": "String",
"created_on": 42,
"error_messages": "String",
"error_messages_json": [
{
"code": "String",
"message": "String",
"source": "String"
}
],
"image": "String",
"manifest": {
"areas": [
{
"description": "String",
"id": "String",
"named_service": "String",
"required_capabilities": [
"String"
],
"text": "String",
"url": "String"
}
],
"authentication": {
"oauth2": {
"authorization_flow": "String",
"requested_capabilities": [
"String"
]
}
},
"configuration_pages": [
{
"description": "String",
"icon": "String",
"location": "String",
"named_service": "String",
"required_capabilities": [
"String"
],
"text": "String",
"url": "String"
}
],
"console_ip": "String",
"custom_columns": [
{
"label": "String",
"named_service": "String",
"page_id": "String",
"required_capabilities": [
"String"
],
"rest_endpoint": "String"
}
],
"dashboard_items": [
{
"description": "String",
"required_capabilities": [
"String"
],
"rest_method": "String",
"text": "String"
}
],
"dependencies": {
"pip_directory": "String",
"rpms_directory": "String"
},
"description": "String",
"environment_variables": [
{
"name": "String",
"value": "String"
}
],
"fragments": [
{
"app_name": "String",
"location": "String",
"named_service": "String",
"page_id": "String",
"required_capabilities": [
"String"
],
"rest_endpoint": "String"
}
],
"gui_actions": [
{
"description": "String",
"groups": [
"String"
],
"icon": "String",
"id": "String",
"javascript": "String",
"named_service": "String",
"required_capabilities": [
"String"
],
"rest_method": "String",
"text": "String"
}
],
"image": "String",
"load_flask": "String",
"log_level": "String",
"metadata_providers": [
{
"metadata_type": "String",
"rest_method": "String"
}
],
"multitenancy_safe": "String",
"name": "String",
"page_scripts": [
{
"app_name": "String",
"named_service": "String",
"page_id": "String",
"scripts": [
"String"
]
}
],
"resource_bundles": [
{
"bundle": "String",
"locale": "String"
}
],
"resources": {
"memory": 42
},
"rest_methods": [
{
"argument_names": [
"String"
],
"method": "String <one of: GET, HEAD, POST, PUT, DELETE, TRACE, OPTIONS, CONNECT, PATCH>",
"name": "String",
"named_service": "String",
"required_capabilities": [
"String"
],
"url": "String"
}
],
"services": [
{
"autorestart": "String",
"autostart": "String",
"command": "String",
"directory": "String",
"endpoints": [
{
"error_mime_type": "String",
"http_method": "String",
"name": "String",
"parameters": [
{
"definition": "String",
"location": "String",
"name": "String"
}
],
"path": "String",
"request_mime_type": "String",
"response": {
"mime_type": "String"
}
}
],
"environment": "String",
"exitcodes": "String",
"name": "String",
"numprocs": 42,
"port": 42,
"priority": 42,
"process_name": "String",
"redirect_stderr": "String",
"serverurl": "String",
"startretries": 42,
"startsecs": 42,
"stderr_capture_maxbytes": "String",
"stderr_events_enabled": "String",
"stderr_logfile": "String",
"stderr_logfile_backups": 42,
"stderr_logfile_maxbytes": "String",
"stdout_capture_maxbytes": "String",
"stdout_events_enabled": "String",
"stdout_logfile": "String",
"stdout_logfile_backups": 42,
"stdout_logfile_maxbyte": "String",
"stopsignal": "String",
"stopwaitsecs": 42,
"umask": "String",
"user": "String",
"uuid": "String",
"version": "String"
}
],
"single_instance_only": "String",
"uninstall_hooks": [
{
"description": "String",
"documentation_url": "String",
"last_instance_only": "String",
"rest_method": "String"
}
],
"uuid": "String",
"version": "String"
},
"status": "String <one of: CREATING, UPGRADING, COMPLETED, ERROR, DELETING, CANCELLED>",
"user_role_ids": [
42
]
}