Journeys
Please note:
Journeys are only available in our Enterprise hosted version of Learning Locker. For more information about the differences, please see this page.
A visualisation of an actor/person’s progress through a journey.
It is accessible through the following HTTP interfaces:
Connection HTTP Interface via http://www.example.org/api/connection/journey.
REST HTTP Interface via http://www.example.org/api/v2/journey.
SCHEMA
Name | Type | Description |
---|---|---|
_id | Mongo ID | The id of this journey (autogenerated) |
organisation | Organisation Mongo ID | The id of the organisation this journey belongs to (autogenerated) |
owner | User Mongo ID | The id of the user who created this journey (autogenerated) |
createdAt | Timestamp | When this journey was created (autogenerated) |
updatedAt | Timestamp | When this journey was last updated (autogenerated) |
description | String | The name of the journey |
isActive | Boolean | If this journey is active |
sources | Array [Store Mongo IDs] | An array of stores that this journey applies to |
waypoints | Array [Waypoints] | An array of waypoints for this journey. See waypoints |
outcomes | Array [Outcomes] | An array of outcomes for this journey |
isSequential | Boolean | If this journey is sequential |
isRepeatable | Boolean | If this journey is repeatable |
trackBy | String | Only |
recalculateStatus | JSON {Recalculate Status} | Progress in calculating this journey |
isPublic | Boolean | If false then this visualisation is only available to the owner and users with org/all/journey/view scope, otherwise it’s available to everyone in the organisation with permission |
queryHint | String | Specifies a Mongo collection index to use instead of the chosen index selected during the query planner stage, e.g. |
WAYPOINTS
An array of points with properties: