Skip to content

Add query parameters section to creating data services documentation #2176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sanavi-nk wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add query parameters section to creating data services documentation #2176

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 32 additions & 1 deletion en/docs/develop/creating-artifacts/data-services/creating-data-services.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,37 @@ In this step, you can configure a REST resource to invoke the data service.

<a href="{{base_path}}/assets/img/integrate/tutorials/data_services/resource-graphical-view.png" class="glightbox"><img src="{{base_path}}/assets/img/integrate/tutorials/data_services/resource-graphical-view.png" width="80%"></a>

## Add query parameters to a resource
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Apr 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix heading level to match document structure.

This section uses ## (level 2), making it equivalent to "Tutorials" and "Examples". However, according to the PR description, this should be a subsection under "Add a resource" (which uses ###). Use #### to create a proper subsection hierarchy.

📝 Proposed fix for heading level 
-## Add query parameters to a resource
+#### Add query parameters to a resource
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@en/docs/develop/creating-artifacts/data-services/creating-data-services.md`
at line 98, The "Add query parameters to a resource" heading currently uses
level 2 ("## Add query parameters to a resource") but should be a subsection
under "Add a resource"; change that heading to level 4 by replacing the leading
"##" with "####" so it becomes "#### Add query parameters to a resource" to
match the document hierarchy.


Query parameters allow you to filter or customize the data returned by a resource
using URL parameters in the format `?param=value`.

Follow the steps below to add a query parameter to a data service resource.

1. In the **Data Service Designer**, click the resource you created under **Resources**.
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Apr 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Inconsistent UI terminology.

This line references "Data Service Designer", but the same UI component is called "Service Designer" elsewhere in the document (lines 33, 90). Use consistent terminology throughout.

📝 Proposed fix for terminology consistency 
-1. In the **Data Service Designer**, click the resource you created under **Resources**.
+1. In the **Service Designer**, click the resource you created under **Resources**.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
1. In the **Data Service Designer**, click the resource you created under **Resources**.
1. In the **Service Designer**, click the resource you created under **Resources**.
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@en/docs/develop/creating-artifacts/data-services/creating-data-services.md`
at line 105, Replace the inconsistent term "Data Service Designer" with the
canonical UI name "Service Designer" in this sentence (the string "In the **Data
Service Designer**, click the resource you created under **Resources**.") so it
matches other occurrences (e.g., "Service Designer" used elsewhere); ensure any
other instances of "Data Service Designer" in this document are updated to
"Service Designer" for consistent UI terminology.


2. Click **Query** in the DataService view to open the query configuration.

3. In the **Query / Expression** field, write your SQL query using a named variable.
For example, to filter employees by department:
```sql
SELECT EmployeeNumber, FirstName, LastName FROM Employees WHERE Department=:dept_name
```

4. Click **Input Mapping** in the DataService view to open the input mapping configuration.

5. Click **+ Add Parameter** and fill in the following details:

| Field | Value |
|---------------|--------------------|
| Parameter Name | `dept_name` |
| Parameter Type | `QUERY` |
| SQL Type | `STRING` |

6. Click **Save** to save the input mapping, then click **Submit** to apply.

The resource can now be invoked with a query parameter:
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Apr 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Missing invocation example.

Line 127 states "The resource can now be invoked with a query parameter:" but no example follows. The PR description mentions including "A sample curl/URL invocation example." Provide the promised example.

📝 Suggested addition

Add an example after line 127, such as:

```bash
curl http://localhost:8290/services/YourDataService/resource?dept_name=Engineering

or invoke via browser:

http://localhost:8290/services/YourDataService/resource?dept_name=Engineering


</details>

<details>
<summary>🤖 Prompt for AI Agents</summary>

Verify each finding against the current code and only fix it if needed.

In @en/docs/develop/creating-artifacts/data-services/creating-data-services.md
at line 127, Add a concrete invocation example immediately after the sentence
"The resource can now be invoked with a query parameter:" showing both a curl
command and a browser URL; for example demonstrate calling the service endpoint
/services/YourDataService/resource with the query parameter
dept_name=Engineering (e.g., curl
http://localhost:8290/services/YourDataService/resource?dept_name=Engineering
and the equivalent browser URL
http://localhost:8290/services/YourDataService/resource?dept_name=Engineering)
so readers see a runnable example.


</details>

<!-- fingerprinting:phantom:triton:puma:ef323996-04b0-40f1-99ff-0caeca9f6aa9 -->

<!-- This is an auto-generated comment by CodeRabbit -->


### Add a SOAP operation

In this step you can configure a SOAP operation for invoking the data service.
Expand Down Expand Up @@ -328,4 +359,4 @@ You can use a sample template to create your data service.
1. Go to **Explore Samples** in MI for VS Code.
2. In the **Samples** tab, go to the **REST Data Service** and click on **Download**. This will download the project to your chosen directory and open it in a new VS Code window.

For more information
For more information
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Apr 12, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Incomplete documentation text.

Line 362 contains "For more information" without completion. Either complete this sentence with a relevant link or reference, or remove it if added unintentionally.

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@en/docs/develop/creating-artifacts/data-services/creating-data-services.md`
at line 362, The documentation contains an incomplete sentence "For more
information" in creating-data-services.md; either complete it by appending a
specific resource (e.g., linking to a relevant guide, API reference, or
tutorial) or remove the fragment entirely; update the line that currently reads
"For more information" so it becomes a full sentence with a URL or reference
text, or delete it if it was added accidentally.