View all projects

Learn about the GetAll endpoint in the Project collection.

This API lets you retrieve information about all existing projects, such as its name, purpose, status, domain, function, calibration status, and more. You can also filter the results using pagination parameters.

Error while loading OpenAPI operation — Failed to fetch OpenAPI file

API request

Sample

GET {{ServerURL}}/api/services/app/Project/GetAll?MaxResultCount=200

Parameters

Parameter	Description
Keyword	A pagination parameter that helps you filter results by specific keywords.
SkipCount	A pagination parameter that helps you define the number of results to skip (i.e. where to start counting) when returning results.
MaxResultCount	A pagination parameter that helps you limit the number of results returned. It specifies the number of retrieved results.

API response

Sample

{
    "result": {
        "totalCount": 2,
        "items": [
            {
                "duplication_Summary": {
                    "feedingDataMapping": {},
                    "contentAttributesMapping": {},
                    "interactionAttributesMapping": {},
                    "destinationEntity_Mapping": {},
                    "interactionChannelsMapping": {},
                    "interactionChannelsInputCategoryMapping": {},
                    "logicsMapping": {},
                    "logicActionsMapping": {},
                    "logicConditionsMapping": {},
                    "triggeredActionAttributesMapping": {},
                    "destinationEntityEnvironmentObjects_Mapping": {}
                },
                "projectName": "Home Interior Validation",
                "duplicated_Project_Id": null,
                "duplicated_Project_Name": "",
                "project_Domain_Id": 4,
                "project_Function_Id": 13,
                "project_Domain_Name": "Digital user experience",
                "project_Function_Name": "Neuro-architecture",
                "productCalibrationStatus": true,
                "isRecurringUser": false,
                "project_Purpose": "data_collection",
                "relatesTo_Project_Id": null,
                "project_Status": "draft",
                "id": 67
            },
            {
                "duplication_Summary": {
                    "feedingDataMapping": {},
                    "contentAttributesMapping": {},
                    "interactionAttributesMapping": {},
                    "destinationEntity_Mapping": {},
                    "interactionChannelsMapping": {},
                    "interactionChannelsInputCategoryMapping": {},
                    "logicsMapping": {},
                    "logicActionsMapping": {},
                    "logicConditionsMapping": {},
                    "triggeredActionAttributesMapping": {},
                    "destinationEntityEnvironmentObjects_Mapping": {}
                },
                "projectName": "Car Design Validation",
                "duplicated_Project_Id": null,
                "duplicated_Project_Name": "",
                "project_Domain_Id": 4,
                "project_Function_Id": 13,
                "project_Domain_Name": "Digital user experience",
                "project_Function_Name": "Neuro-architecture",
                "productCalibrationStatus": null,
                "isRecurringUser": false,
                "project_Purpose": "General",
                "relatesTo_Project_Id": null,
                "project_Status": "draft",
                "id": 68
            },
             "id": 122
            }
        ]
    },
    "targetUrl": null,
    "success": true,
    "error": null,
    "unAuthorizedRequest": false,
    "__abp": true
}

Attributes

Attribute	Description
duplication_Summary	Summary of the mapping between the project components of the original and cloned (current) project, if applicable. Note: This data is available only if the project was cloned (duplicated) from an existing one.
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.
id	Unique identifier of the project