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

Proof Revisions

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

Proof Revisions represents a specific version of a proof. The latest version that most operations are taken on is the current version. Associating a new ProofRevision with a proof will make it the new current revision.

Fetching a list of Proof Revisions

This endpoint returns structured Proof Revision 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_revisions 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 (Proof)
  • proof_review (ProofReview).
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.

order
string
Default: "revision_date:desc"

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: revision_date:asc and revision_date:desc.

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

A list of Proof Revisions 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_revisions
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "proof_revisions": {
    },
  • "proofs": {
    },
  • "proof_reviews": {
    }
}
Creating a new Proof Revision
This endpoint returns structured Proof Revision 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_revisions 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 (Proof)
    • 

  • proof_review (ProofReview).
    • 



 
Request Body schema: application/json
required
object
 
proof_id
required
integer <int32> 
 
attachment_id
required
integer <int32> 
The ID of the ProofAttachment associated with the revision.


 
title
string
 
Responses 
200
Proof Revision 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_revisions
Request samples 
application/json
{
  • "proof_revision": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "proof_revisions": {
    },
  • "proofs": {
    },
  • "proof_reviews": {
    }
}
Fetching a single Proof Revision
This endpoint returns structured Proof Revision 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_revisions 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 (Proof)
    • 

  • proof_review (ProofReview).
    • 



 
Responses 
200
The Proof Revision has 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_revisions/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "proof_revisions": {
    },
  • "proofs": {
    },
  • "proof_reviews": {
    }
}
Updating an existing Proof Revision
This endpoint returns structured Proof Revision 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_revisions 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 (Proof)
    • 

  • proof_review (ProofReview).
    • 



 
Request Body schema: application/json
required
object
 
title
string
 
Responses 
200
Proof Revision 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_revisions/{id}
Request samples 
application/json
{
  • "proof_revision": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "proof_revisions": {
    },
  • "proofs": {
    },
  • "proof_reviews": {
    }
}
➔ Next to Proofs