Communities
A collaborative platform to connect and grow with like-minded Informaticans across the globe
Product Communities
Connect and collaborate with Informatica experts and champions
Discussions
Have a question? Start a Discussion and get immediate answers you are looking for
User Groups
Customer-organized groups that meet online and in-person. Join today to network, share ideas, and get tips on how to get the most out of Informatica
Get Started
Community Guidelines
Knowledge Center
Troubleshooting documents, product guides, how to videos, best practices, and more
Knowledge Base
One-stop self-service portal for solutions, FAQs, Whitepapers, How Tos, Videos, and more
Support TV
Video channel for step-by-step instructions to use our products, best practices, troubleshooting tips, and much more
Documentation
Information library of the latest product documents
Velocity (Best Practices)
Best practices and use cases from the Implementation team
Learn
Rich resources to help you leverage full capabilities of our products
Trainings
Role-based training programs for the best ROI
Certifications
Get certified on Informatica products. Free, Foundation, or Professional
Product Learning Paths
Free and unlimited modules based on your expertise level and journey
Resources
Library of content to help you leverage the best of Informatica products
Tech Tuesdays Webinars
Most popular webinars on product architecture, best practices, and more
Product Availability Matrix
Product Availability Matrix statements of Informatica products
SupportFlash
Monthly support newsletter
Support Documents
Informatica Support Guide and Statements, Quick Start Guides, and Cloud Product Description Schedule
Product Lifecycle
End of Life statements of Informatica products
Ideas
Events
Change Request Tracking
Marketplace
English
  • Data Integration Connectors
  • All Products

Table of Contents

Search

  1. Preface
  2. Introduction to REST V2 Connector
  3. Connections for REST V2
  4. REST V2 operations
  5. Mappings and mapping tasks with REST V2 Connector
  6. Swagger File Generation
  7. Appendix A: Swagger objects
  8. OpenAPI objects

REST V2 Connector

REST V2 Connector

Back Next

Array of objects

Array of objects

You can define an array of objects for
application/json
 media type in the OpenAPI specification file in the request and response definitions.

Inline array in the request and response body

The requestBody or response where all the fields of the request body are defined in the
requestBody
 section.
For example, 
"/users_inline": {
"post": {
  "description": "Add Multiple Users",
  "operationId": "users_inline",
  "requestBody": {
  "description": "Add Multiple Users",
  "content": {
  "application/json": {
  "schema": {
   "type": "array",
   "items": {
   "type": "object",
   "properties": {
      "first_name": {
      "type": "string"
       },
       "last_name": {
        "type": "string"
       }
      }
     }
    }
   }
  }
}
"responses": {
  "200": {
   "description": "add User Response",
    "content": {
     "application/json": {
       "schema": {
       "type": "array",
       	"items": {
       	"type": "object",
        "properties": {
          "first_name": {
          "type": "string"
           },
          "last_name": {
          "type": "string"
           },
          "id": {
           "type": "string"
           }
         }
        }
       }
      }
    }
   }
}

Inline ref array in the request and response body

The requestBody or response where the schema type is array and it contains the reference object
$ref
.
For example, 
"post": {
"description": "Add Multiple Users",
"operationId": "users_inline_ref",
"requestBody": {
  "description": "Add new Users",
  "content": {
   "application/json": {
    "schema": {
    "type": "array",
    "items": {
    "$ref": "#/components/schemas/user"
     }
    }
   }
  }
 }
"responses": {
  "200": {
   "description": "add User Response",
    "content": {
    "application/json": {
    "schema": {
     "type": "array",
     "items": {
      "$ref": "#/components/schemas/user"
    	}
    }
   }
  }
 }
}

Array in component in the request and response body

The requestBody or response where schema contains only the reference object
$ref
 pointing to a component.
For example, 
"post": {
"description": "Add Multiple Users",
 "operationId": "users",
 "requestBody": {
   "description": "Add new Users",
   "content": {
   "application/json": {
   "schema": {
   "$ref": "#/components/schemas/user_list_inline"
    }
   }
  }
 }
"components": {
  "schemas": {
  "user_list": {
  "type": "array",
  "items": {
  "$ref": "#/components/schemas/user"
   }
  }
 }
}
"responses": {
 "200": {
  "description": "add User Response",
  "content": {
  "application/json": {
  "schema": {
  "$ref": "#/components/schemas/user_list"
     }
    }
   }
  }
}
"components": {
  "schemas": {
   "user_list": {
    "type": "array",
     "items": {
     "$ref": "#/components/schemas/user"
          }
       }
     }
 }

Complex object in the request and response body

The requestBody or response that contains array fields along with simple fields.
For example, 
"description": "Add Complex Object",
 "operationId": "aad_complex_object",
 "requestBody": {
   "description": "Add new Users",
   "content": {
   "application/json": {
    "schema": {
    "$ref": "#/components/schemas/complex_object"
       		}
      }
    }
  }
"components": {
   "schemas": {
    "complex_object": {
    "type": "object",
     "properties": {
       "sample_string": {
        "type": "string"
         },
        "user_array": {
         "type": "array",
          "items": {
          "$ref": "#/components/schemas/user"
          }
         }
        }
       }
     }
    }
"responses": {
  "200": {
    "description": "add User Response",
     "content": {
     "application/json": {
       "schema": {
       "$ref": "#/components/schemas/complex_object"
         }
       }
     }
   }
 }

"components": {
  "schemas": {
   "complex_object": {
    "type": "object",
    "properties": {
     "sample_string": {
      "type": "string"
      	},
      "user_array": {
       "type": "array",
       "items": {
       "$ref": "#/components/schemas/user"
       }
      }
     }
    }
  }
}
0 COMMENTS
We’d like to hear from you!