Skip to content

Latest commit

 

History

History
514 lines (339 loc) · 11.4 KB

ReportSchedulesApi.md

File metadata and controls

514 lines (339 loc) · 11.4 KB
Raw

SwaggerClient::ReportSchedulesApi

All URIs are relative to http://superset.data-us-east4.clusters.production.universe.engineer/

Method HTTP request Description
api_v1_report_delete DELETE /api/v1/report/
api_v1_report_get GET /api/v1/report/
api_v1_report_info_get GET /api/v1/report/_info
api_v1_report_pk_delete DELETE /api/v1/report/{pk}
api_v1_report_pk_get GET /api/v1/report/{pk}
api_v1_report_pk_log_get GET /api/v1/report/{pk}/log/
api_v1_report_pk_log_log_id_get GET /api/v1/report/{pk}/log/{log_id}
api_v1_report_pk_put PUT /api/v1/report/{pk}
api_v1_report_post POST /api/v1/report/
api_v1_report_related_column_name_get GET /api/v1/report/related/{column_name}

api_v1_report_delete

InlineResponse400 api_v1_report_delete(opts)

Deletes multiple report schedules in a bulk operation.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
end

api_instance = SwaggerClient::ReportSchedulesApi.new
opts = { 
  q: SwaggerClient::GetDeleteIdsSchema.new # GetDeleteIdsSchema | 
}

begin
  result = api_instance.api_v1_report_delete(opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ReportSchedulesApi->api_v1_report_delete: #{e}"
end

Parameters

Name Type Description Notes
q GetDeleteIdsSchema [optional]

Return type

InlineResponse400

Authorization

jwt

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

api_v1_report_get

InlineResponse20039 api_v1_report_get(opts)

Get a list of report schedules, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
end

api_instance = SwaggerClient::ReportSchedulesApi.new
opts = { 
  q: SwaggerClient::GetListSchema.new # GetListSchema | 
}

begin
  result = api_instance.api_v1_report_get(opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ReportSchedulesApi->api_v1_report_get: #{e}"
end

Parameters

Name Type Description Notes
q GetListSchema [optional]

Return type

InlineResponse20039

Authorization

jwt

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

api_v1_report_info_get

InlineResponse2001 api_v1_report_info_get(opts)

Get metadata information about this API resource

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
end

api_instance = SwaggerClient::ReportSchedulesApi.new
opts = { 
  q: SwaggerClient::GetInfoSchema.new # GetInfoSchema | 
}

begin
  result = api_instance.api_v1_report_info_get(opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ReportSchedulesApi->api_v1_report_info_get: #{e}"
end

Parameters

Name Type Description Notes
q GetInfoSchema [optional]

Return type

InlineResponse2001

Authorization

jwt

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

api_v1_report_pk_delete

InlineResponse400 api_v1_report_pk_delete(pk)

Delete a report schedule

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
end

api_instance = SwaggerClient::ReportSchedulesApi.new
pk = 56 # Integer | The report schedule pk


begin
  result = api_instance.api_v1_report_pk_delete(pk)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ReportSchedulesApi->api_v1_report_pk_delete: #{e}"
end

Parameters

Name Type Description Notes
pk Integer The report schedule pk

Return type

InlineResponse400

Authorization

jwt

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

api_v1_report_pk_get

InlineResponse20040 api_v1_report_pk_get(pk, opts)

Get a report schedule

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
end

api_instance = SwaggerClient::ReportSchedulesApi.new
pk = 56 # Integer | 
opts = { 
  q: SwaggerClient::GetItemSchema.new # GetItemSchema | 
}

begin
  result = api_instance.api_v1_report_pk_get(pk, opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ReportSchedulesApi->api_v1_report_pk_get: #{e}"
end

Parameters

Name Type Description Notes
pk Integer
q GetItemSchema [optional]

Return type

InlineResponse20040

Authorization

jwt

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

api_v1_report_pk_log_get

InlineResponse20042 api_v1_report_pk_log_get(pk, opts)

Get a list of report schedule logs, use Rison or JSON query parameters for filtering, sorting, pagination and for selecting specific columns and metadata.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
end

api_instance = SwaggerClient::ReportSchedulesApi.new
pk = 56 # Integer | The report schedule id for these logs
opts = { 
  q: SwaggerClient::GetListSchema.new # GetListSchema | 
}

begin
  result = api_instance.api_v1_report_pk_log_get(pk, opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ReportSchedulesApi->api_v1_report_pk_log_get: #{e}"
end

Parameters

Name Type Description Notes
pk Integer The report schedule id for these logs
q GetListSchema [optional]

Return type

InlineResponse20042

Authorization

jwt

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

api_v1_report_pk_log_log_id_get

InlineResponse20043 api_v1_report_pk_log_log_id_get(pk, log_id, opts)

Get a report schedule log

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
end

api_instance = SwaggerClient::ReportSchedulesApi.new
pk = 56 # Integer | The report schedule pk for log
log_id = 56 # Integer | The log pk
opts = { 
  q: SwaggerClient::GetItemSchema.new # GetItemSchema | 
}

begin
  result = api_instance.api_v1_report_pk_log_log_id_get(pk, log_id, opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ReportSchedulesApi->api_v1_report_pk_log_log_id_get: #{e}"
end

Parameters

Name Type Description Notes
pk Integer The report schedule pk for log
log_id Integer The log pk
q GetItemSchema [optional]

Return type

InlineResponse20043

Authorization

jwt

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

api_v1_report_pk_put

InlineResponse20041 api_v1_report_pk_put(bodypk)

Update a report schedule

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
end

api_instance = SwaggerClient::ReportSchedulesApi.new
body = SwaggerClient::ReportScheduleRestApiPut.new # ReportScheduleRestApiPut | Report Schedule schema
pk = 56 # Integer | The Report Schedule pk


begin
  result = api_instance.api_v1_report_pk_put(bodypk)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ReportSchedulesApi->api_v1_report_pk_put: #{e}"
end

Parameters

Name Type Description Notes
body ReportScheduleRestApiPut Report Schedule schema
pk Integer The Report Schedule pk

Return type

InlineResponse20041

Authorization

jwt

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

api_v1_report_post

InlineResponse20113 api_v1_report_post(body)

Create a report schedule

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
end

api_instance = SwaggerClient::ReportSchedulesApi.new
body = SwaggerClient::ReportScheduleRestApiPost.new # ReportScheduleRestApiPost | Report Schedule schema


begin
  result = api_instance.api_v1_report_post(body)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ReportSchedulesApi->api_v1_report_post: #{e}"
end

Parameters

Name Type Description Notes
body ReportScheduleRestApiPost Report Schedule schema

Return type

InlineResponse20113

Authorization

jwt

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

api_v1_report_related_column_name_get

RelatedResponseSchema api_v1_report_related_column_name_get(column_name, opts)

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
end

api_instance = SwaggerClient::ReportSchedulesApi.new
column_name = 'column_name_example' # String | 
opts = { 
  q: SwaggerClient::GetRelatedSchema.new # GetRelatedSchema | 
}

begin
  result = api_instance.api_v1_report_related_column_name_get(column_name, opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling ReportSchedulesApi->api_v1_report_related_column_name_get: #{e}"
end

Parameters

Name Type Description Notes
column_name String
q GetRelatedSchema [optional]

Return type

RelatedResponseSchema

Authorization

jwt

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json