Workflows - List Swagger

Gets an OpenAPI definition for the workflow.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Logic/workflows/{workflowName}/listSwagger?api-version=2016-06-01

URI Parameters

Name In Required Type Description
resourceGroupName
path True
  • string

The resource group name.

subscriptionId
path True
  • string

The subscription id.

workflowName
path True
  • string

The workflow name.

api-version
query True
  • string

The API version.

Responses

Name Type Description
200 OK

OK

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Get the swagger for a workflow

Sample Request

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testResourceGroup/providers/Microsoft.Logic/workflows/testWorkflowName/listSwagger?api-version=2016-06-01

Sample Response

{
  "swagger": "2.0",
  "info": {
    "title": "flow",
    "description": "Azure Logic App."
  },
  "host": "test-host",
  "basePath": "/workflows/2e420261710e423490d5d502fe9c4abb/triggers",
  "schemes": [
    "http"
  ],
  "consumes": [
    "application/json"
  ],
  "produces": [
    "application/json"
  ],
  "paths": {
    "/simpleManualTrigger/paths/invoke": {
      "post": {
        "description": "Trigger a run of the logic app.",
        "operationId": "simpleManualTrigger-invoke",
        "parameters": [
          {
            "name": "api-version",
            "in": "query",
            "description": "The service API version.",
            "required": true,
            "type": "string"
          },
          {
            "name": "sp",
            "in": "query",
            "description": "The permissions; generally 'read' or 'write'.",
            "required": true,
            "type": "string"
          },
          {
            "name": "sv",
            "in": "query",
            "description": "The version number of the query parameters.",
            "required": true,
            "type": "string"
          },
          {
            "name": "sig",
            "in": "query",
            "description": "The SHA 256 hash of the entire request URI with an internal key.",
            "required": true,
            "type": "string"
          }
        ],
        "responses": {
          "default": {
            "description": "The Logic App Response.",
            "schema": {
              "type": "object"
            }
          }
        }
      }
    }
  }
}

Definitions

Object