Acknowledgement History - AcceleratorKMS - Version 5.0 - Help - Hexagon

AcceleratorKMS API Guide

Language
English
Product
AcceleratorKMS
Search by Category
Help
AcceleratorKMS Version
5.1

Use the Acknowledgement History API to pull data on acknowledgements, such as content, user, and date range.

Users with domain access and a role with View acknowledgement history can view API results.

URL

https://AcceleratorKMS_URL/api/Acknowledgements/Search

Where:

AcceleratorKMS_URL is replaced with your AcceleratorKMS instance.

HTTP Verb

Make an HTTP POST request using the following header and parameters.

Header

Key

Value

Description

Authorization

bearer <token>

Actual token value acquired from the authentication step

Content-Type

application/json

Designates the POST’s content response as JSON format

Parameters

At least one search parameter is required for the request to proceed.

Parameters

Type

Description

ContentIds

Array

Represents array list of Content GUIDs to search. If left blank, all content is included n the response. The response only includes content in domains to which the user has access.

Usernames

Array

Represents the usernames of users who have acknowledged or performed a completion on the content

Acknowledged DateMin

Date

Earliest acknowledgement date. Format is: YYYY-MM-DD (example: 2023-06-31).

Defaults to six months before today, if no other date range filters set

Acknowledged DateMax

Date

Latest acknowledgement date. Format is: YYYY-MM-DD. Default is 6 months.

Sample Query

{

"ContentIds": [

"3f8818ed-2b1c-413e-be56-e2e2d4630f89",

"fad24a51-35ae-4a23-9d91-6237bfb2dbc5"

],

"Usernames": [

"user1",

"user2"

],

"AcknowledgedDateMin": "2023-01-01",

"AcknowledgedDateMax": "2023-06-01"

}

Sample Response (JSON)

When "Classification" is seen in response parameters, it is referring to the domain within AcceleratorKMS.

{

"ContentId": "3f8818ed-2b1c-413e-be56-e2e2d4630f89",

"ContentTitle": "EVAP123 - Evaporator - Shutdown",

"Username": "user1"

"AcknowledgedDate": "2023-05-03T19:16:32.4",

"ContentTypeName": "Procedure",

"ContentTypeId": "d8106fd-f0ed-4256-8d98-3cbff2all4a2",

"ClassificationPath": "Global",

"ClassificationId": "00000000-0000-0000-0000-000000000000",

"AcknowledgedVersion": "1.0.0",

},