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

External References

External References allows users see which objects (one of Assignment, CustomField, CustomFieldChoice, CustomFieldSet, CustomFieldValue, Estimate, EstimateScenario, EstimateScenarioResource, Expense, Invoice, Participation, Post, RateCard, Role, Skill, StatusReport, Story, StoryAllocationDay, Submission, SurveyAnswer, SurveyQuestion, SurveyResponse, SurveyTemplate, TimeEntry, TimeOffEntry, User, Vendor, Workspace, WorkspaceAllocation, WorkspaceGroup, or WorkspaceResource are synced with third party systems. This allows you to view the sync status of items in addition to the integration specifics for a synced object.

Objects that are synced with a third party system have external integration attributes that include the corresponding ID of the third-party object with which it is synced, a link that allows you to view the object in the third party system, the status of the external object in the external system, the status of the sync, and a link to exceptions.

Fetches all external references on a user's account

Returns external references, for objects of particular types, that are synced with the third-party systems.

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

Request
query Parameters
subject_type
required
string

The type of the Kantata OX object that has the external reference. One of Assignment, CustomField, CustomFieldChoice, CustomFieldSet, CustomFieldValue, Estimate, EstimateScenario, EstimateScenarioResource, Expense, Invoice, Participation, Post, RateCard, Role, Skill, StatusReport, Story, StoryAllocationDay, Submission, SurveyAnswer, SurveyQuestion, SurveyResponse, SurveyTemplate, TimeEntry, TimeOffEntry, User, Vendor, Workspace, WorkspaceAllocation, WorkspaceGroup, or WorkspaceResource.

created_after
string <date-time>

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_before
string <date-time>

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

external_message
string

Only include external references with the specified external message.

external_status
string

The status of the external object in the external system.

include
string

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

  • subject (polymorphic) - The item with which the external reference is associated.
last_synced_after
string <date-time>

Filter for records last synced after a specified datetime. The datetime must be in ISO 8601 format.

last_synced_before
string <date-time>

Filter for records last synced before a specified datetime. The datetime must be in ISO 8601 format.

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

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

Valid values: created_at:asc, created_at:desc, last_synced_at:asc, and last_synced_at:desc.

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

The type of the external object.

service_model_ref
string

The object ID of an external object.

service_name
string

The provider name of the integration.

status
string

The status of the integration. Options are 'pending', 'successful', or 'failed'.

subject_id
integer <int32>

The ID of the Kantata OX object that has the external reference.

updated_after
string <date-time>

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_before
string <date-time>

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

Responses
200

A list of External References have been retrieved.

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

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/external_references
Request samples 
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "external_references": {
    },
  • "assignments": {
    },
  • "custom_fields": {
    },
  • "custom_field_choices": {
    },
  • "custom_field_sets": {
    },
  • "custom_field_values": {
    },
  • "estimates": {
    },
  • "estimate_scenarios": {
    },
  • "estimate_scenario_resources": {
    },
  • "expenses": {
    },
  • "invoices": {
    },
  • "participations": {
    },
  • "posts": {
    },
  • "rate_cards": {
    },
  • "roles": {
    },
  • "skills": {
    },
  • "status_reports": {
    },
  • "stories": {
    },
  • "story_allocation_days": {
    },
  • "submissions": {
    },
  • "survey_answers": {
    },
  • "survey_questions": {
    },
  • "survey_responses": {
    },
  • "survey_templates": {
    },
  • "time_entries": {
    },
  • "time_off_entries": {
    },
  • "users": {
    },
  • "vendors": {
    },
  • "workspaces": {
    },
  • "workspace_allocations": {
    },
  • "workspace_groups": {
    },
  • "workspace_resources": {
    }
}
Create or update an external reference
This endpoint returns structured External Reference 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 external_references 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.


    

  • subject (polymorphic) - The item with which the external reference is associated.
    • 



 
Request Body schema: application/json
required
object
 
subject_type
required
string
The type of the Kantata OX object to which this external reference belongs.
One of Assignment, CustomField, CustomFieldChoice, CustomFieldSet, CustomFieldValue, Estimate, EstimateScenario, EstimateScenarioResource, Expense, Invoice, Participation, Post, RateCard, Role, Skill, StatusReport, Story, StoryAllocationDay, Submission, SurveyAnswer, SurveyQuestion, SurveyResponse, SurveyTemplate, TimeEntry, TimeOffEntry, User, Vendor, Workspace, WorkspaceAllocation, WorkspaceGroup, or WorkspaceResource.


 
subject_id
required
integer <int32> 
The ID of the Kantata OX object to which this external reference belongs.


 
service_name
required
string
The provider name of the integration.


 
service_model
required
string
The type of the external object to which this reference belongs.


 
service_model_ref
required
string
The ID of the external object to which this external reference belongs.


 
status
string
The status of the integration. Options are 'pending', 'successful', or 'failed'.


 
external_link
required
string
A URL that links to either the external object or event.


 
external_status
string
The status of the external object in the external system.


 
external_message
string
An optional message about the external object.


 
locked
boolean
An optional field, indicates whether the subject should be locked. To prevent changes
to the object in Kantata OX, set this to true. This currently only applies to expense
report rejections.


 
Responses 
200
External Reference has been created.


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


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


post/external_references/create_or_update
Request samples 
application/json
{
  • "external_reference": {
    }
}
Response samples 
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "external_references": {
    },
  • "assignments": {
    },
  • "custom_fields": {
    },
  • "custom_field_choices": {
    },
  • "custom_field_sets": {
    },
  • "custom_field_values": {
    },
  • "estimates": {
    },
  • "estimate_scenarios": {
    },
  • "estimate_scenario_resources": {
    },
  • "expenses": {
    },
  • "invoices": {
    },
  • "participations": {
    },
  • "posts": {
    },
  • "rate_cards": {
    },
  • "roles": {
    },
  • "skills": {
    },
  • "status_reports": {
    },
  • "stories": {
    },
  • "story_allocation_days": {
    },
  • "submissions": {
    },
  • "survey_answers": {
    },
  • "survey_questions": {
    },
  • "survey_responses": {
    },
  • "survey_templates": {
    },
  • "time_entries": {
    },
  • "time_off_entries": {
    },
  • "users": {
    },
  • "vendors": {
    },
  • "workspaces": {
    },
  • "workspace_allocations": {
    },
  • "workspace_groups": {
    },
  • "workspace_resources": {
    }
}
Deleting an existing External Reference
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
External Reference has been deleted.


400
Bad Request


401
Unauthorized request


403
Forbidden request


404
Page Not Found


422
Unprocessable Entity


503
Service is unavailable


delete/external_references/{id}
Request samples 
Response samples 
application/json
{
  • "errors": [
    ]
}
➔ Next to Exchange Tables