Get Table Sheet Import Operation

Check the status of an asynchronous Table sheet import.

GET /api/public/v2/tables/{table_id}/sheets/operations/{operation_id}

Get Sheet Import Operation

cURL

curl --request GET \
  --url https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/operations/{operation_id} \
  --header 'X-API-KEY: <api-key>'

import requests

url = "https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/operations/{operation_id}"

headers = {"X-API-KEY": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/operations/{operation_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/operations/{operation_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/operations/{operation_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/operations/{operation_id}")
  .header("X-API-KEY", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.promptlayer.com/api/public/v2/tables/{table_id}/sheets/operations/{operation_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "operation": {
    "operation_id": "<string>",
    "progress": 123,
    "message": "<string>",
    "rows_added": 123,
    "row_count": 123,
    "file_name": "<string>",
    "error_message": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}

{
  "success": false,
  "message": "<string>",
  "error": "<string>"
}

Poll a sheet import operation started by Create Table Sheet, Create Table Sheet File Import, or Create Table Sheet Request Log Import.

Operation statuses are queued, running, succeeded, and failed. Successful operations can include rows_added and row_count; failed operations include error_message when available.

Authorizations

X-API-KEY · string · header · required

Path Parameters

table_id · string<uuid> · required

operation_id · string · required

Response

200

application/json

Operation status

success · boolean

operation · object

Status of an asynchronous sheet import operation.

Show child attributes