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

Proofs

Proofs represent an asset that has been uploaded for review. Proofs belong to a Story (Task) and can have many Proof Revisions and one current revision which represents the most recent Revision made to the Proof.

Fetching a list of Proofs

Proofs are assets, belonging to a task that has been uploaded for review. Although they can have several revisions, proofs only have a single current revision.

This endpoint returns structured Proof 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 proofs top-level JSON key. Please see our Response Format section for more information.

Request
query Parameters
by_story
integer <int32>

By proofs associated to a task.

by_workspace
integer <int32>

By proofs associated to a project (through their tasks).

include
string

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

  • current_revision (ProofRevision)
  • revisions (ProofRevision)
  • story (Story).
matching
string

By matching title.

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: "created_at:desc"

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

Valid values: associated_task:asc, associated_task:desc, created_at:asc, created_at:desc, creator_name:asc, creator_name:desc, revision_date:asc, revision_date:desc, title:asc, and title:desc.

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

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


    

  • current_revision (ProofRevision)
    • 

  • revisions (ProofRevision)
    • 

  • story (Story).
    • 



 
Request Body schema: application/json
required
object
 
story_id
required
string
The task to which the proof will be added.


 
attachment_id
required
string
The attachment the proof references.


 
title
required
string
The title of the proof.


 
Responses 
200
Proof 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/proofs
Request samples 
application/json
{
  • "proof": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "proofs": {
    },
  • "stories": {
    },
  • "proof_revisions": {
    }
}
Fetching a single Proof
This endpoint returns structured Proof 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 proofs 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.


    

  • current_revision (ProofRevision)
    • 

  • revisions (ProofRevision)
    • 

  • story (Story).
    • 



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


    

  • current_revision (ProofRevision)
    • 

  • revisions (ProofRevision)
    • 

  • story (Story).
    • 



 
Request Body schema: application/json
required
object
 
title
required
string
The title of the proof.


 
Responses 
200
Proof 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/proofs/{id}
Request samples 
application/json
{
  • "proof": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "proofs": {
    },
  • "stories": {
    },
  • "proof_revisions": {
    }
}
Deleting an existing Proof
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 has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/proofs/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Activations