Adapter Registry¶
This page lists the Resource and Operation values you can use when adding an item to the Workflow Engine list to trigger IMPACT 365 automation. Use these exact values (case does not matter; the system normalizes to lowercase internally).
For each entry you need:
- Params JSON with
resource,operation,correlationId(required, use a new GUID per job), and optionallytargetIdandpayloadas noted below.
Core¶
| Resource | Operation | Description | TargetId | Payload notes |
|---|---|---|---|---|
Core.UserRole |
Grant |
Grants a user an IMPACT portal role (e.g. Admin, Business Broker) by adding them to the appropriate SharePoint group. | User email or identifier | Optional: UserEmail, UserRole to clarify. |
Core.UserRole |
Revoke |
Revokes a user’s IMPACT portal role by removing them from the relevant groups. | User email or identifier | Optional: UserEmail, UserRole. |
Core.Notify |
Email |
Sends an email notification (e.g. via Microsoft Graph). | Any (e.g. logical ID) | RecipientEmails (array), Subject, HtmlBody. |
Core.Utility |
Backup |
Exports specified IMPACT lists to backup files (e.g. JSON/Excel) and uploads to the Backup Files library. Often run on a schedule. | Any or empty | listConfigKeys: array of config key names that identify the lists to back up. |
Blueprint¶
| Resource | Operation | Description | TargetId | Payload notes |
|---|---|---|---|---|
Blueprint.WorkspaceTemplate |
Create |
Creates a workspace template from a source SharePoint site and stores it. | Template ID (from list) | None required; template row must exist. |
Blueprint.WorkspaceTemplate |
Update |
Updates a workspace template by re-generating it from the source site. | Template ID | None required. |
Blueprint.WorkspaceTemplate |
Delete |
Removes a workspace template (deletes stored file and list entry). | Template ID | None required. |
Blueprint.RepositoryTemplate |
Create |
Creates a repository (list) template from a source list/library and stores the definition. | Template ID (from list) | None required; list item must exist with TemplateID and source URL. |
Blueprint.RepositoryTemplate |
Update |
Re-extracts the list template and updates the stored definition. | Template ID | None required. |
Blueprint.Taxonomy |
Export |
Exports a term set from the term store (e.g. to Excel) and uploads to the Taxonomy Files library. | Any or term set ID | TermGroupID, TermSetID (GUIDs). |
Workspace provisioning¶
| Resource | Operation | Description | TargetId | Payload notes |
|---|---|---|---|---|
Workspace.Request |
Provision |
Provisions a single workspace from an approved request. | Workspace request ID (e.g. WSR-000429) | Request data (e.g. site name, template ID, hub, owners, language) may be in payload; often read from request list by ID. |
Workspace.Request |
Notify.NewRequest |
Sends notification emails for a new workspace request. | Workspace request ID | None required. |
Workspace.Request |
Notify.CompletedRequest |
Sends completion notifications to workspace owners and requester. | Workspace request ID | None required. |
Workspace.BulkProvision |
QueueAll |
Processes all approved pending workspace requests in one run. | Empty | None required. |
Repository provisioning¶
| Resource | Operation | Description | TargetId | Payload notes |
|---|---|---|---|---|
Repository.Request |
Provision |
Provisions a single repository (list/library) from an approved request on an existing workspace. | Repository request ID | Request data is read from the request list by ID. |
Insights¶
| Resource | Operation | Description | TargetId | Payload notes |
|---|---|---|---|---|
Insights.TeamActivity |
Report |
Fetches Teams activity report from Microsoft Graph and stores data in a SharePoint list. | Any or empty | Optional: Period — e.g. D7, D30, D90, D180. |
Insights.Report |
SiteUsage |
Fetches SharePoint site usage from Graph and updates provisioned-workspaces list with usage metrics. | Any or empty | Optional: Period — e.g. D7, D30, D90, D180. |
Insights.Audit |
Run |
Runs workspace governance audit: computes KPIs per workspace, writes to audit lists, updates LastAuditDate/LastAuditStatus. | Empty | Optional: BatchSize, MaxConsecutiveFailures, OnlyAuditIfLastAuditOlderThanDays, MaxWorkspacesPerRun. |
Compliance¶
| Resource | Operation | Description | TargetId | Payload notes |
|---|---|---|---|---|
Compliance.Repository |
Run |
Runs repository compliance: processes non-compliant provisioned repositories, applies labels and Business Authority default, marks Compliant when done. | Empty | None required. |
Compliance.Workspace |
Run |
Runs workspace compliance: processes workspaces due for run, validates/updates business authority and template labels, updates ComplianceLastRunDate/Status. | Empty | None required. |
Example: adding a workflow item¶
To trigger workspace provisioning for request WSR-000429, the Params JSON could look like this (exact field names may depend on your portal; your provider will confirm):
{
"resource": "Workspace.Request",
"operation": "Provision",
"targetId": "WSR-000429",
"correlationId": "2e0b1a5f-a833-4d2f-9f15-8a3d9b7d7cda",
"payload": {}
}
If the adapter reads request details from the request list by targetId, payload can be empty. For other operations (e.g. email, taxonomy export), include the payload fields indicated in the table.
To trigger workspace compliance (no target; run processes all due workspaces):
{
"resource": "Compliance.Workspace",
"operation": "Run",
"targetId": "",
"correlationId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"payload": {}
}
Notes¶
- Unique correlationId — Use a new GUID for each job to avoid idempotency issues and to trace the run.
- Resource/Operation spelling — Must match the table (e.g.
Workspace.RequestandProvision). Case is normalized by the system. - Future operations — Additional capabilities (e.g. Teams archiving/disposal) will be added as new Resource/Operation pairs; documentation will be updated when they are released.
For implementation details (list names, column names, configuration keys), work with your IMPACT 365 provider.