Jump to

• Request
• Response

View an Activity Favorite

get

/api/restapi/activityFavorite/{activityFavoriteId}

This endpoint returns activity favorites that meet the following requirements:

• The object has an activity favorite ID that matches the value of the {activityFavoriteId} path parameter.

Request

Path Parameters

• activityFavoriteId(required): integer(int64)
  The system-generated identifier of an activity favorite.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityActivityFavorite

Type: object

Title: ApiEntityActivityFavorite

Show Source

• activity: integer (int64)
  The unique identifier for the activity.The activity object can also be identified by its unique criteria.
• activityCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of the activity.
• activityFavoriteId: integer (int64)
  The unique identifier of an activity favorite.
• applicationUser: integer (int64)
  Unique identifier of a user.
• 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 unique identifier for a project set by the user who created the project.
• 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 user-specified identifier of a workspace.

{
    "title":"ApiEntityActivityFavorite",
    "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"
            ]
        },
        "activityFavoriteId":{
            "type":"integer",
            "description":"The unique identifier of an activity favorite.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "activityCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of the activity.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "applicationUser":{
            "type":"integer",
            "description":"Unique identifier of a user.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "activity":{
            "type":"integer",
            "description":"The unique identifier for the activity.The activity object can also be identified by its unique criteria.",
            "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
}

404 Response

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

Back to Top