@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen") @Beta public class ExportImportApi extends AbstractOpenApiService
apiClient
Constructor and Description |
---|
ExportImportApi(ApiClient apiClient)
Instantiates this API class to invoke operations on the Rule Authoring API for Cloud Foundry based on a given
ApiClient . |
ExportImportApi(HttpDestinationProperties httpDestination)
Instantiates this API class to invoke operations on the Rule Authoring API for Cloud Foundry.
|
Modifier and Type | Method and Description |
---|---|
Project |
exportProject(String id)
Export a project from design time repository
|
Project |
exportProjectWithRevision(String id,
String revision)
Export the highest semantic version of a project for a given revision, from the design time repository.
|
Project |
exportProjectWithVersion(String id,
String version)
Export a version of a project from design time repository
|
OpenApiResponse |
exportRule(String id,
String objectId)
Export decision table rule as excel
|
ProjectVersionObject |
importProject(Project body)
Import a project to design time repository
|
DecisionTableRule |
importRule(File file)
Import rule expressions from Excel into decision table rule
|
public ExportImportApi(@Nonnull HttpDestinationProperties httpDestination)
httpDestination
- The destination that API should be used with@Nullable public Project exportProject(@Nonnull String id) throws OpenApiRequestException
Export a project from design time repository
Export a project and all its entities like data objects, rules, rule services, rulesets from the design repository.
200 - Project exported successfully
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Project Not Found
id
- Json payload of the project with all the relevant entities like data objects, rules, rule services,
rulesets.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public Project exportProjectWithRevision(@Nonnull String id, @Nonnull String revision) throws OpenApiRequestException
Export the highest semantic version of a project for a given revision, from the design time repository.
Exports the highest semantic version of a project for a given revision from the design-time repository, along with all its entities like data objects, rules, rule services, and rulesets.
200 - Project exported
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Object not found. The entity you are trying to read does not exist.
id
- ID of the project. ID is 32 characters long.revision
- Revision of the project which is to be exported.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public Project exportProjectWithVersion(@Nonnull String id, @Nonnull String version) throws OpenApiRequestException
Export a version of a project from design time repository
Exports the specified version of the specified project along with all its entities like data objects, rules, rule services and rulesets from the design time repository.
200 - Project exported successfully
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Object not found. The entity you are trying to read does not exist.
id
- ID of the project. ID is 32 characters long.version
- Version ID of the project which is to be exported. ID is 18 digits long.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nonnull public OpenApiResponse exportRule(@Nonnull String id, @Nonnull String objectId) throws OpenApiRequestException
Export decision table rule as excel
Exports decision table rule expressions(conditions and result expressions) as excel. The file is saved as an Excel Workbook(.xlsx).
200 - Excel Exported.
400 - Bad Request. Invalid Decision Table.
401 - Unauthorized. User does not have required authorization to execute this request.
404 - Object not found. The entity you are trying to read does not exist.
500 - Exception occurred while processing the request.
id
- The Project ID of the rule which is to be exported. The ID is 32 characters long.objectId
- The ID of the rule which is to be exported. The ID is 32 characters long.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public ProjectVersionObject importProject(@Nonnull Project body) throws OpenApiRequestException
Import a project to design time repository
Imports a project and all its entities like data objects, rules, rule services, rulesets to the design repository. An existing project is updated or a project is created. A project can have maximum 10 versions excluding working set.
201 - Project imported successfully
400 - Bad Request
401 - Unauthorized. User does not have required authorization to execute this request.
body
- JSON payload of the project with all the relevant entities like data objects, rules, rule services,
and rulesets.OpenApiRequestException
- if an error occurs while attempting to invoke the API@Nullable public DecisionTableRule importRule(@Nonnull File file) throws OpenApiRequestException
Import rule expressions from Excel into decision table rule
Imports rule expressions(conditions and result expressions) modeled in Excel into decision table rule. The file should be of type Excel Workbook(.xlsx).<br> It is recommended to use the export API to get the excel file for modeling the rule expressions.
200 - Updated Rule
400 - Bad Request. Headers or Content in Excel does not Match with Decision Table.
404 - Object not found. The entity you are trying to read does not exist.
415 - Invalid input file / Unsupported Input Media Type
500 - Exception occurred while processing the request.
file
- Excel File to be ImportedOpenApiRequestException
- if an error occurs while attempting to invoke the APICopyright © 2021 SAP SE. All rights reserved.