Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Example request

Code Block
languagebash
curl -X 'GET' \
  'https://cv-dev.b-yond.com/cv/api/v1/analysis?datetimeFrom=2023-10-01T00%3A00%3A00&datetimeTo=2023-10-31T23%3A59%3A59&containsInFilePath=pcap&finalStatus=true%2Cfalse%2Cwarning&results=success%2Cfailure%2Cwarning&orderAsc=false&page=1&size=50' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_ID_TOKEN'

...

Example request

Code Block
languagebash
curl -X 'GET' \
  'https://cv-dev.b-yond.com/cv/api/v1/analysis/d8116c50-c891-4378-9191-5b8bb53d873b/file' \
  -H 'accept: application/octet-stream' \
  -H 'Authorization: Bearer YOUR_ID_TOKEN'

...

Example request

Code Block
languagebash
curl -X 'POST' \
  'https://agility.b-yond.com/cv/api/v1/webhooks/subscriptions' \
  -H 'accept: application/json' \
  -H 'userId: 1234' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://example.com/",
  "events": [
    "*"
  ],
  "description": "My webhook",
  "enabled": true,
  "subscribe_to_all_users": true
}'

...

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: Page number (default: 1).

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

...

Code Block
languagebash
curl -X '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 'Authorization: Bearer YOUR_ID_TOKEN' \
  -H 'userId: user123'

Submit a New Evaluation

...

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

...

Query Parameters

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

...

Code Block
languagebash
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 'Authorization: Bearer YOUR_ID_TOKEN' \
  -H 'userId: user123'

Search Evaluations

...

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

...

Code Block
languagebash
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 'Authorization: Bearer YOUR_ID_TOKEN' \
  -H 'userId: user123'