Request dispatch — RIPS packages

POST/api/v1/workspaces/{workspaceId}/rips-packages/{packageId}/dispatches

Operation ID: ripsPackages.requestDispatch · Access: PAT with send scope and authorized workspace where applicable · Effect: external.

Production action

This operation can send data to an external service. Use a new idempotency key for each new intent. A timeout does not prove that the action failed.

An Idempotency-Key is required. Retry the same intent with the same key and the same request bytes. Read the retry rules.

Read the rips packages workflow before this operation.

The server checks the revision and current validation again. HTTP 200 can contain Accepted or Rejected. HTTP 202 can contain Dispatching or Unknown. Inspect package.status and the attempt.

Parameters

Name	In	Required	Type / allowed values
workspaceId	path	Yes	string
packageId	path	Yes	string
idempotency-key	header	Yes	string

Request body

Content type: application/json · Required: yes.

Schema: RevisionInput. Browse schema fields.

Example: revision

Synthetic contract example. Replace identifiers and clinical data with authorized values. This example does not prove ministry acceptance.

Download JSON

{
  "revision": 1
}

Responses

HTTP	Content	Schema
200	application/json	RipsDispatchResult
202	application/json	RipsDispatchResult
400	application/json	ApiError
401	application/json	ApiError
403	application/json	ApiError
404	application/json	ApiError
409	application/json	ApiError
413	application/json	ApiError
415	application/json	ApiError
422	application/json	ApiError
428	application/json	ApiError
500	application/json	ApiError
502	application/json	ApiError
503	application/json	ApiError

Use error.code, error.issues, and requestId for JSON errors. Error and recovery guide.

cURL

Set the connection variables from the quickstart. Set each path variable to an authorized identifier or an allowed parameter value from the table above.

Save your authorized JSON input as request.json. Use the request schema and examples above; replace synthetic data before use.

Set IDEMPOTENCY_KEY to a unique key for this intent. Preserve it and the exact request for retries.

curl --fail-with-body --request POST \
  "$RIPSCLOUD_BASE_URL/api/v1/workspaces/$WORKSPACE_ID/rips-packages/$PACKAGE_ID/dispatches" \
  --header "Authorization: Bearer $RIPSCLOUD_TOKEN" \
  --header 'Accept: application/json' \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header 'Content-Type: application/json' \
  --data-binary @request.json