Retrieve details for a Java process available for PMI metric collection in Dynatrace with the Extensions 2.0 API, using the process ID and optional filter.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/extensions/v2/discovery/pmi/processes/{process-id} |
You provide the process-id path parameter to select a discovered Java process and can use the filter query parameter to refine the result. The operation returns a success response with the process details.
To execute this request, you need a platform token or OAuth access token with extensions:discovery.pmi:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| process-id | string | Id of the Java process discovered in the environment for PMI metric collection. | path | Required |
| filter | string | The filter parameter, as explained here. Filtering is supported on the following field:
If the parameter is omitted, all processes are returned. Example: | query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Pmi | Success. |
| 404 | Error | Failed. Agent data isn't yet available. Try again in a few seconds. |
| 504 | Error | Failed. Agent communication timeout. |
| 4XX | Error | Client error. |
| 5XX | Error | Server error. |
PmiProcessDetails objectErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | - |
Error object| Element | Type | Description |
|---|---|---|
| code | integer | The HTTP status code. |
| details | Error | The error details. |
| message | string | The error message. |
ErrorDetails objectThe error details.
| Element | Type | Description |
|---|---|---|
| constraintViolations | Constraint | A list of constraint violations. |
ConstraintViolation objectA list of constraint violations.
| Element | Type | Description |
|---|---|---|
| location | string | - |
| message | string | - |
| parameterLocation | string | -The element can hold these values
|
| path | string | - |
{"WebSphere": {"statistics": [{"name": "requestCount","type": "CountStatistic"},{"name": "responseTime","type": "TimeStatistic"}],"modules": ["server1/applications/MyApp","server1/applications/OtherApp"]}}
{"error": {"code": 404,"message": "Pmi process information is not yet available from agent: 12345678901234567"}}