WorkflowRun

The workflow run.

Microsoft AzureCloudComputeEvent-DrivenMicrosoftServerless

Properties

Name Type Description
properties object The workflow run properties.
View JSON Schema on GitHub

JSON Schema

microsoft-azure-functions-workflow-run-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-azure-functions/json-schema/microsoft-azure-functions-workflow-run-schema.json",
  "title": "WorkflowRun",
  "description": "The workflow run.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-azure-functions-workflow-runs-api-openapi.yml#/components/schemas/WorkflowRun",
  "type": "object",
  "properties": {
    "properties": {
      "$ref": "#/$defs/WorkflowRunProperties",
      "description": "The workflow run properties.",
      "x-ms-client-flatten": true
    }
  },
  "allOf": [
    {
      "$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
    }
  ],
  "$defs": {
    "ContentHash": {
      "type": "object",
      "description": "The content hash.",
      "properties": {
        "algorithm": {
          "type": "string",
          "description": "The algorithm of the content hash."
        },
        "value": {
          "type": "string",
          "description": "The value of the content hash."
        }
      }
    },
    "ContentLink": {
      "type": "object",
      "description": "The content link.",
      "properties": {
        "uri": {
          "type": "string",
          "description": "The content link URI."
        },
        "contentVersion": {
          "type": "string",
          "description": "The content version.",
          "readOnly": true
        },
        "contentSize": {
          "type": "integer",
          "format": "int64",
          "description": "The content size.",
          "readOnly": true
        },
        "contentHash": {
          "$ref": "#/$defs/ContentHash",
          "description": "The content hash.",
          "readOnly": true
        },
        "metadata": {
          "description": "The metadata.",
          "readOnly": true
        }
      }
    },
    "Correlation": {
      "type": "object",
      "description": "The correlation property.",
      "properties": {
        "clientTrackingId": {
          "type": "string",
          "description": "The client tracking id."
        }
      }
    },
    "ParameterType": {
      "type": "string",
      "description": "The parameter type.",
      "enum": [
        "NotSpecified",
        "String",
        "SecureString",
        "Int",
        "Float",
        "Bool",
        "Array",
        "Object",
        "SecureObject"
      ],
      "x-ms-enum": {
        "name": "ParameterType",
        "modelAsString": true,
        "values": [
          {
            "name": "NotSpecified",
            "value": "NotSpecified"
          },
          {
            "name": "String",
            "value": "String"
          },
          {
            "name": "SecureString",
            "value": "SecureString"
          },
          {
            "name": "Int",
            "value": "Int"
          },
          {
            "name": "Float",
            "value": "Float"
          },
          {
            "name": "Bool",
            "value": "Bool"
          },
          {
            "name": "Array",
            "value": "Array"
          },
          {
            "name": "Object",
            "value": "Object"
          },
          {
            "name": "SecureObject",
            "value": "SecureObject"
          }
        ]
      }
    },
    "ResourceReference": {
      "type": "object",
      "description": "The resource reference.",
      "properties": {
        "id": {
          "type": "string",
          "description": "The resource id."
        },
        "name": {
          "type": "string",
          "description": "Gets the resource name.",
          "readOnly": true
        },
        "type": {
          "type": "string",
          "description": "Gets the resource type.",
          "readOnly": true
        }
      }
    },
    "WorkflowOutputParameter": {
      "type": "object",
      "description": "The workflow output parameter.",
      "properties": {
        "error": {
          "description": "Gets the error.",
          "readOnly": true
        }
      },
      "allOf": [
        {
          "$ref": "#/$defs/WorkflowParameter"
        }
      ]
    },
    "WorkflowParameter": {
      "type": "object",
      "description": "The workflow parameters.",
      "properties": {
        "type": {
          "$ref": "#/$defs/ParameterType",
          "description": "The type."
        },
        "value": {
          "description": "The value."
        },
        "metadata": {
          "description": "The metadata."
        },
        "description": {
          "type": "string",
          "description": "The description."
        }
      }
    },
    "WorkflowRunProperties": {
      "type": "object",
      "description": "The workflow run properties.",
      "properties": {
        "waitEndTime": {
          "type": "string",
          "format": "date-time",
          "description": "Gets the wait end time.",
          "readOnly": true
        },
        "startTime": {
          "type": "string",
          "format": "date-time",
          "description": "Gets the start time.",
          "readOnly": true
        },
        "endTime": {
          "type": "string",
          "format": "date-time",
          "description": "Gets the end time.",
          "readOnly": true
        },
        "status": {
          "$ref": "#/$defs/WorkflowStatus",
          "description": "Gets the status.",
          "readOnly": true
        },
        "code": {
          "type": "string",
          "description": "Gets the code.",
          "readOnly": true
        },
        "error": {
          "description": "Gets the error.",
          "readOnly": true
        },
        "correlationId": {
          "type": "string",
          "description": "Gets the correlation id.",
          "readOnly": true
        },
        "correlation": {
          "$ref": "#/$defs/Correlation",
          "description": "The run correlation."
        },
        "workflow": {
          "$ref": "#/$defs/ResourceReference",
          "description": "Gets the reference to workflow version.",
          "readOnly": true
        },
        "trigger": {
          "$ref": "#/$defs/WorkflowRunTrigger",
          "description": "Gets the fired trigger.",
          "readOnly": true
        },
        "outputs": {
          "type": "object",
          "description": "Gets the outputs.",
          "additionalProperties": {
            "$ref": "#/$defs/WorkflowOutputParameter"
          },
          "readOnly": true
        },
        "response": {
          "$ref": "#/$defs/WorkflowRunTrigger",
          "description": "Gets the response of the flow run.",
          "readOnly": true
        }
      }
    },
    "WorkflowRunTrigger": {
      "type": "object",
      "description": "The workflow run trigger.",
      "properties": {
        "name": {
          "type": "string",
          "description": "Gets the name.",
          "readOnly": true
        },
        "inputs": {
          "description": "Gets the inputs.",
          "readOnly": true
        },
        "inputsLink": {
          "$ref": "#/$defs/ContentLink",
          "description": "Gets the link to inputs.",
          "readOnly": true
        },
        "outputs": {
          "description": "Gets the outputs.",
          "readOnly": true
        },
        "outputsLink": {
          "$ref": "#/$defs/ContentLink",
          "description": "Gets the link to outputs.",
          "readOnly": true
        },
        "scheduledTime": {
          "type": "string",
          "format": "date-time",
          "description": "Gets the scheduled time.",
          "readOnly": true
        },
        "startTime": {
          "type": "string",
          "format": "date-time",
          "description": "Gets the start time.",
          "readOnly": true
        },
        "endTime": {
          "type": "string",
          "format": "date-time",
          "description": "Gets the end time.",
          "readOnly": true
        },
        "trackingId": {
          "type": "string",
          "description": "Gets the tracking id.",
          "readOnly": true
        },
        "correlation": {
          "$ref": "#/$defs/Correlation",
          "description": "The run correlation."
        },
        "code": {
          "type": "string",
          "description": "Gets the code.",
          "readOnly": true
        },
        "status": {
          "$ref": "#/$defs/WorkflowStatus",
          "description": "Gets the status.",
          "readOnly": true
        },
        "error": {
          "description": "Gets the error.",
          "readOnly": true
        },
        "trackedProperties": {
          "description": "Gets the tracked properties.",
          "readOnly": true
        }
      }
    },
    "WorkflowStatus": {
      "type": "string",
      "description": "The workflow status.",
      "enum": [
        "NotSpecified",
        "Paused",
        "Running",
        "Waiting",
        "Succeeded",
        "Skipped",
        "Suspended",
        "Cancelled",
        "Failed",
        "Faulted",
        "TimedOut",
        "Aborted",
        "Ignored"
      ],
      "x-ms-enum": {
        "name": "WorkflowStatus",
        "modelAsString": true,
        "values": [
          {
            "name": "NotSpecified",
            "value": "NotSpecified"
          },
          {
            "name": "Paused",
            "value": "Paused"
          },
          {
            "name": "Running",
            "value": "Running"
          },
          {
            "name": "Waiting",
            "value": "Waiting"
          },
          {
            "name": "Succeeded",
            "value": "Succeeded"
          },
          {
            "name": "Skipped",
            "value": "Skipped"
          },
          {
            "name": "Suspended",
            "value": "Suspended"
          },
          {
            "name": "Cancelled",
            "value": "Cancelled"
          },
          {
            "name": "Failed",
            "value": "Failed"
          },
          {
            "name": "Faulted",
            "value": "Faulted"
          },
          {
            "name": "TimedOut",
            "value": "TimedOut"
          },
          {
            "name": "Aborted",
            "value": "Aborted"
          },
          {
            "name": "Ignored",
            "value": "Ignored"
          }
        ]
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/microsoft-azure-functions-workflow-run"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.