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

Backup Approver Associations

A Backup Approver Association represents the relationship of a delegated approver to a range of specific dates. Approval responsibilities are delegated to a backup approver.

Fetching a list of Backup Approver Associations

The index endpoint only returns backup approver associations that are visible to the user. Backup approver associations are only visible to account members.

This endpoint returns structured Backup Approver Association 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 backup_approver_associations 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.

  • approver (User) - The user who would normally approve time.
  • backup_approver (User) - The user who will be approving time in place of the normal approver.
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 Backup Approver Associations have been retrieved.

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

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/backup_approver_associations
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "backup_approver_associations": {
    },
  • "users": {
    }
}
Creating a new Backup Approver Association
This endpoint returns structured Backup Approver Association 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 backup_approver_associations 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.


    

  • approver (User) - The user who would normally approve time.
    • 

  • backup_approver (User) - The user who will be approving time in place of the normal approver.
    • 



 
Request Body schema: application/json
required
object
 
backup_approver_id
required
integer <int32> 
The ID of the user designated as backup approver.


 
approver_id
required
integer <int32> 
The ID of the user designated as the approver.


 
start_date
required
string <date> 
The start date on which the approver and backup approver are current. The date must be in ISO 8601 format.


 
end_date
required
string <date> 
The end date on which the approver and backup approver are current. The date must be in ISO 8601 format.


 
Responses 
200
Backup Approver Association has been created.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/backup_approver_associations
Request samples 
application/json
{
  • "backup_approver_association": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "backup_approver_associations": {
    },
  • "users": {
    }
}
Fetching a single Backup Approver Association
This endpoint returns structured Backup Approver Association 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 backup_approver_associations 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.


    

  • approver (User) - The user who would normally approve time.
    • 

  • backup_approver (User) - The user who will be approving time in place of the normal approver.
    • 



 
Responses 
200
The Backup Approver Association has been retrieved.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


get/backup_approver_associations/{id}
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "backup_approver_associations": {
    },
  • "users": {
    }
}
Updating an existing Backup Approver Association
This endpoint returns structured Backup Approver Association 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 backup_approver_associations 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.


    

  • approver (User) - The user who would normally approve time.
    • 

  • backup_approver (User) - The user who will be approving time in place of the normal approver.
    • 



 
Request Body schema: application/json
required
object
 
backup_approver_id
integer <int32> 
The ID of the user designated as backup approver.


 
approver_id
integer <int32> 
The ID of the user designated as the approver.


 
start_date
string <date> 
The start date on which the approver and backup approver are current. The date must be in ISO 8601 format.


 
end_date
string <date> 
The end date on which the approver and backup approver are current. The date must be in ISO 8601 format.


 
Responses 
200
Backup Approver Association has been updated.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


put/backup_approver_associations/{id}
Request samples 
application/json
{
  • "backup_approver_association": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "backup_approver_associations": {
    },
  • "users": {
    }
}
Deleting an existing Backup Approver Association
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
Backup Approver Association has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/backup_approver_associations/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Billable Utilizations