OBJECT

SolutionRepository

Read operations for Solution records.

link GraphQL Schema definition

  • type SolutionRepository {
  • # Returns the record with the given id, or null when there is none. Deleted
  • # records are returned as well.
  • #
  • # Arguments
  • # entityId: Id of the record to return.
  • getById(entityId: ID!): SolutionEntity
  • # Returns the records with the given ids; ids without a record are left out.
  • # Deleted records are returned as well.
  • #
  • # Arguments
  • # entityIds: Ids of the records to return.
  • getByIds(entityIds: [ID!]!): [SolutionEntity!]!
  • # Returns the records that match the filter, paged with limit and offset.
  • #
  • # Arguments
  • # limit: Maximum number of records to return.
  • # offset: Number of records to skip from the start of the result.
  • # filter: Conditions the returned records must meet.
  • # orderBy: Sorting of the returned records.
  • # includeDeleted: When true, deleted records are returned as
  • # well. Defaults to false.
  • getAll(
  • limit: Int,
  • offset: Int,
  • filter: SolutionFilterInput,
  • orderBy: [SolutionOrderByInput!],
  • includeDeleted: Boolean
  • ): [SolutionEntity!]!
  • # Returns the records that match the filter as a cursor-paginated connection.
  • #
  • # Arguments
  • # filter: Conditions the returned records must meet.
  • # orderBy: Sorting of the returned records.
  • # includeDeleted: When true, deleted records are returned as
  • # well. Defaults to false.
  • # 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.
  • getByCriteria(
  • filter: SolutionFilterInput,
  • orderBy: [SolutionOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): SolutionEntityConnection
  • # Returns the ids of the fields of a record that changed after the given revision.
  • # Returns an empty list for entities without change tracking.
  • #
  • # Arguments
  • # id: Id of the record.
  • # revision: Revision to compare against; only later changes are
  • # returned.
  • getChangedFieldsSinceRevision(
  • id: UUID!,
  • revision: Int!
  • ): [UUID!]!
  • # Returns a page of solutions filtered by owner, status and tags, in addition to
  • # the regular filter.
  • #
  • # Arguments
  • # listingOptions: Owner, status (Active, Partial, Inactive) and
  • # tag filters applied to the list.
  • # filter: Conditions the returned records must meet.
  • # orderBy: Sorting of the returned records.
  • # 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.
  • getBySolutionCriteria(
  • listingOptions: SolutionTabDataGridViewOptionsParams!,
  • filter: SolutionFilterInput,
  • orderBy: [SolutionOrderByInput!],
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): SolutionEntityConnection
  • # Returns the current status and name of the given nodes of a solution canvas,
  • # computed from the live state of the records and features they reference. Node
  • # ids not present on the canvas are left out of the result.
  • #
  • # Arguments
  • # settings: The solution canvas to evaluate, as a JSON object
  • # conforming to the SolutionSchema type; it may be unsaved.
  • # nodeIds: Ids of the canvas nodes to evaluate.
  • nodeStatus(settings: SolutionSchemaJSONString!, nodeIds: [UUID!]!): [SolutionNodeStatusResult!]!
  • # Scans a solution canvas for related records and returns an updated canvas
  • # together with related records it did not add, so the user can choose which to
  • # add. Nothing is saved; save the returned canvas with the update mutation.
  • # Without nodeId the whole canvas is verified and outdated automatically added
  • # nodes are removed, but no new nodes are added.
  • #
  • # Arguments
  • # settings: The solution canvas to scan, as a JSON object
  • # conforming to the SolutionSchema type; it may be unsaved.
  • # nodeId: Id of the canvas node whose direct neighbours are
  • # scanned and added; omit to verify the whole canvas.
  • # addRecordIds: Candidate records of the scanned node to add, as
  • # chosen by the user. Requires nodeId.
  • # solutionId: Id of the solution being edited, excluded when
  • # counting how many other solutions use each candidate. Omit for an unsaved
  • # solution.
  • scan(
  • settings: SolutionSchemaJSONString!,
  • nodeId: UUID,
  • addRecordIds: [UUID!],
  • solutionId: UUID
  • ): SolutionScanResult!
  • }