GET   scenarios/desktopapp/{scenario_id}?include_associated_check_ids={include_associated_check_ids}

Gets info about a Dektop App check scenario.

URL Parameters

NameDescription
scenario_id

Dektop App check scenario identifier. Type: numeric.

include_associated_check_ids

(Optional) Indicates whether identifiers of the associated checks should be included in the response. By default, they are not included and the corresponding property of the response is null. Type: boolean. Example: true. Default value: false.

Request example

curl --request GET "https://api-asm1.apica.io/v3/scenarios/desktopapp/5666?include_associated_check_ids=true&auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E"

Response body model example and description

Desktop App scenario info

{
  "id": 1,
  "guid": "3df90c09-8813-4ca2-8226-b30dd0afc63a",
  "name": "sample string 3",
  "description": "sample string 4",
  "created_utc": "2024-05-19T10:36:58",
  "updated_utc": "2024-05-19T10:36:58",
  "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.