Update a first value state
PATCH
/v1/first-value-statecurl -X PATCH 'https://api.embodiflow.io/v1/first-value-state' \
-H 'Authorization: Bearer $EMBODIFLOW_PAT' \
-H 'Content-Type: application/json' \
-d '{
"action": "resume",
"path": "sample",
"reachedDatasetVersionId": "string"
}'Authorization
Send a personal access token with every request.
- Authorization: Bearer PAT
Header parameters
- If-Matchstring
Optional precondition. A matching tag proceeds and returns the new ETag. A stale tag returns 412 PRECONDITION_FAILED with no write. Absent proceeds (opt-in this release). If-Match: * succeeds when the resource exists. Malformed values return 400 IF_MATCH_INVALID.
Request body
Content-Typeapplication/json
- actionstringrequiredAllowed valuesresumedismissmark_milestone
- pathstringAllowed valuessamplereal
- reachedDatasetVersionIdstring
Responses
Success
- dataobjectrequired
- statestringrequiredAllowed valuesin_progressnot_startedchoosing_pathfirst_value_reacheddismissed
- pathstring | nullrequiredAllowed valuessamplereal
- sampleProjectIdstring | nullrequired
- reachedDatasetVersionIdstring | nullrequired
- dismissedAtstring | nullrequired
- firstValueReachedAtstring | nullrequired
- nonSampleProjectCountnumberrequired
- canCreateProjectone ofrequired
- shouldShowChooserone ofrequired
Response example
{
"data": {
"state": "in_progress",
"path": "sample",
"sampleProjectId": "string",
"reachedDatasetVersionId": "string",
"dismissedAt": "string",
"firstValueReachedAt": "string",
"nonSampleProjectCount": 0,
"canCreateProject": false,
"shouldShowChooser": false
}
}Servershttps://api.embodiflow.io/v1https://api.embodiflow.dev/v1