headless_batch_engine

Crates.ioheadless_batch_engine
lib.rsheadless_batch_engine
version0.1.0
sourcesrc
created_at2023-03-17 06:30:59.459976
updated_at2023-03-17 06:30:59.459976
descriptionA client and model library for Liferay DXP's batch engine api, auto generated by open-api-generator.
homepage
repository
max_upload_size
id812465
size95,187
Brian Heise (bnheise)

documentation

README

Rust API client for batch_api

A Java client JAR is available for use with the group ID 'com.liferay', artifact ID 'com.liferay.headless.batch.engine.client', and version '1.0.11'.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: v1.0
  • Package version: v1.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named batch_api and add the following to Cargo.toml under [dependencies]:

batch_api = { path = "./batch_api" }

Documentation for API Endpoints

All URIs are relative to http://localhost:8080/o/headless-batch-engine

Class Method HTTP request Description

DefaultApi | get_open_api | GET /v1.0/openapi.{type} | ExportTaskApi | get_export_task | GET /v1.0/export-task/{exportTaskId} | ExportTaskApi | get_export_task_by_external_reference_code | GET /v1.0/export-task/by-external-reference-code/{externalReferenceCode} | ExportTaskApi | get_export_task_by_external_reference_code_content | GET /v1.0/export-task/by-external-reference-code/{externalReferenceCode}/content | ExportTaskApi | get_export_task_content | GET /v1.0/export-task/{exportTaskId}/content | ExportTaskApi | post_export_task | POST /v1.0/export-task/{className}/{contentType} | ImportTaskApi | delete_import_task1 | DELETE /v1.0/import-task/{className} | ImportTaskApi | get_import_task | GET /v1.0/import-task/{importTaskId} | ImportTaskApi | get_import_task_by_external_reference_code | GET /v1.0/import-task/by-external-reference-code/{externalReferenceCode} | ImportTaskApi | get_import_task_by_external_reference_code_content | GET /v1.0/import-task/by-external-reference-code/{externalReferenceCode}/content | ImportTaskApi | get_import_task_by_external_reference_code_failed_item_report | GET /v1.0/import-task/by-external-reference-code/{externalReferenceCode}/failed-items/report | ImportTaskApi | get_import_task_content | GET /v1.0/import-task/{importTaskId}/content | ImportTaskApi | get_import_task_failed_item_report | GET /v1.0/import-task/{importTaskId}/failed-items/report | ImportTaskApi | post_import_task1 | POST /v1.0/import-task/{className} | ImportTaskApi | put_import_task1 | PUT /v1.0/import-task/{className} |

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

Commit count: 0

cargo fmt