FindStringRegexResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/cloudmersive/json-schema/cloudmersive-find-string-regex-response-schema.json",
  "title": "FindStringRegexResponse",
  "description": "Result of finding a string",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cloudmersive-edittext-api-openapi.yml#/components/schemas/FindStringRegexResponse",
  "type": "object",
  "properties": {
    "Successful": {
      "description": "True if successful, false otherwise",
      "type": "boolean"
    },
    "Matches": {
      "description": "Regular expression matches",
      "type": "array",
      "items": {
        "$ref": "#/$defs/FindRegexMatch"
      }
    },
    "MatchCount": {
      "format": "int32",
      "description": "The number of matches",
      "type": "integer"
    }
  },
  "$defs": {
    "FindRegexMatch": {
      "description": "Individual regular expression match result of finding a target regex in a longer text string",
      "type": "object",
      "properties": {
        "CharacterOffsetStart": {
          "format": "int32",
          "description": "0-based index of the start of the match",
          "type": "integer"
        },
        "CharacterOffsetEnd": {
          "format": "int32",
          "description": "0-based index of the end of the match",
          "type": "integer"
        },
        "ContainingLine": {
          "description": "Text content of the line containing the match",
          "type": "string"
        },
        "MatchValue": {
          "description": "The match value",
          "type": "string"
        },
        "MatchGroups": {
          "description": "Regular expression regex match groups; these correspond to the match values",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    }
  }
}