Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Updates the attributes of an existing layout.
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
A ValidationException
is returned when you add non-existent fieldIds
to a layout.
Title and Status fields cannot be part of layouts because they are not configurable.
Synopsis
- data UpdateLayout = UpdateLayout' {}
- newUpdateLayout :: Text -> Text -> UpdateLayout
- updateLayout_content :: Lens' UpdateLayout (Maybe LayoutContent)
- updateLayout_name :: Lens' UpdateLayout (Maybe Text)
- updateLayout_domainId :: Lens' UpdateLayout Text
- updateLayout_layoutId :: Lens' UpdateLayout Text
- data UpdateLayoutResponse = UpdateLayoutResponse' {
- httpStatus :: Int
- newUpdateLayoutResponse :: Int -> UpdateLayoutResponse
- updateLayoutResponse_httpStatus :: Lens' UpdateLayoutResponse Int
Creating a Request
data UpdateLayout Source #
See: newUpdateLayout
smart constructor.
UpdateLayout' | |
|
Instances
Create a value of UpdateLayout
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateLayout
, updateLayout_content
- Information about which fields will be present in the layout, the order
of the fields, and a read-only attribute of the field.
UpdateLayout
, updateLayout_name
- The name of the layout. It must be unique per domain.
UpdateLayout
, updateLayout_domainId
- The unique identifier of the Cases domain.
UpdateLayout
, updateLayout_layoutId
- The unique identifier of the layout.
Request Lenses
updateLayout_content :: Lens' UpdateLayout (Maybe LayoutContent) Source #
Information about which fields will be present in the layout, the order of the fields, and a read-only attribute of the field.
updateLayout_name :: Lens' UpdateLayout (Maybe Text) Source #
The name of the layout. It must be unique per domain.
updateLayout_domainId :: Lens' UpdateLayout Text Source #
The unique identifier of the Cases domain.
updateLayout_layoutId :: Lens' UpdateLayout Text Source #
The unique identifier of the layout.
Destructuring the Response
data UpdateLayoutResponse Source #
See: newUpdateLayoutResponse
smart constructor.
UpdateLayoutResponse' | |
|
Instances
newUpdateLayoutResponse Source #
Create a value of UpdateLayoutResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateLayoutResponse'
, updateLayoutResponse_httpStatus
- The response's http status code.
Response Lenses
updateLayoutResponse_httpStatus :: Lens' UpdateLayoutResponse Int Source #
The response's http status code.