“archivedAudit” Resource Type#

Represents an archived audit as part of Vendor Rating Management in Business Central.

Note

For information about enabling APIs for Business Central, please refer to Enabling APIs for Dynamics 365 Business Central.

Methods#

Method	Return Type	Description
GET archivedAudit	archivedAudit	Gets an archived audit object.

Navigation	Return Type	Description
auditTemplate	auditTemplate	Gets the audit template associated with the current archived audit.
archivedAuditLines	archivedAuditLines	Gets the archived audit lines associated with the current archived audit.

Properties#

Property	Type	Description
id	Guid	The unique ID of the archived audit. Non-editable.
no	String	Specifies the unique number of the archived audit.
description	String	Specifies the description of the archived audit.
vendorNo	String	Specifies the number of the vendor this archived audit was conducted for.
auditDirector	String	Specifies the code of the user responsible for this archived audit.
auditDate	Date	Specifies the date when the audit was processed.
auditStatus	NAV.KVSVRMAuditHeaderStatus	Specifies the status of the archived audit. Possible values: "New", "Planned", "In Progress", or "Completed".
completedAt	Date	Specifies the date when the audit was completed.
completedBy	String	Specifies the user who completed the audit.
achievedAssessmentNumber	Decimal	Specifies the points scored in the audit.
maxAchievableAssessmentNo	Decimal	Specifies the possible maximum score that could be achieved in the audit.
templateNo	String	Specifies the code of the audit template that was used for the current archived audit.

JSON Representation#

The following code shows a JSON representation of the archivedAudit resource.

{
    "id": "GUID",
    "no": "string",
    "description": "string",
    "vendorNo": "string",
    "auditDirector": "string",
    "auditDate": "date",
    "auditStatus": "string",
    "completedAt": "date",
    "completedBy": "string",
    "achievedAssessmentNumber": "decimal",
    "maxAchievableAssessmentNo": "decimal",
    "templateNo": "string"
}

HTTP Requests#

Get archivedAudits#

Retrieves the properties and relationships of an archivedAudit object for Business Central.

HTTP Request#

Replace the URL prefix for Business Central depending on your environment, following the guideline.

GET businesscentralPrefix/kumavision/kvsvrm/v1.0/companies({id})/archivedAudits({id})

Request Headers#

Header	Value
Authorization	Bearer {token}. Required.

Request Body#

For this method, no request body is required.

Response#

If successful, this method returns the 200 OK response code and an archivedAudit object in the response body.

Example#

Request

The following code shows an example of the request.

GET https://{businesscentralPrefix}/api/kumavision/kvsvrm/v1.0/companies({id})/archivedAudits({id})

Response The following code shows an example of the response.

{
    "@odata.context": "https://{businesscentralPrefix}/api/kumavision/kvsvrm/v1.0/companies({id})/archivedAudits",
    "value": [
        {
            "@odata.etag": "W/\"JzIwOzExMjQ2MDYyMjU3MTUwMTgxODI1MTswMDsn\"",
            "id": "3c6e0363-1b39-4cbe-bfa6-e38215dd2bb6",
            "no": "AA554123",
            "description": "Healthcare Audit",
            "vendorNo": "10000",
            "auditDirector": "PETER",
            "auditDate": "2023-01-11",
            "auditStatus": "Finished",
            "completedAt": "2023-02-14",
            "completedBy": "MITCHELL",
            "achievedAssessmentNumber": 154,
            "maxAchievableAssessmentNo": 220,
            "templateNo": "A01"
        }
    ]
}