Dataset

Create or update

Creates a new dataset, or updates the content of an existing dataset.

Request

The Create or Update Dataset request may be constructed as follows (HTTPS is recommended):

HTTP Verb Request URI HTTP Version
PUT https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/datasets/{DatasetName}?api-version={api-version} HTTP/1.1

URI Parameters

URI Parameter Required Description
SubscriptionID Yes Your Azure subscription ID.
ResourceGroupName Yes The unique name for the resource group that hosts your Azure data factory.
DataFactoryName Yes Name for the data factory that you want to create your dataset in.
DatasetName Yes Name of dataset you want to create.
Api-Version Yes Specifies the version of the protocol used to make this request.

Request Headers

The following table describes the request headers.

Request Header Required Description
x-ms-client-request-id Yes The operation id for this request.

Request Body

Request body depends on your dataset type. The example here uses AzureBlob dataset.

The format of the request body is as follows.

{  
  "name": "MyDataset",  
  "properties": {  
    "structure": [  
      {  
        "name": "Column1",  
        "type": "String"  
      },  
      {  
        "name": "Column2",  
        "type": "String"  
      }  
    ],  
    "type": "<Dataset type>",  
    "linkedServiceName": "<Name of the linked service that contains the data>",  
    "typeProperties": {  
            "type specific property": "<value>",  
            "type specific property 2": "<value>"  
    },  
    "external": true,  
    "availability": {  
      "frequency": "<Hour/Day/etc...>",  
      "interval": <number>  
    }  
  }  
}  

See Datasets in Azure Data Factory article for descriptions of properties in the JSON.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

  • 200 (OK) - if request completed successfully.

  • 202 (Accepted) - if request was accepted.

  • 400 (Bad Request) - if request body fails validation.

  • 404 (NotFound) - if subscription or resource group does not exist.

  • 412 (Precondition Failed) - if condition specified by If-Match header failed.

  • 501 (Not Implemented) - if validate is not implemented

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Header Description
x-ms-request-id A unique identifier for the current operation, service generated.
x-ms-ratelimit-remaining-subscription-writes The remaining limit for current subscription.
x-ms-correlation-request-id Specifies the tracing correlation Id for the request; the resource provider must log this so that end-to-end requests can be correlated across Azure.
x-ms-routing-request-id Location+DateTime+correlation-request-ID
Date A UTC date/time value generated by the service that indicates the time at which the response was initiated.
Location URI of the object you want to create or get.

Response Body

{  
  "name": "InputDataset",  
  "id":  
"/subscriptions/{subscription ID>/resourcegroups/{resource group name>/providers/Microsoft.DataFactory/datafactories/  
<data factory name>/tables/InputDataset",  
    "type": "AzureBlob",  
    "linkedServiceName": "<Name of the Data Factory linked service that contains the data>",  
    "typeProperties": {  
            "type specific property": "<value>",  
            "type specific property 2": "<value>"  
    },  
    "availability": {  
      "frequency": "<Hour | Day etc...>",  
      "interval": <number>  
    },  
    "external": true,  
    "policy": {},  
    "id": "7c4495bf-f12b-46b6-a653-d4cda899c91c",  
    "createTime": "2016-02-06T00:41:05.2978434Z",  
    "provisioningState": "Succeeded"  
  }  
}  

See Datasets in Azure Data Factory article for descriptions of properties in the JSON.

Sample Request and Response

Example URI:

PUT: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/adf/providers/Microsoft.DataFactory/datafactories/test/datasets/datasettest?api-version=2015-10-01  

The request is sent with the following headers:

x-ms-client-request-id        : 00000000-1111-1111-1111-000000000000  

and with the following body:

{  
  "name": "InputDataset",  
  "properties": {  
    "structure": [  
      {  
        "name": "FirstName",  
        "type": "String"  
      },  
      {  
        "name": "LastName",  
        "type": "String"  
      }  
    ],  
    "type": "AzureBlob",  
    "linkedServiceName": "StorageLinkedService",  
    "typeProperties": {  
      "folderPath": "adftutorial/",  
      "fileName": "emp.txt",  
      "format": {  
        "type": "TextFormat",  
        "columnDelimiter": ","  
      }  
    },  
    "external": true,  
    "availability": {  
      "frequency": "Hour",  
      "interval": 1  
    }  
  }  
}  

After the request has been sent, the following response is returned.


Status Code:  
OK  

Headers:  
Pragma                        : no-cache  
x-ms-request-id               : 00000000-0000-0000-0000-000000000000  
x-ms-ratelimit-remaining-subscription-reads: 14979  
x-ms-correlation-request-id   : 00000000-0000-0000-0000-000000000000  
x-ms-routing-request-id       : EASTUS:20160206T004111Z:00000000-0000-0000-0000-000000000000  
Strict-Transport-Security     : max-age=31536000; includeSubDomains  
Cache-Control                 : no-cache  
Date                          : Sat, 06 Feb 2016 00:41:10 GMT  
Server                        : Microsoft-IIS/8.5  
X-Powered-By                  : ASP.NET  

Body:  
{  
  "name": "InputDataset",  
  "id":  
"/subscriptions/{subscription ID>/resourcegroups/{resource group name>/providers/Microsoft.DataFactory/datafactories/  
<name of data factory>/tables/InputDataset",  
  "properties": {  
    "structure": [  
      {  
        "name": "FirstName",  
        "type": "String"  
      },  
      {  
        "name": "LastName",  
        "type": "String"  
      }  
    ],  
    "published": false,  
    "type": "AzureBlob",  
    "linkedServiceName": "StorageLinkedService",  
    "typeProperties": {  
      "fileName": "emp.txt",  
      "folderPath": "adftutorial/",  
      "format": {  
        "type": "TextFormat",  
        "columnDelimiter": ","  
      }  
    },  
    "availability": {  
      "frequency": "Hour",  
      "interval": 1  
    },  
    "external": true,  
    "policy": {},  
    "id": "00000000-0000-0000-0000-000000000000",  
    "createTime": "2016-02-06T00:41:05.2978434Z",  
    "provisioningState": "Succeeded"  
  }  
}  

Delete

Deletes the specified dataset.

Request

The Delete Dataset request may be constructed as follows (HTTPS is recommended):

HTTP Verb Request URI HTTP Version
DELETE https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/dataset/{DatasetName}?api-version={api-version} HTTP/1.1

URI Parameters

URI Parameter Required Description
SubscriptionID Yes Your Azure subscription ID.
ResourceGroupName Yes The unique name for the resource group that hosts your Azure data factory.
DataFactoryName Yes Name for the data factory that you want to delete your dataset in.
DatasetName Yes Name of dataset you want to delete
Api-Version Yes Specifies the version of the protocol used to make this request.

Request Headers

The following table describes the request headers.

Request Header Required Description
x-ms-client-request-id Yes The operation ID for this request.

Request Body

None.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

  • 200 (OK) - if the request was completed successfully.

  • 400 (Bad Request) - if request body fails validation.

  • 404 (NotFound) - if subscription or resource group does not exist.

  • 412 (Precondition Failed) - if condition specified by If-Match header failed.

  • 501 (Not Implemented) - if validate is not implemented

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Header Description
x-ms-request-id A unique identifier for the current operation, service generated.
x-ms-ratelimit-remaining-subscription-writes The remaining limit for current subscription.
x-ms-correlation-request-id Specifies the tracing correlation Id for the request; the resource provider must log this so that end-to-end requests can be correlated across Azure.
x-ms-routing-request-id Location+DateTime+correlation-request-ID
Date A UTC date/time value generated by the service that indicates the time at which the response was initiated.

Response Body

None.

Sample Request and Response

Example URI:

DELETE: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/adf/providers/Microsoft.DataFactory/datafactories/test/dataset/myds?api-version=2015-10-01  

The request is sent with the following headers.

x-ms-client-request-id        : 00000000-1111-1111-1111-000000000000  

After the request has been sent, the following response is returned.


Status Code:  
OK  

Headers:  
Pragma                        : no-cache  
x-ms-request-id               : 00000000-1111-1111-1111-000000000000  
x-ms-ratelimit-remaining-subscription-writes: 799985  
x-ms-correlation-request-id   : 00000000-1111-2222-1111-000000000000  
x-ms-routing-request-id       : WESTUS:20141203T213307Z: 00000000-1111-2222-1111-000000000000  
Strict-Transport-Security     : max-age=31536000; includeSubDomains  
Cache-Control                 : no-cache  
Date                          : Wed, 03 Dec 2014 21:33:07 GMT  
Server                        : Microsoft-IIS/8.5  
X-Powered-By                  : ASP.NET  
client-tracking-id            : 83  

Get

Gets information about datasets in a data factory.

Request

The Get Dataset request may be constructed as follows (HTTPS is recommended):

HTTP Verb Request URI HTTP Version
GET https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/datasets/{DatasetName}?api-version={api-version} HTTP/1.1

URI Parameters

URI Parameter Required Description
SubscriptionID Yes Your Azure subscription ID.
ResourceGroupName Yes A unique name for the resource group that hosts your Azure data factory Service.
DataFactoryName Yes Name for the data factory that you want to get your dataset in.
DatasetName Yes Name of dataset you want to get.
Api-Version Yes Specifies the version of the protocol used to make this request.

Request Headers

The following table describes the request headers.

Request Header Required Description
x-ms-client-request-id Yes The operation id for this request.

Request Body

None.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

  • 200 (OK) - if the request was completed successfully.

  • 400 (Bad Request) - if the request body fails validation.

  • 404 (NotFound) - if the subscription or resource group does not exist.

  • 412 (Precondition Failed) - if the condition specified by If-Match header failed.

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Header Description
x-ms-request-id A unique identifier for the current operation, service generated.
x-ms-ratelimit-remaining-subscription-writes The remaining limit for current subscription.
x-ms-correlation-request-id Specifies the tracing correlation Id for the request. The resource provider must log this so that end-to-end requests can be correlated across Azure.
x-ms-routing-request-id Location+DateTime+correlation-request-ID
Date A UTC date/time value generated by the service that indicates the time at which the response was initiated.

Response Body

Response body depends on your dataset type. This example uses an AzureBlob dataset.

{  
  "name": "InputDataset",  
  "id":  
"/subscriptions/{subscription ID>/resourcegroups/{resource group name>/providers/Microsoft.DataFactory/datafactories/  
<data factory name>/tables/InputDataset",  
    "type": "AzureBlob",  
    "linkedServiceName": "<Name of the Data Factory linked service that contains the data>",  
    "typeProperties": {  
            "type specific property": "<value>",  
            "type specific property 2": "<value>"  
    },  
    "availability": {  
      "frequency": "<Hour | Day etc...>",  
      "interval": <number>  
    },  
    "external": true,  
    "policy": {},  
    "id": "7c4495bf-f12b-46b6-a653-d4cda899c91c",  
    "createTime": "2016-02-06T00:41:05.2978434Z",  
    "provisioningState": "Succeeded"  
  }  
}  

See Datasets in Azure Data Factory article for descriptions of properties in the JSON.

Sample Request and Response

Example URI:

GET: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/adf/providers/Microsoft.DataFactory/datafactories/test/dataset/InputDataset?api-version=2015-10-01  

The request is sent with the following headers.

x-ms-client-request-id        : 00000000-1111-1111-1111-000000000000  

After the request has been sent, the following response is returned.

Header:


Status Code:  
OK  

Headers:  
Pragma                        : no-cache  
x-ms-request-id               : 00000000-1111-1111-1111-000000000000  
x-ms-ratelimit-remaining-subscription-reads: 14998  
x-ms-correlation-request-id   : 00000000-1111-2222-1111-000000000000  
x-ms-routing-request-id       : EASTUS:20160206T004938Z:00000000-1111-2222-1111-000000000000  
Strict-Transport-Security     : max-age=31536000; includeSubDomains  
Cache-Control                 : no-cache  
Date                          : Sat, 06 Feb 2016 00:49:37 GMT  
Server                        : Microsoft-IIS/8.5  
X-Powered-By                  : ASP.NET  

The response includes the following XML body.

{  
  "name": "InputDataset",  
  "id":  
"/subscriptions/{subscription ID>/resourcegroups/{resource group name>/providers/Microsoft.DataFactory/datafactories/{data factory name>/tables/InputDataset",  
  "properties": {  
    "structure": [  
      {  
        "name": "FirstName",  
        "type": "String"  
      },  
      {  
        "name": "LastName",  
        "type": "String"  
      }  
    ],  
    "published": false,  
    "type": "AzureBlob",  
    "linkedServiceName": "StorageLinkedService",  
    "typeProperties": {  
      "fileName": "emp.txt",  
      "folderPath": "adftutorial/",  
      "format": {  
        "type": "TextFormat",  
        "columnDelimiter": ","  
      }  
    },  
    "availability": {  
      "frequency": "Hour",  
      "interval": 1  
    },  
    "external": true,  
    "policy": {},  
    "id": "00000000-1111-1111-1111-000000000000",  
    "createTime": "2016-02-06T00:41:05.2978434Z",  
    "provisioningState": "Succeeded"  
  }  
}  

List

Lists information of all datasets in the data factory.

Request

The List Datasets request may be constructed as follows (HTTPS is recommended):

HTTP Verb Request URI HTTP Version
GET https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName}/datasets?api-version={api-version} HTTP/1.1

URI Parameters

URI Parameter Required Description
SubscriptionID Yes Your Azure subscription ID.
ResourceGroupName Yes A unique name for the resource group that hosts your Azure data factory.
DataFactoryName Yes Name for the data factory that you want to find your dataset.
Api-Version Yes Specifies the version of the protocol used to make this request.

Request Headers

The following table describes the request headers.

Request Header Required Description
x-ms-client-request-id Yes The operation id for this request.

Request Body

None.

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

  • 200 (OK) - if the request completed successfully.

  • 400 (Bad Request) - if the request body fails validation.

  • 404 (NotFound) - if the subscription or resource group does not exist.

  • 412 (Precondition Failed) - if the condition specified by If-Match header failed.

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Header Description
x-ms-request-id A unique identifier for the current operation, service generated.
x-ms-ratelimit-remaining-subscription-writes The remaining limit for current subscription.
x-ms-correlation-request-id Specifies the tracing correlation Id for the request. The resource provider must log this so that end-to-end requests can be correlated across Azure.
x-ms-routing-request-id Location+DateTime+correlation-request-ID
Date A UTC date/time value generated by the service that indicates the time at which the response was initiated.

Response Body

{  
  "value": [  
    {  
      "name": "Name of the dataset",  
      "id":  
"/subscriptions/{Subscription ID>/resourcegroups/{Resource Group Name>/providers/Microsoft.DataFactory/datafactories/  
<Data Factory Name>/tables/{datasetname>",  
      "properties": {  
        "published": false,  
        "type": "Type of the dataset",  
        "typeProperties": {},  
        "id": "00000000-0000-0000-0000-000000000000",  
        "createTime": "2016-02-22T20:19:27.250261Z",  
        "provisioningState": "Succeeded"  
      }  
    },  
    {  
      "name": "Name of the dataset",  
      "id":  
"/subscriptions/{subscription ID>/resourcegroups/{resource group name>/providers/Microsoft.DataFactory/datafactories/  
<data factory name>/tables/{datasetname>",  
      "properties": {  
        "published": false,  
        "type": "Type of the dataset",  
        "typeProperties": {},  
        "id": "11111111-111-1111-1111-1111111111111",  
        "createTime": "2016-02-22T21:43:50.3713029Z",  
        "provisioningState": "Succeeded"  
      }  
    }  
  ]  
}  

If there are more than 100 records, you will get 100 records at a time with a nextLink:

{
  "value": [
    {
      "name": "AzureBlobInput99",
      "id": "/subscriptions/{subscription ID>/resourcegroups/{resource group name>/providers/Microsoft.DataFactory/datafactories/ADFCopyTutorialDF/datasets/AzureBlobInput99",
      "properties": {
        "published": false,
        "type": "AzureBlob",
        "linkedServiceName": "AzureStorageLinkedService",
        "typeProperties": {},
        "id": "11111111-111-1111-1111-1111111111111",
        "createTime": "2016-08-27T01:59:21.5963602Z",
        "provisioningState": "Succeeded"
       }
    }, 
    {
      "name": "AzureBlobInput100",
      "id": "/subscriptions/{subscription ID>/resourcegroups/{resource group name>/providers/Microsoft.DataFactory/datafactories/ADFCopyTutorialDF/datasets/AzureBlobInput100",
      "properties": {
        "published": false,
        "type": "AzureBlob",
        "linkedServiceName": "AzureStorageLinkedService",
        "typeProperties": {},
        "id": "11111111-111-1111-1111-1111111111111",
        "createTime": "2016-08-17T18:38:04.695873Z",
        "provisioningState": "Succeeded"
      }
     }
  ],
  "nextLink": "https://management.azure.com/subscriptions/{subscription ID>/resourcegroups/{Resource group name>/providers/Microsoft.DataFactory/datafactories/{data factory name>/datasets?api-version=2015-10-01&%24skipToken=MSExNiFSR0YwWVVGeWRHbG1ZV04wCjEhNTIhUkVGZlpUSXlaR1UyTXpndFpURTJNeTAwWXpZNUxUaGhNR0l0Wm1VMU1ETmpOakF4T0RObA%3d%3d"
}  

You send the next request using the nextLink URL to get the next set of records. You may need to wrap & with double quotes ("") in the nextLink URL. Only 100 records are returned at a time.

See Datasets in Azure Data Factory article for descriptions of properties in the JSON.

Sample Request and Response

Example URI:

GET: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/adf/providers/Microsoft.DataFactory/datafactories/test/datasets?api-version=2015-10-01  

The request is sent with the following headers.

x-ms-client-request-id        : 00000000-1111-1111-1111-000000000000  

After the request has been sent, the following response is returned.


Status Code:  
OK  

Headers:  
Pragma                        : no-cache  
x-ms-request-id               : 00000000-1111-1111-1111-000000000000  
x-ms-ratelimit-remaining-subscription-reads: 14999  
x-ms-correlation-request-id   : 00000000-1111-2222-1111-000000000000  
x-ms-routing-request-id       : EASTUS:20160206T191716Z:00000000-1111-2222-1111-000000000000  
Strict-Transport-Security     : max-age=31536000; includeSubDomains  
Cache-Control                 : no-cache  
Date                          : Sat, 06 Feb 2016 19:17:15 GMT  
Server                        : Microsoft-IIS/8.5  
X-Powered-By                  : ASP.NET  

The response includes the following XML body.

{  
  "value": [  
    {  
      "name": "EmpTableFromBlob",  
      "id":  
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ADF/providers/Microsoft.DataFactory/datafactories/  
SPRestDataFactory/tables/EmpTableFromBlob",  
      "properties": {  
        "published": false,  
        "type": "AzureBlob",  
        "typeProperties": {},  
        "id": "35555f2c-2cfe-48f4-86a8-bce7a3f1d1bd",  
        "createTime": "2016-02-22T20:19:27.250261Z",  
        "provisioningState": "Succeeded"  
      }  
    },  
    {  
      "name": "EmpSQLTable",  
      "id":  
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ADF/providers/Microsoft.DataFactory/datafactories/  
SPRestDataFactory/tables/EmpSQLTable",  
      "properties": {  
        "published": false,  
        "type": "AzureSqlTable",  
        "typeProperties": {},  
        "id": "376389aa-cef0-4418-8c80-4a8f2af3a84b",  
        "createTime": "2016-02-22T21:43:50.3713029Z",  
        "provisioningState": "Succeeded"  
      }  
    }  
  ]  
}  

List Activity Windows

Lists the first page of activity window instances associated with a dataset along with a link to the next page.

Request

The Get Activity window request may be constructed as follows (HTTPS is recommended):

HTTP Verb Request URI HTTP Version
POST https://management.azure.com/subscriptions/{SubscriptionID}/resourcegroups/{ResourceGroupName}/providers/Microsoft.DataFactory/datafactories/{DataFactoryName/datasets/{DatasetName}/activitywindows?api-version={api-version} HTTP/1.1

URI Parameters

URI Parameter Required Description
SubscriptionID Yes Your Azure subscription ID.
ResourceGroupName Yes Name of the resource group that hosts your Azure data factory.
DataFactoryName Yes Name of the data factory.
DatasetName Yes Name of the dataset.
Api-Version Yes Specifies the version of the protocol used to make this request.

Request Headers

The following table describes the request headers.

Request Header Required Description
x-ms-client-request-id Yes The operation id for this request.

Request Body

Element name Description Required
Filter The activity window filter specified using Azure Search filter grammar. See https://msdn.microsoft.com/library/azure/dn798921.aspx for details. No
OrderBy Order the response by specified activity window properties. This is a list of comma separated properties. For example: WindowStart, PercentComplete. By befault, the order is ascending order (ASC). Specify DESC if you want the list to be ordered in descending order. No
Top The number of activity windows to be listed. No
RunStart The start time of activity window run. No
RunEnd The end time of activity window run. No
WindowStart The start time activity window. No
WindowEnd The end time of activity window. No
WindowState The state of activity window. Must be one of the values specified in this article. No
WindowSubstate The substate of activity window. Must be one of the values specified in this article. No

Response

The response includes an HTTP status code, a set of response headers, and a response body.

Status Code

  • 200 (OK) - if the request completed successfully.

  • 400 (Bad Request) - if the request body fails validation.

  • 404 (NotFound) - if the subscription or resource group does not exist.

Response Headers

The response for this operation includes the following headers. The response may also include additional standard HTTP headers. All standard headers conform to the HTTP/1.1 protocol specification.

Response Header Description
x-ms-request-id A unique identifier for the current operation, service generated.
x-ms-ratelimit-remaining-subscription-writes The remaining limit for current subscription.
x-ms-correlation-request-id Specifies the tracing correlation Id for the request. The resource provider must log this so that end-to-end requests can be correlated across Azure.
x-ms-routing-request-id Location+DateTime+correlation-request-ID
Date A UTC date/time value generated by the service that indicates the time at which the response was initiated.

Response Body

{  
    "value": {  
    "activityWindows": [  
      {  
        "resourceGroupName": "<resource group name>",  
        "dataFactoryName": "<data factory name>",  
        "pipelineName": "<pipeline name>",  
        "activityName": "<Pipeline activity name.>",  
        "linkedServiceName": "<linked service name>",  
        "activityType": "<The activity type>",  
        "runAttempts": "<Number of activity run attempts.>",  
        "runStart": "<start time of the last run>",  
        "runEnd": "<end time of the last run>",  
        "duration": "<duration of the activity window>",  
        "percentComplete": "<percent completion of activity window>",  
        "windowStart": "<window start time>",  
        "windowEnd": "<window end time>",  
        "windowState": "<window state>",  
        "windowSubstate": "<window substate>",  
        "inputDatasets": "[<input dataset names>]",  
        "outputDatasets": [  
          "<output dataset names>"  
        ],  
        "inputDatasetIds":["<input dataset ids>"],  
        "outputDatasetIds": [  
          "<output dataset ids>" 
        ]  
      }  
    ],  
    "lastUpdate":"<The approximate time for the last activity windows>",  
    "aggregates": {}  
  },  
    "nextLink": "<Link to next page>"  
}  

Sample Request and Response

Example URI:

POST:https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ADF/providers/Microsoft.DataFactory/datafactories/dfName/datasets/dsName/activitywindows?api-version=2015-10-01  

The request is sent with the following headers and the body:

Header:

x-ms-client-request-id        : 00000000-1111-1111-1111-000000000000  

Body:

{
  "top": 5,
  "windowState": "Failed",
  "filter": "RunAttempts ge 1"
}

After the request has been sent, the following response is returned.


Status Code:  
OK  

Headers:  
Pragma                        : no-cache  
x-ms-request-id               : 00000000-1111-1111-1111-000000000000  
x-ms-ratelimit-remaining-subscription-writes: 799985  
x-ms-correlation-request-id   : 00000000-1111-2222-1111-000000000000  
x-ms-routing-request-id       : WESTUS:20141203T213307Z: 00000000-1111-2222-1111-000000000000  
Strict-Transport-Security     : max-age=31536000; includeSubDomains  
Cache-Control                 : no-cache  
Date                          : Wed, 03 Dec 2014 21:33:07 GMT  
Server                        : Microsoft-IIS/8.5  
X-Powered-By                  : ASP.NET  

The response includes the following XML body.

{
  "value": {
    "activityWindows": [
      {
        "resourceGroupName": "rgName",  
        "dataFactoryName": "dfName",  
        "pipelineName": "DP_WikipediaSamplePipeline",
        "activityName": "BlobToSqlCopyActivity",
        "linkedServiceName": "HDILinkedService",
        "activityType": "Copy",
        "runAttempts": 2,
        "runStart": "2016-11-18T20:16:43.149Z",
        "runEnd": "2016-11-18T20:20:06.517Z",
        "duration": "00:03:23.3680000",
        "percentComplete": 50,
        "windowStart": "2016-11-18T19:00:00Z",
        "windowEnd": "2016-11-18T20:00:00Z",
        "windowState": "Failed",
        "windowSubstate": "",
        "inputDatasets": [
          "DA_CuratedWikiData"
        ],
        "outputDatasets": [
          "DA_WikiAggregatedData"
        ],
        "inputDatasetIds": [
          "b7707e71-2bf8-4596-94c7-90676d67bb3d"
        ],
        "outputDatasetIds": [
          "5aee09bb-ec37-4c3e-b8c3-a974741769b4"
        ]
      },
      {
        "resourceGroupName": "rgName",  
        "dataFactoryName": "dfName",  
        "pipelineName": "DP_WikipediaSamplePipeline",
        "activityName": "BlobToSqlCopyActivity",
        "linkedServiceName": "HDILinkedService",
        "activityType": "Copy",
        "runAttempts": 2,
        "runStart": "2016-11-18T20:43:59.716Z",
        "runEnd": "2016-11-18T20:47:27.827Z",
        "duration": "00:03:28.1110000",
        "percentComplete": 50,
        "windowStart": "2016-11-18T15:00:00Z",
        "windowEnd": "2016-11-18T16:00:00Z",
        "windowState": "Failed",
        "windowSubstate": "",
        "inputDatasets": [
          "DA_CuratedWikiData"
        ],
        "outputDatasets": [
          "DA_WikiAggregatedData"
        ],
        "inputDatasetIds": [
          "b7707e71-2bf8-4596-94c7-90676d67bb3d"
        ],
        "outputDatasetIds": [
          "5aee09bb-ec37-4c3e-b8c3-a974741769b4"
        ]
      },
      {
        "resourceGroupName": "rgName",  
        "dataFactoryName": "dfName",  
        "pipelineName": "DP_WikipediaSamplePipeline",
        "activityName": "BlobToSqlCopyActivity",
        "linkedServiceName": "HDILinkedService",
        "activityType": "Copy",
        "runAttempts": 2,
        "runStart": "2016-11-18T20:50:54.688Z",
        "runEnd": "2016-11-18T20:54:19.826Z",
        "duration": "00:03:25.1370000",
        "percentComplete": 50,
        "windowStart": "2016-11-18T14:00:00Z",
        "windowEnd": "2016-11-18T15:00:00Z",
        "windowState": "Failed",
        "windowSubstate": "",
        "inputDatasets": [
          "DA_CuratedWikiData"
        ],
        "outputDatasets": [
          "DA_WikiAggregatedData"
        ],
        "inputDatasetIds": [
          "b7707e71-2bf8-4596-94c7-90676d67bb3d"
        ],
        "outputDatasetIds": [
          "5aee09bb-ec37-4c3e-b8c3-a974741769b4"
        ]
      },
      {
        "resourceGroupName": "rgName",  
        "dataFactoryName": "dfName",  
        "pipelineName": "DP_WikipediaSamplePipeline",
        "activityName": "BlobToSqlCopyActivity",
        "linkedServiceName": "HDILinkedService",
        "activityType": "Copy",
        "runAttempts": 2,
        "runStart": "2016-11-18T20:57:45.579Z",
        "runEnd": "2016-11-18T21:01:09.939Z",
        "duration": "00:03:24.3590000",
        "percentComplete": 50,
        "windowStart": "2016-11-18T13:00:00Z",
        "windowEnd": "2016-11-18T14:00:00Z",
        "windowState": "Failed",
        "windowSubstate": "",
        "inputDatasets": [
          "DA_CuratedWikiData"
        ],
        "outputDatasets": [
          "DA_WikiAggregatedData"
        ],
        "inputDatasetIds": [
          "b7707e71-2bf8-4596-94c7-90676d67bb3d"
        ],
        "outputDatasetIds": [
          "5aee09bb-ec37-4c3e-b8c3-a974741769b4"
        ]
      },
      {
        "resourceGroupName": "rgName",  
        "dataFactoryName": "dfName",  
        "pipelineName": "DP_WikipediaSamplePipeline",
        "activityName": "BlobToSqlCopyActivity",
        "linkedServiceName": "HDILinkedService",
        "activityType": "Copy",
        "runAttempts": 2,
        "runStart": "2016-11-18T21:11:26.944Z",
        "runEnd": "2016-11-18T21:14:52.082Z",
        "duration": "00:03:25.1380000",
        "percentComplete": 50,
        "windowStart": "2016-11-18T20:00:00Z",
        "windowEnd": "2016-11-18T21:00:00Z",
        "windowState": "Failed",
        "windowSubstate": "",
        "inputDatasets": [
          "DA_CuratedWikiData"
        ],
        "outputDatasets": [
          "DA_WikiAggregatedData"
        ],
        "inputDatasetIds": [
          "b7707e71-2bf8-4596-94c7-90676d67bb3d"
        ],
        "outputDatasetIds": [
          "5aee09bb-ec37-4c3e-b8c3-a974741769b4"
        ]
      }
    ],
    "lastUpdate": "2016-11-18T13:29:28.4180094-08:00",
    "aggregates": {}
  },  
    "nextLink": "https://localhost:86/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rgName/datafactories/dfName/datasets/dsName/activitywindows/skip=FG154H?ApiVerion01012015"
}  

Use the nextLink URL to get the next page of results.