POST scenarios/zebratester

Gets a list of all ZebraTester scenarios that are visible to you as an administrator of the customer checks.

Remarks

The result can be filtered or/and extended by optional parameters provided in the body.

Request example and description

curl --request POST "https://api-asm1.apica.io/v3/scenarios/zebratester?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E" --header "Content-Type: application/json" --data-raw "{
  \"filter\": {
    \"name\": \"sample string 1\",
    \"version\": \"sample string 2\",
    \"created\": {
      \"from_utc\": \"2013-08-20T13:32:08\",
      \"to_utc\": \"2013-08-21T13:32:08\"
    },
    \"updated\": {
      \"from_utc\": \"2013-08-20T13:32:08\",
      \"to_utc\": \"2013-08-21T13:32:08\"
    },
    \"associated_check_ids\": [
      1,
      2,
      3
    ]
  },
  \"include\": {
    \"associated_check_ids\": true
  }
}"

Name	Type	Required	Description
filter	Object	No	The filter section defines the criteria for selecting the ZebraTester scenarios. This section is optional, any parameter can be omitted.
name	String	No	This parameter defines a substring to filter scenarios by original filename.
version	String	No	This parameter defines a substring to filter scenarios by ZebraTester version.
created	Object	No	This section defines the date range to filter scenarios by the time they were created at.
from_utc	DateTime	No	Starting timestamp (in UTC) for the date range.
to_utc	DateTime	No	Ending timestamp (in UTC) for the date range.
updated	Object	No	This section defines the date range to filter scenarios by the last time they were updated at.
from_utc	DateTime	No	Starting timestamp (in UTC) for the date range.
to_utc	DateTime	No	Ending timestamp (in UTC) for the date range.
associated_check_ids	Array	No	This parameter allows to filter scenarios by associated checks. If it is null, it will be ignored. If it is empty, the only scenarios which are not associated with any checks will be inlcuded in the response. If it contains identifiers, the only scenarios which are associated with at least one of the presented checks will be included in the response.
include	Object	No	The include section defines additional ZebraTester scenario information to include into the response. If this section is omitted or empty, the response will only contain main data.
associated_check_ids	Boolean	No	This parameter indicates whether identifiers of the associated checks should be included in the response.

Response body model example and description

ZebraTester scenario info

[
  {
    "id": 1,
    "original_filename": "sample string 2",
    "zebratester_version": "sample string 3",
    "class_name": "sample string 4",
    "compiled_as_zip": true,
    "created_utc": "2024-11-21T15:25:44",
    "updated_utc": "2024-11-21T15:25:44",
    "associated_check_ids": [
      1,
      2,
      3
    ],
    "scenario_compilation_logs": [
      {
        "Id": 1,
        "ScenarioId": 2,
        "ScenarioCompiledFileId": 1,
        "TimestampUtc": "2024-11-21T15:25:44",
        "Message": "sample string 4",
        "UserGuid": "cc6e3bd3-17aa-4cfb-9acd-b4dc58b9efc9"
      },
      {
        "Id": 1,
        "ScenarioId": 2,
        "ScenarioCompiledFileId": 1,
        "TimestampUtc": "2024-11-21T15:25:44",
        "Message": "sample string 4",
        "UserGuid": "73ee9ca7-baae-4a0b-83b4-3b3bd36ba4f2"
      },
      {
        "Id": 1,
        "ScenarioId": 2,
        "ScenarioCompiledFileId": 1,
        "TimestampUtc": "2024-11-21T15:25:44",
        "Message": "sample string 4",
        "UserGuid": "d6b50327-2bfa-4a6b-88b4-76c0f94a72d5"
      }
    ]
  },
  {
    "id": 1,
    "original_filename": "sample string 2",
    "zebratester_version": "sample string 3",
    "class_name": "sample string 4",
    "compiled_as_zip": true,
    "created_utc": "2024-11-21T15:25:44",
    "updated_utc": "2024-11-21T15:25:44",
    "associated_check_ids": [
      1,
      2,
      3
    ],
    "scenario_compilation_logs": [
      {
        "Id": 1,
        "ScenarioId": 2,
        "ScenarioCompiledFileId": 1,
        "TimestampUtc": "2024-11-21T15:25:44",
        "Message": "sample string 4",
        "UserGuid": "73ee9ca7-baae-4a0b-83b4-3b3bd36ba4f2"
      },
      {
        "Id": 1,
        "ScenarioId": 2,
        "ScenarioCompiledFileId": 1,
        "TimestampUtc": "2024-11-21T15:25:44",
        "Message": "sample string 4",
        "UserGuid": "73ee9ca7-baae-4a0b-83b4-3b3bd36ba4f2"
      },
      {
        "Id": 1,
        "ScenarioId": 2,
        "ScenarioCompiledFileId": 1,
        "TimestampUtc": "2024-11-21T15:25:44",
        "Message": "sample string 4",
        "UserGuid": "d6b50327-2bfa-4a6b-88b4-76c0f94a72d5"
      }
    ]
  },
  {
    "id": 1,
    "original_filename": "sample string 2",
    "zebratester_version": "sample string 3",
    "class_name": "sample string 4",
    "compiled_as_zip": true,
    "created_utc": "2024-11-21T15:25:44",
    "updated_utc": "2024-11-21T15:25:44",
    "associated_check_ids": [
      1,
      2,
      3
    ],
    "scenario_compilation_logs": [
      {
        "Id": 1,
        "ScenarioId": 2,
        "ScenarioCompiledFileId": 1,
        "TimestampUtc": "2024-11-21T15:25:44",
        "Message": "sample string 4",
        "UserGuid": "cc6e3bd3-17aa-4cfb-9acd-b4dc58b9efc9"
      },
      {
        "Id": 1,
        "ScenarioId": 2,
        "ScenarioCompiledFileId": 1,
        "TimestampUtc": "2024-11-21T15:25:44",
        "Message": "sample string 4",
        "UserGuid": "73ee9ca7-baae-4a0b-83b4-3b3bd36ba4f2"
      },
      {
        "Id": 1,
        "ScenarioId": 2,
        "ScenarioCompiledFileId": 1,
        "TimestampUtc": "2024-11-21T15:25:44",
        "Message": "sample string 4",
        "UserGuid": "d6b50327-2bfa-4a6b-88b4-76c0f94a72d5"
      }
    ]
  }
]

Name	Type	Description
id	Integer	The scenario's numeric identifier.
original_filename	String	The original filename.
zebratester_version	String	The version of ZebraTester.
class_name	String	The scenario class name.
compiled_as_zip	Boolean	The scenario is compiled as ZIP.
created_utc	DateTime	The time at which the scenario was created.
updated_utc	DateTime	The last time at which the scenario was updated.
associated_check_ids	Array	The list of identifiers of the checks which are associated with the scenario.
scenario_compilation_logs	Array	Compilation Logs generated during scenario compilation
Id	Integer	No documentation available.
ScenarioId	Integer	No documentation available.
ScenarioCompiledFileId	Integer	No documentation available.
TimestampUtc	DateTime	No documentation available.
Message	String	No documentation available.
UserGuid	Guid	No documentation available.