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

Proof Review Participations

Important: After December 31, 2024, Proofing will no longer be available in Kantata OX and the Proofing APIs will be unavailable.

Proof Review Participations represents a user's involvement (participation) in the review of a proof. Their status can be either Waiting, Approved, or Rejected.

Fetching a list of Proof Review Participations

This endpoint returns structured Proof Review Participation 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_review_participations 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.

  • proof_review (ProofReview) - The ProofReview associated with the ProofReviewParticipation.
  • user (User) - The user associated with the ProofReviewParticipation.
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
Responses
200

A list of Proof Review Participations 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_review_participations
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "proof_review_participations": {
    },
  • "users": {
    },
  • "proof_reviews": {
    }
}
Updating an existing Proof Review Participation
This endpoint returns structured Proof Review Participation 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_review_participations 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.


    

  • proof_review (ProofReview) - The ProofReview associated with the ProofReviewParticipation.
    • 

  • user (User) - The user associated with the ProofReviewParticipation.
    • 



 
Request Body schema: application/json
required
object
 
status
required
string
The status of the user's participation. This can move from 'in_progress' to 'rejected' or 'approved'.


 
Responses 
200
Proof Review Participation 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_review_participations/{id}
Request samples 
application/json
{
  • "proof_review_participation": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "proof_review_participations": {
    },
  • "users": {
    },
  • "proof_reviews": {
    }
}
➔ Next to Proof Reviews