Skip to content

Reply View Request

PUT /api/v1/edge-protocol/devices/{device_id}/view-requests/{request_id}/reply

Reply only to an unexpired dispatched demand from this exact device binding. Metadata is at most 256 KiB; original encoded ranges are at most 1 MiB.

Authentication options declared in the contract include device-scoped appliance credential.

Authentication and permissions explains tokens, cookies, CSRF, and workspace context.

Name Location Required Type Description and constraints
device_id path Yes string (uuid)
request_id path Yes string (uuid)
X-Edge-View-Status header Yes string values "available", "not_found", "unavailable", "capacity_exhausted", "range_invalid"

Required.

application/octet-stream — string (binary).

{
"type": "string",
"format": "binary"
}

image/jpeg — string (binary).

{
"type": "string",
"format": "binary"
}

application/json — EdgeViewTimeline or EdgeViewSegment.

{
"oneOf": [
{
"$ref": "#/components/schemas/EdgeViewTimeline"
},
{
"$ref": "#/components/schemas/EdgeViewSegment"
}
]
}

Set the connection variables described in Get started. Replace each additional EOI_… variable with the parameter value for this request. Prepare the body file using the request schema above. This template sends the request when run.

Terminal window
curl --fail-with-body --silent --show-error \
--request PUT \
--header "Authorization: Bearer ${EOI_EDGE_TOKEN}" \
--header "X-Edge-View-Status: ${EOI_X_EDGE_VIEW_STATUS}" \
--header "Content-Type: application/octet-stream" \
--data-binary @request-body.bin \
"${EOI_API_BASE_URL}/edge-protocol/devices/${EOI_DEVICE_ID}/view-requests/${EOI_REQUEST_ID}/reply"

The table records responses declared by the OpenAPI contract. See Errors and status codes for the runtime error envelope and shared failures.

Status Description Media type Body
204 Successful Response — Empty body
422 Validation Error application/json HTTPValidationError

Operation identifier replyEdgeViewRequest. Browse Device protocol.

Image preview