Assessment Summary JSON File Format

Overview Assessment Summary Comment JSON Task JSON Survey JSON

Overview

This appendix documents the JSON schemas for all object types used in Assessment Summary export files. Each schema is referenced by the others using angle-bracket notation (e.g. <Assessment JSON>).

📋 Field types: UUID, EMAIL, TEXT, and DATETIME are defined in the JSON File Format article. The Assessment JSON schema is defined in the Assessment JSON appendix.

Assessment Summary JSON File Format

Assessment Summary

{
  assessments: [
    {
      <Assessment JSON>
    }
  ]
}

Comment JSON

Comment Object

{
  id:         UUID,
  text:       String,
  creator:    EMAIL,
  date:       DATETIME,
  files:      [TEXT],
  parent_id:  UUID
}

Task JSON

Task Object

{
  name:               String,
  description:        String,
  status:             String,       // OPEN, CLOSED
  type:               String,       // MANUAL, REMEDIATION
  priority:           String,       // LOW, MEDIUM, HIGH
  creator:            EMAIL,
  assignee:           EMAIL,
  created_date:       DATETIME,
  due_date:           DATETIME,
  last_modified_date: DATETIME
}

Survey (Question & Answer) JSON

Survey Object

{
  section:        Integer,
  question_label: String,
  question_text:  String,
  respondent:     EMAIL,
  answer_date:    DATETIME,
  risk:           String,   // NO_RISK, LOW, LOW_MEDIUM, MEDIUM, MEDIUM_HIGH, HIGH
  compliance:     String,   // COMPLIANT, NON_COMPLIANT
  answers: [
    {
      answer: String,
      labels: [String]
    }
  ],
  comments: [
    {
      <Comment JSON>
    }
  ],
  tasks: [
    {
      <Task JSON>
    }
  ]
}

TrustArc  ·  Assessment API — Appendix: Assessment Summary JSON File Format  ·  support.trustarc.com