AssessmentQuestionSet | Metadata API Developer Guide

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

AssessmentQuestionSet components have the suffix .AssessmentQuestionSet and are stored in the AssessmentQuestionSets folder.

Version

AssessmentQuestionSet components are available in API version 55.0 and later.

Fields

Field Name	Description
assessmentQuestionDeveloperNames	Field Type string[] Description The developer names for the assessment question. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
developerName	Field Type string Description Required. The developer name for the assessment question set. Can contain only underscores and alphanumeric characters and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores.
name	Field Type string Description Required. The question set name.

Declarative Metadata Sample Definition

The following is an example of an AssessmentQuestionSet component.

1<?xml version="1.0" encoding="UTF-8"?>
2<AssessmentQuestionSet
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<developerName>QuestionSetDevName</developerName>
5	<name>QuestionSetName</name>
6	<assessmentQuestionDeveloperNames>QuestionDevName</assessmentQuestionDeveloperNames>
7</AssessmentQuestionSet>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package
3	xmlns="http://soap.sforce.com/2006/04/metadata">
4	<types>
5		<members>*</members>
6		<name>AssessmentQuestion</name>
7	</types>
8	<types>
9		<members>*</members>
10		<name>AssessmentQuestionSet</name>
11	</types>
12	<version>55.0</version>
13</Package>

Wildcard Support in the Manifest File

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.

Usage

Before you retrieve assessment question sets, we recommend that you review these considerations.

When retrieving an assessment question set, if its fields contain values, then the XML definition must contain tags with those values.
When retrieving an assessment question set, if that set is associated with multiple questions, then the XML definition must contain developer names of all the associated questions.

Before you deploy assessment question sets, we recommend that you review these considerations.

When deploying an assessment question set, if an assessment question set with the same developer name doesn't exist in the target org, deploying creates one with that name.
If an assessment question set with the same developer name exists in the target org, then deploying the question set updates the values of the other fields in the target org.
If the questions associated with the assessment question set don't exist in the target org, deploying the assessment question set fails.
If the questions associated with the assessment question set don’t exist in the target org but are available in the package, then deploying the assessment question sets inserts the questions in the correct order.