diff --git a/packages/rest-api-client/docs/app.md b/packages/rest-api-client/docs/app.md index 8890102fa9..1cc1e923f8 100644 --- a/packages/rest-api-client/docs/app.md +++ b/packages/rest-api-client/docs/app.md @@ -110,7 +110,7 @@ Gets the list of fields and field settings of an app. | properties | Object | An object with data of the field settings. | | properties.{fieldCode}.label | String | The field name. | | properties.{fieldCode}.code | String | The field code. | -| properties.{fieldCode}.type | String | The field type.\* The type of the Look-up field will be the same type as the Key field it's looking up. | +| properties.{fieldCode}.type | String | The field type.\* The type of the Look-up field will be the same type as the Key field it's looking up. | | properties.{fieldCode}.noLabel | Boolean | The "Hide field name" option.
It indicates whether the field's name is hidden. | | properties.{fieldCode}.required | String | The "Required field" option.
It indicates whether the field is a required field. | | properties.{fieldCode}.unique | String | The "Prohibit duplicate values" option.
It indicates whether duplicate values are prohibited. | @@ -180,7 +180,7 @@ Adds fields to a form of an app. | properties.{fieldCode} | Object | Yes | An object with data of fields that will be added.
Specify the field code of the field for `{fieldCode}`. Field codes have the following limitations: | | properties.{fieldCode}.label | String | Conditionally
Required | The field name.
Ignore this parameter for tables. | | properties.{fieldCode}.code | String | Yes | The field code of the field.
Specify the same value used for the `properties.{fieldCode}` parameter. | -| properties.{fieldCode}.type | String | Yes | The field type.For lookup fields, specify either `SINGLE_LINE_TEXT` or `NUMBER`, depending on the type of the Key field it's looking up. | +| properties.{fieldCode}.type | String | Yes | The field type.For lookup fields, specify either `SINGLE_LINE_TEXT` or `NUMBER`, depending on the type of the Key field it's looking up. | | properties.{fieldCode}.noLabel | Boolean | | The "Hide field name" option.
It indicates whether the field's name will be hidden. | | properties.{fieldCode}.required | Boolean | | The "Required field" option.
It indicates whether the field will be a required field.
If ignored, this value is `false`. | | properties.{fieldCode}.unique | Boolean | | The "Prohibit duplicate values" option.
It indicates whether duplicate values will be prohibited.
If ignored, this value is `false`. | @@ -256,7 +256,7 @@ Updates the field settings of fields in a form of an app. | properties.{fieldCode} | Object | | An object with data of the field settings of the field specified in `{fieldCode}`.
To update a field code, state the current field code in `{fieldCode}`, and state the new field code in `properties.{fieldCode}.code`. | | properties.{fieldCode}.label | String | | The field name. | | properties.{fieldCode}.code | String | | The field code of the field.
Field codes have the following limitations: | -| properties.{fieldCode}.type | String | Yes | The field type.For lookup fields, specify either `SINGLE_LINE_TEXT` or `NUMBER`, depending on the type of the Key field it's looking up. | +| properties.{fieldCode}.type | String | Yes | The field type.For lookup fields, specify either `SINGLE_LINE_TEXT` or `NUMBER`, depending on the type of the Key field it's looking up. | | properties.{fieldCode}.noLabel | Boolean | | The "Hide field name" option.
It indicates whether the field's name will be hidden. | | properties.{fieldCode}.required | Boolean | | The "Required field" option.
It indicates whether the field will be a required field. | | properties.{fieldCode}.unique | Boolean | | The "Prohibit duplicate values" option.
It indicates whether duplicate values will be prohibited. | @@ -356,7 +356,7 @@ Gets the field layout info of a form in an app. | layout[].type | String | The type of row. | | layout[].code | String | The field code of the table or group field. This parameter will not be returned for other row types. | | layout[].fields | Array | A list of fields in the row. | -| layout[].fields[].type | String | The type of field.\*The type of the Look-up field will be the same type as the Key field it's looking up. | +| layout[].fields[].type | String | The type of field.\*The type of the Look-up field will be the same type as the Key field it's looking up. | | layout[].fields[].code | String | The field code. | | layout[].fields[].label | String | The text set in the Label field. Only returned for Label fields. | | layout[].fields[].elementId | String | The element ID of the Space field. Only returned for Space fields. | @@ -384,14 +384,14 @@ Updates the field layout info of a form in an app. | layout[].type | String | Yes | The type of row. | | layout[].code | String | Conditionally
Required | The field code of the table or group field. Ignore, if the row type is not a table or a group. | | layout[].fields | Array | | A list of fields in the row. | -| layout[].fields[].type | String | Yes | The type of field.For lookup fields, specify either `SINGLE_LINE_TEXT` or `NUMBER`, depending on the type of the Key field it's looking up. | +| layout[].fields[].type | String | Yes | The type of field.For lookup fields, specify either `SINGLE_LINE_TEXT` or `NUMBER`, depending on the type of the Key field it's looking up. | | layout[].fields[].code | String | Conditionally
Required | The field code of the field. Ignore, if the field is a Label, Blank space or a Border. | | layout[].fields[].label | String | | The text set in the Label field. Only specify for Label fields. | | layout[].fields[].elementId | String | | The element ID of the Space field. Only specify for Space fields. | | layout[].fields[].size | Object | | An object with data of the field's size.
Depending on how the field is placed, the field may not become the size that you specified. | -| layout[].fields[].size.width | Number | | The width of the field in pixels.
The width can be set for the following fields: | +| layout[].fields[].size.width | Number | | The width of the field in pixels.
The width can be set for the following fields: | | layout[].fields[].size.height | Number | | The height of the field in pixels, including the height of the field name.
Only Blank space fields can use this parameter. | -| layout[].fields[].size.innerHeight | Number | | The height of the field in pixels, excluding the height of the field name.
Only the following fields can use this parameter: | +| layout[].fields[].size.innerHeight | Number | | The height of the field in pixels, excluding the height of the field name.
Only the following fields can use this parameter: | | layout[].layout | Array | | A list of field layouts for each row inside a group field.The parameters for this are the same for the `layout` property. | | revision | Number or String | | Specify the revision number of the settings that will be deployed.
The request will fail if the revision number is not the latest revision.
The revision will not be checked if this parameter is ignored, or `-1` is specified. |