Directly sets Attribute values, bypassing the Workflow Engine.

To perform Actions and Behaviors as well, API/WorkflowInstance/PerformStep

This page is protected from public access. This API is intended for internal use only at this time. There are too many limitations and risk factors for this to be used by external callers without our guidance.

This API currently only supports Extrinsic Attributes. Support for Intrinsic Attributes might be added at a later 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:

Pros	Cons
Highly performant (simple database update)	Does not perform Actions or Behaviors
Supports bulk updates in a single API call	Does not enforce Validation Rules; caller is responsible for ensuring data is valid
Updates a Workflow Instance regardless of which Step it is on	Can create issues if Attributes are updated in a way that the Workflow would not allow, and therefore does not account for
	Only supports data types that store a simple value in the `ITEM_ATTRIBUTE_VALUE` table
	Currently supports Extrinsic Attributes only

Supported Entities / Workflow types

The API currently supports Activity Instance, Learning Plan Instance, Member Role, and Activity Offering Instance Attributes.

Workflow Type	Rules
Create Activity	The Workflow Instance must be Incomplete.
Complete Activity
Complete Learning Plan
Complete Offering
Grant Role / Edit Role	The status of the Workflow Instance does not matter. `Member Role` Attributes can always be updated by this API.

Using the API

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

HTTP Request

Payload is a JSON document submitted via HTTP Post.

This payload can contain multiple Attribute values to update.

[
  {
    "entityType": "LearningPlanInstance",
    "workflowInstanceId": 42,
    "reason": "updating status from Nursys",
    "attrValues": [
      { "attrDefId": 123, "value": "some new value" },
      { "attrDefId": 456, "value": "another value" },
    ]
  },
  {
    "entityType": "MemberRole",
    "workflowInstanceId": 48,
    "reason": "updating status from Nursys",
    "attrValues": [
      { "attrDefId": 555, "value": "some new value" },
      { "attrDefId": 543, "value": "another value" },
    ]
  }
]

Field	Description
`entityType`	`ActivityInstance`, `LearningPlanInstance`, or `MemberRole`
`workflowInstanceId`	The ID of the Workflow instance. `ActivityInstance` - must point to an Incomplete Complete Activity WFI `LearningPlanInstance` - must point to an Incomplete Complete LP WFI `MemberRole` - can point to any Grant Role or Edit Role WFI, regardless of status
`reason`	(optional) text string describing the update
`attrValues`	An array of attribute values to set.
`attrValues[i].attrDefId`	Attribute Definition Id of the attribute to set. Must be a valid Attribute defined for the specified entity type.
`attrValues[i].value`	Value to set. No validation or processing is performed on this value. Take care when using this with data types that handle structured data, as you are responsible for correctly formatting the value in the API call.

HTTP Response

The HTTP response is a JSON document indicating the results.

{
  "modifiedRecords": 4,
  "validationErrors": [
    
  ]
}

API/WorkflowInstance/SetAttributeValues [DRAFT]

Overview

Supported Entities / Workflow types

Using the API

HTTP Request

HTTP Response