Kantata Kantata OX Knowledge Base
Release Notes
Kantata OX Release Notes API Breaking Changes
Status Page
Kantata OX API Documentation

Proof Reviews

Proof Reviews represent the process by which a proof is reviewed and feedback is specified. A proof review can be done by several users (represented as Proof Review Participations). A review begins with an in_progress status, and is moved to approved after it has been reviewed and accepted by all participants. If any participant rejects the review, it moves to a rejected status.

Fetching a list of Proof Reviews

This endpoint returns structured Proof Review objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the proof_reviews top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
include
string

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • participations (ProofReviewParticipation) - Represents the user assigned to review the proof, along with any actions they have taken on it.
  • proof_revision (ProofRevision) - The version to which this review is associated.
only
string

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

page
integer <int32>
Default: 1
per_page
integer <int32> <= 200
Default: 20
proof_revision_id
integer <int32>

Scoped to the specified proof revision.

Responses
200

A list of Proof Reviews have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
object
object
object
400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/proof_reviews
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "proof_reviews": {
    },
  • "proof_review_participations": {
    },
  • "proof_revisions": {
    }
}
Creating a new Proof Review
This endpoint returns structured Proof Review objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the proof_reviews top-level JSON key.
Please see our Response Format section for more information.


Request 
query Parameters
include
string
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.


    

  • participations (ProofReviewParticipation) - Represents the user assigned to review the proof, along with any actions they have taken on it.
    • 

  • proof_revision (ProofRevision) - The version to which this review is associated.
    • 



 
Request Body schema: application/json
required
object
 
proof_revision_id
required
integer <int32> 
The ID of the proof revision on which the review is created.


 
user_ids
required
Array of integers <int32> 
The IDs of all users added as participants in the proof review.


 
Responses 
200
Proof Review has been created.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/proof_reviews
Request samples 
application/json
{
  • "proof_review": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "proof_reviews": {
    },
  • "proof_review_participations": {
    },
  • "proof_revisions": {
    }
}
Updating an existing Proof Review
This endpoint returns structured Proof Review objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array
and will be indexed by ID in the proof_reviews top-level JSON key.
Please see our Response Format section for more information.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
query Parameters
include
string
Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.


    

  • participations (ProofReviewParticipation) - Represents the user assigned to review the proof, along with any actions they have taken on it.
    • 

  • proof_revision (ProofRevision) - The version to which this review is associated.
    • 



 
Request Body schema: application/json
required
object
 
status
required
string
The creator or Project Administrator can update the status to in_progress to continue a rejected review.
This sets the status of the participant who rejected it to waiting.


 
Responses 
200
Proof Review has been updated.


Response Schema: application/json
count
integer <int32> 
 
object
 
Array of objects
 
object
 
object
 
object
 
400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/proof_reviews/{id}
Request samples 
application/json
{
  • "proof_review": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "proof_reviews": {
    },
  • "proof_review_participations": {
    },
  • "proof_revisions": {
    }
}
Deleting an existing Proof Review
The response will contain no content and an HTTP 204 status code if the request was
successful, or a standard Kantata OX error message explaining why the object could not be deleted.


Request 
path Parameters
id
required
integer
The ID of the Model.


 
Responses 
204
Proof Review has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/proof_reviews/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Proof Revisions