Assessment JSON

Overview

The Assessment JSON schema below documents all fields returned in assessment export files. Field types reference the format definitions in the JSON File Format article. Comments indicate field groupings and usage notes.

📋 Field types: UUID, EMAIL, TEXT, and DATETIME are defined in the JSON File Format article. Square brackets denote arrays.

JSON Schema

Assessment Object

{
  id:                        UUID,
  projectIdentifier:         String,
  name:                      String,
  description:               String,
  status:                    String,        // OPEN, SURVEY, SURVEY_COMPLETE, IN_REVIEW,
                                             // APPROVAL, APPROVED_PENDING_REMEDIATION
  template_id:               UUID,
  template_name:             String,
  template_version:          Integer,
  auto_assessment_name:      String,        // Name of assessment to be created
  autoAssessmentsFrom: {
    projectIdentifier:       String,
    Name:                    String
  },
  autoGeneratedAssessments: [
    {
      projectIdentifier:     String,
      Name:                  String
    }
  ],
  cloned_from:               String,        // Name of assessment to be cloned from

  // Users
  creator:                   EMAIL,
  owner:                     EMAIL,
  respondents:               [EMAIL],
  approvers:                 [EMAIL],
  participants:              [EMAIL],

  // Dates
  created_date:              DATETIME,
  start_date:                DATETIME,
  survey_completed_date:     DATETIME,
  approved_date:             DATETIME,
  due_date:                  DATETIME,
  last_modified_date:        DATETIME,

  // Tags
  tags: [
    {
      group:                 String,
      values:                [TEXT]
    }
  ],
  labels:                    [TEXT],        // Labels

  // Assets (Specific for IBM)
  asset_id:                  UUID,
  asset_name:                String,
  asset_ext_id:              String,
  asset_type:                String,
  asset_ao:                  [EMAIL],
  asset_bpo:                 [EMAIL],
  asset_ao_at_approval:      String,
  asset_bpo_at_approval:     String,

  // DFM Record
  record_id:                 UUID,
  record_name:               String,
  record_type:               String
}

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