Resource Drilldown
Resource Drilldown
The Application Summary method returns a list of the available Resource Vectors, and the number of rows in each Resource Vector.
The Resource Drilldown method is an API which provides the contents of an individual Resource Vector lists belonging to a specific application.
Internally, the ManageApp
sends a !MANAGEMENT-RESOURCE-DRILLDOWN-REQUEST
message to
the application and wait for the corresponding !MANAGEMENT-RESOURCE-DRILLDOWN-RESPONSE
message.
HTTP Request
- METHOD:
GET
- URI:
/api/app/
/resource/ - Content-Type:
- Content:
Special characters in the
or
must be URI percent-encoded.
HTTP Response
In failure, the response is a non-200 HTTP Status, with an optional text/plain
Content
describing the reason for failure.
In success, the HTTP Response content is a text/json
representation of the system status
and application list.
- Status:
200
- Content-Type:
text/json
- Content: JSON Object
The JSON Object has the following structure:
Attribute | Type | Description |
---|---|---|
admin
|
0 /1
|
[Required] Does this connection have access to update fields, and query protected fields. |
config_file
|
String |
[Required] The n2svcd.xml resource file as specified at startup time.
|
multi
|
0 /1
|
[Required] This this n2svcd install running in multi-process mode with shared-memory IPC communication?
|
shm_path
|
String |
When running in multi-process mode, this is the path of the shared memory area. Two n2svcd instancess running on the same platform must use different shared memory paths.
|
app
|
Object | [Required] A condensed summary of the Application status. |
.idx
|
Integer | [Required] The unique index number of this application. |
.name
|
Integer | [Required] The unique name of this application. |
.status
|
0 -8
|
The availability status of this application. Refer to the list in the Application Configuration section. |
.status_name
|
String |
The human-readable label corresponding to the status level. Refer to the list in the
Application Configuration section.
|
columns
|
Array of Object |
Descriptions of the columns in the resource vector being returned. See columns attribute in !MANAGEMENT-CONFIGURATION-DRILLDOWN-RESPONSE
internal message documentation.
|
list
|
Array of Object |
One object for each entry in the resource vector table. See list attribute in !MANAGEMENT-CONFIGURATION-DRILLDOWN-RESPONSE
internal message documentation.
|
Note that the full value of extended
columns is not included in the list
results. Instead
the returned value is a short summary of the content, e.g. “3044 Bytes” or “90 Rows”. To access
the full value of an extended
column you must use the
Resource Drilldown Extended API method.