Skip to main content
?

Object Remove Property (attribute)

Overview​

Remove properties (attribute) from an object. Received data in two object.

  • values: object with values.
  • result-list: object with keys of values to keep.

Example Configuration

Learn how to use

Tutorial


Supporting Concepts​

Basic concepts needed for the use case
TopicDescription
APIAn API in API AutoFlow is simply an OpenAPI model
ServerA server accepts and handles the request and response.
SimulationData simulation is a mock data simulated for the purpose of visualizing the data in every step of the workflow.
  • Simulated data is NOT the real data but a sample data you create.
  • To use real data, use the Transaction feature to capture the data you send from Postman or CURL.
ScopeA scope is a namespace for variables.
Data TypesData types describe the different types or kinds of data that you are gonna store and work with.
Use case specific concepts
TopicDescription
Action
object/take		Returns a new 'object' with all the key-value pairs in 'object' where the key is in keys.

Detail​

The HTTP request has an input:

{
 "values" : 
  {
   "drop-pkts" : 100,
   "dropped-bytes" : 10000,
   "transmitted-pkts" : 200,
   "transmitted-bytes": 30000
   },
 "result-list" : 
  [
   "drop-pkts",
   "dropped-bytes"
  ]
}

The goal of the operation is to merge the object into a flatter structure:

{
 "drop-pkts": 100,
 "dropped-bytes": 10000
}

Content​

INPUT: HTTP Request​

1: Create an API endpoint​

Required Concepts

Learn how to create an API.

Create an API

From the left navigation, go to the API section and create a new API.

Create API
  • ID: sample-data-transformation
Create an API Path
Create API Path
  • Path: /obj-propty-rm
  • Method: POST

2. Create a Server Operation​

Required Concepts

Learn how to create a Server.

Create a Server

From the left navigation, go to the Server section and create a new Server.

Create Server
  • Server ID: sample-data-transformation
  • Port Number: 1114 Feel free to select your own port number
  • Linked API: sample-data-transformation (select the API you created above)
Create a Server Operation
Create Server Operation
  • Press the "Add API Operation"
  • Select the API endpoint created above

3 : Create Data Simulation using Real Data​

Required Concepts

Learn how to create a Simulation.

We will use the "real data" to create the test simulation.

1. Send a HTTP request from Postman or CURL
Send Postman Request

API Autoflow Postman Collections

cURL​
curl --location 'localhost:1114/obj-propty-rm' \
--header 'Content-Type: application/json' \
--data '{
    "values" : {
            "drop-pkts" : 100,
            "dropped-bytes" : 10000,
            "transmitted-pkts" : 200,
            "transmitted-bytes": 30000
        },
    "result-list" : [
        "drop-pkts",
        "dropped-bytes"]
}'
2. Check the data is received by the server endpoint

API Autoflow captures the data received and it can be used to create data simulation.

Simulation

Action(s)​

Required Concepts

Learn how to create a Actions.

Add actions to transform the data.

1. Take only the values with keys in the list​

The action goes through the object and keeps the values that match the keys.

Object Take
SETTINGS​
Object Take

object: data

request: body > values

keys: data

request body > result-list
OUTPUT​

variables: output

OUTPUT: HTTP Response​

1. Create a NEW object and map the IP and Subnet​

Both the action's output and HTTP response body are set to variables: output. There's no change that needs to be made.

HTTP Response
SETTINGS​
Server Workflow Default Output

body: data

[variables: output]

Mapping the action output to the HTTP response output
  • Data referenced in HTTP response is what gets sent back to the client.
  • Map the output from the actions to be sent back.

NOTE: By default, the action output is set to variable output. If you intend to keep each action's output without it being overwritten by the next action, simply rename the output location in the action's output.

2. Test the API with Postman or cURL​

cURL​
curl --location 'localhost:1114/obj-propty-rm' \
--header 'Content-Type: application/json' \
--data '{
    "values" : {
            "drop-pkts" : 100,
            "dropped-bytes" : 10000,
            "transmitted-pkts" : 200,
            "transmitted-bytes": 30000
        },
    "result-list" : [
        "drop-pkts",
        "dropped-bytes"]
}'