POST/v1/drafts/{draft_id}/approve

Godkjenn publisering

approve_draft

Tilgjengelig for en godkjenner med COLLECTION_PUBLISH; publish_requested → approved. Forfatteren eller godkjenneren publiserer utkastet i et eget steg.

Autentisering

Send en API-nøkkel i headeren Authorization: Authorization: Bearer <nøkkel>.

Baneparametere

draft_idintegerobligatorisk

Headerparametere

Idempotency-Keystring
Nøkkel for et trygt nytt forsøk på en skriveoperasjon: 1 til 255 utskrivbare ASCII-tegn; en UUID v4 per logisk operasjon anbefales. Et nytt forsøk med samme nøkkel innen 24 timer kjører ikke operasjonen på nytt: det returnerer det lagrede svaret (status, headere og brødtekst) med headeren Idempotency-Replayed: true. Samme nøkkel med en annen metode, bane, Content-Type eller brødtekst returnerer 409 api.idempotency_mismatch; mens den første forespørselen fortsatt kjører, 409 api.idempotency_in_progress med Retry-After: 1. Etter et 5xx- eller 429-svar frigjøres nøkkelen, og et nytt forsøk kjører operasjonen på nytt. Nøkkelen gjelder per organisasjon og per kaller (API-nøkkel, bruker eller nøkkel for en egendefinert kilde).
length ≥ 1, length ≤ 255

Svar

200Vellykket svar

Headere i svaret

RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.
Idempotency-Replayed
true betyr at svaret ble gjentatt fra det lagrede svaret for denne Idempotency-Key: operasjonen ble ikke kjørt på nytt.

application/json

Objekt: Draft

idintegerobligatorisk
org_idintegerobligatorisk
card_idstring | nullobligatorisk
Kortet som utkastet redigerer; null – et utkast til et nytt kort.
collection_idintegerobligatorisk
collectionstringobligatorisk
titlestringobligatorisk
body_markdownstringobligatorisk
tagsarray of stringobligatorisk
base_versioninteger | null
Versjonen av kortet som utkastet startet fra.
scheduled_publish_atstring (date-time) | null
workflow_stateDraftWorkflowStateobligatorisk
revision_notestring | null
verify_on_publishbooleanobligatorisk
notify_followersbooleanobligatorisk
created_byintegerobligatorisk
updated_byinteger | null
created_atstring (date-time)obligatorisk
updated_atstring (date-time)obligatorisk
publish_requested_byinteger | null
publish_requested_atstring (date-time) | null
approved_byinteger | null
approved_atstring (date-time) | null
collaboratorsarray of DraftCollaboratorobligatorisk
conflictstring | null
card_published – kortet ble publisert eller endret etter at utkastet ble startet; card_deleted – kortet ble slettet; utvidbar.

401Ingen påloggingsinformasjon ble sendt (verken øktinformasjonskapsel eller API-nøkkel), eller nøkkelen ble ikke funnet.

Headere i svaret

RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

403Handlingen er ikke tillatt: rollen er utilstrekkelig, det finnes ingen tilgang til samlingen eller kortet, forespørselen kjører i modusen «View as», eller organisasjonen er suspendert eller slettet (`detail` er et objekt med `code: org_suspended | org_deleted`).

Headere i svaret

RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

404Objektet finnes ikke eller er ikke tilgjengelig for deg. API-et bekrefter ikke at et objekt med begrenset tilgang finnes.

Headere i svaret

RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

409Objektets tilstand tillater ikke handlingen, for eksempel et duplikat, en indeksering som pågår, eller en jobb som allerede er behandlet.

Headere i svaret

RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

429For mange forespørsler (`api.rate_limited`), organisasjonens kvote for minuttet, døgnet eller måneden er brukt opp (`api.quota_exceeded`; `error.details` inneholder `quota`, `limit` og `reset_at`), organisasjonens grense er nådd, eller svartjenesten er opptatt (`answers.engine_busy`). Vent så lenge som headeren `Retry-After` angir.

Headere i svaret

Retry-After
Antall sekunder du skal vente før du prøver forespørselen på nytt.
RateLimit-Policy
Gjeldende grenser i formatet fra IETF-utkastet draft-ietf-httpapi-ratelimit-headers: kommaseparerte elementer "<name>";q=<quota>;w=<window in seconds>. key er forespørselsraten til API-nøkkelen (kvoten er burst, tidsvinduet er tiden det tar å fylle den helt opp igjen; for en økt er det user, uten påloggingsinformasjon ip); minute, day og month er organisasjonens kvoter for kalenderminuttet, kalenderdøgnet og kalendermåneden i UTC.
RateLimit
Hva som gjenstår av hver grense i RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.
X-RateLimit-Limit
Grensen for den strengeste oppføringen i RateLimit-Policy (den med færrest gjenværende forespørsler).
X-RateLimit-Remaining
Gjenværende forespørsler under den strengeste grensen.
X-RateLimit-Reset
Sekunder til den strengeste grensen nullstilles.

application/json

Objekt: Error

Feilkoder

Kodene denne operasjonen kan returnere i error.code, i tillegg til de generelle kodene for alle forespørsler.

Trygge nye forsøk

Send en Idempotency-Key-header (for eksempel en UUID) med hver POST og PATCH. Et nytt forsøk med samme nøkkel innen 24 timer returnerer det lagrede svaret i stedet for å kjøre forespørselen på nytt.

Hastighetsgrenser

Svarene har headerne RateLimit og RateLimit-Policy og de eldre X-RateLimit-Limit, X-RateLimit-Remaining og X-RateLimit-Reset. Et 429-svar har Retry-After i sekunder: Vent, og prøv på nytt.

← drafts · API-referanse

curl -X POST 'https://api.sursa.com/v1/drafts/1/approve' \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Authorization: Bearer $SURSA_API_KEY"

Prøv

API-nøkkel

Nøkkelen lagres bare i minnet til denne fanen og sendes bare til https://api.sursa.com.

Forespørslene utføres på de faktiske dataene i organisasjonen din.

draft_id path *

Idempotency-Key header

Idempotency-Key

Når feltet er tomt, genereres en ny nøkkel for hver forespørsel.