- Docs
- API reference
- Endpoints and schemas
- GraphQL
- Selection
Suggestion
A suggestion is a proposed correction to Enigma data.
Selection. This type is a selection. An intent returns it, and you choose which of its fields come back.
A suggestion is a proposed correction to Enigma data. Send one with the createSuggestion mutation. The status field shows the review state of the suggestion.
Where it appears
Section titled “Where it appears”No connection leads here from a primary entity.
CreateSuggestion.suggestion
Fields
Section titled “Fields”| Field | Type | Description |
|---|---|---|
id |
UUID! |
The ID of the suggestion. |
revision |
ID! |
The revision number of the suggestion. |
apiKeyId |
String! |
The ID of the API key that sent the suggestion. |
dataAssetVersion |
String! |
The version of Enigma data that the API served when it received the suggestion. |
payload |
JSONString! |
The suggested change. It holds the affected entities and relationships, and the suggested value of each changed field. |
createdTimestamp |
DateTime |
The date and time when the suggestion was created. |
requestId |
String! |
The ID of the API request that created the suggestion. |
suggestedByEmail |
String |
The email address of the person who made the suggestion. |
lastModifiedByEmail |
String |
The email address of the person who last changed the suggestion. |
status |
String! |
The review state of the suggestion. The values are PENDING_REVIEW, APPROVED, REJECTED, and BACKUP. BACKUP means that the API stored the suggestion in its backup store. |
Example
Section titled “Example”This intent writes, so the reference does not run it against production data. No response is shown. The payload variable holds the suggested change as a JSON object.
mutation CreateSuggestion($payload: JSON!) { createSuggestion(suggestion: { suggestedByEmail: "user@example.com" payload: $payload }) { suggestion { id status createdTimestamp } }}