REST API

The PTT REST API’s support added for get entities, status, put status for EB, SBD, SBI and Project. There are also GET and PUT method for a resource identifier to retrieve and update the entities, retrospectively. There are also GET and PUT method for a resource identifier to retrieve and update the status of entities, retrospectively.

Once deployed, the API should be available at <HOST>/ptt/api/<MAJOR_VERSION>/<RESOURCE> and the Swagger UI at <HOST>/api/<MAJOR_VERSION>/ui. The host depends on the environment that the server is deployed to, and may include a k8s namespace - see the README for more details.

Status Propagation

The PTT system implements automatic status propagation between related entities following the hierarchy: Project → SBD → SBI → EB.

Top-Down Propagation:

• Project “Ready” → SBDs become “Ready”

• Project “Cancelled” → SBDs become “Suspended”, SBIs become “Failed”, EBs become “Failed”

Bottom-Up Propagation:

• EB “Fully Observed” → SBI becomes “Observed” → SBD becomes “Observed” → Project becomes “Observed”

• EB “Failed” → SBI becomes “Failed” → SBD becomes “Suspended” → Project becomes “Cancelled”

• SBI “Executing” → SBD becomes “In Progress” → Project becomes “Ready”

For detailed status propagation rules, see Status Propagation Rules.

API Endpoints

The PTT API endpoints, with the accepted requests and expected responses, are documented below:

GET /dev-ska-oso-ptt-services-nak-1790-status-filter-changes/ptt/api/v2/sbds

Get All SB Definition with status appended, filter by the query parameter like created_before, created_after and user namer

Auto-generated OpenAPI operation description.

Request Headers:

• X-Request-ID

Query Parameters:

• user

• match_type

• query_type

• created_before

• created_after

• last_modified_before

• last_modified_after

• entity_id

• purpose

• status

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /dev-ska-oso-ptt-services-nak-1790-status-filter-changes/ptt/api/v2/sbds/{sbd_id}

Get specific SB Definition by identifier with status appended

Auto-generated OpenAPI operation description.

Request Headers:

• X-Request-ID

Parameters:

• sbd_id (string, required)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /dev-ska-oso-ptt-services-nak-1790-status-filter-changes/ptt/api/v2/sbis

Get All SB Instance with status appended, filter by the query parameter like created_before, created_after and user name

Auto-generated OpenAPI operation description.

Request Headers:

• X-Request-ID

Query Parameters:

• user

• match_type

• query_type

• created_before

• created_after

• last_modified_before

• last_modified_after

• entity_id

• purpose

• status

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /dev-ska-oso-ptt-services-nak-1790-status-filter-changes/ptt/api/v2/sbis/{sbi_id}

Get specific SB Instance by identifier with status appended

Auto-generated OpenAPI operation description.

Request Headers:

• X-Request-ID

Parameters:

• sbi_id (string, required)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /dev-ska-oso-ptt-services-nak-1790-status-filter-changes/ptt/api/v2/ebs

Get All Execution Block with status appended, filter by the query parameter like created_before, created_after and user name

Auto-generated OpenAPI operation description.

Request Headers:

• X-Request-ID

Query Parameters:

• user

• match_type

• query_type

• created_before

• created_after

• last_modified_before

• last_modified_after

• entity_id

• purpose

• status

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /dev-ska-oso-ptt-services-nak-1790-status-filter-changes/ptt/api/v2/ebs/{eb_id}

Get specific Execution Block by identifier with status appended

Auto-generated OpenAPI operation description.

Request Headers:

• X-Request-ID

Parameters:

• eb_id (string, required)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /dev-ska-oso-ptt-services-nak-1790-status-filter-changes/ptt/api/v2/prjs

Get All Project with status appended, filter by the query parameter like created_before, created_after and user name

Auto-generated OpenAPI operation description.

Request Headers:

• X-Request-ID

Query Parameters:

• user

• match_type

• query_type

• created_before

• created_after

• last_modified_before

• last_modified_after

• entity_id

• purpose

• status

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /dev-ska-oso-ptt-services-nak-1790-status-filter-changes/ptt/api/v2/prjs/{prj_id}

Get specific Project by identifier with status appended

Auto-generated OpenAPI operation description.

Request Headers:

• X-Request-ID

Parameters:

• prj_id (string, required)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /dev-ska-oso-ptt-services-nak-1790-status-filter-changes/ptt/api/v2/entity/latest/status

Get latest status entries for entities

Auto-generated OpenAPI operation description.

Request Headers:

• X-Request-ID

Query Parameters:

• entity_id – Filter by entity ID

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /dev-ska-oso-ptt-services-nak-1790-status-filter-changes/ptt/api/v2/entity/current/status

Get current view of entity statuses

Auto-generated OpenAPI operation description.

Request Headers:

• X-Request-ID

Query Parameters:

• entity_id – Filter by entity ID

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

PUT /dev-ska-oso-ptt-services-nak-1790-status-filter-changes/ptt/api/v2/entity/{entity_id}/status

Update entity status

Auto-generated OpenAPI operation description.

Request Headers:

• X-Request-ID

Parameters:

• entity_id (string, required)

Query Parameters:

• status (string, required)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /dev-ska-oso-ptt-services-nak-1790-status-filter-changes/ptt/api/v2/entity/history

Get status history with query parameters

Auto-generated OpenAPI operation description.

Request Headers:

• X-Request-ID

Query Parameters:

• entity_id

• updated_by

• start_date

• end_date

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /dev-ska-oso-ptt-services-nak-1790-status-filter-changes/ptt/api/v2/entity/status/get_entity

Get status dictionary by the entity parameter

Auto-generated OpenAPI operation description.

Request Headers:

• X-Request-ID

Query Parameters:

• is_purpose (boolean) – Flag to get Purpose enums instead of entity status enums

• entity_name – Entity name (required when is_purpose=False)

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /dev-ska-oso-ptt-services-nak-1790-status-filter-changes/ptt/api/v2/status/stream

stream shift data for real time update to multiple users

Auto-generated OpenAPI operation description.

Request Headers:

• X-Request-ID

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error

GET /dev-ska-oso-ptt-services-nak-1790-status-filter-changes/ptt/api/v2/dashboard

Get Project Hierarchy Filtered

Auto-generated OpenAPI operation description.

Request Headers:

• X-Request-ID

Query Parameters:

• user

• match_type

• query_type

• created_before

• created_after

• last_modified_before

• last_modified_after

• entity_id

• purpose

• status

Status Codes:

• 200 OK – Successful Response

• 422 Unprocessable Entity – Validation Error