You are on page 1of 15

Sheet1

Features API API Method Parameters


Api Gateway /api/v2/gateway Class (CreateApiGatewayRequest)
createGatewayApi String id
String path
String basePath
String requestMethod

String description
String actionName
String moduleDescripton
String category

List<String> roleIds
String moduleName

int copyCount

Class (CreateApiGatewayRequest)
updateGatewayApi String path
String requestMethod

String description
String actionName
String moduleDescripton
String category

List<String> roleIds
String moduleName

Page Creator /api/v2/page Class (PageRequest)


createPage String name
updatePage

String description
List<WidgetRequest> widgets

IAM(Roles) /api/v2/role Class (CreateRoleRequest)


createRole String name
updateRole

String description

Page 1
Sheet1

String icon
List<RoleMenuMapping> menus

App Creator /api/v2/applications Class (ApplicationRequest)


createApplication String name
updateApplicationById

List<AppPageRequest> page
String description
List<String> roleIds
Boolean isPublicApplication
Boolean collapsedView
String theme

Simulation Studio /api/v2/simulate Class (SimulationRequest)


createSimulation String name
updateSimulation

String description
Integer loadCount
String inputJson
List<Document> masterConfig
String templateData
Integer loadIntervalSecs
String connectorType
String connector
Document kafkaData
Document mqttData
Boolean isExternal

Widget Studio /api/v2/widgetManager Class (WidgetManagerRequest)


createWidgetManager String name
updateWidgetManager
String type
String image
HashMap<String, Object> info
String javaScriptPreprocessor
String category
String description

Page 2
Sheet1

connectors api/v3/connectors createDataSource Class (ConnectorRequest)


String name

String category
boolrean source
boolean sink
boolean isExternal(true)
Document properties
String description

updateDataSource Class (ConnectorRequest)


String name (Unchanged)

String category (Unchanged)


boolrean source
boolean sink
boolean isExternal(true)
Document properties
String description

getRawKafka Class (KafkaConnectionRequest)


String bootstrapServer
boolean isAuthenticated = false
String username
String password
String topic
boolean isExternal(true)

Class (VMQConnectionRequest)
getRawVmq String bootstrapServer
boolean isAuthenticated = false
String username
String password
String topic
boolean isExternal(true)

testKafkaConnection Class (TestConnectionRequest)


testVMQConnection boolean isExternal(true)
testS3Connection boolean isAuthenticated = false
testHDFSConnection String category
testMongoConnection String url
testConnection String username
validateRequest String password
String bootstrapServer
String accessKey

Page 3
Sheet1

String secretKey
String database

Transformations api/v3/transformations/ createEtlConfig Class (TransformationRequest)


updateEtl String state
getSchemaETL boolean isDebug
String name

Document etlConfig
Document connector
String type
List<Map> defination
String description
String createdFor
String sinkStatus

Js Functions api/v2/dynamicEtl dynamicJSTemplates Class(DynamicJSTemplates)


updateDynamicjsTemplaString tenantName
String originalFunction
String functionName

String description

Code Engine api/v2/actions createAction Class (CreateActionRequest)


String actionName

String kind
List<String> requirements
String code
String description
String category

List<String> collections
Boolean saveAsDraft = false
String imageName
String imageDescription
HashMap<String,Object>
responseFormat
List<GatewayApiPathParametersR
equest> pathParameters

updateAction Class (UpdateActionRequest)


String kind
List<String> requirements
String code

Page 4
Sheet1

String description
Boolean saveAsDraft = false
String imageName
String imageDescription
List<String> collections
HashMap<String,Object>
responseFormat
List<GatewayApiPathParametersR
equest> pathParameters

IAM -> Users api/v2/users changePassword Class (ChangePasswordRequest)


String oldPassword
String newPassword

createUser Class (CreateUserRequest)


String roleId

String firstName

String lastName

String email
String mobile
boolean skipverification = false
String password

updateUser Class (UpdateUserRequest)


String roleId

String firstName

String lastName

String email
String mobile
String password

getUsers Class (PaginatedRequest)


Integer offset = 0
Integer max = 10
Order order
String sortBy
String tableName

Page 5
Sheet1

Validations

Path should not be blank


Base Path should not be blank
Request Method should not be blank
Allowed values are GET,PUT,POST,PATCH,DELETE

Action Name should not be blank

Category should not be blank


Allowed values are gaugeChart,barChart,sankeyChart,xyChart,radarChart,pieChart,table,map,counter,other,utilities,customWi

Allowed Characters are alphabet,underscore, and whitespace


Module Name should not be blank
Module Name should not be greater than 30 characters

Path should not be blank


Request Method should not be blank
Allowed values are GET,PUT,POST,PATCH,DELETE

Action Name should not be blank

Category should not be blank


Allowed values are gaugeChart,barChart,sankeyChart,xyChart,radarChart,pieChart,table,map,counter,other,utilities,customWi

Module Name should not be blank


Allowed Characters are alphabet,underscore, and whitespace
Module Name should not be greater than 30 characters

Page name should not be blank


Allowed special characters are '_','-','space' and name should start with alphanumeric
Name should not be greater than 30 characters

Name should not be blank


Name will only start with capital alphabet and contains underscore in between the word
Name should not be greater than 30 characters

Page 6
Sheet1

Application name should not be blank


Allowed special characters are '_','-','space' and name should start with alphanumeric
Name should not be greater than 30 characters

Simulation name should not be blank


Allowed characters are underscore and alphanumeric
Name should not be greater than 30 characters

Load Count should not be blank


Input Json should not be blank
Master Config should not be blank or empty
Template data should not be blank
Load IntervalSecs should not be blank
Connector type should not be blank
Connector should not be blank

Widget name should not be blank


Name should not be greater than 30 characters
Type should not be blank

Category should not be blank

Page 7
Sheet1

Name should not be blank


Allowed special character are '_','-','space' and name should start with alphanumeric
Name should not be greater than 30 characters
Connector Category should not be blank or empty

Name should not be blank


Allowed special character are '_','-','space' and name should start with alphanumeric
Name should not be greater than 30 characters
Connector Category should not be blank or empty

Topic should not be blank

Topic should not be blank

Category should not be blank

Page 8
Sheet1

Name should not be blank


Allowed special character are '_','-','space' and name should start with alphanumeric
Name should not be greater than 30 characters

Connector should not be blank or empty


Type should not be blank
Definition should not be blank or empty

CreatedFor should not be blank

Name should not be blank or empty


Function should not be blank or empty
Function Name should not be blank or empty
It should start with alphabets and consist of _ and number in between the word

Action Name should not be blank or empty


It should start with alphabets and consist of _ and number in between the word
Name should not be greater than 50 characters
Kind should not be blank or empty

Code block should not be blank or empty

Category should not be blank


Allowed values are gaugeChart,barChart,sankeyChart,xyChart,radarChart,pieChart,table,map,counter,other,

Kind should not be blank or empty

Code block should not be blank or empty

Page 9
Sheet1

New password should not be blank


Password should not be empty

Role Id should not be empty


Role Id should not be blank
First Name should not be blank
First Name size must be between 1 and 255
Last Name should not be blank
Last Name size must be between 1 and 255
Email should not be blank or empty
Please provide valid Email Address
Please provide a valid contact number

Role Id should not be empty


Role Id should not be blank
First Name should not be blank
First Name size must be between 1 and 255
Last Name should not be blank
Last Name size must be between 1 and 255
Email should not be blank or empty
Please provide valid Email Address
Please provide a valid contact number

Page 10
Sheet1

Name Size Complition status


Ashwani Done

30

Bharat Done
30

Priti Done
30

Page 11
Sheet1

Bharat Done
30

Narayan Done
30

Alok & Akansha Done

Page 12
Sheet1

Inder Mani Done


30

30

Page 13
Sheet1

Inder Mani Done

30

Done

Ashwani

50

Page 14
Sheet1

Priti Done

Page 15

You might also like