Node

Updating Node item

Updates an existing item

put/api/simulations/{simulationId}/nodes/{nodeId}

Request

  • Base URL
    https://api.wearelearning.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Implicit: https://login.wearelearning.io/authorize?audience=https://api.wearelearning.io

Path parameters

simulationIdstring uuid required

A valid GUID

nodeIdstring required

Id of an existing Node that needs to be updated

Request body

idstring nullable
labelstring nullable
textstring nullable
colorstring nullable
eventIdstring nullable
nodeType'dialogue' | 'response' | 'poster' | 'event' | 'end' | 'open-response' | 'outcome' | 'no-match' | 'hotspot' | 'quiz' | 'page' | 'code' required
speakerIndexstring nullable
speakerIdstring nullable
timelineDurationnumber float nullable
shouldDoAiRephraseboolean required
audioTimelineStartTimenumber double nullable
audioType'None' | 'Recording' | 'TextToSpeech' | 'Upload'
audioGuidstring nullable
sceneBackgroundstring nullable
selectedSceneIdstring nullable
voiceoverEnabledboolean required
randomResponseOrderboolean required
ambienceVolumenumber float nullable
isSuccessboolean nullable
displayPosterIconboolean nullable
referencesstring[] nullable
locationstring nullable
timeOfDaynumber float nullable
audioVolumenumber float nullable

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.