Workflow Run Action Repetitions Request Histories - List

Reference

Service:: App Service

API Version:: 2024-04-01

List a workflow run repetition request history.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories?api-version=2024-04-01

URI Parameters

Name	In	Required	Type	Description
actionName	path	True	string	The workflow action name.
name	path	True	string	Site name.
repetitionName	path	True	string	The workflow repetition.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: `^[-\w\._]+[^\.]$`
runName	path	True	string	The workflow run name.
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
workflowName	path	True	string	The workflow name.
api-version	query	True	string	API Version

Responses

Name	Type	Description
200 OK	RequestHistoryListResult	OK
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

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

List repetition request history

Sample request

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-resource-group/providers/Microsoft.Web/sites/test-name/hostruntime/runtime/webhooks/workflow/api/management/workflows/test-workflow/runs/08586776228332053161046300351/actions/HTTP_Webhook/repetitions/000001/requestHistories?api-version=2024-04-01


/**
 * Samples for WorkflowRunActionRepetitionsRequestHistories List.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/
     * WorkflowRunActionRepetitionsRequestHistories_List.json
     */
    /**
     * Sample code: List repetition request history.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listRepetitionRequestHistory(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWorkflowRunActionRepetitionsRequestHistories().list(
            "test-resource-group", "test-name", "test-workflow", "08586776228332053161046300351", "HTTP_Webhook",
            "000001", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitionsRequestHistories_List.json
func ExampleWorkflowRunActionRepetitionsRequestHistoriesClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewWorkflowRunActionRepetitionsRequestHistoriesClient().NewListPager("test-resource-group", "test-name", "test-workflow", "08586776228332053161046300351", "HTTP_Webhook", "000001", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.RequestHistoryListResult = armappservice.RequestHistoryListResult{
		// 	Value: []*armappservice.RequestHistory{
		// 		{
		// 			Name: to.Ptr("08586611142732800686"),
		// 			Type: to.Ptr("/workflows/runs/actions/requestHistories"),
		// 			ID: to.Ptr("/workflows/test-workflow/runs/08586611142736787787412824395CU21/actions/HTTP_Webhook/requestHistories/08586611142732800686"),
		// 			Properties: &armappservice.RequestHistoryProperties{
		// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-25T18:36:52.186Z"); return t}()),
		// 				Response: &armappservice.Response{
		// 					BodyLink: &armappservice.ContentLink{
		// 						ContentHash: &armappservice.ContentHash{
		// 							Algorithm: to.Ptr("md5"),
		// 							Value: to.Ptr("2LOOAR8Eh2pd7AvRHXUhRg=="),
		// 						},
		// 						ContentSize: to.Ptr[int64](137),
		// 						ContentVersion: to.Ptr("2LOOAR8Eh2pd7AvRHXUhRg=="),
		// 						URI: to.Ptr("https://tempuri.org"),
		// 					},
		// 					Headers: map[string]any{
		// 						"Cache-Control": "private",
		// 						"Date": "Thu, 25 Oct 2018 18:36:51 GMT",
		// 						"Location": "http://www.bing.com/",
		// 						"Server": "Microsoft-IIS/10.0",
		// 						"X-AspNet-Version": "4.0.30319",
		// 						"X-Powered-By": "ASP.NET",
		// 					},
		// 					StatusCode: to.Ptr[int32](302),
		// 				},
		// 				StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-10-25T18:36:51.920Z"); return t}()),
		// 				Request: &armappservice.Request{
		// 					Method: to.Ptr("GET"),
		// 					Headers: map[string]any{
		// 						"Accept-Language": "en-US",
		// 						"User-Agent": "azure-logic-apps/1.0,(workflow 80244732be3648f59d2084fd979cdd56; version 08586611142904036539)",
		// 						"x-ms-action-tracking-id": "ad27f634-6523-492f-924e-9a75e28619c8",
		// 						"x-ms-client-request-id": "ad484925-4148-4dd0-9488-07aed418b256",
		// 						"x-ms-client-tracking-id": "08586611142736787787412824395CU21",
		// 						"x-ms-correlation-id": "ad484925-4148-4dd0-9488-07aed418b256",
		// 						"x-ms-execution-location": "brazilsouth",
		// 						"x-ms-tracking-id": "ad484925-4148-4dd0-9488-07aed418b256",
		// 						"x-ms-workflow-id": "80244732be3648f59d2084fd979cdd56",
		// 						"x-ms-workflow-name": "test-workflow",
		// 						"x-ms-workflow-operation-name": "HTTP_Webhook",
		// 						"x-ms-workflow-resourcegroup-name": "test-resource-group",
		// 						"x-ms-workflow-run-id": "08586611142736787787412824395CU21",
		// 						"x-ms-workflow-run-tracking-id": "b4cd2e77-f949-4d8c-8753-791407aebde8",
		// 						"x-ms-workflow-subscription-capacity": "Large",
		// 						"x-ms-workflow-subscription-id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
		// 						"x-ms-workflow-system-id": "/locations/brazilsouth/scaleunits/prod-17/workflows/80244732be3648f59d2084fd979cdd56",
		// 						"x-ms-workflow-version": "08586611142904036539",
		// 					},
		// 					URI: to.Ptr("http://tempuri.org"),
		// 				},
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/WorkflowRunActionRepetitionsRequestHistories_List.json
// this example is just showing the usage of "WorkflowRunActionRepetitionsRequestHistories_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this WorkflowRunActionRepetitionResource created on azure
// for more information of creating WorkflowRunActionRepetitionResource, please refer to the document of WorkflowRunActionRepetitionResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "test-resource-group";
string name = "test-name";
string workflowName = "test-workflow";
string runName = "08586776228332053161046300351";
string actionName = "HTTP_Webhook";
string repetitionName = "000001";
ResourceIdentifier workflowRunActionRepetitionResourceId = WorkflowRunActionRepetitionResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name, workflowName, runName, actionName, repetitionName);
WorkflowRunActionRepetitionResource workflowRunActionRepetition = client.GetWorkflowRunActionRepetitionResource(workflowRunActionRepetitionResourceId);

// get the collection of this WebAppRequestHistoryResource
WebAppRequestHistoryCollection collection = workflowRunActionRepetition.GetWebAppRequestHistories();

// invoke the operation and iterate over the result
await foreach (WebAppRequestHistoryResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    WebAppRequestHistoryData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "value": [
    {
      "properties": {
        "startTime": "2018-10-25T18:36:51.9206732Z",
        "endTime": "2018-10-25T18:36:52.1863033Z",
        "request": {
          "headers": {
            "Accept-Language": "en-US",
            "User-Agent": "azure-logic-apps/1.0,(workflow 80244732be3648f59d2084fd979cdd56; version 08586611142904036539)",
            "x-ms-execution-location": "brazilsouth",
            "x-ms-workflow-id": "80244732be3648f59d2084fd979cdd56",
            "x-ms-workflow-version": "08586611142904036539",
            "x-ms-workflow-name": "test-workflow",
            "x-ms-workflow-system-id": "/locations/brazilsouth/scaleunits/prod-17/workflows/80244732be3648f59d2084fd979cdd56",
            "x-ms-workflow-run-id": "08586611142736787787412824395CU21",
            "x-ms-workflow-run-tracking-id": "b4cd2e77-f949-4d8c-8753-791407aebde8",
            "x-ms-workflow-operation-name": "HTTP_Webhook",
            "x-ms-workflow-subscription-id": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
            "x-ms-workflow-resourcegroup-name": "test-resource-group",
            "x-ms-workflow-subscription-capacity": "Large",
            "x-ms-tracking-id": "ad484925-4148-4dd0-9488-07aed418b256",
            "x-ms-correlation-id": "ad484925-4148-4dd0-9488-07aed418b256",
            "x-ms-client-request-id": "ad484925-4148-4dd0-9488-07aed418b256",
            "x-ms-client-tracking-id": "08586611142736787787412824395CU21",
            "x-ms-action-tracking-id": "ad27f634-6523-492f-924e-9a75e28619c8"
          },
          "uri": "http://tempuri.org",
          "method": "GET"
        },
        "response": {
          "headers": {
            "Cache-Control": "private",
            "Date": "Thu, 25 Oct 2018 18:36:51 GMT",
            "Location": "http://www.bing.com/",
            "Server": "Microsoft-IIS/10.0",
            "X-AspNet-Version": "4.0.30319",
            "X-Powered-By": "ASP.NET"
          },
          "statusCode": 302,
          "bodyLink": {
            "uri": "https://tempuri.org",
            "contentVersion": "2LOOAR8Eh2pd7AvRHXUhRg==",
            "contentSize": 137,
            "contentHash": {
              "algorithm": "md5",
              "value": "2LOOAR8Eh2pd7AvRHXUhRg=="
            }
          }
        }
      },
      "id": "/workflows/test-workflow/runs/08586611142736787787412824395CU21/actions/HTTP_Webhook/requestHistories/08586611142732800686",
      "name": "08586611142732800686",
      "type": "/workflows/runs/actions/requestHistories"
    }
  ]
}

Definitions

Name	Description
ContentHash	The content hash.
ContentLink	The content link.
ErrorProperties	Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.
ErrorResponse	Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.
Object
Request	A request.
RequestHistory	The request history.
RequestHistoryListResult	The list of workflow request histories.
RequestHistoryProperties	The request history.
Response	A response.

ContentHash

The content hash.

Name	Type	Description
algorithm	string	The algorithm of the content hash.
value	string	The value of the content hash.

ContentLink

The content link.

Name	Type	Description
contentHash	ContentHash	The content hash.
contentSize	integer	The content size.
contentVersion	string	The content version.
metadata	Object	The metadata.
uri	string	The content link URI.

ErrorProperties

Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
code	string	Error code.
message	string	Error message indicating why the operation failed.

ErrorResponse

Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.

Name	Type	Description
error	ErrorProperties	The error properties.

Object

Request

A request.

Name	Type	Description
headers	Object	A list of all the headers attached to the request.
method	string	The HTTP method used for the request.
uri	string	The destination for the request.

RequestHistory

The request history.

Name	Type	Description
id	string	The resource id.
location	string	The resource location.
name	string	Gets the resource name.
properties	RequestHistoryProperties	The request history properties.
tags	object	The resource tags.
type	string	Gets the resource type.

RequestHistoryListResult

The list of workflow request histories.

Name	Type	Description
nextLink	string	The URL to get the next set of results.
value	RequestHistory[]	A list of workflow request histories.

RequestHistoryProperties

The request history.

Name	Type	Description
endTime	string	The time the request ended.
request	Request	The request.
response	Response	The response.
startTime	string	The time the request started.

Response

A response.

Name	Type	Description
bodyLink	ContentLink	Details on the location of the body content.
headers	Object	A list of all the headers attached to the response.
statusCode	integer	The status code of the response.

Share via

Workflow Run Action Repetitions Request Histories - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List repetition request history

Sample request

Sample response

Definitions

ContentHash

ContentLink

ErrorProperties

ErrorResponse

Object

Request

RequestHistory

RequestHistoryListResult

RequestHistoryProperties

Response

Additional resources