Origami Risk Standard Rating API

Standalone standard rating service that accepts a rating request referencing a rater and intake payloads and returns rating results, offered in both synchronous and asynchronous modes with request retrieval and cancellation. The only one of Origami's four published OpenAPI definitions that carries a complete set of request/response schemas.

OpenAPI Specification

origami-risk-standard-rating-api-openapi.json Raw ↑
{"openapi":"3.0.1","info":{"title":"Rating API","version":"1.0.0"},"servers":[{"url":"http://origamirater-standard.dev.dais.com?oas"}],"paths":{"/Requests/sync":{"post":{"tags":["Requests"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardRatingRequestDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/StandardRatingRequestDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/StandardRatingRequestDto"}}}},"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/SyncRatingResponseDto"}},"application/json":{"schema":{"$ref":"#/components/schemas/SyncRatingResponseDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/SyncRatingResponseDto"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/Requests/async":{"post":{"tags":["Requests"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StandardRatingRequestDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/StandardRatingRequestDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/StandardRatingRequestDto"}}}},"responses":{"202":{"description":"Accepted","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/AsyncRatingResponseDto"}},"application/json":{"schema":{"$ref":"#/components/schemas/AsyncRatingResponseDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/AsyncRatingResponseDto"}}}},"400":{"description":"Bad Request","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/Requests/{requestId}":{"get":{"tags":["Requests"],"parameters":[{"name":"requestId","in":"path","required":true,"schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"OK","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/StandardRatingRequestDto2"}},"application/json":{"schema":{"$ref":"#/components/schemas/StandardRatingRequestDto2"}},"text/json":{"schema":{"$ref":"#/components/schemas/StandardRatingRequestDto2"}}}},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}},"delete":{"tags":["Requests"],"parameters":[{"name":"requestId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"No Content"},"404":{"description":"Not Found","content":{"text/plain":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}},"text/json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"schemas":{"AsyncRatingResponseDto":{"required":["requestId"],"type":"object","properties":{"requestId":{"$ref":"#/components/schemas/RequestId"}}},"IntakeId":{},"NullableOfRaterVersion":{"nullable":true},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}}},"RaterId":{},"RatingResultDetailsDto":{"type":"object","properties":{"intakeId":{"$ref":"#/components/schemas/IntakeId"},"raterResult":{"type":"object","nullable":true},"errors":{"type":"array","items":{"type":"string"},"nullable":true}}},"RequestId":{},"StandardRatingRequestDto":{"required":["raterId"],"type":"object","properties":{"intakeIds":{"type":"array","nullable":true},"intakes":{"type":"array","items":{"type":"string"},"nullable":true},"raterId":{"$ref":"#/components/schemas/RaterId"},"raterVersion":{"$ref":"#/components/schemas/NullableOfRaterVersion"},"generateWorksheet":{"type":"boolean"}},"nullable":true},"StandardRatingRequestDto2":{"required":["raterId"],"type":"object","properties":{"intakeIds":{"type":"array","nullable":true},"intakes":{"type":"array","items":{"type":"string"},"nullable":true},"raterId":{"$ref":"#/components/schemas/RaterId"},"raterVersion":{"$ref":"#/components/schemas/NullableOfRaterVersion"},"generateWorksheet":{"type":"boolean"}}},"SyncRatingResponseDto":{"required":["ratingResults"],"type":"object","properties":{"requestId":{"$ref":"#/components/schemas/RequestId"},"ratingResults":{"type":"array","items":{"$ref":"#/components/schemas/RatingResultDetailsDto"}},"failedToQueueErrors":{"type":"object","additionalProperties":{"type":"string"},"nullable":true}}}}},"tags":[{"name":"Requests"}]}