Overlap tables Resource

Endpoints under /overlap/table allow you to pass tables information and receive a preliminary overlap report computed based on the table schema
The results of comparision are collected in TableComparisionTO model and are returned back

GET /v2/overlap/table

A GET request to the /overlap/table endpoint initiates an overlap calculation and returns the results in a TableComparisionTO model format.

Request Parameters
name type description
table1 query Name of a table (schema.table_name, eg: default.t1)
table2 query Name of a table (schema.table_name, eg: default.t2)
Response Body
media type data type description
application/json TableComparisionTO (JSON)

Example

Request
GET /v2/overlap/table
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }
                
              

POST /v2/overlap/table

A POST request to the /overlap/table which accepts multiple TableComparisionTO models, performs overlap comparision and returns back a list of TableComparisionTO model format
eg: [ { "virtualFolder": "MyHive", "tableOne": "default.t1", "tableTwo": "default.t4" } ]

Request Body
media type data type description
application/json array of TableComparisionTO (JSON) Array of VF, tableOne, tableTwo information
Response Body
media type data type description
application/json IterableOfTableComparisionTO (JSON)

Example

Request
POST /v2/overlap/table
Content-Type: application/json
Accept: application/json

                
[ { } ]
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }
                
              

POST /v2/overlap/table/csv

A POST request to the /overlap/table/csv which accepts a csv file with a pre-defined file format, computes the overlap and returns a downloadable csv file with the results.

Request Parameters
name type description
fileStream formdata CSV File which has to be processed
separator query Separator to be considered while parsing source file and creating the csv result file
Response Body
media type data type description
multipart/form-data (custom) Downloaded streaming CSV file

Example

Request
POST /v2/overlap/table/csv
Content-Type: */*
Accept: multipart/form-data

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: multipart/form-data

                
...
                
              

Copyright © Waterline Data Science, Inc. Generated by Enunciate.