Project

What is a Project

The Project resource creates the entry that will appear on the "Projects" page in the Qualtrics product. Different project types will have different behavior including which tabs appear when a user clicks the project. For more information on projects, check out this Qualtrics support page

If you would like to join the early access program for XM Solution Plugins, then please let us know by taking this survey.

Not generally available

This feature is in Early Access and is not yet generally available. Functionality, APIs, and documentation may change before general availability.

Project resources are not always required

Certain Project types use dedicated resources; in particular, regular Survey Projects should be created through the survey resource with the ProjectCategory set to something other than NONE. In those cases you should not use the general-purpose Project resource.

Context

The Project resource will generate one field:

• projectId

The projectId will be your Project's id, and it can be accessed with <step.id>.projectId or <step.id>.id.

The Project id will be necessary for directing users to the page for that project. There are several locations that use the projectId for navigation.

Solution Execution

Project resources are created using a "Create" step.

{
  "id": "project",
  "type": "Create",
  "config": {
    "apiVersion": "project.v0",
    "templateFilePath": "Resources/project.json",
    "transformationFilePath": "Resources/interpolate.js"
  }
}

The current apiVersion for Project is "project.v0".

The resource body will always look similar to this:

{
  "name": "{{ $.setup.answers.title }}",
  "type": "ModeratedUserTesting",
  "initializationParams": {
    "builtin:survey:preparedSurveyId": "{{ $.survey.surveyId }}"
  }
}

Do NOT manually set the name

The name field will not be translated, because it's recommended that the project title always be provided by the user. You should ask the user to input their project name in the Setup Assistant, and use that value for the name in this resource.

Supported Project Types

ModeratedUserTesting

Initialization parameters	Required	Value	Description
builtin:survey:preparedSurveyId	true	A survey ID	A survey ID that has been created using the survey resource that has the ProjectCategory inside the survey set to NONE.