OBJECT

Objective

Objective class

link GraphQL Schema definition

  • type Objective {
  • # Auto-incrementing integer unique to objective table. Generated automatically on
  • # create
  • id: Int
  • # The objective
  • title: String
  • # The objective's life area id
  • life_area_id: Int
  • # The year and quarter for the objective
  • cycle: String
  • # Type of objective. Allowed values: “LIFE” - A life objective e.g. “get grade 2
  • # at piano”, “TEAM” - An objective assigned to a team, “BUSINESS” - An objective
  • # assigned to a User within a Business. May or may not be aligned with other
  • # businesses, “BUSINESS_TOP” - A top-level objective of a company
  • type: Int
  • # The id of the User who is assigned to this objective. Must always be set. If
  • # type is “TEAM”, “BUSINESS_TOP” or “BUSINESS” then this can only be set to an id
  • # of a user that belongs to the Business set on business_id
  • user_id: Int
  • # The id of the Business who is assigned to this objective. If type is “PERSONAL”
  • # this is ignored. Otherwise this can only be set to an id of a business that the
  • # User with user_id belongs to
  • business_id: Int
  • # The ID of the team that this objective is assigned to. If type is “TEAM” then
  • # team_id is required
  • team_id: Int
  • # The confidence in the success of the task
  • confidence: Int
  • # The id of the Objective to which this objective is aligned with. This can only
  • # be set to an ID of an objective with the same business_id. It cannot be set to
  • # an objective that is already a ‘descendant’ of this objective as that would
  • # cause a loop. If type is “BUSINESS_TOP” then this value will be cleared out /
  • # ignored
  • parent_objective_id: Int
  • # Is this a major objective
  • major: Int
  • # Is this objective locked. An objective is ‘locked’ at a certain point at the
  • # start of a quarter. At that point certain editing functions are restricted.
  • # Defaults to FALSE
  • is_locked: Int
  • # Should this objective be hidden from other people? Defaults to FALSE
  • is_hidden: Int
  • # Has the User assigned to this Objective marked this as important? Shows on UI as
  • # star icon. Defaults to FALSE
  • is_important: Int
  • # The current progress of the all the child Key Results as set by the User. Must
  • # be an integer between 0-100. Defaults to 0
  • progress: Int
  • # An array of key results assigned to an objective
  • key_results: [Keyresult]
  • # An array of tasks assigned to an objective
  • tasks: [Task]
  • # A count of the key results on this objective
  • key_result_count: Int
  • # A count of the tasks on this objective
  • task_count: Int
  • }

link Require by