Jump to

• Request
• Response

View All Assignment Favorites by Parent

get

/api/restapi/assignmentFavorite/parentCode

Send a request to this endpoint to view all assignment favorites under parent with codes matching the code fields in query parameters.

Request

Query Parameters

• activityCode(required): string
  The user-specified identifier of an activity.
  This is a required field.
• projectCode(required): string
  The user-specified identifier of a project.
  This is a required field.
• userName(required): string
  User name of application user.
  This is a required field.
• workspaceCode(required): string
  The user-specified identifier of a workspace.
  This is a required field.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityAssignmentFavorite>

Type: array

Title: List<ApiEntityAssignmentFavorite>

Show Source

• Array of: object ApiEntityAssignmentFavorite
  Title: ApiEntityAssignmentFavorite

{
    "title":"List<ApiEntityAssignmentFavorite>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityAssignmentFavorite",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityAssignmentFavorite

Type: object

Title: ApiEntityAssignmentFavorite

Show Source

• 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.

{
    "title":"ApiEntityAssignmentFavorite",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userName":{
            "maxLength":"255",
            "type":"string",
            "description":"The username a user uses to log in to the system.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "activityCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The activity code of an assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The project code of an assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The workspace code of an assignment.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "applicationUser":{
            "type":"integer",
            "description":"The unique identifier of a user.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "assignmentId":{
            "type":"integer",
            "description":"The unique identifier for the assignment.The assignment object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified identifier of a resource.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class of the resource of an assignment. ",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "assignmentFavoriteId":{
            "type":"integer",
            "description":"The unique identifier of an assignment favorite.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

The requested assignment favorite does not exist, or you do not have access to it.

Back to Top