Optional
requestFactory: ReferenceTablesApiRequestFactoryOptional
responseProcessor: ReferenceTablesApiResponseProcessorPrivate
configurationPrivate
requestPrivate
responseThe request object
Optional
options: ConfigurationCreate a reference table upload for bulk data ingestion
The request object
Optional
options: ConfigurationDelete a reference table by ID
The request object
Optional
options: ConfigurationGet reference table rows by their primary key values.
The request object
Optional
options: ConfigurationGet a reference table by ID
The request object
Optional
options: ConfigurationList all reference tables in this organization.
The request object
Optional
options: ConfigurationUpdate a reference table by ID. You can update the table's data, description, and tags. Note: The source type cannot be changed after table creation. For data updates: For existing tables of type source:LOCAL_FILE
, call POST api/v2/reference-tables/uploads first to get an upload ID, then PUT chunks of CSV data to each provided URL, and finally call this PATCH endpoint with the upload_id in file_metadata. For existing tables with source:
types of S3
, GCS
, or AZURE
, provide updated access_details in file_metadata pointing to a CSV file in the same type of cloud storage.
The request object
Optional
options: ConfigurationGenerated using TypeDoc
Create a new reference table. You can provide data in two ways: 1) Call POST api/v2/reference-tables/upload first to get an upload ID, then PUT chunks of CSV data to each provided URL, and finally call this POST endpoint with the upload_id in file_metadata, OR 2) Provide access_details in file_metadata pointing to a CSV file in cloud storage (Amazon S3, Azure Blob Storage, or GCP Cloud Storage).