Retrieve Attribute values for a given Workflow Instance. Introduced in 13.3.0.

This API is considered experimental and is intended for internal use only at this time.

Overview

This is a utility API for updating Workflow Attribute values without going through the Workflow Engine. It was designed to allow integrations to update data in LearningBuilder over an HTTP call.

Bypassing the Workflow Engine includes some trade-offs:

Using the API

Calling this API requires an API Key with the SetAttributeValues permission.

The key should be passed using the “apikey” authorization scheme.

Authorization: apikey xxxxxxxxxxxxxxxxx

HTTP Request

Payload is a JSON document submitted via HTTP Post.

This payload can contain multiple Attribute values to update.

{
    "WorkflowInstanceId": 20657,
    "AttributeNames":["LearningPlan.attr A","LearningPlanInstance.attr B"],
    "AttributeIds":[20,9600]
}

The maximum number of records that can be updated at one time is controlled by https://heuristicsolutions.atlassian.net/wiki/spaces/DOCS/pages/3699179521

Field	Description

Field	Description
`WorkflowInstanceId`	Required Must be a valid `WorkflowInstanceId` in the system.
`AttributeNames`	OPTIONAL Must have a list of valid attributes for the provided `WorkflowInstanceId` using the `<<EntityName>>:<<AttributeName>>` format.
`AttributeIds`	OPTIONAL Must have a list of valid attribute ids for the provided `WorkflowInstanceId` .

If no attributes are provided, all attributes for the given WorkflowInstanceId are returned. If both AttributeNames and AttributeIds both sets of attributes are included in the response

API/WorkflowInstance/AttributeValues

Overview

Using the API

HTTP Request