GraphQL RepositoriesprojectObjective

`entities.projectObjective`

Read project objective records with the projectObjective repository, and change them with the project objective mutations. Same records as the REST ProjectObjectives entity.

Example: first three project objective recordsGraphQLcURL

query FirstProjectObjectives {
  entities {
    projectObjective {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id name modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstProjectObjectives { entities { projectObjective { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id name modified } } } } } }"}'

Queries

Fields of entities { projectObjective { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	ProjectObjectiveEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[ProjectObjectiveEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: ProjectObjectiveFilterInput, orderBy: [ProjectObjectiveOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[ProjectObjectiveEntity!]!
QUERY	`getByCriteria`(filter: ProjectObjectiveFilterInput, orderBy: [ProjectObjectiveOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	ProjectObjectiveEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`updateProjectObjectiveSort`(input: UpdateProjectObjectiveSortInput!)	Update fields	UpdateProjectObjectiveSortPayload
MUTATION	`copyProjectObjective`(input: CopyProjectObjectiveInput!)	Copy a record GraphQL only	CopyProjectObjectivePayload
MUTATION	`updateProjectObjectiveActivitiesSort`(input: UpdateProjectObjectiveActivitiesSortInput!)	Update fields	UpdateProjectObjectiveActivitiesSortPayload
MUTATION	`createProjectObjective`(input: CreateProjectObjectiveInput!, validationLevel: [ValidationLevel!])	Create one record	CreateProjectObjectivePayload
MUTATION	`updateProjectObjective`(input: UpdateProjectObjectiveInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateProjectObjectivePayload
MUTATION	`bulkUpdateProjectObjective`(input: [CreateOrUpdateProjectObjectiveInput!]!, deleteInput: [DeleteProjectObjectiveInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateProjectObjectivePayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

ProjectObjectiveEntity object 12 fields: isDeleteProtected, id, isDeleted, …

Objective (goal) of a project.

Field	Type	Description
`isDeleteProtected`	Boolean!	True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`project`	ProjectEntity	Project this objective belongs to.
`name`	String!	Name of the entity and its default text representation.
`projectId`	ID!	Id of the project this objective belongs to. Set on create; cannot be changed afterwards.
`sortOrder`	Int!	Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed.
`revision`	Int	Revision when entity was lastly changed.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.
`relatedEntitiesDrilldown`	CompactViewDrilldownModel! (1 args)	Records of the given entity type that are related to this record, as a drilldown list.

ProjectObjectiveEntityConnection object pageInfo: PageInfo!, edges: [ProjectObjectiveEntityEdge]!, totalCount: Int

Paginated list of ProjectObjective records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[ProjectObjectiveEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

ProjectObjectiveEntityEdge object node: ProjectObjectiveEntity, cursor: String!

A Relay edge containing a ProjectObjectiveEntity and its cursor.

Field	Type	Description
`node`	ProjectObjectiveEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

ProjectObjectiveFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for ProjectObjective records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[ProjectObjectiveFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[ProjectObjectiveFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	ProjectObjectiveFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`name`	EntityFilterStringField	Name of the entity and its default text representation.
`projectId`	EntityFilterStringField	Id of the project this objective belongs to. Set on create; cannot be changed afterwards.
`sortOrder`	EntityFilterNumberField	Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`project`	ProjectFilterInput	Project this objective belongs to. Matches records where a related record meets these conditions.

ProjectObjectiveOrderByInput input Asc or Desc per field

Sorting of ProjectObjective records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`project`	[ProjectOrderByNestedInput!]	Project this objective belongs to. Sorts by fields of the related record, listed in order of priority.
`name`	OrderByEnum	Name of the entity and its default text representation.
`projectId`	OrderByEnum	Id of the project this objective belongs to. Set on create; cannot be changed afterwards.
`sortOrder`	OrderByEnum	Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CopyProjectObjectiveInput input copyTasks: Boolean!, id: ID!, clientMutationId: String

Parameters of the copyProjectObjective mutation.

Input field	Type	Description
`copyTasks`	Boolean!	When true, the objective's tasks are copied as well, as not-started tasks without dates or duration.
`id`	ID!	Identifier of the ProjectObjectiveEntity to perform the action on.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

CreateOrUpdateProjectObjectiveInput input 8 fields: clientMutationId, id, modified, …

Field values of a ProjectObjective record to create, or to update when its id is set.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`name`	String	Name of the entity and its default text representation.
`projectId`	ID	Id of the project this objective belongs to. Set on create; cannot be changed afterwards.
`sortOrder`	Int	Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed.
`revision`	Int	Revision when entity was lastly changed.

CreateProjectObjectiveInput input 7 fields: clientMutationId, modified, created, …

Field values of a new ProjectObjective record.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`name`	String!	Name of the entity and its default text representation.
`projectId`	ID!	Id of the project this objective belongs to. Set on create; cannot be changed afterwards.
`sortOrder`	Int!	Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed.
`revision`	Int	Revision when entity was lastly changed.

DeleteProjectObjectiveInput input clientMutationId: String, id: ID!

Id of the ProjectObjective record to delete.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.

UpdateProjectObjectiveActivitiesSortInput input 6 fields: projectId, ids, beforeId, …

Parameters of the updateProjectObjectiveActivitiesSort mutation.

Input field	Type	Description
`projectId`	ID!	Project the activities belong to.
`ids`	[ID!]!	Activities to move; all must be linked to the project.
`beforeId`	ID	Activity in the destination objective that the moved activities are placed before; leave empty to add them at the end.
`objectiveId`	ID	Objective the activities are moved to; leave empty to move them out of any objective.
`sessionIdToUpdate`	String	Id of an open list view of the project's activities that is reordered to match. Integrations can leave it empty.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateProjectObjectiveInput input 8 fields: clientMutationId, id, modified, …

Id of a ProjectObjective record and the field values to change.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`name`	String	Name of the entity and its default text representation.
`projectId`	ID	Id of the project this objective belongs to. Set on create; cannot be changed afterwards.
`sortOrder`	Int	Position of the row within its sibling set; lower values appear first. The platform reorders neighbouring rows automatically when a value is inserted or changed.
`revision`	Int	Revision when entity was lastly changed.

UpdateProjectObjectiveSortInput input beforeId: ID, sessionIdToUpdate: String, id: ID!, clientMutationId: String

Parameters of the updateProjectObjectiveSort mutation.

Input field	Type	Description
`beforeId`	ID	Objective of the same project that this objective is placed before; leave empty to move it to the end.
`sessionIdToUpdate`	String	Id of an open list view of the project's activities that is reordered to match. Integrations can leave it empty.
`id`	ID!	Identifier of the ProjectObjectiveEntity to perform the action on.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

BulkUpdateProjectObjectivePayload object result: BulkUpdateResults!

Result of the bulkUpdateProjectObjective mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

CopyProjectObjectivePayload object result: ProjectObjectiveEntity, clientMutationId: String

Result of the copyProjectObjective mutation.

Field	Type	Description
`result`	ProjectObjectiveEntity	The new objective.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

CreateProjectObjectivePayload object projectObjective: ProjectObjectiveEntity, clientMutationId: String

Result of the createProjectObjective mutation.

Field	Type	Description
`projectObjective`	ProjectObjectiveEntity	The created record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateProjectObjectiveActivitiesSortPayload object result: Boolean, clientMutationId: String

Result of the updateProjectObjectiveActivitiesSort mutation.

Field	Type	Description
`result`	Boolean	True when the activities were moved.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateProjectObjectivePayload object projectObjective: ProjectObjectiveEntity, clientMutationId: String

Result of the updateProjectObjective mutation.

Field	Type	Description
`projectObjective`	ProjectObjectiveEntity	The updated record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateProjectObjectiveSortPayload object result: ProjectObjectiveEntity, clientMutationId: String

Result of the updateProjectObjectiveSort mutation.

Field	Type	Description
`result`	ProjectObjectiveEntity	The moved objective.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).