Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ExportForms

Exports form configurations to code that is ready to integrate into an Amplify app.

Request Syntax


GET /export/app/appId/environment/environmentName/forms?nextToken=nextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appId

The unique ID of the Amplify app to export forms to.

Required: Yes

environmentName

The name of the backend environment that is a part of the Amplify app.

Required: Yes

nextToken

The token to request the next page of results.

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "entities": [ 
      { 
         "appId": "string",
         "cta": { 
            "cancel": { 
               "children": "string",
               "excluded": boolean,
               "position": { ... }
            },
            "clear": { 
               "children": "string",
               "excluded": boolean,
               "position": { ... }
            },
            "position": "string",
            "submit": { 
               "children": "string",
               "excluded": boolean,
               "position": { ... }
            }
         },
         "dataType": { 
            "dataSourceType": "string",
            "dataTypeName": "string"
         },
         "environmentName": "string",
         "fields": { 
            "string" : { 
               "excluded": boolean,
               "inputType": { 
                  "defaultChecked": boolean,
                  "defaultCountryCode": "string",
                  "defaultValue": "string",
                  "descriptiveText": "string",
                  "fileUploaderConfig": { 
                     "acceptedFileTypes": [ "string" ],
                     "accessLevel": "string",
                     "isResumable": boolean,
                     "maxFileCount": number,
                     "maxSize": number,
                     "showThumbnails": boolean
                  },
                  "isArray": boolean,
                  "maxValue": number,
                  "minValue": number,
                  "name": "string",
                  "placeholder": "string",
                  "readOnly": boolean,
                  "required": boolean,
                  "step": number,
                  "type": "string",
                  "value": "string",
                  "valueMappings": { 
                     "bindingProperties": { 
                        "string" : { 
                           "bindingProperties": { 
                              "model": "string"
                           },
                           "type": "string"
                        }
                     },
                     "values": [ 
                        { 
                           "displayValue": { 
                              "bindingProperties": { 
                                 "field": "string",
                                 "property": "string"
                              },
                              "concat": [ 
                                 "FormInputValueProperty"
                              ],
                              "value": "string"
                           },
                           "value": { 
                              "bindingProperties": { 
                                 "field": "string",
                                 "property": "string"
                              },
                              "concat": [ 
                                 "FormInputValueProperty"
                              ],
                              "value": "string"
                           }
                        }
                     ]
                  }
               },
               "label": "string",
               "position": { ... },
               "validations": [ 
                  { 
                     "numValues": [ number ],
                     "strValues": [ "string" ],
                     "type": "string",
                     "validationMessage": "string"
                  }
               ]
            }
         },
         "formActionType": "string",
         "id": "string",
         "labelDecorator": "string",
         "name": "string",
         "schemaVersion": "string",
         "sectionalElements": { 
            "string" : { 
               "excluded": boolean,
               "level": number,
               "orientation": "string",
               "position": { ... },
               "text": "string",
               "type": "string"
            }
         },
         "style": { 
            "horizontalGap": { ... },
            "outerPadding": { ... },
            "verticalGap": { ... }
         },
         "tags": { 
            "string" : "string" 
         }
      }
   ],
   "nextToken": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

entities

Represents the configuration of the exported forms.

Type: Array of Form objects

nextToken

The pagination token that's included if more results are available.

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

An internal error has occurred. Please retry your request.

HTTP Status Code: 500

InvalidParameterException

An invalid or out-of-range value was supplied for the input parameter.

HTTP Status Code: 400