Interface ResourceCreateResult

The result of a POST. id is the id the store minted — the answer the caller came for.

interface ResourceCreateResult {
    broadcast?: ResourceBroadcast<object>;
    fault?: ResourceFault;
    id?: Readonly<Record<string, string | number>>;
    ok: boolean;
    reason?: string;
    refusal?: Refusal;
    rippled?: readonly ResourceBroadcast<object>[];
    state?: object;
}

Index

Properties

broadcast? fault? id? ok reason? refusal? rippled? state?

Properties

`Optional` `Readonly`broadcast

broadcast?: ResourceBroadcast<object>

`Optional` `Readonly`fault

fault?: ResourceFault

`Optional` `Readonly`id

id?: Readonly<Record<string, string | number>>

The created item's id, as the entity spells it.

`Readonly`ok

ok: boolean

`Optional` `Readonly`reason

reason?: string

`Optional` `Readonly`refusal

refusal?: Refusal

`Optional` `Readonly`rippled

rippled?: readonly ResourceBroadcast<object>[]

`Optional` `Readonly`state

state?: object

The collection's state after the creation, re-read exactly as a patch re-reads.