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

GetForm

Returns an existing form for an Amplify app.

Request Syntax


GET /app/appId/environment/environmentName/forms/id HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

appId

The unique ID of the Amplify app.

Required: Yes

environmentName

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

Required: Yes

id

The unique ID of the form.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "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" 
   }
}