The "create-form" and "edit-form" Link Relations
ioseb.dzmanashvili@gmail.com
RFC 5988 standardized a means of indicating the relationships between resources on the Web.  This specification defines link relation types that may be used to express the relationships between a resource and an input form for constructing data submissions.
RFC 5988 standardized a means of indicating the relationships between resources on the Web.  This specification defines link relation types that may be used to express the relationships between a resource and an input form for constructing data submissions. The "create-form" and "edit-form" link relations are intentionally generic, and they can be used with multiple media types in a wide variety of use cases.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in .
The following link relations are defined.
When included in a response, the "create-form" link relation indicates a target resource that represents a form that can be used to append a new member to the link context.
  • Entry Description 1
  • Entry Description 2
[Add New Entry] ]]>
or, expressed as a Link header
; rel="create-form"; title="Add New Entry" ]]>
If the form representation includes a submission URI, this URI MUST be used to submit the form. The context URI SHOULD be used otherwise. If the form representation includes a submission method, this method MUST be used for submit requests. HTTP's POST method SHOULD be used otherwise.
When included in a response, the "edit-form" link relation indicates a target resource that represents a form that can be used for updating the context resource.
... ... ]]>
or, expressed as a Link header
; rel="edit-form"; title="Edit Entry" ]]>
If the form representation includes a submission URI, this URI MUST be used to submit the form. The context URI SHOULD be used otherwise. If the form representation includes a submission method, this method MUST be used for submit requests. HTTP's PUT method SHOULD be used otherwise.
When submitting forms in unsupported media type format, service may respond to the client with HTTP's 415 Unsupported Media Type status code.
; rel="create-form"; title="Create new entry" Content-Type: text/html Content-Length: ... Use this form to create a new entry. ]]>
IANA has registered the "create-form" and "edit-form" link relations below as per .
Relation Name: create-form Description: The target IRI points to a resource where a submission form can be obtained. Security considerations: Automated agents should take care when this relation crosses administrative domains (e.g., the URI has a different authority than the current document). Reference: See .
Relation Name: edit-form Description: The target IRI points to a resource where a submission form for editing the associated resource can be obtained. Security Considerations: Automated agents should take care when this relation crosses administrative domains (e.g., the URI has a different authority than the current document). Reference: See .
See Section 7 of RFC 5988.
See Section 8 of RFC 5988.
Key words for use in RFCs to Indicate Requirement Levels Web Linking
The author gratefully acknowledges the contributions of Jan Algermissen.