client.organizations.post_favorites

A method of the Organizations endpoint.

post_favorites(object_id: int, object_type: str) → Response

Favorite an item for your organization

API URL: POST /organizations/favorites

import civis
client = civis.APIClient()
response = client.organizations.post_favorites(...)

Parameters:

object_idint

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

object_typestr

The type of the object that is favorited. Valid options: Container Script, Identity Resolution, Import, Python Script, R Script, dbt Script, JavaScript Script, SQL Script, Template Script, Project, Workflow, Table, Tableau Report, Service Report, HTML Report, SQL Report

Returns:

civis.Response

• idint

  The id of the favorite.

• object_idint

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

• object_typestr

  The type of the object that is favorited. Valid options: Container Script, Identity Resolution, Import, Python Script, R Script, dbt Script, JavaScript Script, SQL Script, Template Script, Project, Workflow, Table, Tableau Report, Service Report, HTML Report, SQL Report

• object_namestr

  The name of the object that is favorited.

• created_atstr (time)

  The time this favorite was created.

• object_updated_atstr (time)

  The time the object that is favorited was last updated

• object_authorcivis.Response

  • idint

    The ID of this user.

  • namestr

    This user’s name.

  • usernamestr

    This user’s username.

  • initialsstr

    This user’s initials.

  • onlinebool

    Whether this user is online.