OBJECT

TargetEntity

link GraphQL Schema definition

  • type TargetEntity {
  • # Tells if the entity instance is protected against delete (Entities that need to
  • # be present in the system at any time). Delete action still may fail if entity is
  • # deletable, due some other additional validations.
  • isDeleteProtected: Boolean!
  • # Unique identifier of entity.
  • id: ID!
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • currency: CurrencyEntity
  • owner: ClientEntity
  • targetClient: ClientEntity
  • # Field whose values are strictly defined with an enumeration of values.
  • calculationType: TargetCalculationTypeEnum
  • # Relation to single entity instance.
  • currencyId: ID
  • # Multi-line text input field.
  • description: String
  • # Boolean value.
  • isActive: Boolean!
  • # Name of the entity and its default text representation.
  • name: String!
  • # Relation to single entity instance.
  • ownerId: ID!
  • # Date information.
  • periodFrom: Date
  • # Date information.
  • periodTo: Date
  • settings: TargetsSettings!
  • # Relation to single entity instance.
  • targetClientId: ID
  • # Field whose values are strictly defined with an enumeration of values.
  • type: TargetTypeEnum
  • # Revision when entity was lastly changed.
  • revision: Int
  • target: Float
  • virtualPeriodFrom: Date
  • virtualPeriodTo: Date
  • daysLeft: Int!
  • status: TargetStatusEnum
  • finishedDate: Date
  • periodYear: Int!
  • periodType: TargetsPeriodTypeEnum!
  • # Returns if current target has any non-deleted parent group target.
  • hasParentGroupTarget: Boolean!
  • # Relations to Targets.
  • #
  • # Arguments
  • # filter: Filter Target relations by target Target attributes.
  • # filterEdge: Filter TargetRelation relations by edge (relation)
  • # TargetRelation attributes.
  • # orderBy: Order Target relations by target Target attributes.
  • # includeDeleted: Returns deleted target records as well. Default
  • # is true.
  • # before: Cursor until which to take entities to result set.
  • # after: Cursor after which to start taking entities to result
  • # set.
  • # first: Number of entities to return from beginning of the
  • # result set.
  • # last: Return only the "last" number of entities from result
  • # set.
  • childTargets(
  • filter: TargetFilterInput,
  • filterEdge: TargetRelationFilterInput,
  • orderBy: [TargetOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): TargetRelationEntityConnection
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • # Arguments
  • # period: [Not documented]
  • targetGoal(period: PeriodOptionParams): Int!
  • currentIndicators: TargetsIndicators!
  • # Arguments
  • # includeChildIds: [Not documented]
  • currentMetrics(includeChildIds: [UUID]): [TargetsCurrentMetrics]!
  • # Arguments
  • # includeChildIds: [Not documented]
  • currentTargetValue(includeChildIds: [UUID]): Float!
  • # Arguments
  • # metric: [Not documented]
  • # granularity: [Not documented]
  • # includeChildIds: [Not documented]
  • chartData(
  • metric: TargetsMetricEnum!,
  • granularity: TargetsChartGranularityEnum!,
  • includeChildIds: [UUID]
  • ): [TargetsUserChartData!]!
  • # If group target -> null else period of target!
  • absolutePeriod: TargetsAbsolutePeriod
  • # Returns if period.type and period.year can be updated - Child of inactive group
  • # is dependent on the group
  • canUpdatePeriodTypeAndYear: Boolean!
  • # Returns if period.fragment_type can be updated - Child of inactive group is
  • # dependent on the group!
  • canUpdatePeriodFragmentType: Boolean!
  • # Returns if settings.filter and settings.pipeline_lead_process_id can be changed
  • # - Child of inactive group is dependent on the group
  • canChangeFilterSettings: Boolean!
  • # Indicate if target_client can be changed.
  • canChangeTargetClient: Boolean!
  • }