Add Favorite Project to Favorite Projects of a User
Request
POST <REST API URL>/users/{user id}/favoriteprojects?fields=string
Parameter | Description |
---|---|
fields | Optional. Returns only the specified subset of the fields for each FavoriteProject. Use Fields Syntax to define the subset. |
Request Body
project
{
"id": string,
"aliases": [alias, ...],
"key": string,
"name": string,
"archived": boolean,
"description": string,
"creationTime": calendar,
"iconUrl": string,
"icon": string,
"defaultIcon": boolean,
"resources": [resource, ...],
"projectRoles": [projectRole, ...],
"transitiveProjectRoles": [projectRole, ...],
"myFavorite": boolean,
"team": projectTeam,
"owner": user,
"global": boolean,
"restricted": boolean,
"dashboard": raw,
"organization": organization,
"projectType": projectType,
"helpdeskSettings": projectHelpdeskSettings
}
Response
Response Code | Meaning |
---|---|
200 OK | Successful request. |
400 Bad Request | At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response. |
403 Forbidden | The requester has no access to the requested resource. |
404 Not Found | The requested resource was not found. |
500 Internal Server Error | Failed to process request because of the server error. For details, check the error message in the response. |
Response body
{
"id": string,
"aliases": [alias, ...],
"key": string,
"name": string,
"archived": boolean,
"description": string,
"creationTime": calendar,
"iconUrl": string,
"icon": string,
"defaultIcon": boolean,
"resources": [resource, ...],
"projectRoles": [projectRole, ...],
"transitiveProjectRoles": [projectRole, ...],
"myFavorite": boolean,
"team": projectTeam,
"owner": user,
"global": boolean,
"restricted": boolean,
"dashboard": raw,
"organization": organization,
"projectType": projectType,
"helpdeskSettings": projectHelpdeskSettings
}
Last modified: 22 October 2024