\DownloadAPI

All URIs are relative to http://localhost

Method	HTTP request	Description
DownloadGetExport	Get /download/e/{id}	Returns a export file with specified id
DownloadGetExportThumbnail	Get /download/e/{id}/thumbnail	Returns export's thumbnail
DownloadGetExports	Get /download/es/{archiveName}	Returns a zip archive with selected ids
DownloadGetLastSVGExport	Get /download/lastPreview/{reportId}	returns export, that was created from report with specified id. INTERNAL USAGE ONLY!
DownloadGetReport	Get /download/r/{id}	Returns a prepared file with specified id
DownloadGetReportThumbnail	Get /download/r/{id}/thumbnail	Returns report's thumbnail
DownloadGetReports	Get /download/rs/{archiveName}	Returns a zip archive with selected files
DownloadGetTemplate	Get /download/t/{id}	Returns a Template file with specified id
DownloadGetTemplateThumbnail	Get /download/t/{id}/thumbnail	Returns template's thumbnail
DownloadGetTemplates	Get /download/ts/{archiveName}	Returns a zip archive with selected files

DownloadGetExport

*os.File DownloadGetExport(ctx, id).Preview(preview).Execute()

Returns a export file with specified id

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/fastreports/gofrcloud"
)

func main() {
	id := "id_example" // string | 
	preview := true // bool |  (optional) (default to false)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DownloadAPI.DownloadGetExport(context.Background(), id).Preview(preview).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DownloadAPI.DownloadGetExport``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DownloadGetExport`: *os.File
	fmt.Fprintf(os.Stdout, "Response from `DownloadAPI.DownloadGetExport`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string

Other Parameters

Other parameters are passed through a pointer to a apiDownloadGetExportRequest struct via the builder pattern

Name	Type	Description	Notes

preview | bool | | [default to false]

Return type

*os.File

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, application/octet-stream, application/pdf

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DownloadGetExportThumbnail

*os.File DownloadGetExportThumbnail(ctx, id).Execute()

Returns export's thumbnail

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/fastreports/gofrcloud"
)

func main() {
	id := "id_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DownloadAPI.DownloadGetExportThumbnail(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DownloadAPI.DownloadGetExportThumbnail``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DownloadGetExportThumbnail`: *os.File
	fmt.Fprintf(os.Stdout, "Response from `DownloadAPI.DownloadGetExportThumbnail`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string

Other Parameters

Other parameters are passed through a pointer to a apiDownloadGetExportThumbnailRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

*os.File

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, image/png, image/jpeg

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DownloadGetExports

*os.File DownloadGetExports(ctx, archiveName).FileIds(fileIds).FolderIds(folderIds).Execute()

Returns a zip archive with selected ids

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/fastreports/gofrcloud"
)

func main() {
	archiveName := "archiveName_example" // string | name of the created archive
	fileIds := "fileIds_example" // string | ids separated with a ',' sign (optional)
	folderIds := "folderIds_example" // string | ids separated with a ',' sign (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DownloadAPI.DownloadGetExports(context.Background(), archiveName).FileIds(fileIds).FolderIds(folderIds).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DownloadAPI.DownloadGetExports``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DownloadGetExports`: *os.File
	fmt.Fprintf(os.Stdout, "Response from `DownloadAPI.DownloadGetExports`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
archiveName	string	name of the created archive

Other Parameters

Other parameters are passed through a pointer to a apiDownloadGetExportsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

*os.File

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, application/zip

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DownloadGetLastSVGExport

*os.File DownloadGetLastSVGExport(ctx, reportId).Execute()

returns export, that was created from report with specified id. INTERNAL USAGE ONLY!

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/fastreports/gofrcloud"
)

func main() {
	reportId := "reportId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DownloadAPI.DownloadGetLastSVGExport(context.Background(), reportId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DownloadAPI.DownloadGetLastSVGExport``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DownloadGetLastSVGExport`: *os.File
	fmt.Fprintf(os.Stdout, "Response from `DownloadAPI.DownloadGetLastSVGExport`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
reportId	string

Other Parameters

Other parameters are passed through a pointer to a apiDownloadGetLastSVGExportRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

*os.File

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DownloadGetReport

*os.File DownloadGetReport(ctx, id).Execute()

Returns a prepared file with specified id

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/fastreports/gofrcloud"
)

func main() {
	id := "id_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DownloadAPI.DownloadGetReport(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DownloadAPI.DownloadGetReport``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DownloadGetReport`: *os.File
	fmt.Fprintf(os.Stdout, "Response from `DownloadAPI.DownloadGetReport`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string

Other Parameters

Other parameters are passed through a pointer to a apiDownloadGetReportRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

*os.File

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DownloadGetReportThumbnail

*os.File DownloadGetReportThumbnail(ctx, id).Execute()

Returns report's thumbnail

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/fastreports/gofrcloud"
)

func main() {
	id := "id_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DownloadAPI.DownloadGetReportThumbnail(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DownloadAPI.DownloadGetReportThumbnail``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DownloadGetReportThumbnail`: *os.File
	fmt.Fprintf(os.Stdout, "Response from `DownloadAPI.DownloadGetReportThumbnail`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string

Other Parameters

Other parameters are passed through a pointer to a apiDownloadGetReportThumbnailRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

*os.File

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, image/png, image/jpeg

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DownloadGetReports

*os.File DownloadGetReports(ctx, archiveName).FileIds(fileIds).FolderIds(folderIds).Execute()

Returns a zip archive with selected files

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/fastreports/gofrcloud"
)

func main() {
	archiveName := "archiveName_example" // string | name of the created archive
	fileIds := "fileIds_example" // string | ids separated with a ',' sign (optional)
	folderIds := "folderIds_example" // string | ids separated with a ',' sign (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DownloadAPI.DownloadGetReports(context.Background(), archiveName).FileIds(fileIds).FolderIds(folderIds).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DownloadAPI.DownloadGetReports``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DownloadGetReports`: *os.File
	fmt.Fprintf(os.Stdout, "Response from `DownloadAPI.DownloadGetReports`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
archiveName	string	name of the created archive

Other Parameters

Other parameters are passed through a pointer to a apiDownloadGetReportsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

*os.File

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, application/zip

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DownloadGetTemplate

*os.File DownloadGetTemplate(ctx, id).Execute()

Returns a Template file with specified id

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/fastreports/gofrcloud"
)

func main() {
	id := "id_example" // string | template id

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DownloadAPI.DownloadGetTemplate(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DownloadAPI.DownloadGetTemplate``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DownloadGetTemplate`: *os.File
	fmt.Fprintf(os.Stdout, "Response from `DownloadAPI.DownloadGetTemplate`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	template id

Other Parameters

Other parameters are passed through a pointer to a apiDownloadGetTemplateRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

*os.File

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DownloadGetTemplateThumbnail

*os.File DownloadGetTemplateThumbnail(ctx, id).Execute()

Returns template's thumbnail

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/fastreports/gofrcloud"
)

func main() {
	id := "id_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DownloadAPI.DownloadGetTemplateThumbnail(context.Background(), id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DownloadAPI.DownloadGetTemplateThumbnail``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DownloadGetTemplateThumbnail`: *os.File
	fmt.Fprintf(os.Stdout, "Response from `DownloadAPI.DownloadGetTemplateThumbnail`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string

Other Parameters

Other parameters are passed through a pointer to a apiDownloadGetTemplateThumbnailRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

*os.File

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, image/png, image/jpeg

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DownloadGetTemplates

*os.File DownloadGetTemplates(ctx, archiveName).FileIds(fileIds).FolderIds(folderIds).Execute()

Returns a zip archive with selected files

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/fastreports/gofrcloud"
)

func main() {
	archiveName := "archiveName_example" // string | name of the created archive
	fileIds := "fileIds_example" // string | ids separated with a ',' sign (optional)
	folderIds := "folderIds_example" // string | ids separated with a ',' sign (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DownloadAPI.DownloadGetTemplates(context.Background(), archiveName).FileIds(fileIds).FolderIds(folderIds).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DownloadAPI.DownloadGetTemplates``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DownloadGetTemplates`: *os.File
	fmt.Fprintf(os.Stdout, "Response from `DownloadAPI.DownloadGetTemplates`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
archiveName	string	name of the created archive

Other Parameters

Other parameters are passed through a pointer to a apiDownloadGetTemplatesRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

*os.File

Authorization

ApiKey, JWT

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json, application/zip

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

DownloadAPI.md

Latest commit

History

DownloadAPI.md

File metadata and controls

\DownloadAPI

DownloadGetExport

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DownloadGetExportThumbnail

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DownloadGetExports

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DownloadGetLastSVGExport

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DownloadGetReport

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DownloadGetReportThumbnail

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DownloadGetReports

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DownloadGetTemplate

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DownloadGetTemplateThumbnail

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DownloadGetTemplates

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers