Giao diện
API · mission
Trang sinh tự động
Parse từ schema.graphql (SDL backend export) bằng parser graphql. Mô tả và quyền lấy nguyên văn từ description trong SDL.
7 query · 4 mutation.
Query
mission
Requires mission.read (MS-01).
query · quyền: mission.read
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
id | ID! |
Trả về Mission!
| Field | Kiểu | Mô tả |
|---|---|---|
id | ID! | |
code | String! | |
purpose | MissionPurpose! | |
audience | MissionAudience! | |
name | String! | |
description | String | |
current | MissionVersion | Non-draft version whose window contains now (paused included), else null. |
draft | MissionVersion | Open DRAFT version, if any (one at a time). |
latest | MissionVersion | Highest version number. |
versions | [MissionVersion!]! | All versions, newest first; history is never deleted. |
createdBy | ID! | |
createdAt | DateTime! | |
updatedAt | DateTime! | |
version | Int! |
missionEvidence
Evidence behind one assignment (Admin). mission_progress.read (MPR-02).
query · SDL không ghi quyền
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
assignmentId | ID! | ||
criterionId | ID | ||
page | Int | ||
pageSize | Int |
Trả về MissionEvidencePage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [MissionEvidenceItem!]! | |
page | Int! | |
pageSize | Int! | |
total | Int! |
missionPauseImpact
Requires mission.pause (MS-03). Read-only.
query · quyền: mission.pause
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
versionId | ID! | ||
effectiveAt | DateTime |
Trả về MissionPauseImpact!
| Field | Kiểu | Mô tả |
|---|---|---|
versionId | ID! | |
missionId | ID! | |
activity | MissionActivity! | |
canPause | Boolean! | False when the version is not PUBLISHED or its window has ended. |
blockReason | String | Why canPause is false: not_published, window_ended or pause_in_past. |
effectiveAt | DateTime! | |
assignedCount | Int! | |
completedCount | Int! | |
inProgressCount | Int! | Assigned and not completed: progress stays readable, no new contribution after the pause. |
withProgressCount | Int! | In progress with recorded evidence (net contributions > 0). |
contributionCount | Int! | |
reversalCount | Int! | |
requiredBy | MissionDependencies! | |
asOf | DateTime! |
missionProgress
One account's Missions with criterion progress (Admin). mission_progress.read (MPR-02).
query · SDL không ghi quyền
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
accountId | ID! | ||
purpose | MissionPurpose | ||
page | Int | ||
pageSize | Int |
Trả về MissionProgressPage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [MissionProgress!]! | |
page | Int! | |
pageSize | Int! | |
total | Int! |
missions
Requires mission.read (MS-01). Filters combine with AND; status = has a version in that state.
query · quyền: mission.read
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
search | String | ||
purpose | MissionPurpose | ||
audience | MissionAudience | ||
status | MissionVersionStatus | ||
page | Int | ||
pageSize | Int |
Trả về MissionPage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [Mission!]! | |
page | Int! | |
pageSize | Int! | |
total | Int! | |
sourceStatus | SourceStatus! |
myMissionEvidence
Evidence behind one of the caller's own assignments. mission_progress.read (own, MPR-01).
query · SDL không ghi quyền
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
assignmentId | ID! | ||
criterionId | ID | ||
page | Int | ||
pageSize | Int |
Trả về MissionEvidencePage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [MissionEvidenceItem!]! | |
page | Int! | |
pageSize | Int! | |
total | Int! |
myMissions
The caller's own Missions in this app, newest first; purpose filters one group. mission_progress.read (own, MPR-01).
query · SDL không ghi quyền
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
purpose | MissionPurpose | ||
page | Int | ||
pageSize | Int |
Trả về MissionProgressPage!
| Field | Kiểu | Mô tả |
|---|---|---|
items | [MissionProgress!]! | |
page | Int! | |
pageSize | Int! | |
total | Int! |
Mutation
assignMission
Requires mission.assign (MS-04, GAP-45: denied for every caller today).
mutation · quyền: mission.assign
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
input | AssignMissionInput! |
Trả về AssignMissionResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
assignment | MissionAssignment! |
pauseMission
Requires mission.pause (MS-03). PUBLISHED -> PAUSED, set once.
mutation · quyền: mission.pause
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
input | PauseMissionInput! |
Trả về MissionVersionResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
missionId | ID! | |
missionVersion | MissionVersion! | |
closedVersionIds | [ID!]! | Predecessor versions whose open window this publish closed. |
publishMission
Requires mission.write (MS-02). DRAFT -> PUBLISHED.
mutation · quyền: mission.write
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
input | PublishMissionInput! |
Trả về MissionVersionResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
missionId | ID! | |
missionVersion | MissionVersion! | |
closedVersionIds | [ID!]! | Predecessor versions whose open window this publish closed. |
saveMissionDraft
Requires mission.write (MS-02).
mutation · quyền: mission.write
| Tham số | Kiểu | Mặc định | Mô tả |
|---|---|---|---|
input | SaveMissionDraftInput! |
Trả về MissionVersionResult!
| Field | Kiểu | Mô tả |
|---|---|---|
aggregateId | ID! | |
version | Int! | |
status | CommandStatus! | |
requestId | ID! | |
correlationId | ID! | |
nextAction | NextAction | |
missionId | ID! | |
missionVersion | MissionVersion! | |
closedVersionIds | [ID!]! | Predecessor versions whose open window this publish closed. |