Monitor and Trigger Continuous Integration Projects

Get diagnostic bundle statuses

Retrieves the statuses of diagnostic bundles for the specified project. Optionally filter by a specific bundle ID or bundle name using the query parameters. Only one filter can be specified at a time.

Process Overview:

  • Validate caller has replication-pipeline::view permission.
  • If no filters are provided, return statuses for all bundles in the project.
  • Provide comprehensive response with bundle details by categories (e.g., agent logs, runtime engine logs).

Key Features:

  • Provides comprehensive bundle information with sizes in MB.
  • Supports monitoring of ongoing or completed diagnostic processes.
  • Optional filtering by bundle ID or bundle name for targeted queries.

Required Permissions: replication-pipeline::view

get/v1/integration/continuous/monitoring/projects/{projectId}/diagnostic-bundles/status

Request

  • Base URL: https://integration-adapter.connect.cloud.precisely.com
  • URL: https://integration-adapter.connect.cloud.precisely.com/v1/integration/continuous/monitoring/projects/{projectId}/diagnostic-bundles/status
  • Auth: HTTP bearer

Path parameters

projectIdstring required

Unique identifier of the project.

Query parameters

bundleIdstring

Optional bundle ID to filter results

bundleNamestring

Optional bundle name to filter results

Response

Successfully retrieved diagnostic bundle statuses

idstring

Unique identifier of the diagnostic bundle

bundleNamestring

Name of the diagnostic bundle

status'UNKNOWN' | 'COMPLETED' | 'IN_PROGRESS' | 'QUEUED' | 'STOPPED' | 'ERROR'

Current processing status of the diagnostic bundle

createdAtstring date-time

Timestamp when the bundle was created in ISO format

sizeInMBnumber double

Total size of the bundle in megabytes

projectIdstring

Unique identifier of the associated project

projectNamestring

Name of the project

agentIdstring

Unique identifier of the agent that generated the bundle

agentNamestring

Name of the agent

descriptionstring

Description of the bundle's purpose and contents

createdBystring

Email of the bundle creator

tenantIdstring

Unique identifier of the tenant/organization

locationstring

File system path or storage location of the bundle

processNamestring

Name of the associated process or pipeline

Example response

{
  "id": "bundle-uuid-123",
  "bundleName": "Diagnostic Bundle 2023-10-01",
  "status": "COMPLETED",
  "createdAt": "2023-10-01T10:00:00Z",
  "sizeInMB": 117.74,
  "projectId": "project-uuid-456",
  "projectName": "My Project",
  "agentId": "agent-uuid-789",
  "agentName": "Agent 1",
  "description": "Logs for debugging pipeline issues",
  "createdBy": "user@example.com",
  "tenantId": "tenant-uuid-000",
  "location": "path/to/bundle",
  "processName": "pipeline-process-1",
  "logMetadata": {
    "categories": [
      {
        "name": "Agent logs",
        "sizeInMB": 48.87,
        "status": "COMPLETED",
        "server": {
          "name": "Dixit-Mac-Engine",
          "host": "server.example.com",
          "port": 8080,
          "type": "ENGINE",
          "altIP": "x.x.x.x",
          "useSSLA": true
        },
        "items": [
          {
            "label": "Gateway logs",
            "sizeInMB": 5.67,
            "status": "COMPLETED"
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.