Баримт бичиг / API лавлах
Шагналт даалгавар
Түншид зориулсан шагналтай даалгавар.
GET/v1/workspaces/{workspaceId}/bounties
List bounties of the program, oldest first.
Шаардлагатай API түлхүүрийн хамрах хүрээ: bounties.read
Параметр (6)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
state | query | string | | `scheduled`, `active`, `ended` or `archived`. |
type | query | string | | `submission` or `performance`. |
pageSize | query | integer (int32) | | |
startingAfter | query | string | | |
endingBefore | query | string | | |
Хариу: 200 BountyDto[]
POST/v1/workspaces/{workspaceId}/bounties
Create a bounty (R6 to R11). Accepts Idempotency-Key. A start date in the past or now notifies eligible partners at the next scan.
Шаардлагатай API түлхүүрийн хамрах хүрээ: bounties.write
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хүсэлтийн бие (CreateBounty)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
type | string | тийм | `submission` or `performance`. |
name | string | | |
description | string | | |
startMode | string | | `absolute` (default) or `relative`. |
startsAt | string (date-time) | | |
endsAt | string (date-time) | | |
endsAfterDays | integer (int32) | | |
rewardAmount | integer (int64) | | |
rewardDescription | string | | |
groupIds | array | | |
partnerTagIds | array | | |
performanceCondition | null | PerfIn | | |
performanceScope | string | | |
maxSubmissions | integer (int32) | | |
submissionFrequency | string | | |
submissionsOpenDays | integer (int32) | | |
submissionRequirements | object | | |
Хариу: 201 BountyDto
GET/v1/workspaces/{workspaceId}/bounties-needs-review
Number of submissions waiting for review in the program (R27).
Шаардлагатай API түлхүүрийн хамрах хүрээ: bounties.read
Параметр (1)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
Хариу: 200 NeedsReview
GET/v1/workspaces/{workspaceId}/bounties/{bountyId}
One bounty with submission counts.
Шаардлагатай API түлхүүрийн хамрах хүрээ: bounties.read
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
bountyId | path | string | тийм | |
Хариу: 200 BountyDto
PATCH/v1/workspaces/{workspaceId}/bounties/{bountyId}
Edit a bounty (R14). Before the first submission everything except the type is editable; afterwards only the name, description, end, audience, reward note and loosened requirements.
Шаардлагатай API түлхүүрийн хамрах хүрээ: bounties.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
bountyId | path | string | тийм | |
Хүсэлтийн бие (PatchBounty)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
type | string | | |
name | string | | |
description | string | | |
startMode | string | | |
startsAt | string (date-time) | | |
endsAt | string (date-time) | | |
endsAfterDays | integer (int32) | | |
rewardAmount | integer (int64) | | |
rewardDescription | string | | |
groupIds | array | | |
partnerTagIds | array | | |
performanceCondition | null | PerfIn | | |
performanceScope | string | | |
maxSubmissions | integer (int32) | | |
submissionFrequency | string | | |
submissionsOpenDays | integer (int32) | | |
submissionRequirements | object | | |
Хариу: 200 BountyDto
DELETE/v1/workspaces/{workspaceId}/bounties/{bountyId}
Delete a bounty without submissions (R15, no webhook); with submissions it must be archived.
Шаардлагатай API түлхүүрийн хамрах хүрээ: bounties.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
bountyId | path | string | тийм | |
Хариу: 204
POST/v1/workspaces/{workspaceId}/bounties/{bountyId}/archive
Archive: hidden from partners, kept for history (R15, R16).
Шаардлагатай API түлхүүрийн хамрах хүрээ: bounties.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
bountyId | path | string | тийм | |
Хариу: 200 BountyDto
GET/v1/workspaces/{workspaceId}/bounties/{bountyId}/submissions
Submissions of one bounty (R27): the review queue, oldest first by default. Drafts are private to the partner and never listed (R20).
Шаардлагатай API түлхүүрийн хамрах хүрээ: bounties.read
Параметр (9)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
bountyId | path | string | тийм | |
status | query | string | | `draft`, `submitted` (default), `approved`, `rejected`; `all` for every status but drafts. |
groupId | query | string | | |
partnerId | query | string | | |
sortBy | query | string | | `completedAt` (default) or `performanceCount`. |
sortOrder | query | string | | `asc` (default) or `desc`. |
pageSize | query | integer (int32) | | |
startingAfter | query | string | | |
Хариу: 200 SubmissionDto[]
POST/v1/workspaces/{workspaceId}/bounties/{bountyId}/submissions/bulk
Approve or reject up to 100 submissions independently (R31): never all-or-nothing.
Шаардлагатай API түлхүүрийн хамрах хүрээ: bounties.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
bountyId | path | string | тийм | |
Хүсэлтийн бие (BulkBody)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
action | string | тийм | `approve` or `reject`. |
partnerIds | string[] | тийм | |
groupId | string | | |
tagIds | array | | |
tagNames | array | | |
rejectionReason | string | | |
rejectionNote | string | | |
reapplicationTimeframe | string | | |
flagForFraud | boolean | | |
flagForFraudReason | string | | |
Хариу: 200 BulkResult[]
POST/v1/workspaces/{workspaceId}/bounties/{bountyId}/submissions/{submissionId}/approve
Approve a submitted entry (R28): creates the reward commission in the same transaction.
Шаардлагатай API түлхүүрийн хамрах хүрээ: bounties.write
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
bountyId | path | string | тийм | |
submissionId | path | string | тийм | |
Хүсэлтийн бие (ApproveBody)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
access | string | | `editor` (default) or `owner`. |
Хариу: 200 SubmissionDto
POST/v1/workspaces/{workspaceId}/bounties/{bountyId}/submissions/{submissionId}/reject
Reject a submitted entry (R29).
Шаардлагатай API түлхүүрийн хамрах хүрээ: bounties.write
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
bountyId | path | string | тийм | |
submissionId | path | string | тийм | |
Хүсэлтийн бие (RejectBody)
| Нэр | Төрөл | Заавал | Тайлбар |
|---|
partnerId | string | тийм | |
applicationId | string | | |
rejectionReason | string | | |
rejectionNote | string | | |
reapplicationTimeframe | string | | `instant`, `standard` (default, 30 days) or `never`. |
flagForFraud | boolean | | |
flagForFraudReason | string | | |
Хариу: 200 SubmissionDto
POST/v1/workspaces/{workspaceId}/bounties/{bountyId}/submissions/{submissionId}/reopen
Reopen a rejected or submitted entry so the partner can edit it (R17, R30).
Шаардлагатай API түлхүүрийн хамрах хүрээ: bounties.write
Параметр (3)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
bountyId | path | string | тийм | |
submissionId | path | string | тийм | |
Хариу: 200 SubmissionDto
POST/v1/workspaces/{workspaceId}/bounties/{bountyId}/unarchive
Unarchive: the bounty returns to its derived state (R16).
Шаардлагатай API түлхүүрийн хамрах хүрээ: bounties.write
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
bountyId | path | string | тийм | |
Хариу: 200 BountyDto
GET/v1/workspaces/{workspaceId}/bounty-files/{fileId}
Download a proof file of a submission (authenticated; the API serves the bytes).
Шаардлагатай API түлхүүрийн хамрах хүрээ: bounties.read
Параметр (2)
| Нэр | Байрлал | Төрөл | Заавал | Тайлбар |
|---|
workspaceId | path | string | тийм | |
fileId | path | string | тийм | |
Хариу: 200