...
Calling the API
| Insert excerpt | |||||||||
|---|---|---|---|---|---|---|---|---|---|
|
...
Method | Explanation | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| These endpoints require an API Key, assigned by the system administrators. These should be passed using Basic Authentication If the endpoint requires a |
Configuration and diagnostics
/health
| Handy status macro | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
| Handy status macro | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
| Info |
|---|
Returns a summary of the configuration’s health. Indicates if it is properly configured for the specified client and the results of any diagnostics that are run. |
...
| Handy status macro | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
| Info |
|---|
The To modify specific settings after initialization use |
JSON Payload
| Code Block |
|---|
{
"ClientId": "{{lb_client_id}}",
"ClientCredentials": {
"UserApiKeys": [
{ "user": "LearningBuilder", "api_key": "abcdef123", "scope": "SYSTEM" },
{ "user": "joe_schmoe", "api_key": "abcdef123", "scope": "SYSTEM" },
{ "user": "bob_dylan", "api_key": "defabc654", "scope": "CLIENT" }
],
"LbApiKeyOwner": "{{lb_api_key_username}}",
"LbApiKey": "{{lb_api_key_password}}"
},
"ClientSettings": {
}
} |
...
Parameter
...
Description
...
ClientId
...
Client Id that is used in learning builder
...
ClientCredentials
...
UserApiKeys
...
An array of API Keys for individual users. These are used to make API calls against the Lambda endpoints.
The scope is either “SYSTEM” or “CLIENT”.
...
LbApiKeyOwner
...
LearningBuilder API key. Used when the Lambda makes API calls to LearningBuilder.
...
LbApiKey
...
ClientSettings
...
LbHostOverride
...
The hostname to use when making API calls back to LearningBuilder.
When empty, the Lambda uses the LbConfiguration.ClientLbDomain value for {CLIENT_ID}
If you need to override that value during testing or troubleshooting, enter the fully qualified hostname here.
...
| Handy status macro | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
| Info |
|---|
Updates one or more of the configuration settings at a time, without sending the entire configuration document. NOTE: This can not be used to change API Key credentials. Use |
JSON Payload
| Code Block |
|---|
{
"settings": [
{ "name": "xxx", "value": "some new value"}
]
} |
...
Parameter
...
Description
...
settings
...
Array of settings to set
...
name
...
Name of the setting to update.
This must be “scope-prefixed” with the name of the relevant settings bucket, e.g.:
“ClientCredentials.NursysUsername”
“ClientSettings.SomeValue”
...
value
...
Value to set
...
| Handy status macro | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
| Info |
|---|
Adds or updates API Keys for individual users. |
JSON Payload
...
Publishing events into the Registry
TODO
Pulling events from the Registry
TODO