Slice version 1 (V1)

Article
05/10/2022

Note

This reference documentation applies to Azure Data Factory version 1 (V1).

Get

Gets data slices for a table in data factory.

Request

The Get Slice 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}/tables/{TableName}/slices?start={StartDateTime}&end={EndDateTime}&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 table.
TableName	Yes	Name of table you want to slice.
StartDateTime	Yes	The date-time when slices start.
EndDateTime	No	The date-time when slices end. The default value is 48 hours after start date-time.
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.

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": [  
    {  
        "status": <SliceStatus>,  
        "state": <SliceState>,  
        "retryCount": <RetryCount>,  
        "longRetryCount": <LongRetryCount>,  
        "statusUpdateTimestamp": <Timestamp>,  
        "start": <StartDateTime1>.  
        "end": <EndDateTime1>  
    },  
    {  
        "status": <SliceStatus>,  
        "state": <SliceState>,  
        "retryCount": <RetryCount>,  
        "longRetryCount": <LongRetryCount>,  
        "statusUpdateTimestamp": <Timestamp>,  
        "start": <StartDateTime2>.  
        "end": <EndDateTime2>  
    },  
    {  
        "status": <SliceStatus>,  
        "state": <SliceState>,  
        "retryCount": <RetryCount>,  
        "longRetryCount": <LongRetryCount>,  
        "statusUpdateTimestamp": <Timestamp>,  
        "start": <StartDateTime3>.  
        "end": <EndDateTime3>  
    }  
    ]  
}

The following table describes the elements of the response body.

Element Name	Description
SliceStatus	Status of this slice.
SliceState	State of the slice.
RetryCount	The number of times the slices would retry.
LongRetryCount	The number of times the slices would do a long retry.
StartDateTime	The date-time when this slice starts
EndDateTime	The date-time when this slice ends.

Sample Request and Response

Example URI:

GET:https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ADF/providers/Microsoft.DataFactory/datafactories/SPRestDataFactory/datasets/EmpSQLTable/slices?start=2015-12-09T12:00:00.0000000&end=2015-12-09T14:00:00.0000000&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-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": [  
    {  
      "status": "Ready",  
      "state": "Ready",  
      "retryCount": 0,  
      "longRetryCount": 0,  
      "statusUpdateTimestamp": "2016-02-22T23:06:59.1238656Z",  
      "start": "2015-12-09T12:00:00Z",  
      "end": "2015-12-09T13:00:00Z"  
    },  
    {  
      "status": "Ready",  
      "state": "Ready",  
      "retryCount": 0,  
      "longRetryCount": 0,  
      "statusUpdateTimestamp": "2016-02-22T23:06:59.1238656Z",  
      "start": "2015-12-09T13:00:00Z",  
      "end": "2015-12-09T14:00:00Z"  
    }  
  ]  
}

Set status

Sets the status of slices for a table in a data factory.

Request

The Set Slice Status 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}/tables/{TableName}/slices/ setstatus?start={StartDateTime}&end={EndDateTime}&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 create your table in.
TableName	Yes	Name of table you want to create.
StartDateTime	Yes	The datetime when slices start.
EndDateTime	Yes	The datetime when slices end.
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

  
{  
    "SliceStatus": <NewSliceStatus>,  
    "UpdateType": <UpdateType>  
}

The following table describes the elements of the response body.

Element Name	Description
NewSliceStatus	The status you want to set.
UpdateType	Specifies the type of update to the slice.

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

None.

Sample Request and Response

Example URI:

  
PUT: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/adf/providers/Microsoft.DataFactory/datafactories/test/tables/tabletest/slices/setstatus?start=2015-12-02T00:00:00.0000000&end=2015-12-02T01:00:00.0000000&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

Slice version 1 (V1)

Get

Request

URI Parameters

Request Headers

Request Body

Response

Status Code

Response Headers

Response Body

Sample Request and Response

Set status

Request

URI Parameters

Request Headers

Request Body

Response

Status Code

Response Headers

Response Body

Sample Request and Response

Additional resources