Page Comparison

...

• 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).

...

Example Request

{curl -X  "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:

...

'GET' \
  'https://agility-dev.b-yond.com/cv/api/v1/intent-based-diagnostic/evaluation-scenarios?formatSteps=false&page=1&size=50' \
  -H 'accept: application/json' \
  -H 'userId: user123'

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

curl -X 'POST' \
  'https://agility-dev.b-yond.com/cv/api/v1/intent-based-diagnostic/evaluations/file' \
  -H 'accept: application/json' \
  -H 'userId: user123' \
  -H 'Content-Type: multipart/form-data' \
  -F 'file=@example_trace.pcapng' \
  -F 'scenarioId=69'

Check Evaluation Status and Retrieve Results

Endpoint:

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

Description

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

Request Body

Headers:

...

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

Path Parameters

• id (required): The evaluation 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.

Search Evaluations

Endpoint

GET /v1/intent-based-diagnostic/evaluations

Description

Return all Intent Based Evaluations based on filter criteria.

Parameters

Headers:

• userId (required): The username of the user making the request.

Query Parameters:

• datetimeRanges (optional): Filter by predefined datetime ranges.

• datetimeFrom (optional): Filter evaluations created after this datetime.

• datetimeTo (optional): Filter evaluations created before this datetime.

• containsInFilename (optional): Filter by filename containing this string.

• evaluationStatus (optional): Filter by evaluation status.

• scenarioIds (optional): Filter by scenario IDs.

• createdOnAsc (optional): Sort by creation date in ascending order (default: false).

• listAll (optional): List all evaluations (default: false).

• multicallflowSupport (optional): Enable multicallflow support.

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

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

Response Example

...

• returned from the POST /evaluations/file endpoint.

Query Parameters

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

Statuses

• pending: The evaluation is queued.

• processing: The evaluation is in progress.

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

Example Request

curl -X 'GET' \
  'https://agility-dev.b-yond.com/cv/api/v1/intent-based-diagnostic/evaluations/783e4a2c-9875-4f31-ac82-a1ffe1b11a34?multicallflowSupport=true' \
  -H 'accept: application/json' \
  -H 'userId: user123'

Search Evaluations

Endpoint

GET /v1/intent-based-diagnostic/evaluations

Description

Return all Intent Based Evaluations based on filter criteria.

Parameters

Headers:

• userId (required): The username of the user making the request.

Query Parameters:

• datetimeRanges (optional): Filter by predefined datetime ranges.

• datetimeFrom (optional): Filter evaluations created after this datetime.

• datetimeTo (optional): Filter evaluations created before this datetime.

• containsInFilename (optional): Filter by filename containing this string.

• evaluationStatus (optional): Filter by evaluation status.

• scenarioIds (optional): Filter by scenario IDs.

• createdOnAsc (optional): Sort by creation date in ascending order (default: false).

• listAll (optional): List all evaluations (default: false).

• multicallflowSupport (optional): Enable multicallflow support.

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

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

Example Request

curl -X 'GET' \
  'https://agility-dev.b-yond.com/cv/api/v1/intent-based-diagnostic/evaluations?createdOnAsc=false&listAll=true&page=1&size=50' \
  -H 'accept: application/json' \
  -H 'userId: user123'