ApiResponseOfListGamebooksResultDto

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/contraforce/json-schema/contraforce-api-response-of-list-gamebooks-result-dto-schema.json",
  "title": "ApiResponseOfListGamebooksResultDto",
  "description": "Standard v2 API response envelope for single-item responses.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/contraforce-gamebooks-api-openapi.yml#/components/schemas/ApiResponseOfListGamebooksResultDto",
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/$defs/ListGamebooksResultDto"
    },
    "meta": {
      "$ref": "#/$defs/ResponseMeta"
    }
  },
  "$defs": {
    "GamebookDto": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "null",
            "string"
          ]
        },
        "tracingId": {
          "type": [
            "null",
            "string"
          ]
        },
        "incidentId": {
          "type": [
            "null",
            "string"
          ]
        },
        "source": {
          "description": "Source of the system that owns the incident Sentinel, Defender ATP, etc.",
          "$ref": "#/$defs/IncidentSource"
        },
        "incidentTitle": {
          "type": [
            "null",
            "string"
          ]
        },
        "incidentNumber": {
          "pattern": "^-?(?:0|[1-9]\\d*)$",
          "type": [
            "integer",
            "string"
          ],
          "format": "int32"
        },
        "isOcr": {
          "type": "boolean"
        },
        "isRecover": {
          "type": "boolean"
        },
        "triggedByUserId": {
          "type": [
            "null",
            "string"
          ]
        },
        "displayName": {
          "type": [
            "null",
            "string"
          ]
        },
        "modificationDate": {
          "type": "string",
          "format": "date-time"
        },
        "creationDate": {
          "type": "string",
          "format": "date-time"
        },
        "status": {
          "$ref": "#/$defs/GamebookRunningStatus"
        },
        "title": {
          "type": [
            "null",
            "string"
          ]
        },
        "isAdminRequired": {
          "type": "boolean"
        },
        "workspaceId": {
          "type": [
            "null",
            "string"
          ]
        },
        "workspaceName": {
          "type": [
            "null",
            "string"
          ]
        },
        "tenantId": {
          "type": [
            "null",
            "string"
          ]
        },
        "isAutoRun": {
          "type": "boolean"
        },
        "originalGamebookId": {
          "type": [
            "null",
            "string"
          ],
          "description": "Used if the gamebook is retry gamebook and refers to the id of the gamebook id that has been retried"
        },
        "originalGamebookTitle": {
          "type": [
            "null",
            "string"
          ],
          "description": "Used if the gamebook is retry gamebook and refers to the id of the gamebook title that has been retried"
        },
        "isRetryGamebook": {
          "type": "boolean",
          "description": "Indicator if the gamebook is a retry to failed gamebook"
        },
        "isQueued": {
          "type": "boolean",
          "description": "Indicator if the gamebook is queued by a service provider and it is not started yet"
        },
        "playbooks": {
          "type": [
            "null",
            "array"
          ],
          "items": {
            "$ref": "#/$defs/PlaybookGameplanDto"
          }
        },
        "summary": {
          "type": [
            "null",
            "string"
          ]
        }
      }
    },
    "GamebookRunningStatus": {
      "enum": [
        "Pending",
        "Running",
        "Finished",
        "Failed",
        "Queued",
        "Denied",
        "Cancelled"
      ]
    },
    "IncidentSource": {
      "enum": [
        "Sentinel",
        "DefenderXDR",
        "QRadar",
        "Splunk",
        "CrowdStrike",
        "SentinelOne",
        "SumoLogic"
      ]
    },
    "ListGamebooksResultDto": {
      "type": "object",
      "properties": {
        "gamebooks": {
          "type": [
            "null",
            "array"
          ],
          "items": {
            "$ref": "#/$defs/GamebookDto"
          }
        },
        "pageToken": {
          "type": [
            "null",
            "string"
          ]
        },
        "totalCount": {
          "pattern": "^-?(?:0|[1-9]\\d*)$",
          "type": [
            "integer",
            "string"
          ],
          "format": "int32"
        }
      }
    },
    "PlaybookEntityType": {
      "enum": [
        "User",
        "Endpoint",
        "General",
        "Network",
        "Email"
      ]
    },
    "PlaybookGameplanDto": {
      "type": "object",
      "properties": {
        "id": {
          "type": [
            "null",
            "string"
          ]
        },
        "referenceId": {
          "type": [
            "null",
            "string"
          ],
          "description": "Stable identity of a plan item — the playbook id combined with the target it acts on.\nUsed for the gamebook plan's de-duplication, equality, and the V2 list `@key`."
        },
        "entityId": {
          "type": [
            "null",
            "string"
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "userObjectId": {
          "type": [
            "null",
            "string"
          ],
          "description": "Azure AD object id (GUID) of the user/mailbox a playbook should act on, supplied\ndirectly by the caller instead of being resolved from the incident's entities."
        },
        "userPrincipalName": {
          "type": [
            "null",
            "string"
          ],
          "description": "User principal name (UPN) of the user/mailbox a playbook should act on, supplied\ndirectly by the caller instead of being resolved from the incident's entities."
        },
        "internetMessageId": {
          "type": [
            "null",
            "string"
          ],
          "description": "RFC 2822 internet message id of the email an email playbook should act on, supplied\ndirectly by the caller instead of being read from the incident's email entity."
        },
        "description": {
          "type": [
            "null",
            "string"
          ]
        },
        "entityType": {
          "$ref": "#/$defs/PlaybookEntityType"
        },
        "affectedEntity": {
          "type": [
            "null",
            "string"
          ]
        },
        "isRecommended": {
          "type": "boolean"
        },
        "status": {
          "$ref": "#/$defs/PlaybookRunningStatus"
        },
        "errorMessage": {
          "type": [
            "null",
            "string"
          ]
        },
        "sequence": {
          "pattern": "^-?(?:0|[1-9]\\d*)$",
          "type": [
            "integer",
            "string"
          ],
          "format": "int32"
        },
        "modificationDate": {
          "type": "string",
          "format": "date-time"
        },
        "startingDate": {
          "type": [
            "null",
            "string"
          ],
          "format": "date-time"
        },
        "finishingDate": {
          "type": [
            "null",
            "string"
          ],
          "format": "date-time"
        },
        "executionTime": {
          "type": [
            "null",
            "string"
          ],
          "description": "Total execution time taken to execute the playbook, the value is null until the DateTime? PlaybookGameplanDto.FinishingDate property is populated"
        },
        "tracingId": {
          "type": [
            "null",
            "string"
          ]
        },
        "parameters": {
          "type": [
            "null",
            "object"
          ],
          "description": "Represents the parameters of the playbooks to be sent in the message\nThe value will be populated only if the playbook is configurable (Block IP)"
        },
        "isAdminRequired": {
          "type": "boolean"
        }
      }
    },
    "PlaybookRunningStatus": {
      "enum": [
        "Pending",
        "Running",
        "Finished",
        "Failed",
        "Terminated"
      ]
    },
    "ResponseMeta": {
      "type": "object",
      "properties": {
        "requestId": {
          "type": [
            "null",
            "string"
          ]
        },
        "timestamp": {
          "type": [
            "null",
            "string"
          ]
        }
      }
    }
  }
}