Create a project

Learn about the Create endpoint in the Project collection.

This API lets you create a new project and define its data inputs.

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

API request

Sample

POST {{ServerURL}}/api/services/app/Project/Create

Body

{
  "projectName": "Museum Digital Guide",
  "project_Domain_Id": 4,
  "project_Function_Id": 10,
  "project_Purpose": "General",
  "isRecurringUser": false,
  "productCalibrationStatus": true,
  "interactionSetups": [
    {
      "interaction_setup_id": 5,
      "interaction_mode": "diagnostics"
    },{
      "interaction_setup_id": 3,
      "interaction_mode": "diagnostics"
    },{
     "interaction_setup_id": 3
      "interaction_mode": "user_calibration"
    },{
      "interaction_setup_id": 8,
      "interaction_mode": "user_calibration"
    }
  ]
}

Parameters

Parameter	Description
projectName	Name of the project
project_Domain_Id	Unique identifier of the project's domain. Note: Whether or not you need to enter the project domain ID depends on your user account; If you are working with a private solution, you might need to enter the project ID instead of the project domain ID. On the other hand, if you are working with a public solution, you might need to enter the project domain and function ID. This parameter can have the following values:
project_Function_Id	Unique identifier of the project's function based on the project's domain. Note: Whether or not you need to enter the project function ID depends on your user account; If you are working with a private solution, you might need to enter the project ID instead of the project domain ID. On the other hand, if you are working with a public solution, you might need to enter the project domain and function ID. This parameter can have the following values: For No domain (when project_Domain_Id is -1) For Security & Safety (when project_Domain_Id is 2) For Human wellbeing (when project_Domain_Id is 3) For Digital user experience (project_Domain_Id is 4)
duplicate_Project_Id	Indicates whether the project was created by duplicating an existing one. By default, the value of this parameter is null.
project_Purpose	Purpose of the project. This parameter can have the following values: General Data_Collection Simulation Simulation_bulk By default, the value of this parameter is General.
relatesTo_Project_Id	Unique identifier of another project to which the project is related. Note: When working with solutions that implement simulation, you can have two projects; one for raw data collection (RDC) and the other for running the simulation. In the simulation project, you can enter the project ID of the RDC project so that the results or data gathered in the RDC process can be used for the simulation.
isRecurringUser	Indicates whether the users will interact with Affective Computing (powered by Virtue) once or multiple times. By default, the value of this parameter is false.
productCalibrationStatus	Indicates whether the project is operating in product calibration mode.
interactionSetups	The data inputs you want to configure for the new project. You must enter the following information for each data input:

API response

Sample

{
    "result": {
        "projectName": "Museum Digital Guide",
        "duplicated_Project_Id": null,
        "duplicated_Project_Name": null,
        "project_Domain_Id": 4,
        "project_Function_Id": 10,
        "project_Domain_Name": null,
        "project_Function_Name": null,
        "productCalibrationStatus": true,
        "isRecurringUser": false,
        "project_Purpose": "General",
        "relatesTo_Project_Id": null,
        "project_Status": "draft",
        "id": 1234
    },
    "targetUrl": null,
    "success": true,
    "error": null,
    "unAuthorizedRequest": false,
    "__abp": true
}

Attributes

Attribute	Description
id	Unique identifier of the project
projectName	Name of the project
duplicated_Project_Id	The ID of the original project from which the (current) project was cloned, if applicable. Note: This data is available only if the project was cloned (duplicated) from an existing one.
duplicated_Project_Name	The name of the original project from which the (current) project was cloned, if applicable. Note: This data is available only if the project was cloned (duplicated) from an existing one.
project_Domain_Id	Unique identifier of the project's domain. This parameter can have the following values:
project_Function_Id	Unique identifier of the project's function based on the project's domain. Note: Whether or not you need to enter the project function ID depends on your user account; If you are working with a private solution, you might need to enter the project ID instead of the project domain ID. On the other hand, if you are working with a public solution, you might need to enter the project domain and function ID. This parameter can have the following values: For No domain (when project_Domain_Id is -1) For Security & Safety (when project_Domain_Id is 2) For Human wellbeing (when project_Domain_Id is 3) For Digital user experience (project_Domain_Id is 4)
project_Domain_Name	Name of the project domain.
project_Function_Name	Name of the project function.
productCalibrationStatus	Indicates whether the project is operating in product calibration mode.
isRecurringUser	Indicates whether the project's user will interact with Affective Computing (powered by Virtue) one or multiple times.
project_Purpose	Purpose of the project.
relatesTo_Project_Id	Unique identifier of another project to which the (current) project is related. Note: A project can be linked with another one to enable the data collected by it in the other one too. This data is available in this attribute only if the project is linked to another one. For example, in simulation solutions, the RDC and simulation projects might be linked to facilitate using RDC data for the simulation.
project_Status	Indicates whether the project is released to production.

---

Related information

Understanding data inputsViewing available data inputs (interaction setups)