Kantata Kantata OX Knowledge Base Release Notes Status Page

Status Reports

A Status Report represents a snapshot of a Workspace's status across several categories at a moment in time. Status Reports are usually referred to Health Reports to in the UI.

Fetching a list of Status Reports

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

Request
query Parameters
created_after
string

Filter for records created after a specified datetime.

created_before
string

Filter for records created before a specified datetime.

external_reference_external_message
string

Filter the objects based on the external message of their associated external references. This is an exact match.

external_reference_external_status
string

Filter by the status of the external object in the external system.

external_reference_service_model
string

Filter by the type of the external object this external reference belongs to.

external_reference_service_model_ref
integer <int32>

Filter by the id of the external object this external reference belongs to.

external_reference_service_name
string

Filter by the name of the provider for integration.

external_reference_status
string

Filter by the status of the integration, this can be successful or fail.

has_external_references
boolean

Filter by whether or not the object has external references.

include
string

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

  • creator (User) - The user who created the status report.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • updater (User) - The user who last updated the status report.
  • workspace (Workspace) - The workspace associated with the status report.
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
updated_after
string

Filter for records updated after a specified datetime.

updated_before
string

Filter for records updated before a specified datetime.

without_external_reference_service_name
string

Exclude by the existence of an external reference with the specified service name.

workspace_id
integer <int32>

Return only status reports for the given workspace_id.

Responses
200

A list of Status Reports have been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
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/status_reports
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "status_reports": {
    },
  • "external_references": {
    },
  • "workspaces": {
    },
  • "users": {
    }
}

Creating a new Status Report

This endpoint returns structured Status Report 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 status_reports 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.

  • creator (User) - The user who created the status report.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • updater (User) - The user who last updated the status report.
  • workspace (Workspace) - The workspace associated with the status report.
Request Body schema: application/json
object
workspace_id
required
string

The ID of the project to create the status report for.

color
required
string

The status color of the overall report. Valid values: green, yellow, red.

description
required
string

The description of the overall status of the project.

Array of objects

An array of optional category statuses to report on specific aspects of a project.

object

Typically populated programmatically by a third party system via an integration, this is an optional object that holds data from an external system. It connects objects in an external system with objects in Kantata OX (for example, to connect a HubSpot Deal to a Kantata OX Project).

Responses
200

Status Report has been created.

Response Schema: application/json
count
integer <int32>
object
Array of objects
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/status_reports
Request samples
application/json
{
  • "status_report": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "status_reports": {
    },
  • "external_references": {
    },
  • "workspaces": {
    },
  • "users": {
    }
}

Fetching a single Status Report

This endpoint returns structured Status Report 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 status_reports 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.

  • creator (User) - The user who created the status report.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • updater (User) - The user who last updated the status report.
  • workspace (Workspace) - The workspace associated with the status report.
Responses
200

The Status Report has been retrieved.

Response Schema: application/json
count
integer <int32>
object
Array of objects
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/status_reports/{id}
Request samples
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "status_reports": {
    },
  • "external_references": {
    },
  • "workspaces": {
    },
  • "users": {
    }
}

Updating an existing Status Report

This endpoint returns structured Status Report 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 status_reports 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.

  • creator (User) - The user who created the status report.
  • external_references (ExternalReference) - Includes references to external integrations for this object.
  • updater (User) - The user who last updated the status report.
  • workspace (Workspace) - The workspace associated with the status report.
Request Body schema: application/json
object
color
string

The status color for for the report overall. One of green, yellow, red.

description
string

The description of the overall status of the project.

Array of objects

An array of optional category statuses to report on specific aspects of a project. Any categories not provided when updating will be deleted if they were previously present.

object

Typically populated programmatically by a third party system via an integration, this is an optional object that holds data from an external system. It connects objects in an external system with objects in Kantata OX (for example, to connect a HubSpot Deal to a Kantata OX Project).

Responses
200

Status Report has been updated.

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

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

put/status_reports/{id}
Request samples
application/json
{
  • "status_report": {
    }
}
Response samples
application/json
{
  • "count": 0,
  • "meta": {
    },
  • "results": [
    ],
  • "status_reports": {
    },
  • "external_references": {
    },
  • "workspaces": {
    },
  • "users": {
    }
}

Deleting an existing Status Report

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

Status Report has been deleted.

400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

delete/status_reports/{id}
Request samples
Response samples
application/json
{
  • "errors": [
    ]
}