How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ocean Health Systems Templates API

Endpoint for template-related services, including listing and getting templates.

Ocean Health Systems Templates API is one of 9 APIs that Ocean Health Systems publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Templates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and rate-limit docs.

This API exposes 17 operations across 13 paths, and defines 3 schemas. It is described by OpenAPI 3.2.0, at version 1.6.0.

Requests are made against a single base URL, /ckm/rest/v1.

17 operations 13 paths 3 schemas 1 DELETE12 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.6.0
Base URL
https://ckm.openehr.org/ckm/rest/v1
Authentication
API Key, HTTP Basic
Resource Areas
1

Authentication & Security 2

Ocean Health Systems Templates API declares 2 security schemes for authenticating requests. An API key is passed in the header as JSESSIONID (sessionid). It accepts HTTP basic authentication (basicAuth).

  • sessionid — Once the session id is known, it can be used for authentication until expired. The provided session id is used (and validated) on making an actual request.
  • basicAuth — Basic authentification using the CKM username and password. The provided credentials are used (and validated) on making an actual request.

Paths & Operations 17

Across 13 paths, the API surfaces 17 operations — 1 DELETE, 12 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Templates 17

Endpoint for template-related services, including listing and getting templates.

GET
/templates
Lists all or a selection of templates in CKM
listTemplates 16 params → 200400
POST
/templates
Imports a new template into a CKM project.
importTemplate 4 params body → 201400403424
GET
/templates/{cid-template}
Gets the main data of one template
getTemplateAsCKMResource 3 params → 200400404
PUT
/templates/{cid-template}
Updates the specified template on the trunk.
updateTemplateOnTrunk 6 params body → 200400403404412424
DELETE
/templates/{cid-template}
PERMANENTLY and IRREVOCABLY DELETES the specified template in CKM.
deleteTemplate 3 params → 204400403404
GET
/templates/{cid-template}/embedded-templates
Lists the templates embedded in the specified template, if any
listEmbeddedTemplates 4 params → 200400404
GET
/templates/{cid-template}/required-archetypes
Lists the archetypes required for (i.e. used by) the specified template
listRequiredArchetypesForTemplate 4 params → 200400404
GET
/templates/{cid-template}/oet
Gets the specified template in OET format
getTemplateOET 3 params → 200400404
GET
/templates/{cid-template}/opt
Gets the operational template (OPT) for the specified template
getTemplateOPT 3 params → 200400404
GET
/templates/{cid-template}/hash
Gets the MD5 hash of the specified template in OET format
getTemplateOETHash 3 params → 200400404
GET
/templates/{cid-template}/file-set-url
Gets the URL for a file set of the template.
getTemplateFileSetURL 3 params → 200400404
GET
/templates/{cid-template}/status
Gets the current status of the template in CKM
getCurrentTemplateStatus 1 param → 200400403404
PUT
/templates/{cid-template}/status
Updates the status of the specified trunk template
updateTemplateStatus 5 params → 200400403404412
POST
/templates/validation-report
Gets CKM's template validation report for the template provided as OET.
getValidationReportForTemplate 1 param body → 200400401403
GET
/templates/{cid-template}/status/{asset-version}
Gets the status of the template in CKM for the specified asset version (i.e.
getTemplateStatusAtVersion 2 params → 200400403404
GET
/templates/{cid-template}/project
Gets the CKM project of the template
getProjectOfTemplate 1 param → 200400404
GET
/templates/citeable-identifier/{template-id}
Gets the citeable identifier of a template based on the specified template id
getCiteableIdentifierForTemplateId 1 param → 200400404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are TemplateValidationItem (21 properties), CkmResource (20 properties), Project (9 properties). Each schema is shown below with its type and property counts.

TemplateValidationItem
object
21 properties
Project
object
9 properties
CkmResource
object
Contains the relevant main data to describe a CKM resource such as an archetype or a template.
20 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ocean-health-systems-templates-api-openapi.yml Raw ↑

Other APIs Ocean Health Systems publishes across the network.

Ocean Health Systems Archetypes API
Ocean Health Systems Change Requests API
Ocean Health Systems Projects API
Ocean Health Systems Resource Proposals API
Ocean Health Systems Resources API
Ocean Health Systems Sessions API
Ocean Health Systems Subdomains API
Ocean Health Systems Users API
Where this information came from

This is an independent, third-party profile of Ocean Health Systems Templates API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.