Introduction
When you have created the POST Consume Web API file, you can configure it at any time. The main aspects you can configure are the request schema, parameters, and response schema.
Prerequisites
The file you need must already exist.
|
Quick Steps |
| 1 |
Open the Consume Web API file |
| 2 |
Update the file details |
| 3 |
Click URL/Params |
| 4 |
Enter the parameter details, then click OK |
| 5 |
Open the Request tab, then click Add or Edit JSON Structure |
| 6 |
Enter the request schema, then click OK |
| 7 |
Update the entity |
| 8 |
Map the Data fields, then click Get Schema |
| 9 |
Enter the key values, then click Send |
| 10 |
Select the desired fields and collections, then click Update Schema |
| 11 |
Save the file |
Detailed Steps
Step 1. Open the Consume Web API file.
Open the file you want to configure. This example uses wpiPostUserData.
Step 2. Update the file details.
The important properties are:
- ID: Name of the Web API file.
- Content Type: Determines which type of content is returned. There are three types: JSON, XML, and PLAIN. In this example, the Content Type is JSON.
- Request Type: Determines the below HTTP methods:
- GET: It is used to retrieve data from a specified resource.
- POST: It is used to send data to the specified resource. In this example, the Request Type is POST.
- PUT: It is used to send data to update or create a new resource. When a PUT request is sent, the entire resource is replaced with the new data. If the resource does not exist, it will be created.
- DELETE: It is used to delete the specified resource.
- PATCH: It is used to update the desired data in the specified resource by sending only those fields of the resource in the request body.
Step 3. Click URL/Params.
Click the button to add the URL you want to consume the data for.
Step 4. Enter the parameter details, then click OK.
Enter the URL for the specified resource parameters you want to consume to get the data. This example uses api/users.
This example doesn't use a parameter.
The URL is added.
Step 5. Open the Request tab, then click Add or Edit JSON Structure.
Step 6. Enter the request schema, then click OK.
Enter the JSON structure to post the data and get the request schema.
Step 7. Update the entity.
This example uses the existing entity entUser, as you want to use the API on wfmUserMaintenance.
You can also create a new entity with the Create/Update Entity button.
Step 8. Map the Data fields, then Click Get Schema.
Map the fields with the existing entity fields. In this case, you will map Name to First Name in entUser and Job to Skill in entUser.
Click Get Schema to get the schema for the data.
Step 9. Enter the key values, then click Send.
Open the form-data tab to enter the values. You have already provided the JSON structure. Now you must enter the desired values for the fields. This tests whether the values are getting posted.
Step 10. Select the desired fields and collections, then click Update Schema.
If you want a field or collection included, make sure it is checked. Xelence displays a preview of the data.
Step 11. Save the file.
Xelence creates and displays the schema. This file is considered usable without further configuration.
Click the Save icon to save the file.
What are the improvements over S3 Version 6?
This is a new process.
Related Articles
Create an Access Token and Consume Post 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