View Article

Introduction

When you have created the Expose Web API file, you can update it at any time. The two main aspects you can update are the entity attributes and parameters: you can add or remove both.

Prerequisites

The Expose API file you need must already exist.

Detailed Steps

Step 1. Open the Expose Web API file.

Open the file you want to edit. This example uses the apiGetCustomer file.

Step 2. If desired, add entity attributes.

In the Tree panel, select the attributes you want to expose.

This example uses the lstOrder collection to add the fields. When you have selected the fields you want, click the Add button to add them to the Attribute Tree panel.

Step 3. If desired, remove entity attributes.

You can remove attributes from the Attribute Tree panel. This example does not remove any attribute.

Step 4. Open the Parameters panel.

This is where you can manage the Expose Web API file parameters.

Step 5. If desired, add a parameter.

Click the plus icon to add a parameter to search for the data.

By default, the Expose Web API file already has the parameter of the entity's primary key.

 Step 6. Enter the parameter details, then click OK.

The important properties are:

• ID: Display the name of the parameter.
• Entity Field: Attribute the parameter uses.
• Required: If checked, the user must enter the parameter. Otherwise, the user may leave it blank.

Xelence adds the parameter.

Step 7. If desired, remove parameters.

You can remove parameters from the Parameters panel. This example does not remove any parameter.

Step 8. Save the file.

What are the improvements over S3 Version 6?

This is a new process.

Related Articles

Create an Expose Get Web API File

Test the Expose Get Web API File

This post is part of the Web API topic. Click here to open Web API Overview

#Develop
#Development Studio
#Task Steps
#Everyone
#Text Help

#Xelence
#API

#WebAPI