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 Archetypes API

Endpoint for archetype-related services, including listing and getting archetypes.

Ocean Health Systems Archetypes 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 Archetypes. 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 14 operations across 11 paths, and defines 2 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.

14 operations 11 paths 2 schemas 1 DELETE11 GET1 POST1 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 Archetypes 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 14

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

Archetypes 14

Endpoint for archetype-related services, including listing and getting archetypes.

GET
/archetypes/{cid-archetype}/hash
Gets the (non-canonical) MD5 hash of the specified archetype in ADL format
getArchetypeADLHash 4 params → 200400404
GET
/archetypes/{cid-archetype}/parent
Gets main data about the specified archetype's parent archetype, if any
getParentArchetype 1 param → 200204400404
GET
/archetypes/citeable-identifier/{archetype-id}
Gets the citeable identifier of an archetype based on the specified archetype id
getCiteableIdentifierForArchetypeId 1 param → 200400404
GET
/archetypes/{cid-archetype}/status
Gets the current status of the archetype in CKM
getCurrentArchetypeStatus 1 param → 200400403404
GET
/archetypes/{cid-archetype}/status/{asset-version}
Gets the status of the archetype in CKM for the specified asset version (i.e.
getArchetypeStatusAtVersion 2 params → 200400403404
GET
/archetypes/{cid-archetype}/project
Gets the CKM project of the archetype
getProjectOfArchetype 1 param → 200400404
GET
/archetypes
Lists a selection of archetypes in CKM
listArchetypes 16 params → 200400
POST
/archetypes
Imports a new archetype into a CKM project.
importArchetype 2 params body → 201400403
GET
/archetypes/{cid-archetype}
Gets the main data of one archetype
getArchetypeAsCKMResource 5 params → 200400404
PUT
/archetypes/{cid-archetype}
Updates the stated archetype on the trunk.
updateArchetypeOnTrunk 4 params body → 200400403404412
DELETE
/archetypes/{cid-archetype}
PERMANENTLY and IRREVOCABLY DELETES the specified archetype in CKM.
deleteArchetype 3 params → 204400403404
GET
/archetypes/{cid-archetype}/adl
Gets the specified archetype in ADL format
getArchetypeInADL 4 params → 200400404
GET
/archetypes/{cid-archetype}/xml
Gets the specified archetype in XML format
getArchetypeInXML 4 params → 200400404
GET
/archetypes/{cid-archetype}/mindmap
Get archetype mindmap
getArchetypeMindmap 6 params → 200400404

Schemas 2

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

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-archetypes-api-openapi.yml Raw ↑

Other APIs Ocean Health Systems publishes across the network.

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 Templates API
Ocean Health Systems Users API
Where this information came from

This is an independent, third-party profile of Ocean Health Systems Archetypes 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.