-
Notifications
You must be signed in to change notification settings - Fork 708
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Integration changes for 7.16 (#1219)
* Feature/deprecated operation (#1) * Is Deprecated ref guide * Update open-api operation * Update versioning doc * Update version-rest-service.md * Update open-api.md * Update published-rest-operation.md * Update version-rest-service.md * Update open-api.md * Documentation and example value in message definitions * Updated documentation about proxy information in REST consume and about default content-type. * A bit more detail about date/time format * Updated the image for call-rest-action * Publish a microflow as a REST operation * A message definition now has a unique name * Added documentation for deprecated web service client setting (#3) * Added documentation for deprecated web service client setting * Project setting 'Web service calls' * Schema validation is not possible when using the new implementation for web service calls (#4) * REST Access Tab (#2) * Feature/deprecated operation (#1) * Is Deprecated ref guide * Update open-api operation * Update versioning doc * Update version-rest-service.md * Update open-api.md * Update published-rest-operation.md * Update version-rest-service.md * Update open-api.md * REST Access Tab * Typos * Re-worded rest access * Rest Access * Update index * Remove Allowed Roles * Added documentation about proxy settings in webservice call action (#5) * Review of release notes for 7.15 * Update call-rest-action.md * Update call-web-service-action.md * Update message-definition.md * Update module-security.md * Update open-api.md * Update project-settings.md * Update publish-microflow-as-rest-operation.md * Update published-rest-operation.md * Update published-rest-services.md * Generate mapping(s) button on the message definitions list * Generating REST operations (#7) * Update version-rest-service.md * Update call-web-service-action.md * Update generate-rest-resource.md * Update message-definitions.md * Update module-security.md * Update project-settings.md * Update generate-rest-resource.md * Update publish-microflow-as-rest-operation.md * Update published-rest-services.md * Update published-rest-services.md
- Loading branch information
1 parent
e9b1f6d
commit a08e107
Showing
9 changed files
with
73 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
--- | ||
title: "Generating a REST Resource" | ||
parent: "published-rest-services" | ||
--- | ||
|
||
{{% alert type="info" %}} | ||
|
||
This feature was introduced in version 7.16.0. | ||
|
||
{{% /alert %}} | ||
|
||
## 1 Introduction | ||
|
||
You can publish a REST resource with basic operations based on an entity by right-clicking an entity in the domain model and selecting **Expose as REST resource**. Alternatively, you can drag an entity or message definition onto the list of resources of a published REST service. This page describes the options you have once you perform one of these actions. | ||
|
||
## 2 REST Service | ||
|
||
This only shows up when you click **Expose as REST resource** in the domain model. Next, choose a service in which to generate the resource and operation. | ||
|
||
## 3 General | ||
|
||
### 3.1 Resource Name | ||
|
||
Type the name of the resource that you want to publish. | ||
|
||
### 3.2 Key Attribute | ||
|
||
To be able to create a **Get by key** or a **Delete** operation, there needs to be a unique attribute on the entity. Select that attribute here. | ||
|
||
## 4 Operations | ||
|
||
Check the operations that you want to generate: | ||
|
||
* **Get all** – allows clients to get all the objects | ||
* **Get by key** – allows clients to get an object, given its key | ||
* **Post** – allows clients to add a new object | ||
* **Delete** – allows clients to delete objects | ||
|
||
When you click **OK**, the following items are created: | ||
|
||
* A resource | ||
* All the operations that you selected | ||
* A microflow for each operation | ||
* A message definition | ||
* An import mapping (for the **Post** operation) | ||
* An export mapping (for the **Get all** and **Get by key** operations) | ||
|
||
If you have already created a message definition for the entity, that message definition will be reused. Existing import and export mappings based on that message definition will also be reused. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters