API v2
  • Overview
    • Authentication
    • API Host
    • Error Codes
  • API Reference
    • CSVUploads
    • Explores (Deprecated)
    • Folders
    • Reports
Powered by GitBook
On this page
  1. API Reference

CSVUploads

PreviousError CodesNextExplores (Deprecated)

Last updated 1 year ago

Sample Create Request

import requests

import json

url='https://API_HOST/api/v2/csvuploads/dataImportName/destinationTable'

data={'file':open('path/file.csv')}

authheaders = {'sprinkle-org-id':'OrgId', 'sprinkle-api-key':'key', 'sprinkle-api-secret':'secret'}

r=requests.post(url, files=data, headers=authheaders)

res_json=json.loads(r.text)

Retreive all

get

/csvuploads

Query parameters
projectIdstring

Optional. If not given, then default project is used

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://API_HOST/api/v2/csvuploads'
200
[
  {
    "destinationTable": "orders_raw",
    "destinationSchema": "oms",
    "fileSet": "orders_data",
    "createTime": 1660439099000,
    "updateTime": 1660445539000
  }
]

List of CSV Uploads

Retreive

get

/csvuploads/{destinationTable}

Path parameters
destinationTablestringrequired

name of the destinationTable

Query parameters
projectIdstring

Optional. If not given, then default project is used

Responses
application/json
cURL
JavaScript
Python
HTTP
curl -L \
  --url 'https://API_HOST/api/v2/csvuploads/{destinationTable}'
200
{
  "destinationTable": "orders_raw",
  "destinationSchema": "oms",
  "fileSet": "orders_data",
  "createTime": 1660439099000,
  "updateTime": 1660445539000
}

Details about the CSV Upload

Delete

delete

/csvuploads/{destinationTable}

Path parameters
destinationTablestringrequired

name of the destinationTable

Query parameters
projectIdstring

Optional. If not given, then default project is used

Responses
cURL
JavaScript
Python
HTTP
curl -L \
  --request DELETE \
  --url 'https://API_HOST/api/v2/csvuploads/{destinationTable}'
200
No body

csv upload is deleted

  • GETRetreive all
  • GETRetreive
  • DELETEDelete
  • POSTCreate
  • PUTUpdate
  • Sample Create Request

Create

post

/csvuploads/{dataImportName}//{destinationTable}

Path parameters
dataImportNamestringrequired

name of the dataImport

destinationTablestringrequired

name of the destinationTable

Query parameters
projectIdstring

Optional. If not given, then default project is used

Body
filestring
Responses
application/json
cURL
JavaScript
Python
HTTP
200

Details about the created csv upload

Update

put

/csvuploads/{dataImportName}//{destinationTable}

Path parameters
dataImportNamestringrequired

name of the dataImport

destinationTablestringrequired

name of the destinationTable

Query parameters
projectIdstring

Optional. If not given, then default project is used

Body
filestring
Responses
application/json
cURL
JavaScript
Python
HTTP
200

Details about the updated csv upload

curl -L \
  --request POST \
  --url 'https://API_HOST/api/v2/csvuploads/{dataImportName}/{destinationTable}' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=text'
{
  "destinationTable": "orders_raw",
  "destinationSchema": "oms",
  "fileSet": "orders_data",
  "createTime": 1660439099000,
  "updateTime": 1660445539000
}
curl -L \
  --request PUT \
  --url 'https://API_HOST/api/v2/csvuploads/{dataImportName}/{destinationTable}' \
  --header 'Content-Type: multipart/form-data' \
  --form 'file=text'
{
  "destinationTable": "orders_raw",
  "destinationSchema": "oms",
  "fileSet": "orders_data",
  "createTime": 1660439099000,
  "updateTime": 1660445539000
}