Run persisted virtual-join enrichment for a user now, synchronously
POST
/api/v1/admin/enrichment/run
const url = 'http://localhost:11044/api/v1/admin/enrichment/run?username=example';const options = {method: 'POST', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url 'http://localhost:11044/api/v1/admin/enrichment/run?username=example' \ --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”username
required
string
Username whose world’s persist: true virtual joins are run, writing their bridge anchors into the graph for that user; an unknown user is refused with 400. A world with no persisted joins answers 200 with persistJoins 0 and runs nothing
Responses
Section titled “Responses”The run, or why there was nothing to run
Media typeapplication/json
The outcome of a manual enrichment run. Exactly one of durationMs and note is present
object
durationMs
How long the run took, in milliseconds. Absent when nothing ran
integer format: int64
note
Why nothing ran. Present only when there are no persisted joins
string
persistJoins
required
How many of the world’s virtual joins persist their results. Zero means nothing ran
integer format: int32
username
required
The user the run was for
string
Example generated
{ "durationMs": 1, "note": "example", "persistJoins": 1, "username": "example"}Unknown username
Media typeapplication/json
A refused enrichment run. Carries only the reason
object
error
required
Why the run was refused, naming the username
string
Example generated
{ "error": "example"}