{"swagger":"2.0","info":{"description":"REST API for the Clinical Knowledge Manager.","version":"1.6.0","title":"CKM REST API","contact":{"name":"CKM Support","url":"https://oceanehr.atlassian.net/servicedesk/customer/portal/15","email":"ckm@oceaninformatics.com"}},"basePath":"/ckm/rest/v1","tags":[{"name":"Archetypes","description":"Endpoint for archetype-related services, including listing and getting archetypes."},{"name":"Templates","description":"Endpoint for template-related services, including listing and getting templates."},{"name":"Resources","description":"Endpoint for generic resources, including archetypes and templates. May sometimes be easier to use."},{"name":"Projects","description":"Endpoint for project-related services, including listing and getting projects."},{"name":"Subdomains","description":"Endpoint for subdomain-related services, including listing and getting subdomains."},{"name":"Change Requests","description":"Endpoint for change request-related services, including listing and getting change requests."},{"name":"Resource Proposals","description":"Endpoint for resource proposal-related services, including listing and getting resource proposals."},{"name":"Users","description":"Endpoint for user-related services, including creating new users as an admin."},{"name":"Sessions","description":"Endpoint for creating a new user session or signing out."}],"paths":{"/archetypes/{cid-archetype}/hash":{"get":{"tags":["Archetypes"],"summary":"Gets the (non-canonical) MD5 hash of the specified archetype in ADL format.","description":"","operationId":"getArchetypeADLHash","produces":["text/plain"],"parameters":[{"name":"cid-archetype","in":"path","description":"The citeable identifier of the archetype.","required":true,"type":"string"},{"name":"asset-version","in":"query","description":"The asset version of the archetype. Defaults to the latest.","required":false,"type":"integer","format":"int32"},{"name":"semantic-version","in":"query","description":"The semantic version of the archetype, for example 1.0.1 or 1.0.2-alpha. Only one, either the asset version or the semantic version, can be provided. Providing both will cause an error, and if neither is provided, the latest version will be used by default.","required":false,"type":"string"},{"name":"get-latest-published","in":"query","description":"If set to true, the latest published revision of the archetype is retrieved. If the resource has never been published a 404 error code is returned. If get-latest-published is set to true, the asset-version and semantic-version must not be specified. Defaults to false.","required":false,"type":"boolean","default":false}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the archetype's hash of the ADL."},"400":{"description":"General bad request."},"404":{"description":"An archetype with the provided citeable identifier (cid-archetype) does not exist or does not exist in the specified asset-version, semantic-version or (in case of get-latest-published) has never been published. Alternatively, the archetype may not be accessible based on the provided credentials."}}}},"/archetypes/{cid-archetype}/parent":{"get":{"tags":["Archetypes"],"summary":"Gets main data about the specified archetype's parent archetype, if any.","description":"","operationId":"getParentArchetype","produces":["application/xml","application/json"],"parameters":[{"name":"cid-archetype","in":"path","description":"The citeable identifier of the archetype.","required":true,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the archetype's parent.","schema":{"$ref":"#/definitions/CkmResource"}},"204":{"description":"The specified archetype was found, but it has no parent because it is not specialised. 204 is the sibling code for 200 OK, but without a response body."},"400":{"description":"General bad request."},"404":{"description":"An archetype with the provided citeable identifier (cid-archetype) does not exist or does not exist in the specified asset-version, semantic-version or (in case of get-latest-published) has never been published. Alternatively, the archetype may not be accessible based on the provided credentials."}}}},"/archetypes/citeable-identifier/{archetype-id}":{"get":{"tags":["Archetypes"],"summary":"Gets the citeable identifier of an archetype based on the specified archetype id.","description":"","operationId":"getCiteableIdentifierForArchetypeId","produces":["text/plain"],"parameters":[{"name":"archetype-id","in":"path","description":"The archetype id of the archetype.","required":true,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the archetype's citeable identifier.","schema":{"type":"string"}},"400":{"description":"General bad request."},"404":{"description":"An archetype with the provided archetype-id does not exist or is not accessible based on the provided credentials."}}}},"/archetypes/{cid-archetype}/status":{"get":{"tags":["Archetypes"],"summary":"Gets the current status of the archetype in CKM.","description":"","operationId":"getCurrentArchetypeStatus","produces":["text/plain"],"parameters":[{"name":"cid-archetype","in":"path","description":"The citeable identifier of the archetype.","required":true,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the archetype's current status.","schema":{"type":"string","enum":["INITIAL","DRAFT","TEAMREVIEW","REVIEWSUSPENDED","RELEASECANDIDATE","PUBLISHED","REASSESS_DRAFT","REASSESS_TEAMREVIEW","REASSESS_REVIEWSUSPENDED","REJECTED","DEPRECATED"]}},"400":{"description":"General bad request."},"403":{"description":"Forbidden - the specified archetype does not have a status (branch archetype)."},"404":{"description":"The archetype could not be found (based on the provided credentials, if any)."}}}},"/archetypes/{cid-archetype}/status/{asset-version}":{"get":{"tags":["Archetypes"],"summary":"Gets the status of the archetype in CKM for the specified asset version (i.e. revision).","description":"","operationId":"getArchetypeStatusAtVersion","produces":["text/plain"],"parameters":[{"name":"cid-archetype","in":"path","description":"The citeable identifier of the archetype.","required":true,"type":"string"},{"name":"asset-version","in":"path","description":"The asset version of the archetype.","required":true,"type":"integer","format":"int32"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the archetype's status at the specified asset-version.","schema":{"type":"string","enum":["INITIAL","DRAFT","TEAMREVIEW","REVIEWSUSPENDED","RELEASECANDIDATE","PUBLISHED","REASSESS_DRAFT","REASSESS_TEAMREVIEW","REASSESS_REVIEWSUSPENDED","REJECTED","DEPRECATED"]}},"400":{"description":"General bad request."},"403":{"description":"Forbidden - the specified archetype does not have a status (branch archetype)."},"404":{"description":"The archetype could not be found (based on the provided credentials), or the archetype could not be found in the stated asset-version."}}}},"/archetypes/{cid-archetype}/project":{"get":{"tags":["Archetypes"],"summary":"Gets the CKM project of the archetype.","description":"","operationId":"getProjectOfArchetype","produces":["application/xml","application/json"],"parameters":[{"name":"cid-archetype","in":"path","description":"The citeable identifier of the archetype.","required":true,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the archetype's project.","schema":{"$ref":"#/definitions/Project"}},"400":{"description":"General bad request."},"404":{"description":"Archetype with provided citeable identifier (cid-archetype) does not exist or is not accessible based on the provided credentials or is not a trunk archetype."}}}},"/archetypes":{"get":{"tags":["Archetypes"],"summary":"Lists a selection of archetypes in CKM.","description":"","operationId":"listArchetypes","produces":["application/xml","application/json"],"parameters":[{"name":"cid-subdomain","in":"query","description":"Set to only list archetypes of the specified subdomain.","required":false,"type":"string"},{"name":"cid-project","in":"query","description":"Set to only list archetypes of the specified project.","required":false,"type":"string"},{"name":"project-type","in":"query","description":"Set to only list archetypes in projects of this type. Also note the 'owned-only' param.","required":false,"type":"string","enum":["PROJECT","INCUBATOR"]},{"name":"owned-only","in":"query","description":"Set to true to only list archetypes that are owned by the specified project/any projects of the specified project-type/any projects of the specified subdomain. Set to false (DEFAULT) to include archetypes referenced by the project(s) as well.","required":false,"type":"boolean","default":false},{"name":"search-text","in":"query","description":"Set to only list archetypes with this search text in the archetype meta data.","required":false,"type":"string"},{"name":"restrict-search-to-main-data","in":"query","description":"Restrict search to main data of the archetype. If true, ONLY finds the search text in archetype id, concept name, and descriptive data such as author, purpose, use, misuse, keywords. If false, includes all meta data, the archetype definition, and the archetype's ontology in the search. Defaults to false (=non-restricted).","required":false,"type":"boolean","default":false},{"name":"require-all-search-words","in":"query","description":"If multiple search words, should ALL words be required (true = DEFAULT), or is ANY sufficient (false).","required":false,"type":"boolean","default":true},{"name":"resource-state","in":"query","description":"Set to only list archetypes with the states resource states. Defaults to all active resource states, i.e. all states except REJECTED and DEPRECATED.","required":false,"type":"array","items":{"type":"string","enum":["INITIAL","DRAFT","TEAMREVIEW","REVIEWSUSPENDED","PUBLISHED","REASSESS_DRAFT","REASSESS_TEAMREVIEW","REASSESS_REVIEWSUSPENDED","REJECTED","DEPRECATED"]},"collectionFormat":"multi"},{"name":"class","in":"query","description":"Set to only list archetypes that are classified in/indexed with the specified scheme + class (term). Usage: scheme:class/subclass, where scheme, class and subclasses must be written exactly as is in the original language (no translations). The scheme is separated from the class using \":\" and subclasses are separated by \"/\". For example: Health Domain:Surgery/General Surgery. If a slash \"/\" is used in a class name itself, this must be replaced with a pipe symbol \"|\". For the language scheme, simply use the available ISO 639-1 language codes (2 digits), e.g. 'en', 'nb',  or 'de'. For regional variants, use e.g.: 'en/en-au'.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"require-all-classes","in":"query","description":"If multiple classes (terms) have been specified, should ALL be required (true), or is ANY sufficient (false = DEFAULT).","required":false,"type":"boolean","default":false},{"name":"include-subclasses","in":"query","description":"If one or more classes (terms) have been specified, should subclasses be included (true) or not (false = DEFAULT).","required":false,"type":"boolean","default":false},{"name":"start-date","in":"query","description":"Set to only list archetypes last modified on or after this date/time.Expected date format is the ISO Date Time format, e.g. 2025-03-02T10:15:30+01:00. If the timezone offset is omitted (e.g. 2025-03-02T10:15:30), the server timezone offset is used. If, in addition, the time is omitted (2025-03-02), this defaults to the start of the specified day in the server timezone offset.","required":false,"type":"string"},{"name":"end-date","in":"query","description":"Set to only list archetypes modified up to the specified date/time. Expected date format is the ISO Date Time format, e.g. 2025-03-02T10:15:30+01:00. If the timezone offset is omitted (e.g. 2025-03-02T10:15:30), the server timezone offset is used. If, in addition, the time is omitted (2025-03-02), this defaults to the start(!) of the specified day in the server timezone offset.","required":false,"type":"string"},{"name":"language","in":"query","description":"The preferred language to retrieve the archetype concept names in, eg. 'en' or 'de'. Defaults to the server language. Automatic fallbacks.","required":false,"type":"string"},{"name":"size","in":"query","description":"The maximum number of archetypes returned in the call. <b>Defaults to 20.</b> Response header contains x-total-count to indicate the total number of results. The size should not be set too high - offset can be used to retrieve further results.","required":false,"type":"integer","default":20,"format":"int32"},{"name":"offset","in":"query","description":"The offset when not listing all archetypes. Defaults to 0, i.e. starting with the first archetype.","required":false,"type":"integer","format":"int32"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the main data of all requested archetypes.","schema":{"type":"array","items":{"$ref":"#/definitions/CkmResource"}}},"400":{"description":"General bad request."}}},"post":{"tags":["Archetypes"],"summary":"Imports a new archetype into a CKM project.  Archetypes are imported using the import type \"Create new archetype\". Therefore, if you want to create a fork of the archetype, please upload the archetype using the CKM User Interface, because copyright and references may need to be adapted manually.","description":"","operationId":"importArchetype","consumes":["text/plain"],"produces":["application/xml","application/json"],"parameters":[{"in":"body","name":"body","description":"The complete ADL serialisation as a string.","required":true,"schema":{"type":"string"}},{"name":"cid-project","in":"query","description":"The citeable identifier of the project to import the new archetype into.","required":true,"type":"string"},{"name":"log-message","in":"query","description":"A log message for the import.","required":true,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"201":{"description":"Successful import of the new archetype.","schema":{"$ref":"#/definitions/CkmResource"}},"400":{"description":"General bad request, such as that the provided ADL format is invalid (unparsable) or there were fatal validation errors. Provided project may not be valid."},"403":{"description":"Forbidden to import this archetype for one of many reasons. For example: archetype with the provided archetype id already exists in CKM. Or the user is not allowed to upload to the stated project based on the provided credentials. "}}}},"/archetypes/{cid-archetype}":{"get":{"tags":["Archetypes"],"summary":"Gets the main data of one archetype.","description":"","operationId":"getArchetypeAsCKMResource","produces":["application/xml","application/json"],"parameters":[{"name":"cid-archetype","in":"path","description":"The citeable identifier of the archetype.","required":true,"type":"string"},{"name":"asset-version","in":"query","description":"The asset version of the archetype. Defaults to the latest.","required":false,"type":"integer","format":"int32"},{"name":"semantic-version","in":"query","description":"The semantic version of the archetype, for example 1.0.1 or 1.0.2-alpha. Only one, either the asset version or the semantic version, can be provided. Providing both will cause an error, and if neither is provided, the latest version will be used by default.","required":false,"type":"string"},{"name":"get-latest-published","in":"query","description":"If set to true, the latest published revision of the archetype is retrieved. If the resource has never been published a 404 error code is returned. If get-latest-published is set to true, the asset-version and semantic-version must not be specified. Defaults to false.","required":false,"type":"boolean","default":false},{"name":"language","in":"query","description":"The preferred language to retrieve the concept name in. Defaults to the server language. Automatic fallbacks.","required":false,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the archetype's main data.","schema":{"$ref":"#/definitions/CkmResource"}},"400":{"description":"General bad request."},"404":{"description":"An archetype with the provided citeable identifier (cid-archetype) does not exist or does not exist in the specified asset-version, semantic-version or (in case of get-latest-published) has never been published. Alternatively, the archetype may not be accessible based on the provided credentials."}}},"put":{"tags":["Archetypes"],"summary":"Updates the stated archetype on the trunk. NB: Only archetypes that have NOT been published can be updated using the API. The submitted archetype MUST NOT change the current copyright or original namespace. The submitted archetype MUST NOT be identical to the current revision of the archetype. Manual upload via the CKM interface is required in these cases.","description":"","operationId":"updateArchetypeOnTrunk","consumes":["text/plain"],"produces":["application/xml","application/json"],"parameters":[{"in":"body","name":"body","description":"The complete ADL serialisation as a string.","required":true,"schema":{"type":"string"}},{"name":"cid-archetype","in":"path","description":"The citeable identifier of the archetype.","required":true,"type":"string"},{"name":"log-message","in":"query","description":"A log message describing the update.","required":true,"type":"string"},{"name":"if-match","in":"header","description":"If this header is set, it must match the current asset-version of the resource in CKM. Otherwise the import is cancelled with a 412 (Precondition failed) error.","required":false,"type":"string"},{"name":"if-unmodified-since","in":"header","description":"If this header is set, the newest asset version of the resource must be older than the specified date. Otherwise the import is cancelled with a 412 (Precondition failed) error.<br/> Expected date format is the ISO Date Time format, e.g. 2025-03-02T10:15:30+01:00. If the timezone offset is omitted (e.g. 2025-03-02T10:15:30), the server timezone offset is used. If, in addition, the time is omitted (2025-03-02), this defaults to the start of the specified day in the server timezone offset.","required":false,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful update of the archetype.","schema":{"$ref":"#/definitions/CkmResource"}},"400":{"description":"General bad request, such as that the ADL format is invalid."},"403":{"description":"Forbidden to update this archetype for one of various reasons. For example, the user may not be allowed to upload to the archetype's project based on the provided credentials. Or, the provided archetype has changes that are not allowed to be submitted via the API (copyright changes, original namespace change, identical archetype) or would update a published archetype."},"404":{"description":"Archetype with provided citeable identifier and/or archetype id does not exist."},"412":{"description":"Precondition failed. A provided if-match or if-unmodified-since header precondition fails. This means the optimistic locking approach has found an update to the resource afterwards and has thus prevented the update."}}},"delete":{"tags":["Archetypes"],"summary":"PERMANENTLY and IRREVOCABLY DELETES the specified archetype in CKM. For a trunk archetype, this will also PERMANENTLY DESTROY EVERYTHING that depends on this resource, including its branches, review rounds, individual reviews, discussion comments, documents from the resource's resource centre, tasks from its to do list, change requests, etc.","description":"","operationId":"deleteArchetype","produces":["application/xml","application/json"],"parameters":[{"name":"cid-archetype","in":"path","description":"The citeable identifier of the archetype.","required":true,"type":"string"},{"name":"delete-if-trunk","in":"query","description":"True to delete even if the specified cid refers to a trunk archetype. This will also delete all branches PERMANENTLY DESTROY EVERYTHING that depends on this resource, including its branches, review rounds, individual reviews, discussion comments, documents from the resource's resource centre, tasks from its to do list, change requests, etc. False to only proceed if the specified cid refers to a branch of an archetype.","required":false,"type":"boolean","default":false},{"name":"delete-if-published","in":"query","description":"True to delete even if the specified archetype is or has previously been PUBLISHED.","required":false,"type":"boolean","default":false}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"204":{"description":"Successful deletion of the archetype."},"400":{"description":"General bad request."},"403":{"description":"Forbidden - the specified archetype cannot be deleted with the provided credentials or because there are other restrictions or dependencies."},"404":{"description":"The archetype could not be found (based on the provided credentials, if any)."}}}},"/archetypes/{cid-archetype}/adl":{"get":{"tags":["Archetypes"],"summary":"Gets the specified archetype in ADL format.","description":"","operationId":"getArchetypeInADL","produces":["text/plain"],"parameters":[{"name":"cid-archetype","in":"path","description":"The citeable identifier of the archetype.","required":true,"type":"string"},{"name":"asset-version","in":"query","description":"The asset version of the archetype. Defaults to the latest.","required":false,"type":"integer","format":"int32"},{"name":"semantic-version","in":"query","description":"The semantic version of the archetype, for example 1.0.1 or 1.0.2-alpha. Only one, either the asset version or the semantic version, can be provided. Providing both will cause an error, and if neither is provided, the latest version will be used by default.","required":false,"type":"string"},{"name":"get-latest-published","in":"query","description":"If set to true, the latest published revision of the archetype is retrieved. If the resource has never been published a 404 error code is returned. If get-latest-published is set to true, the asset-version and semantic-version must not be specified. Defaults to false.","required":false,"type":"boolean","default":false}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the archetype's ADL."},"400":{"description":"General bad request."},"404":{"description":"An archetype with the provided citeable identifier (cid-archetype) does not exist or does not exist in the specified asset-version, semantic-version or (in case of get-latest-published) has never been published. Alternatively, the archetype may not be accessible based on the provided credentials."}}}},"/archetypes/{cid-archetype}/xml":{"get":{"tags":["Archetypes"],"summary":"Gets the specified archetype in XML format.","description":"","operationId":"getArchetypeInXML","produces":["application/xml"],"parameters":[{"name":"cid-archetype","in":"path","description":"The citeable identifier of the archetype.","required":true,"type":"string"},{"name":"asset-version","in":"query","description":"The asset version of the archetype. Defaults to the latest.","required":false,"type":"integer","format":"int32"},{"name":"semantic-version","in":"query","description":"The semantic version of the archetype, for example 1.0.1 or 1.0.2-alpha. Only one, either the asset version or the semantic version, can be provided. Providing both will cause an error, and if neither is provided, the latest version will be used by default.","required":false,"type":"string"},{"name":"get-latest-published","in":"query","description":"If set to true, the latest published revision of the archetype is retrieved. If the resource has never been published a 404 error code is returned. If get-latest-published is set to true, the asset-version and semantic-version must not be specified. Defaults to false.","required":false,"type":"boolean","default":false}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the archetype's XML."},"400":{"description":"General bad request."},"404":{"description":"An archetype with the provided citeable identifier (cid-archetype) does not exist or does not exist in the specified asset-version, semantic-version or (in case of get-latest-published) has never been published. Alternatively, the archetype may not be accessible based on the provided credentials."}}}},"/archetypes/{cid-archetype}/mindmap":{"get":{"tags":["Archetypes"],"operationId":"getArchetypeMindmap","produces":["application/xml"],"parameters":[{"name":"cid-archetype","in":"path","description":"The citeable identifier of the archetype.","required":true,"type":"string"},{"name":"asset-version","in":"query","description":"The asset version of the archetype. Defaults to the latest.","required":false,"type":"integer","format":"int32"},{"name":"semantic-version","in":"query","description":"The semantic version of the archetype, for example 1.0.1 or 1.0.2-alpha. Only one, either the asset version or the semantic version, can be provided. Providing both will cause an error, and if neither is provided, the latest version will be used by default.","required":false,"type":"string"},{"name":"get-latest-published","in":"query","description":"If set to true, the latest published revision of the archetype is retrieved. If the resource has never been published a 404 error code is returned. If get-latest-published is set to true, the asset-version and semantic-version must not be specified. Defaults to false.","required":false,"type":"boolean","default":false},{"name":"language","in":"query","description":"The preferred language for any values from the archetype. Defaults to the server language. Automatic fallbacks.","required":false,"type":"string"},{"name":"locale","in":"query","description":"The preferred locale for any locale-specific strings in the mindmap. Defaults to the server language.","required":false,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the archetype's mindmap."},"400":{"description":"General bad request."},"404":{"description":"An archetype with the provided citeable identifier (cid-archetype) does not exist or does not exist in the specified asset-version, semantic-version or (in case of get-latest-published) has never been published. Alternatively, the archetype may not be accessible based on the provided credentials."}}}},"/change-requests":{"get":{"tags":["Change Requests"],"summary":"Lists all or a selection of change requests.","description":"","operationId":"listChangeRequests","produces":["application/xml","application/json"],"parameters":[{"name":"cid-resource","in":"query","description":"Set to only list change requests of the specified resource.","required":false,"type":"string"},{"name":"resource-type","in":"query","description":"Set to only list change requests of specified resource type (archetype, template, ...).","required":false,"type":"string","enum":["ARCHETYPE","TEMPLATE","TERMSET","RELEASESET"]},{"name":"priority","in":"query","description":"Set to only list change requests with the specified priority. Defaults to all.","required":false,"type":"string","enum":["NORMAL","PRIORITY"]},{"name":"status","in":"query","description":"Set to only list change requests with the specified status (open, in-process, closed). Defaults to active states only, i.e. open and in-process.","required":false,"type":"array","items":{"type":"string","enum":["OPEN","IN_PROCESS","CLOSED"]},"collectionFormat":"multi"},{"name":"start-date","in":"query","description":"Set to only list change requests created or last modified on or after this date/time. Expected date format is the ISO Date Time format, e.g. 2024-12-19T10:15:30+01:00. If the timezone offset is omitted (e.g. 2024-12-19T10:15:30), the server timezone offset is used. If, in addition, the time is omitted (2024-12-19), this defaults to the start of the specified day in the server timezone offset.","required":false,"type":"string"},{"name":"end-date","in":"query","description":"Set to only list change requests created or last modificed up to the specified date/time.Expected date format is the ISO Date Time format, e.g. 2024-12-19T10:15:30+01:00. If the timezone offset is omitted (e.g. 2024-12-19T10:15:30), the server timezone offset is used. If, in addition, the time is omitted (2024-12-19), this defaults to the start(!) of the specified day in the server timezone offset.","required":false,"type":"string"},{"name":"size","in":"query","description":"The maximum number of change requests returned in the call. <b>Defaults to 20.</b> The size should not be set too high - offset can be used to retrieve further results.Response header contains x-total-count to indicate the total number of resulting change requests. Note that for users with limited rights, non-public change requests may be excluded from the result set even if counted as part of the x-total-count. ","required":false,"type":"integer","default":20,"format":"int32"},{"name":"offset","in":"query","description":"The offset when not listing all change requests. Defaults to 0, i.e. starting with the first change request.","required":false,"type":"integer","format":"int32"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the requested change requests.","schema":{"type":"array","items":{"$ref":"#/definitions/ChangeRequest"}}},"400":{"description":"General bad request."}}}},"/change-requests/{cid}":{"get":{"tags":["Change Requests"],"summary":"Gets one change request.","description":"","operationId":"getChangeRequest","produces":["application/xml","application/json"],"parameters":[{"name":"cid","in":"path","description":"The citeable identifier of the change request.","required":true,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the change request.","schema":{"$ref":"#/definitions/ChangeRequest"}},"400":{"description":"General bad request."},"404":{"description":"A change request with the specified citeable identifier does not exist (or is not visible to the current user)."}}}},"/projects/{cid-project}":{"get":{"tags":["Projects"],"summary":"Gets the specified CKM project.","description":"","operationId":"getProject","produces":["application/xml","application/json"],"parameters":[{"name":"cid-project","in":"path","description":"The citeable identifier of the project.","required":true,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the main data of the requested project.","schema":{"$ref":"#/definitions/Project"}},"400":{"description":"General bad request."},"404":{"description":"Project with the specified cid-project could not be found (or is private and the specified user, if any, does not have the necesary permissions."}}}},"/projects":{"get":{"tags":["Projects"],"summary":"Lists all or a selection of CKM projects (full projects and incubators).","description":"","operationId":"listProjects","produces":["application/xml","application/json"],"parameters":[{"name":"cid-subdomain","in":"query","description":"Set to only list projects of the specified subdomain.","required":false,"type":"string"},{"name":"project-type","in":"query","description":"Set to only list projects of this type (full projects or incubators).","required":false,"type":"string","enum":["PROJECT","INCUBATOR"]},{"name":"include-order-template-projects","in":"query","description":"True to list order template projects as well, false to exclude such projects. Defaults to true.","required":false,"type":"boolean","default":true},{"name":"my-projects-only","in":"query","description":"Set to true to only list projects where the current user has any explicit role such as member or editor. Defaults to false.","required":false,"type":"boolean","default":false},{"name":"my-editor-projects-only","in":"query","description":"Set to true to only list projects where the current user is an explicit editor of. Defaults to false.","required":false,"type":"boolean","default":false},{"name":"show-all-to-admin","in":"query","description":"True to list all applable projects for CKAs and technical administrators, even if they are not an explicit editor of it and my-editor-projects-only is set to true. This enables a convient way of retrieving all projects the user has editing rights for, either because the user is an explicit editor of the project or a CKM-wide admin. Defaults to true.","required":false,"type":"boolean","default":true}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the main data of all requested projects.","schema":{"type":"array","items":{"$ref":"#/definitions/Project"}}},"400":{"description":"General bad request."},"404":{"description":"Not found. E.g. if a subdomain cid was specified (and is structurally valid), but does not exist."}}}},"/resource-proposals":{"get":{"tags":["Resource Proposals"],"summary":"Lists all or a selection of resource proposals.","description":"","operationId":"listResourceProposals","produces":["application/xml","application/json"],"parameters":[{"name":"start-date","in":"query","description":"Set to only list resource proposals created or last modified on or after this date/time. Expected date format is the ISO Date Time format, e.g. 2024-12-19T10:15:30+01:00. If the timezone offset is omitted (e.g. 2024-12-19T10:15:30), the server timezone offset is used. If, in addition, the time is omitted (2024-12-19), this defaults to the start of the specified day in the server timezone offset.","required":false,"type":"string"},{"name":"end-date","in":"query","description":"Set to only list resource proposals created or last modificed up to the specified date/time.Expected date format is the ISO Date Time format, e.g. 2024-12-19T10:15:30+01:00. If the timezone offset is omitted (e.g. 2024-12-19T10:15:30), the server timezone offset is used. If, in addition, the time is omitted (2024-12-19), this defaults to the start(!) of the specified day in the server timezone offset.","required":false,"type":"string"},{"name":"status","in":"query","description":"Set to only list resource proposals with the specified status (open, in-process, closed). Defaults to active states only, i.e. open and in-process.","required":false,"type":"array","items":{"type":"string","enum":["OPEN","IN_PROCESS","CLOSED"]},"collectionFormat":"multi"},{"name":"size","in":"query","description":"The maximum number of resource proposals returned in the call. Defaults to 20.","required":false,"type":"integer","default":20,"format":"int32"},{"name":"offset","in":"query","description":"The offset when not listing all resource proposals. Defaults to 0.","required":false,"type":"integer","format":"int32"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the requested resource proposals.","schema":{"type":"array","items":{"$ref":"#/definitions/ResourceProposal"}}},"400":{"description":"General bad request."}}}},"/resource-proposals/{cid}":{"get":{"tags":["Resource Proposals"],"summary":"Gets one resource proposal.","description":"","operationId":"getResourceProposal","produces":["application/xml","application/json"],"parameters":[{"name":"cid","in":"path","description":"The citeable identifier of the resource proposal.","required":true,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the resource proposal.","schema":{"$ref":"#/definitions/ResourceProposal"}},"400":{"description":"General bad request."},"404":{"description":"A resource proposal with the specified identifier does not exist (or is not visible to the current user)."}}}},"/resources/publisher-namespace":{"get":{"tags":["Resources"],"summary":"Gets the currently configured publisher namespace for this CKM instance.","description":"","operationId":"PublisherNamespace","produces":["text/plain"],"parameters":[],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the publisher namespace.","schema":{"type":"string"}},"400":{"description":"General bad request."}}}},"/resources/{cid-resource}":{"get":{"tags":["Resources"],"summary":"Gets a CKM Resource. Can be used for both an archetype or a template.","description":"Returns a CKM Resource, i.e. the main data about an archetype or a template.","operationId":"getCKMResource","produces":["application/xml","application/json"],"parameters":[{"name":"cid-resource","in":"path","description":"The citeable identifier of the archetype or template.","required":true,"type":"string"},{"name":"asset-version","in":"query","description":"The asset version of the archetype or template. Defaults to the latest.","required":false,"type":"integer","format":"int32"},{"name":"get-latest-published","in":"query","description":"If set to true, the latest published revision of the resource is retrieved. If the resource has never been published a 404 error code is returned. If get-latest-published is set to true, the asset-version must not be specified. Defaults to false.","required":false,"type":"boolean","default":false}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the archetype's or template's main data.","schema":{"$ref":"#/definitions/CkmResource"}},"400":{"description":"General bad request."},"404":{"description":"An archetype or template with the provided citeable identifier (cid-resource) does not exist or does not exist in the specified version or (in case of get-latest-published) has never been published or is not accessible based on the provided credentials."}}}},"/resources/{cid-resource}/status":{"get":{"tags":["Resources"],"summary":"Gets the current status of the archetype or template in CKM.","description":"","operationId":"getCurrentStatus","produces":["text/plain"],"parameters":[{"name":"cid-resource","in":"path","description":"The citeable identifier of the archetype.","required":true,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the archetype's or template's current status.","schema":{"type":"string","enum":["INITIAL","DRAFT","TEAMREVIEW","REVIEWSUSPENDED","RELEASECANDIDATE","PUBLISHED","REASSESS_DRAFT","REASSESS_TEAMREVIEW","REASSESS_REVIEWSUSPENDED","REJECTED","DEPRECATED"]}},"400":{"description":"General bad request."},"403":{"description":"Forbidden - the specified template does not have a status (branch template)."},"404":{"description":"The archetype or template could not be found (based on the provided credentials, if any)."}}}},"/resources/{cid-resource}/status/{asset-version}":{"get":{"tags":["Resources"],"summary":"Gets the status of the archetype or template in CKM for the specified asset version (i.e. revision).","description":"","operationId":"getStatusAtVersion","produces":["text/plain"],"parameters":[{"name":"cid-resource","in":"path","description":"The citeable identifier of the archetype or template.","required":true,"type":"string"},{"name":"asset-version","in":"path","description":"The asset version of the archetype or template.","required":true,"type":"integer","format":"int32"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the archetype's or template's status at the specified asset-version.","schema":{"type":"string","enum":["INITIAL","DRAFT","TEAMREVIEW","REVIEWSUSPENDED","RELEASECANDIDATE","PUBLISHED","REASSESS_DRAFT","REASSESS_TEAMREVIEW","REASSESS_REVIEWSUSPENDED","REJECTED","DEPRECATED"]}},"400":{"description":"General bad request."},"403":{"description":"Forbidden - the specified archetype or template does not have a status (branch resource)."},"404":{"description":"The archetype or template could not be found (based on the provided credentials), or the archetype/template could not be found in the stated asset-version."}}}},"/sessions":{"get":{"tags":["Sessions"],"summary":"Gets details about the current user, as identified by the session / security context.","description":"","operationId":"getCurrentUser","produces":["application/xml","application/json"],"parameters":[],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the main data of the user of the API.","schema":{"$ref":"#/definitions/User"}},"401":{"description":"The supplied session is not valid or has already expired."}}},"post":{"tags":["Sessions"],"summary":"Sign in the user using basic authentication. The authentication header must be set accordingly for this. Note that in addition each api operation can be used to authenticate directly.","description":"","operationId":"signIn","produces":["application/xml"],"parameters":[],"security":[{"basicAuth":[]}],"responses":{"200":{"description":"Successful sign-in. Session is returned as JSESSIONID cookie."},"401":{"description":"Could not authenticate the user due to incorrect details in the Authorization header."}}},"delete":{"tags":["Sessions"],"summary":"Sign out the user of the session.","description":"","operationId":"signOut","parameters":[],"security":[{"sessionid":[]}],"responses":{"204":{"description":"Successful sign-out."},"401":{"description":"The supplied session is not valid or has already expired."}}}},"/subdomains/{cid-subdomain}":{"get":{"tags":["Subdomains"],"summary":"Gets the main data of one CKM subdomain.","description":"","operationId":"getSubdomain","produces":["application/xml","application/json"],"parameters":[{"name":"cid-subdomain","in":"path","description":"The citeable identifier of the subdomain.","required":true,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the subdomain's main data.","schema":{"$ref":"#/definitions/Subdomain"}},"400":{"description":"General bad request."},"404":{"description":"A subdomain with the specified citeable identifier does not exist."}}}},"/subdomains":{"get":{"tags":["Subdomains"],"summary":"Lists the CKM subdomains.","description":"","operationId":"listSubdomains","produces":["application/xml","application/json"],"parameters":[],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the main data of all subdomains.","schema":{"type":"array","items":{"$ref":"#/definitions/Subdomain"}}},"400":{"description":"General bad request."}}}},"/subdomains/{cid-subdomain}/projects":{"get":{"tags":["Subdomains"],"summary":"Gets the main data of all projects (full projects and incubators) of a specified CKM subdomain. Private incubators are only returned if accessible by the current user, if any. For more options, use the Projects endpoint instead.","description":"","operationId":"listProjectsOfSubdomain","produces":["application/xml","application/json"],"parameters":[{"name":"cid-subdomain","in":"path","description":"The citeable identifier of the subdomain.","required":true,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the subdomain's main data.","schema":{"$ref":"#/definitions/Subdomain"}},"400":{"description":"General bad request."},"404":{"description":"A subdomain with the specified citeable identifier does not exist."}}}},"/templates":{"get":{"tags":["Templates"],"summary":"Lists all or a selection of templates in CKM.","description":"","operationId":"listTemplates","produces":["application/xml","application/json"],"parameters":[{"name":"template-type","in":"query","description":"Set to only list templates of the specified template type.","required":false,"type":"string","enum":["NORMAL","ORDER_ITEM","ORDER_SET","KNOWLEDGE_TOPIC"]},{"name":"cid-subdomain","in":"query","description":"Set to only list templates of the specified subdomain.","required":false,"type":"string"},{"name":"cid-project","in":"query","description":"Set to only list templates of the specified project.","required":false,"type":"string"},{"name":"project-type","in":"query","description":"Set to only list templates in projects of this type. Also note the 'owned-only' param.","required":false,"type":"string","enum":["PROJECT","INCUBATOR"]},{"name":"owned-only","in":"query","description":"Set to true to only list templates that are owned by the specified project/any projects of the specified project-type/any projects of the specified subdomain. Set to false (DEFAULT) to include templates referenced by the project(s) as well.","required":false,"type":"boolean"},{"name":"search-text","in":"query","description":"Set to only list templates with this search text in the template meta data.","required":false,"type":"string"},{"name":"restrict-search-to-main-data","in":"query","description":"Restrict search to main data of the template. If true, ONLY finds the search text in the main metadata fields such as template name, template id, keywords, etc. If false, searches in the complete oet file. Defaults to false (=non-restricted).","required":false,"type":"boolean","default":false},{"name":"require-all-search-words","in":"query","description":"If multiple search words, should ALL words be required (true = DEFAULT), or is ANY sufficient (false).","required":false,"type":"boolean","default":true},{"name":"resource-state","in":"query","description":"Set to only list templates with the provided resource states. Defaults to all active resource states, i.e. all states except REJECTED and DEPRECATED.","required":false,"type":"array","items":{"type":"string","enum":["INITIAL","DRAFT","TEAMREVIEW","REVIEWSUSPENDED","PUBLISHED","REASSESS_DRAFT","REASSESS_TEAMREVIEW","REASSESS_REVIEWSUSPENDED","REJECTED","DEPRECATED"]},"collectionFormat":"multi"},{"name":"class","in":"query","description":"Set to only list templates that are classified in/indexed with the specified scheme + class (term). Usage: scheme:class/subclass, where scheme, class and subclasses must be written exactly as is in the original language (no translations). The scheme is separated from the class using \":\" and subclasses are separated by \"/\". For example: Health Domain:Surgery/General Surgery. If a slash \"/\" is used in a class name itself, this must be replaced with a pipe symbol \"|\". For the language scheme, simply use the available ISO 639-1 language codes (2 digits), e.g. 'en', 'nb',  or 'de'. For regional variants, use e.g.: 'en/en-au'.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"require-all-classes","in":"query","description":"If multiple classes (terms) have been specified, should ALL be required (true), or is ANY sufficient (false = DEFAULT).","required":false,"type":"boolean","default":false},{"name":"include-subclasses","in":"query","description":"If one or more classes (terms) have been specified, should subclasses be included (true) or not (false = DEFAULT).","required":false,"type":"boolean","default":false},{"name":"start-date","in":"query","description":"Set to only list templates last modified on or after this date/time. Expected date format is the ISO Date Time format, e.g. 2025-03-02T10:15:30+01:00. If the timezone offset is omitted (e.g. 2025-03-02T10:15:30), the server timezone offset is used. If, in addition, the time is omitted (2025-03-02), this defaults to the start of the specified day in the server timezone offset.","required":false,"type":"string"},{"name":"end-date","in":"query","description":"Set to only list templates last modified up to the specified date/time. Expected date format is the ISO Date Time format, e.g. 2025-03-02T10:15:30+01:00. If the timezone offset is omitted (e.g. 2025-03-02T10:15:30), the server timezone offset is used. If, in addition, the time is omitted (2025-03-02), this defaults to the start(!) of the specified day in the server timezone offset.","required":false,"type":"string"},{"name":"size","in":"query","description":"The maximum number of templates returned in the call. <b>Defaults to 20.</b>  Response header contains x-total-count to indicate the total number of results. The size should not be set too high - offset can be used to retrieve further results.","required":false,"type":"integer","default":20,"format":"int32"},{"name":"offset","in":"query","description":"The offset when not listing all templates. Defaults to 0, i.e. starting with the first template.","required":false,"type":"integer","format":"int32"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the main data of all requested templates.","schema":{"type":"array","items":{"$ref":"#/definitions/CkmResource"}}},"400":{"description":"General bad request."}}},"post":{"tags":["Templates"],"summary":"Imports a new template into a CKM project. It is recommended to request the template validation report beforehand.","description":"","operationId":"importTemplate","consumes":["application/xml"],"produces":["application/xml","application/json"],"parameters":[{"in":"body","name":"body","description":"The complete OET serialisation as a string.","required":true,"schema":{"type":"string"}},{"name":"template-type","in":"query","description":"The template type.","required":true,"type":"string","enum":["NORMAL","ORDER_ITEM","ORDER_SET","KNOWLEDGE_TOPIC"]},{"name":"cid-project","in":"query","description":"The citeable identifier of the project to import the new template into.","required":true,"type":"string"},{"name":"log-message","in":"query","description":"A log message for the import.","required":true,"type":"string"},{"name":"proceed-if-outdated-resources-used","in":"query","description":"True to proceed even if some related resources are outdated, i.e. there is a newer revision of a resource in CKM. Defaults to false.","required":false,"type":"boolean","default":false}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"201":{"description":"Successful import of the new template.","schema":{"$ref":"#/definitions/CkmResource"}},"400":{"description":"General bad request, such as that the OET format is invalid. Also used to indicate that the provided project cid is not valid or e.g. the project belongs to a remote subdomain that cannot own templates. Or a template with the specified template id or name already exists in CKM."},"403":{"description":"Forbidden to import this template for one of many reasons. The user may not be allowed to upload to the stated project based on the user's provided credentials."},"424":{"description":"Dependencies to required archetypes and/or embedded templates failed. I.e. there were validation errors (or warnings if proceed-if-outdated-resources-used is set to false)."}}}},"/templates/{cid-template}":{"get":{"tags":["Templates"],"summary":"Gets the main data of one template.","description":"","operationId":"getTemplateAsCKMResource","produces":["application/xml","application/json"],"parameters":[{"name":"cid-template","in":"path","description":"The citeable identifier of the template.","required":true,"type":"string"},{"name":"asset-version","in":"query","description":"The asset version of the template. Defaults to the latest.","required":false,"type":"integer","format":"int32"},{"name":"get-latest-published","in":"query","description":"If set to true, the latest published revision of the template is retrieved. If the resource has never been published a 404 error code is returned. If get-latest-published is set to true, the asset-version must not be specified. Defaults to false.","required":false,"type":"boolean","default":false}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the template's main data.","schema":{"$ref":"#/definitions/CkmResource"}},"400":{"description":"General bad request."},"404":{"description":"Template with provided citeable identifier (cid-template) does not exist or does not exist in the specified version or (in case of get-latest-published) has never been published or is not accessible based on the provided credentials."}}},"put":{"tags":["Templates"],"summary":"Updates the specified template on the trunk. It is recommended to request the template validation report beforehand.","description":"","operationId":"updateTemplateOnTrunk","consumes":["application/xml"],"produces":["application/xml","application/json"],"parameters":[{"in":"body","name":"body","description":"The complete OET serialisation as a string.","required":true,"schema":{"type":"string"}},{"name":"cid-template","in":"path","description":"The citeable identifier of the template.","required":true,"type":"string"},{"name":"log-message","in":"query","description":"A log message describing the update.","required":true,"type":"string"},{"name":"proceed-if-outdated-resources-used","in":"query","description":"True to proceed even if some related resources are outdated, i.e. there is a newer revision of a resource in CKM. Defaults to false.","required":false,"type":"boolean","default":false},{"name":"republish-immediately","in":"query","description":"True to immediately republish a TRUNK template if - and only if - its status is PUBLISHED at the moment. If false, the template's status is 'naturally' updated to REASSESS_DRAFT as the next recommended step to enable reviews etc before republication. If true, the template is immediately republished (old status = new status = PUBLISHED). Has no effect, if the template is not currently in PUBLISHED state. Defaults to false.","required":false,"type":"boolean","default":false},{"name":"if-match","in":"header","description":"If this header is set, it must match the current asset-version of the resource in CKM. Otherwise the import is cancelled with a 412 (Precondition failed) error.","required":false,"type":"string"},{"name":"if-unmodified-since","in":"header","description":"If this header is set, the newest asset version of the resource must be older than the specified date. Otherwise the import is cancelled with a 412 (Precondition failed) error.<br/> Expected date format is the ISO Date Time format, e.g. 2025-03-02T10:15:30+01:00. If the timezone offset is omitted (e.g. 2025-03-02T10:15:30), the server timezone offset is used. If, in addition, the time is omitted (2025-03-02), this defaults to the start of the specified day in the server timezone offset.","required":false,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful update of the template.","schema":{"$ref":"#/definitions/CkmResource"}},"400":{"description":"General bad request, such as that the OET format is invalid."},"403":{"description":"Forbidden to update this template for one of various reasons. The user may not be allowed to upload to the template's project based on the provided credentials. "},"404":{"description":"Template with given citeable identifier does not exist."},"412":{"description":"Precondition failed. A provided if-match or if-unmodified-since header precondition fails. This means the optimistic locking approach has found an update to the resource afterwards and has thus prevented the update."},"424":{"description":"Dependencies to required archetypes and/or embedded templates failed. I.e. there were validation errors (or warnings if proceed-if-outdated-resources-used is set to false)"}}},"delete":{"tags":["Templates"],"summary":"PERMANENTLY and IRREVOCABLY DELETES the specified template in CKM. For a trunk template, this will also PERMANENTLY DESTROY EVERYTHING that depends on this resource, including its branches, review rounds, individual reviews, discussion comments, documents from the resource's resource centre, tasks from its to do list, change requests, etc.","description":"","operationId":"deleteTemplate","produces":["application/xml","application/json"],"parameters":[{"name":"cid-template","in":"path","description":"The citeable identifier of the template.","required":true,"type":"string"},{"name":"delete-if-trunk","in":"query","description":"True to delete even if the specified cid refers to a trunk template. This will also PERMANENTLY DESTROY EVERYTHING that depends on this resource, including its branches, review rounds, individual reviews, discussion comments, documents from the resource's resource centre, tasks from its to do list, change requests, etc. False to only proceed if the specified cid refers to a branch template.","required":false,"type":"boolean","default":false},{"name":"delete-if-published","in":"query","description":"True to delete even if the specified template is or has previously been PUBLISHED.","required":false,"type":"boolean","default":false}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"204":{"description":"Successful deletion of the template."},"400":{"description":"General bad request."},"403":{"description":"Forbidden - the specified template cannot be deleted with the provided credentials or because there are other restrictions or dependencies."},"404":{"description":"The template could not be found (based on the provided credentials, if any)."}}}},"/templates/{cid-template}/embedded-templates":{"get":{"tags":["Templates"],"summary":"Lists the templates embedded in the specified template, if any.","description":"","operationId":"listEmbeddedTemplates","produces":["application/xml","application/json"],"parameters":[{"name":"cid-template","in":"path","description":"The citeable identifier of the template.","required":true,"type":"string"},{"name":"version-template","in":"query","description":"The asset version of the template. Defaults to the latest.","required":false,"type":"integer","format":"int32"},{"name":"get-latest-published","in":"query","description":"If set to true, the latest published revision of the template is retrieved. If the resource has never been published a 404 error code is returned. If get-latest-published is set to true, the asset-version must not be specified. Defaults to false.","required":false,"type":"boolean","default":false},{"name":"direct-only","in":"query","description":"True to only return directly embedded templates, i.e. not going down the hierarchy in case of multiple template levels. Defaults to false.","required":false,"type":"boolean","default":false}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the template's embedded templates.","schema":{"type":"array","items":{"$ref":"#/definitions/CkmResource"}}},"400":{"description":"General bad request."},"404":{"description":"Template with provided citeable identifier (cid-template) does not exist or does not exist in the specified version or (in case of get-latest-published) has never been published or is not accessible based on the provided credentials."}}}},"/templates/{cid-template}/required-archetypes":{"get":{"tags":["Templates"],"summary":"Lists the archetypes required for (i.e. used by) the specified template.","description":"","operationId":"listRequiredArchetypesForTemplate","produces":["application/xml","application/json"],"parameters":[{"name":"cid-template","in":"path","description":"The citeable identifier of the template.","required":true,"type":"string"},{"name":"asset-version","in":"query","description":"The asset version of the template. Defaults to the latest.","required":false,"type":"integer","format":"int32"},{"name":"get-latest-published","in":"query","description":"If set to true, the latest published revision of the template is retrieved. If the resource has never been published a 404 error code is returned. If get-latest-published is set to true, the asset-version must not be specified. Defaults to false.","required":false,"type":"boolean","default":false},{"name":"direct-only","in":"query","description":"True to only return archetypes directly required by the specified template, i.e. not going down the hierarchy in case of multiple template levels. Defaults to false.","required":false,"type":"boolean","default":false}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the template's required archetypes.","schema":{"type":"array","items":{"$ref":"#/definitions/CkmResource"}}},"400":{"description":"General bad request."},"404":{"description":"Template with provided citeable identifier (cid-template) does not exist or does not exist in the specified version or (in case of get-latest-published) has never been published or is not accessible based on the provided credentials."}}}},"/templates/{cid-template}/oet":{"get":{"tags":["Templates"],"summary":"Gets the specified template in OET format.","description":"","operationId":"getTemplateOET","produces":["application/xml"],"parameters":[{"name":"cid-template","in":"path","description":"The citeable identifier of the template.","required":true,"type":"string"},{"name":"asset-version","in":"query","description":"The asset version of the template. Defaults to the latest.","required":false,"type":"integer","format":"int32"},{"name":"get-latest-published","in":"query","description":"If set to true, the latest published revision of the template is retrieved. If the resource has never been published a 404 error code is returned. If get-latest-published is set to true, the asset-version must not be specified. Defaults to false.","required":false,"type":"boolean","default":false}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the template's logical definition in OET format."},"400":{"description":"General bad request."},"404":{"description":"Template with provided citeable identifier (cid-template) does not exist or does not exist in the specified version or (in case of get-latest-published) has never been published or is not accessible based on the provided credentials."}}}},"/templates/{cid-template}/opt":{"get":{"tags":["Templates"],"summary":"Gets the operational template (OPT) for the specified template.","description":"","operationId":"getTemplateOPT","produces":["application/xml"],"parameters":[{"name":"cid-template","in":"path","description":"The citeable identifier of the template.","required":true,"type":"string"},{"name":"asset-version","in":"query","description":"The asset version of the template. Defaults to the latest.","required":false,"type":"integer","format":"int32"},{"name":"get-latest-published","in":"query","description":"If set to true, the latest published revision of the template is retrieved. If the resource has never been published a 404 error code is returned. If get-latest-published is set to true, the asset-version must not be specified. Defaults to false.","required":false,"type":"boolean","default":false}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the template's operational template in OPT format."},"400":{"description":"General bad request."},"404":{"description":"Template with provided citeable identifier (cid-template) does not exist or does not exist in the specified version or (in case of get-latest-published) has never been published or is not accessible based on the provided credentials."}}}},"/templates/{cid-template}/hash":{"get":{"tags":["Templates"],"summary":"Gets the MD5 hash of the specified template in OET format.","description":"","operationId":"getTemplateOETHash","produces":["text/plain"],"parameters":[{"name":"cid-template","in":"path","description":"The citeable identifier of the template.","required":true,"type":"string"},{"name":"asset-version","in":"query","description":"The asset version of the template. Defaults to the latest.","required":false,"type":"integer","format":"int32"},{"name":"get-latest-published","in":"query","description":"If set to true, the latest published revision of the template is retrieved. If the resource has never been published a 404 error code is returned. If get-latest-published is set to true, the asset-version must not be specified. Defaults to false.","required":false,"type":"boolean","default":false}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the template's hash of the oet."},"400":{"description":"General bad request."},"404":{"description":"Template with provided citeable identifier (cid-template) does not exist or does not exist in the specified version or (in case of get-latest-published) has never been published or is not accessible based on the provided credentials."}}}},"/templates/{cid-template}/file-set-url":{"get":{"tags":["Templates"],"summary":"Gets the URL for a file set of the template. The file set contains all relevant archetypes and templates. Note: For resources in private incubators, the session id must still be valid when requesting the file set via the provided URL.","description":"","operationId":"getTemplateFileSetURL","produces":["text/plain"],"parameters":[{"name":"cid-template","in":"path","description":"The citeable identifier of the template.","required":true,"type":"string"},{"name":"asset-version","in":"query","description":"The asset version of the template. Defaults to the latest.","required":false,"type":"integer","format":"int32"},{"name":"get-latest-published","in":"query","description":"If set to true, the latest published revision of the template is retrieved. If the resource has never been published a 404 error code is returned. If get-latest-published is set to true, the asset-version must not be specified. Defaults to false.","required":false,"type":"boolean","default":false}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the template's file set URL."},"400":{"description":"General bad request."},"404":{"description":"Template with provided citeable identifier (cid-template) does not exist or does not exist in the specified version or (in case of get-latest-published) has never been published or is not accessible based on the provided credentials."}}}},"/templates/{cid-template}/status":{"get":{"tags":["Templates"],"summary":"Gets the current status of the template in CKM.","description":"","operationId":"getCurrentTemplateStatus","produces":["text/plain"],"parameters":[{"name":"cid-template","in":"path","description":"The citeable identifier of the template.","required":true,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the template's current status.","schema":{"type":"string","enum":["INITIAL","DRAFT","TEAMREVIEW","REVIEWSUSPENDED","RELEASECANDIDATE","PUBLISHED","REASSESS_DRAFT","REASSESS_TEAMREVIEW","REASSESS_REVIEWSUSPENDED","REJECTED","DEPRECATED"]}},"400":{"description":"General bad request."},"403":{"description":"Forbidden - the specified template does not have a status (branch template)."},"404":{"description":"The template could not be found (based on the provided credentials, if any)."}}},"put":{"tags":["Templates"],"summary":"Updates the status of the specified trunk template.","description":"","operationId":"updateTemplateStatus","produces":["application/xml","application/json"],"parameters":[{"name":"cid-template","in":"path","description":"The citeable identifier of the trunk template.","required":true,"type":"string"},{"name":"status","in":"query","description":"The new status of the template. This status must be a status that is a possible new status for the template based on its current status as well as its owning project or incubator.","required":true,"type":"string","enum":["INITIAL","DRAFT","TEAMREVIEW","REVIEWSUSPENDED","RELEASECANDIDATE","PUBLISHED","REASSESS_DRAFT","REASSESS_TEAMREVIEW","REASSESS_REVIEWSUSPENDED","REJECTED","DEPRECATED"]},{"name":"proceed-if-active-branches","in":"query","description":"True to proceed even if the resource has active branches. Before some status changes, it may be advisable to clean up (commit, resolve, reject or delete) any active branches. Defaults to false.","required":false,"type":"boolean","default":false},{"name":"if-match","in":"header","description":"If this header is set, it must match the current asset-version of the resource in CKM. Otherwise the import is cancelled with a 412 (Precondition failed) error.","required":false,"type":"string"},{"name":"if-unmodified-since","in":"header","description":"If this header is set, the newest asset version of the resource must be older than the specified date. Otherwise the import is cancelled with a 412 (Precondition failed) error.<br/> Expected date format is the ISO Date Time format, e.g. 2025-03-02T10:15:30+01:00. If the timezone offset is omitted (e.g. 2025-03-02T10:15:30), the server timezone offset is used. If, in addition, the time is omitted (2025-03-02), this defaults to the start of the specified day in the server timezone offset.","required":false,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful update of the template status.","schema":{"$ref":"#/definitions/CkmResource"}},"400":{"description":"General bad request, such as that the format of the citeable identifier is invalid or the provided new status does not exist at all."},"403":{"description":"Forbidden to update the template status for one of various reasons.<br/> The user may not be allowed to update the template status based on the provided credentials.<br/> The provided citeable identifier of the template must refer to a trunk template, not to one of its branches.<br/> This response code may also be provided if the requested new status exists but cannot be set based on the state machine: For example, it is not possible to transition from PUBLISHED to DRAFT or from PUBLISHED to REJECTED.<br/> Or, the specified template may have active branches and proceed-if-active-branches was not set to true."},"404":{"description":"Template with given citeable identifier does not exist (or is not visible to the user based on provided credentials)."},"412":{"description":"Precondition failed. A provided if-match or if-unmodified-since header precondition fails. This means the optimistic locking approach has found an update to the resource afterwards and has thus prevented the update."}}}},"/templates/validation-report":{"post":{"tags":["Templates"],"summary":"Gets CKM's template validation report for the template provided as OET. Validates if all required resources are present and used in the latest revision on the trunk. Note: This is a POST call, not a simple GET to avoid problems with max URI-length due to the long OET and problems with GET support of body.","description":"","operationId":"getValidationReportForTemplate","consumes":["application/xml"],"produces":["application/xml","application/json"],"parameters":[{"in":"body","name":"body","description":"The complete OET serialisation as a string.","required":true,"schema":{"type":"string"}},{"name":"include-information","in":"query","description":"True to include template validation information items as well (Correct matches). Defaults to false - only warnings and errors.","required":false,"type":"boolean"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the template's validation report. This status is also returned if the retrieved validation report contains no errors or warnings.","schema":{"type":"array","items":{"$ref":"#/definitions/TemplateValidationItem"}}},"400":{"description":"General bad request."},"401":{"description":"Log in required to use this service."},"403":{"description":"Forbidden to use with the provided user credentials."}}}},"/templates/{cid-template}/status/{asset-version}":{"get":{"tags":["Templates"],"summary":"Gets the status of the template in CKM for the specified asset version (i.e. revision).","description":"","operationId":"getTemplateStatusAtVersion","produces":["text/plain"],"parameters":[{"name":"cid-template","in":"path","description":"The citeable identifier of the template.","required":true,"type":"string"},{"name":"asset-version","in":"path","description":"The asset version of the template. Defaults to the latest.","required":true,"type":"integer","format":"int32"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the template's status at the specified asset-version.","schema":{"type":"string","enum":["INITIAL","DRAFT","TEAMREVIEW","REVIEWSUSPENDED","RELEASECANDIDATE","PUBLISHED","REASSESS_DRAFT","REASSESS_TEAMREVIEW","REASSESS_REVIEWSUSPENDED","REJECTED","DEPRECATED"]}},"400":{"description":"General bad request."},"403":{"description":"Forbidden - the specified template does not have a status (branch template)."},"404":{"description":"Template with provided citeable identifier (cid-template) does not exist or does not exist in the requested asset-version or is not accessible based on the provided credentials."}}}},"/templates/{cid-template}/project":{"get":{"tags":["Templates"],"summary":"Gets the CKM project of the template.","description":"","operationId":"getProjectOfTemplate","produces":["application/xml","application/json"],"parameters":[{"name":"cid-template","in":"path","description":"The citeable identifier of the template.","required":true,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the template's project.","schema":{"$ref":"#/definitions/Project"}},"400":{"description":"General bad request."},"404":{"description":"Template with provided citeable identifier (cid-template) does not exist on the trunk or is not accessible based on the provided credentials."}}}},"/templates/citeable-identifier/{template-id}":{"get":{"tags":["Templates"],"summary":"Gets the citeable identifier of a template based on the specified template id.","description":"","operationId":"getCiteableIdentifierForTemplateId","produces":["text/plain"],"parameters":[{"name":"template-id","in":"path","description":"The template id of the template.","required":true,"type":"string"}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"200":{"description":"Successful retrieval of the template's citeable identifier.","schema":{"type":"string"}},"400":{"description":"General bad request."},"404":{"description":"A template with the provided template-id does not exist or is not accessible based on the provided credentials."}}}},"/users":{"post":{"tags":["Users"],"summary":"Creates a new user. The stated username must match the firstName and lastName (firstname.lastname), ignoring case and removing whitespace. If successful, depending on the value of hasToActivate, either a welcome email or an activation email is sent to the new user, using the specified email address. If no password is provided for the user, CKM generates an initial password and the user can use CKM's reset password functionality to gain access.","description":"","operationId":"createUser","consumes":["application/json","application/xml"],"produces":["application/json","application/xml"],"parameters":[{"in":"body","name":"body","description":"The details for the new user.","required":true,"schema":{"$ref":"#/definitions/NewUser"}}],"security":[{"basicAuth":[]},{"sessionid":[]}],"responses":{"201":{"description":"Successful creation of the new user.","schema":{"$ref":"#/definitions/NewUser"}},"400":{"description":"General bad request, such as that the provided user format is invalid (unparsable) or there were fatal validation errors, such as missing mandatory fields. The provided username MUST be in the form firstname.lastname"},"403":{"description":"Forbidden to create the user. This error response is used if the session user does not have the necessary permissions to create new CKM users. This error response will also be returned when the username or email address is already used by an existing user or if a user with a matching username who previously unregistered from CKM had contributed to CKM for example in review rounds or discussions. In this case, follow the process in the CKM user interface."}}}}},"securityDefinitions":{"sessionid":{"description":"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.","type":"apiKey","name":"JSESSIONID","in":"header"},"basicAuth":{"description":"Basic authentification using the CKM username and password. The provided credentials are used (and validated) on making an actual request.","type":"basic"}},"definitions":{"CkmResource":{"type":"object","properties":{"cid":{"type":"string","example":"1013.1.130","description":"The citeable identifier of this resource."},"versionAsset":{"type":"integer","format":"int32","example":12,"description":"The asset version of the retrieved resource. Defaults to the latest, if not explicitly requested otherwise."},"resourceMainId":{"type":"string","description":"The main identifer for this resource."},"resourceMainDisplayName":{"type":"string","description":"The main display name for the retrieved resource."},"resourceType":{"type":"string","description":"The resource type of the retrieved resource.","enum":["ARCHETYPE","TEMPLATE","TERMSET","RELEASESET"]},"templateType":{"type":"string","enum":["NORMAL","ORDER_ITEM","ORDER_SET","KNOWLEDGE_TOPIC"]},"resourceDescription":{"type":"string","description":"For archetypes, the concept description."},"status":{"type":"string","example":"PUBLISHED","description":"The resource status of the retrieved resource."},"versionAssetLatest":{"type":"integer","format":"int32","example":25,"description":"The latest asset version of this resource."},"versionAssetLatestPublished":{"type":"integer","format":"int32","example":23,"description":"The latest published asset version of this resource."},"uid":{"type":"string","description":"For archetypes, the archetype's uid that usually only changes with each major version."},"buildUid":{"type":"string","description":"For archetypes, the archetype's build_uid that usually changes with each commit."},"revision":{"type":"string","example":"1.0.0","description":"For archetypes, the archetype's Semantic Version for the REQUESTED asset version."},"revisionLatest":{"type":"string","example":"1.1.1-alpha","description":"For archetypes, the archetype's Semantic Version for the LATEST asset version."},"revisionLatestPublished":{"type":"string","example":"1.1.0","description":"For archetypes, the archetype's Semantic Version for the LATEST PUBLISHED asset version."},"creationTime":{"type":"string","format":"date-time","description":"The initial creation time of this resource (in its initial version) in CKM."},"modificationTime":{"type":"string","format":"date-time","description":"The modification time of the resource in CKM (in the specified asset version, which defaults to the latest if none specified.)."},"branchName":{"type":"string","description":"If not a trunk resource, this states the name of the branch."},"cidProject":{"type":"string","description":"The citeable id of the project that owns this resource."},"projectName":{"type":"string","description":"The name of the project that owns this resource."}},"description":"Contains the relevant main data to describe a CKM resource such as an archetype or a template."},"Project":{"type":"object","properties":{"cid":{"type":"string"},"name":{"type":"string"},"projectURL":{"type":"string"},"cidSubdomain":{"type":"string"},"subdomainName":{"type":"string"},"public":{"type":"boolean"},"projectType":{"type":"string","enum":["PROJECT","INCUBATOR"]},"remoteSubdomain":{"type":"boolean"},"forOrderTemplates":{"type":"boolean"}}},"ChangeRequest":{"type":"object","properties":{"cid":{"type":"string"},"versionAsset":{"type":"integer","format":"int32"},"loginNameCreator":{"type":"string"},"userFullnameCreator":{"type":"string"},"loginNameLastModifier":{"type":"string"},"userFullnameLastModifier":{"type":"string"},"creationTime":{"type":"string","format":"date-time"},"modificationTime":{"type":"string","format":"date-time"},"description":{"type":"string"},"status":{"type":"string","enum":["OPEN","IN_PROCESS","CLOSED"]},"title":{"type":"string"},"priority":{"type":"string","enum":["NORMAL","PRIORITY"]},"directLink":{"type":"string"},"crId":{"type":"string"},"ckmResource":{"$ref":"#/definitions/CkmResource"}}},"ResourceProposal":{"type":"object","properties":{"cid":{"type":"string"},"versionAsset":{"type":"integer","format":"int32"},"loginNameCreator":{"type":"string"},"userFullnameCreator":{"type":"string"},"loginNameLastModifier":{"type":"string"},"userFullnameLastModifier":{"type":"string"},"creationTime":{"type":"string","format":"date-time"},"modificationTime":{"type":"string","format":"date-time"},"description":{"type":"string"},"status":{"type":"string","enum":["OPEN","IN_PROCESS","CLOSED"]},"resourceMainId":{"type":"string"},"resourceMainDisplayName":{"type":"string"},"resourceType":{"type":"string","enum":["ARCHETYPE","TEMPLATE","TERMSET","RELEASESET"]},"directLink":{"type":"string"},"rpId":{"type":"string"}}},"User":{"type":"object","properties":{"username":{"type":"string"},"sessionId":{"type":"string"},"roles":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"roleTypes":{"type":"array","uniqueItems":true,"items":{"type":"string"}},"name":{"type":"string"}},"xml":{"name":"user"},"description":"Essential information about the user, including the session."},"Subdomain":{"type":"object","properties":{"cid":{"type":"string"},"name":{"type":"string"},"remoteURL":{"type":"string"},"namespace":{"type":"string"}}},"TemplateValidationItem":{"type":"object","properties":{"errorType":{"type":"string"},"errorText":{"type":"string"},"errorDescription":{"type":"string"},"cidResource":{"type":"string"},"resourceMainId":{"type":"string"},"resourceMainDisplayName":{"type":"string"},"assetVersion":{"type":"integer","format":"int32"},"assetVersionLatest":{"type":"integer","format":"int32"},"assetVersionLatestPublished":{"type":"integer","format":"int32"},"revisionNumber":{"type":"string"},"revisionNumberLatest":{"type":"string"},"revisionNumberLatestPublished":{"type":"string"},"resourceType":{"type":"string","enum":["ARCHETYPE","TEMPLATE","TERMSET","RELEASESET"]},"expectedHash":{"type":"string","description":"The hash from the integrity check section of the provided template."},"foundHash":{"type":"string","description":"The hash in the latest revision of the archetype."},"foundHashLatestPublished":{"type":"string","description":"The hash in the latest PUBLISHED revision of the archetype, if any."},"statusAtVersion":{"type":"string","enum":["INITIAL","DRAFT","TEAMREVIEW","REVIEWSUSPENDED","RELEASECANDIDATE","PUBLISHED","REASSESS_DRAFT","REASSESS_TEAMREVIEW","REASSESS_REVIEWSUSPENDED","REJECTED","DEPRECATED"]},"statusLatest":{"type":"string","enum":["INITIAL","DRAFT","TEAMREVIEW","REVIEWSUSPENDED","RELEASECANDIDATE","PUBLISHED","REASSESS_DRAFT","REASSESS_TEAMREVIEW","REASSESS_REVIEWSUSPENDED","REJECTED","DEPRECATED"]},"statusLatestPublished":{"type":"string","enum":["INITIAL","DRAFT","TEAMREVIEW","REVIEWSUSPENDED","RELEASECANDIDATE","PUBLISHED","REASSESS_DRAFT","REASSESS_TEAMREVIEW","REASSESS_REVIEWSUSPENDED","REJECTED","DEPRECATED"]},"validationSeverity":{"type":"string","enum":["FATAL","WARNING","INFO"]},"licencingOrCopyrightError":{"type":"boolean"}}},"NewUser":{"type":"object","required":["countryCode","email","firstName","lastName","username"],"properties":{"username":{"type":"string","example":"jane.doe","description":"The username of the user, must be in the form of firstname.lastname - any whitespace needs to be removed."},"firstName":{"type":"string","example":"Jane","description":"The first name of the user."},"lastName":{"type":"string","example":"Doe","description":"The last name of the user."},"email":{"type":"string","example":"jane.doe@openehr.org","description":"A valid email address for the user."},"secondaryEmail":{"type":"string","example":"jane.doe@oceanhealthsystems.com","description":"An optional additional recovery email address of the user."},"organisation":{"type":"string","example":"My health organisation","description":"The name of the user's organisation."},"countryCode":{"type":"string","example":"CA","description":"The (ISO-3166 ALPHA 2) country code for the user."},"stateOfCountry":{"type":"string","example":"VIC [use only for countryCode=AU]","description":"Only for Australia: the state/territory abbreviation, e.g. VIC. Not used for any other country at present."},"availableAsReviewer":{"type":"boolean","description":"True to assert that the user is available as a reviewer, false to assert that the user is not. If this field is NOT provided at all, the user will be asked to be a reviewer in due course (and can then directly choose applicable Health Domains and Professions from CKM's ontology)."},"availableAsTranslator":{"type":"boolean","description":"True to assert that the user is available as a translator, false to assert that the user is not. If this field is NOT provided at all, the user will be asked to be a translator in due course depending on server settings (and can then directly choose the languages the user is proficient in)."},"hasToActivate":{"type":"boolean","description":"True to specify that the user needs to activate the account. An activation email is sent to the user on creation; otherwise a welcome email is sent. Defaults to false."},"password":{"type":"string","example":"dsfd$52332!äEW4","description":"The initial password for the user. When an initial password is not provided when creating a new user, a password will be auto-generated by CKM. In this case, the new user can use the Forgot Your Password functionality to retrieve a password."}},"xml":{"name":"user"},"description":"Contains the relevant main data used to create a new user in CKM."}},"externalDocs":{"description":"Find out more about openEHR and the Clinical Knowledge Manager (CKM)","url":"http://www.openehr.org"}}