Retrieve a project report

GET v1/projects/{:projectId}/report?mode=<'days' | 'hours'>&start_date=<number>&end_date=<number>

Allow to retrieve a report information for a project in the owned workspace.

Query parameters

Name	Type	Description	Required	Default
mode	string	Indicates whether the totalAllocation will be reported in days or hours	No	days
start_date	int	Filters the report start date, in milliseconds	No	-
end_date	int	Filters the report end date, in milliseconds	No	-

Request Body Parameters

 No body parameters

Response

{
    "status": 200,
    "value": {
        "message": "string",
        "status": 200,
        "data": {
            "projectId": "string",
            "external_id": "string",
            "start_date"?: int,
            "end_date"?: int,
            "totalAllocation": number,
            "resources": [
                "resourceId": "string",
                "firstName": "string",
                "lastName": "string",
                "totalAllocation": number,
                "email"?: "string",
            ]
        }
    }
}

Name	Type	Description	Required	Default
message	string	Message of the response	Yes	-
status	number	Status of the response	Yes	200
data	object	Project data	Yes	-

Data

Name	Type	Description	Required	Default
projectId	string (uuid)	Project internal identifier	Yes	-
external_id	string	External reference to the project	No	-
start_date	int	Report start date	No	-
end_date	int	Report end date	No	-
totalAllocation	number	Total allocation	No	0
resources	array	List of resources	No	[]

Resources

Name	Type	Description	Required	Default
resourceId	string (uuid)	Resource id	Yes	-
firstName	string	Resource first name	Yes	-
lastName	string	Resource last name	Yes	-
totalAllocation	number	Total allocation	No	0
email	string	Resource email	No	-