Action Profile
profile: <https://level3.rest/profiles/action>
An Action resource is a hypermedia control that triggers a state change. They act like buttons to execute an action on the server. Actions do not accept a payload; the URL contains all the Action’s identifying information.
Discovery
The Action profile presents the required profile and allow headers.
Trigger Action
Clients trigger an Action by POSTing to it. The resource responds with 303 See Other and the location header points to the state that was changed by the triggered action. The resource returns a 403 Forbidden status if the action cannot be completed because the business state will not accept it.
Mixins
Representation Mixin
The Representation profile mixin enables the client to receive the target representation in the Action response instead of a redirect to the location URL.
Specifications
HTTP/1.1 Semantics and Content: RFC 7231
- 200 OK: section 6.3.1
- 303 See Other: section 6.4.4
- 403 Forbidden: section 6.5.3
© 2019-2023 Matt Bishop
This work is licensed under a Creative Commons Attribution-NoDerivatives 4.0 International License.