Package com.broadleafcommerce.metadata.dsl.core

Class Endpoint.Attributes

java.lang.Object

com.broadleafcommerce.metadata.dsl.core.Endpoint.Attributes

Enclosing interface:

Endpoint<E extends Endpoint<E>>

public static final class Endpoint.Attributes
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	RESPONSE_IS_PARTIAL_STATE	Indicates that this endpoint's response will be a partial state that should be merged with the existing entity state, similar to a PATCH request.

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

RESPONSE_IS_PARTIAL_STATE

public static final String RESPONSE_IS_PARTIAL_STATE

Indicates that this endpoint's response will be a partial state that should be merged with the existing entity state, similar to a PATCH request. This is useful for APIs that do not support PATCH requests directly or that are backing external field groups on a different entity's form. In those cases, the parent entity state should be merged with the new state returned by the endpoint to maintain the full view state.

Since:

Metadata 2.0.8, Release Train 2.1.6, 2.2.2

See Also:

• Constant Field Values