Get pre-service run

Beta

GET

/api/pre-service/v1/runs/:run_id

Retrieve the result of a pre-service run. This endpoint supports long-polling.

AuthorizationBearer

OAuth authentication of the form <token>.

run_idUUIDRequired

include_initial_entity_statebooleanOptional

If true, the run result includes the entity exactly as it was submitted. Default = False

This endpoint returns an object.

run_idUUID

created_atdatetime

entity_external_idstring

The client’s internal ID for the entity that was submitted for pre-service rule processing.

actionslist of any

Actions recommended by the rules engine.

initial_entity_statemap from strings to anyOptional

The submitted entity. Only set if the request asked for it via include_initial_entity_state.

editsmap from strings to anyOptional

Recommended edits to the submitted entity.

errorobjectOptional

Set if the run encountered an unrecoverable error.

403

Unauthorized Error

404

Entity Not Found Error