POST   scenarios/desktopapp

Gets a list of all Desktop App check 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/desktopapp?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E" --header "Content-Type: application/json" --data-raw "{
  \"filter\": {
    \"name\": \"sample string 1\",
    \"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
  }
}"
NameType Required Description
filter Object No

The filter section defines the criteria for selecting the Desktop App scenarios. This section is optional, any parameter can be omitted.
name String No

This parameter defines a substring to filter scenarios by scenario name.
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 Desktop App 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

Desktop App scenario info

[
  {
    "id": 1,
    "guid": "eaf2d66f-05a7-4c02-ab45-76e098c7881c",
    "name": "sample string 3",
    "description": "sample string 4",
    "created_utc": "2024-11-09T02:14:10",
    "updated_utc": "2024-11-09T02:14:10",
    "associated_check_ids": [
      1,
      2,
      3
    ]
  },
  {
    "id": 1,
    "guid": "6143920d-a8f5-4f2a-ac88-199fc9a903fe",
    "name": "sample string 3",
    "description": "sample string 4",
    "created_utc": "2024-11-09T02:14:10",
    "updated_utc": "2024-11-09T02:14:10",
    "associated_check_ids": [
      1,
      2,
      3
    ]
  },
  {
    "id": 1,
    "guid": "ffbfa895-47ba-4585-8f46-ee9058da2375",
    "name": "sample string 3",
    "description": "sample string 4",
    "created_utc": "2024-11-09T02:14:10",
    "updated_utc": "2024-11-09T02:14:10",
    "associated_check_ids": [
      1,
      2,
      3
    ]
  }
]
NameType Description
id Integer

The scenario's numeric identifier.
guid Guid

The scenario's GUID.
name String

The scenario name.
description String

The scenario description.
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.