Create plan definition
curl --request POST \
--url https://api.clinikapi.com/v1/plan-definitions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"title": "<string>",
"type": "<string>",
"description": "<string>",
"purpose": "<string>",
"usage": "<string>",
"publisher": "<string>",
"date": "<string>",
"version": "<string>",
"url": "<string>",
"experimental": true,
"topic": [
"<string>"
],
"goal": [
{
"description": "<string>",
"priority": "<string>",
"category": "<string>"
}
],
"action": [
{
"title": "<string>",
"description": "<string>",
"priority": "<string>",
"code": "<string>",
"type": "<string>",
"definitionUri": "<string>"
}
]
}
'import requests
url = "https://api.clinikapi.com/v1/plan-definitions"
payload = {
"name": "<string>",
"title": "<string>",
"type": "<string>",
"description": "<string>",
"purpose": "<string>",
"usage": "<string>",
"publisher": "<string>",
"date": "<string>",
"version": "<string>",
"url": "<string>",
"experimental": True,
"topic": ["<string>"],
"goal": [
{
"description": "<string>",
"priority": "<string>",
"category": "<string>"
}
],
"action": [
{
"title": "<string>",
"description": "<string>",
"priority": "<string>",
"code": "<string>",
"type": "<string>",
"definitionUri": "<string>"
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
title: '<string>',
type: '<string>',
description: '<string>',
purpose: '<string>',
usage: '<string>',
publisher: '<string>',
date: '<string>',
version: '<string>',
url: '<string>',
experimental: true,
topic: ['<string>'],
goal: [{description: '<string>', priority: '<string>', category: '<string>'}],
action: [
{
title: '<string>',
description: '<string>',
priority: '<string>',
code: '<string>',
type: '<string>',
definitionUri: '<string>'
}
]
})
};
fetch('https://api.clinikapi.com/v1/plan-definitions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.clinikapi.com/v1/plan-definitions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'title' => '<string>',
'type' => '<string>',
'description' => '<string>',
'purpose' => '<string>',
'usage' => '<string>',
'publisher' => '<string>',
'date' => '<string>',
'version' => '<string>',
'url' => '<string>',
'experimental' => true,
'topic' => [
'<string>'
],
'goal' => [
[
'description' => '<string>',
'priority' => '<string>',
'category' => '<string>'
]
],
'action' => [
[
'title' => '<string>',
'description' => '<string>',
'priority' => '<string>',
'code' => '<string>',
'type' => '<string>',
'definitionUri' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clinikapi.com/v1/plan-definitions"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"purpose\": \"<string>\",\n \"usage\": \"<string>\",\n \"publisher\": \"<string>\",\n \"date\": \"<string>\",\n \"version\": \"<string>\",\n \"url\": \"<string>\",\n \"experimental\": true,\n \"topic\": [\n \"<string>\"\n ],\n \"goal\": [\n {\n \"description\": \"<string>\",\n \"priority\": \"<string>\",\n \"category\": \"<string>\"\n }\n ],\n \"action\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"priority\": \"<string>\",\n \"code\": \"<string>\",\n \"type\": \"<string>\",\n \"definitionUri\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.clinikapi.com/v1/plan-definitions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"purpose\": \"<string>\",\n \"usage\": \"<string>\",\n \"publisher\": \"<string>\",\n \"date\": \"<string>\",\n \"version\": \"<string>\",\n \"url\": \"<string>\",\n \"experimental\": true,\n \"topic\": [\n \"<string>\"\n ],\n \"goal\": [\n {\n \"description\": \"<string>\",\n \"priority\": \"<string>\",\n \"category\": \"<string>\"\n }\n ],\n \"action\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"priority\": \"<string>\",\n \"code\": \"<string>\",\n \"type\": \"<string>\",\n \"definitionUri\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/plan-definitions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"purpose\": \"<string>\",\n \"usage\": \"<string>\",\n \"publisher\": \"<string>\",\n \"date\": \"<string>\",\n \"version\": \"<string>\",\n \"url\": \"<string>\",\n \"experimental\": true,\n \"topic\": [\n \"<string>\"\n ],\n \"goal\": [\n {\n \"description\": \"<string>\",\n \"priority\": \"<string>\",\n \"category\": \"<string>\"\n }\n ],\n \"action\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"priority\": \"<string>\",\n \"code\": \"<string>\",\n \"type\": \"<string>\",\n \"definitionUri\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyPlan Definitions
Create Plan Definition
POST
/
v1
/
plan-definitions
Create plan definition
curl --request POST \
--url https://api.clinikapi.com/v1/plan-definitions \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"title": "<string>",
"type": "<string>",
"description": "<string>",
"purpose": "<string>",
"usage": "<string>",
"publisher": "<string>",
"date": "<string>",
"version": "<string>",
"url": "<string>",
"experimental": true,
"topic": [
"<string>"
],
"goal": [
{
"description": "<string>",
"priority": "<string>",
"category": "<string>"
}
],
"action": [
{
"title": "<string>",
"description": "<string>",
"priority": "<string>",
"code": "<string>",
"type": "<string>",
"definitionUri": "<string>"
}
]
}
'import requests
url = "https://api.clinikapi.com/v1/plan-definitions"
payload = {
"name": "<string>",
"title": "<string>",
"type": "<string>",
"description": "<string>",
"purpose": "<string>",
"usage": "<string>",
"publisher": "<string>",
"date": "<string>",
"version": "<string>",
"url": "<string>",
"experimental": True,
"topic": ["<string>"],
"goal": [
{
"description": "<string>",
"priority": "<string>",
"category": "<string>"
}
],
"action": [
{
"title": "<string>",
"description": "<string>",
"priority": "<string>",
"code": "<string>",
"type": "<string>",
"definitionUri": "<string>"
}
]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
title: '<string>',
type: '<string>',
description: '<string>',
purpose: '<string>',
usage: '<string>',
publisher: '<string>',
date: '<string>',
version: '<string>',
url: '<string>',
experimental: true,
topic: ['<string>'],
goal: [{description: '<string>', priority: '<string>', category: '<string>'}],
action: [
{
title: '<string>',
description: '<string>',
priority: '<string>',
code: '<string>',
type: '<string>',
definitionUri: '<string>'
}
]
})
};
fetch('https://api.clinikapi.com/v1/plan-definitions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.clinikapi.com/v1/plan-definitions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'title' => '<string>',
'type' => '<string>',
'description' => '<string>',
'purpose' => '<string>',
'usage' => '<string>',
'publisher' => '<string>',
'date' => '<string>',
'version' => '<string>',
'url' => '<string>',
'experimental' => true,
'topic' => [
'<string>'
],
'goal' => [
[
'description' => '<string>',
'priority' => '<string>',
'category' => '<string>'
]
],
'action' => [
[
'title' => '<string>',
'description' => '<string>',
'priority' => '<string>',
'code' => '<string>',
'type' => '<string>',
'definitionUri' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.clinikapi.com/v1/plan-definitions"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"purpose\": \"<string>\",\n \"usage\": \"<string>\",\n \"publisher\": \"<string>\",\n \"date\": \"<string>\",\n \"version\": \"<string>\",\n \"url\": \"<string>\",\n \"experimental\": true,\n \"topic\": [\n \"<string>\"\n ],\n \"goal\": [\n {\n \"description\": \"<string>\",\n \"priority\": \"<string>\",\n \"category\": \"<string>\"\n }\n ],\n \"action\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"priority\": \"<string>\",\n \"code\": \"<string>\",\n \"type\": \"<string>\",\n \"definitionUri\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.clinikapi.com/v1/plan-definitions")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"purpose\": \"<string>\",\n \"usage\": \"<string>\",\n \"publisher\": \"<string>\",\n \"date\": \"<string>\",\n \"version\": \"<string>\",\n \"url\": \"<string>\",\n \"experimental\": true,\n \"topic\": [\n \"<string>\"\n ],\n \"goal\": [\n {\n \"description\": \"<string>\",\n \"priority\": \"<string>\",\n \"category\": \"<string>\"\n }\n ],\n \"action\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"priority\": \"<string>\",\n \"code\": \"<string>\",\n \"type\": \"<string>\",\n \"definitionUri\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/plan-definitions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"type\": \"<string>\",\n \"description\": \"<string>\",\n \"purpose\": \"<string>\",\n \"usage\": \"<string>\",\n \"publisher\": \"<string>\",\n \"date\": \"<string>\",\n \"version\": \"<string>\",\n \"url\": \"<string>\",\n \"experimental\": true,\n \"topic\": [\n \"<string>\"\n ],\n \"goal\": [\n {\n \"description\": \"<string>\",\n \"priority\": \"<string>\",\n \"category\": \"<string>\"\n }\n ],\n \"action\": [\n {\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"priority\": \"<string>\",\n \"code\": \"<string>\",\n \"type\": \"<string>\",\n \"definitionUri\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Available options:
draft, active, retired Maximum string length:
500Maximum string length:
500Maximum string length:
200Maximum string length:
5000Maximum string length:
5000Maximum string length:
5000Maximum string length:
500Maximum string length:
30Maximum string length:
100Maximum string length:
2000Maximum array length:
10Maximum string length:
200Maximum array length:
20Show child attributes
Show child attributes
Maximum array length:
50Show child attributes
Show child attributes
Response
201
Plan definition created
⌘I