...

• analysis_id (path parameter): The unique identifier for the analysis. This is a required parameter.

  • Type: string

  • Description: The unique identifier of the network topology analysis to retrieve.

• callflowKey (query parameter): An optional parameter to filter the results based on a specific call flow key.

  • Type: string

  • Description: A key used to filter the network topology information by a particular call flow.

Intent-Based Diagnostics Endpoints

The Intent-Based Diagnostics feature in AGILITY allows users to perform detailed network diagnostics through various pre-configured scenarios. It enables the evaluation of variety of scenarios defined by 3GPP and ETSI while allowing users to bring their own scenarios

Find Available Scenarios

Endpoint

GET /v1/intent-based-diagnostic/evaluation-scenarios

Description

This endpoint lists all evaluation scenarios, including system scenarios (pre-built by AGILITY) and extended scenarios (user-created by modifying system scenarios).

Parameters

• name (query, optional): Filter by scenario name (partial match).

• category (query, optional): Filter by scenario category.

• scenarioType (query, optional): Filter by type (SYSTEM or EXTENDED). A System Scenario is provided out of the box and cannot be modified. An Extended Scenario is created by users by extending a System Scenario and overriding its parameters.

• createdByCurrentUser (query, optional): Filter scenarios created by the current user.

• editedByCurrentUser (query, optional): Filter scenarios last edited by the current user.

• lastModifiedDateFrom (query, optional): Filter scenarios modified on or after a specific date.

• lastModifiedDateTo (query, optional): Filter scenarios modified on or before a specific date.

• customTestCaseId (query, optional): Filter scenarios by custom test case ID. It is used to link a given input file automatically to a scenario when using the autoloader. 

• page (query, optional): Page number (default: 1).

• size (query, optional): Page size (default: 50).

Response Example

{
  "items": [
    {
      "id": "123",
      "name": "System Scenario 1",
      "type": "system",
      "category": "Call Barring",
      "createdBy": "admin",
      "lastModifiedDate": "2025-01-01T00:00:00Z"
    },
    {
      "id": "456",
      "name": "Extended Scenario 1",
      "type": "extended",
      "category": "Call Forwarding",
      "createdBy": "user1",
      "lastModifiedDate": "2025-01-10T12:00:00Z"
    }
  ],
  "total": 2,
  "page": 1,
  "size": 50
}

Submit a New Evaluation

Endpoint:

POST /v1/intent-based-diagnostic/evaluations/file

Description

This endpoint submits a network trace file for evaluation against a specific scenario.

Request Body

• Headers:

  • userId (required): The ID of the user submitting the request.

• Payload:

  • uploadFile: The trace file (.PCAP, .PCAPNG, .CAP, or .ZIP).

  • scenarioId (required): The ID of the scenario to evaluate.

  • parameterValuesOverride (optional): Custom parameters to override scenario defaults.

Example Request

{
  "userId": "user123",
  "scenarioId": "123",
  "parameterValuesOverride": {
    "param1": "value1",
    "param2": "value2"
  }
}

Response Example

{
  "id": "evaluation-uuid",
  "analysisId": "analysis-uuid"
}

Check Evaluation Status and Retrieve Results

Endpoint:

GET /v1/intent-based-diagnostic/evaluations/{id}

Description

Retrieve the status and results of an evaluation by its ID.

Path Parameters

• id (required): The evaluation ID returned from the POST /evaluations/file endpoint.

Query Parameters

• multicallflowSupport (query, optional): If true, segregates results by callflow sets.

Response Example (Completed Evaluation)

{
  "id": "evaluation-uuid",
  "scenarioId": "123",
  "status": "completed",
  "results": {
    "name": "Call Forwarding Scenario",
    "result": "passed",
    "callflowSetsResults": [
      {
        "callflowSet": {
          "name": "Callflow Set 1",
          "analysisId": "analysis-uuid"
        },
        "result": "passed",
        "assertionStepsResults": [
          {
            "name": "When UE initiates a call",
            "result": "passed"
          }
        ]
      }
    ]
  }
}

Statuses

• pending: The evaluation is queued.

• processing: The evaluation is in progress.

• completed: The evaluation has finished, and results are available.