users_post_me_favorites {civis}

Favorite an item

Description

Favorite an item

Usage

users_post_me_favorites(object_id, object_type)

Arguments

object_id

integer required. The id of the object. If specified as a query parameter, must also specify object_type parameter.

object_type

string required. The type of the object that is favorited. Valid options: Project, Container Script, Python Script, R Script, JavaScript Script, SQL Script, Workflow

Value

A list containing the following elements:

id

integer, The id of the favorite.

objectId

integer, The id of the object. If specified as a query parameter, must also specify object_type parameter.

objectType

string, The type of the object that is favorited. Valid options: Project, Container Script, Python Script, R Script, JavaScript Script, SQL Script, Workflow

objectName

string, The name of the object that is favorited.

createdAt

string, The time this favorite was created.

objectUpdatedAt

string, The time the object that is favorited was last updated

objectAuthor

list, A list containing the following elements:

• id integer, The ID of this user.

• name string, This user's name.

• username string, This user's username.

• initials string, This user's initials.

• online boolean, Whether this user is online.