View an Assignment Favorite
get
/api/restapi/assignmentFavorite/{assignmentFavoriteId}
This endpoint returns assignment favorites that meet the following requirements:
- The object is associated with an assignment favorite with an ID value that matches the value of the {assignmentFavoriteId} path parameter.
Request
Path Parameters
-
assignmentFavoriteId(required): integer(int64)
The system-generated identifier of an assignment favorite.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityAssignmentFavorite
Type:
object
Title:
Show Source
ApiEntityAssignmentFavorite
-
activityCode: string
Minimum Length:
0
Maximum Length:60
The activity code of an assignment. -
applicationUser: integer
(int64)
The unique identifier of a user.
-
assignmentFavoriteId: integer
(int64)
The unique identifier of an assignment favorite.
-
assignmentId: integer
(int64)
The unique identifier for the assignment.The assignment object can also be identified by its unique criteria.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The project code of an assignment. -
resourceClass: string
Allowed Values:
[ "RESOURCE", "ROLE" ]
The class of the resource of an assignment. -
resourceCode: string
Minimum Length:
1
Maximum Length:60
The user-specified identifier of a resource. -
updateDate: string
(date-time)
Date when the record was last updated.
-
userName: string
Maximum Length:
255
The username a user uses to log in to the system. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The workspace code of an assignment.
404 Response
The requested assignment favorite does not exist, or you do not have access to it.