{"openapi":"3.0.1","info":{"description":"De Opvragenresultaat API biedt de mogelijkheid om de status en het resultaat van asynchrone verzoeken op te vragen. De API ondersteunt momenteel resultaten voor Mediaswitch- en Objectmedia-verzoeken.\n\n#### Zo gebruik je deze API\n* Gebruik het `requestId` dat je hebt ontvangen na het indienen van een asynchroon verzoek.\n* Geef het juiste `opvragentype` op (`mediaswitch` of `objectmedia`).\n* Vraag het resultaat op via `GET /opvragenresultaat/v1/{opvragentype}/{requestId}`.\n* Verwerk de geretourneerde status en controleer of het verzoek succesvol is afgerond.\n\n#### Bijzonderheden\n* De API ondersteunt momenteel de opvragentypes `mediaswitch` en `objectmedia`.\n* Gebruik dezelfde API-token als waarmee het oorspronkelijke verzoek is uitgevoerd.\n* Mogelijke statussen zijn: `WAITING_FOR_S3_UPLOAD`, `IN_PROGRESS`, `OK`, `ERROR` en `EXCEPTION`.\n* Bij een succesvol resultaat kunnen ook gegevens van de aangemaakte of bijgewerkte entiteit worden teruggegeven, zoals `entityId`, `entityKey` en `entityType`.\n\n#### Laatste wijzigingen\n* Nog geen wijzigingen geregistreerd.","title":"Opvragenresultaat"},"externalDocs":{"description":"OpenAPI Specification","url":"/openapi-doc/v1/Opvragenresultaat"},"servers":[{"url":"https://api.realworks.nl"}],"security":[{"rwauth":[]}],"tags":[{"name":"Opvragenresultaat"}],"paths":{"/opvragenresultaat/v1/{opvragentype}/{requestId}":{"get":{"description":"","operationId":"opvragenResultaat","parameters":[{"in":"path","name":"opvragentype","required":true,"schema":{"type":"string","enum":["mediaswitch","objectmedia"]}},{"in":"path","name":"requestId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json;charset=UTF-8":{"schema":{"$ref":"#/components/schemas/SyncWritePathReplyGeneric"}}},"description":"Succes"},"400":{"description":"Foutief verzoek"},"401":{"description":"Geen toegang; de volgende zaken kunnen deze fout geven. 1. De voorwaarden voor gebruik API zijn nog niet geaccepteerd in de developers.realworks.nl omgeving. 2. De token die gebruikt wordt is niet correct. Neem contact op met Realworks als de fout zich voor blijft doen."},"403":{"content":{},"description":"Verboden"},"404":{"content":{},"description":"Niet gevonden"},"429":{"description":"Too Many Requests"},"500":{"description":"Interne fout"},"503":{"content":{},"description":"Service tijdelijk onbeschikbaar"}},"summary":"Opvragen resultaat","tags":["Opvragenresultaat"]}}},"components":{"schemas":{"SyncWritePathReplyGeneric":{"type":"object","properties":{"entityId":{"type":"integer","description":"ID van de nieuw gemaakte/bijgewerkte entiteit","format":"int64","nullable":true},"entityKey":{"type":"string","description":"Key van de nieuw gemaakte/bijgewerkte entiteit","nullable":true},"entityType":{"type":"string","description":"Entiteitstype gemaakt/bijgewerkt","nullable":true},"foutmeldingen":{"type":"array","nullable":true,"items":{"type":"string"}},"ontvangstId":{"type":"string","description":"Identifier zoals mogelijk opgegeven door de client, anders gegenereerd. UUID-4"},"result":{"type":"string","enum":["OK","ERROR","EXCEPTION","IN_PROGRESS","WAITING_FOR_S3_UPLOAD"]}}}},"securitySchemes":{"rwauth":{"in":"header","name":"Authorization","type":"apiKey"}}}}