Skip to main content
GET
Get a suggested field update task

Authorizations

Authorization
string
header
required

A static Affinity API key, presented as a bearer token.

Path Parameters

taskId
string<uuid>
required

Suggested field update task ID

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

Response

OK

Status of a suggested field update generation task

id
string<uuid>
required

The task's unique identifier. Equals the set's id.

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

status
enum<string>
required

The current status of the task.

  • in-progress: suggestions are being generated.
  • success: generation finished. Retrieve the set.
  • failed: generation failed.
Available options:
in-progress,
success,
failed
Example:

"in-progress"

suggestedFieldUpdate
SuggestedFieldUpdateReference · object
required

The set the task generates. Retrieve it once status is success.