Create Knowledge entry
curl --request POST \
--url https://app.govworx.net/api/v1/external/knowledge \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"name": "Cardiac Arrest - Adult",
"provider": "APCO",
"externalId": "apco-card-cardiac-arrest-adult",
"externalVersion": "v1.0",
"description": "APCO standard protocol for adult cardiac arrest.",
"knowledgeType": "GUIDE_CARD",
"publish": "true",
"apiControl": {
"questions": "false",
"incidentType": "false",
"spokenInstructions": "false",
"cadActions": "false",
"smsMessages": "false",
"dispatchTriggers": "false"
},
"isAllCallers": "false",
"interview": {
"id": "<string>",
"name": "Cardiac Arrest - Adult",
"intent": "Caller reports an unresponsive adult with no pulse.",
"service": "MEDICAL",
"isRoot": true,
"disciplines": [
{
"id": 123,
"name": "<string>"
}
],
"questionList": [
{
"id": 123,
"referenceId": "q-1a2b3c4d",
"text": "Is the patient breathing normally?",
"intent": "<string>",
"lowQualityCriteria": "<string>",
"highQualityCriteria": "<string>",
"evaluatable": true,
"useInAssist": true,
"isCritical": true,
"required": true,
"relatedQuestions": [
{
"id": 123,
"displayCriteria": "<string>",
"questionList": "<unknown>"
}
]
}
]
},
"actions": {
"id": "<string>",
"name": "Cardiac Arrest - Actions",
"purpose": "<string>",
"disciplines": [
{
"id": 123,
"name": "<string>"
}
],
"spokenInstructions": [
{
"referenceId": "si-1a2b3c4d",
"instruction": "Place the heel of one hand on the center of the chest.",
"sequence": 123,
"conditionedOn": "<string>",
"referenceMedia": "<string>",
"evaluatable": true,
"useInAssist": true,
"required": true,
"isCritical": true
}
],
"cadActions": [
{
"referenceId": "ca-1a2b3c4d",
"instruction": "Enter call type CARDIAC.",
"role": "CALLTAKER",
"conditionedOn": "<string>",
"sequence": 123,
"evaluatable": true,
"useInAssist": true,
"required": true
}
],
"smsMessages": [
{
"referenceId": "sms-1a2b3c4d",
"message": "We've dispatched help. Stay on the line.",
"mediaRef": "<string>",
"conditionedOn": "<string>",
"sequence": 123
}
],
"dispatchTriggers": [
{
"referenceId": "dt-1a2b3c4d",
"dispatchCode": "29B",
"condition": "<string>",
"sequence": 123,
"pinnedCode": true,
"fallbackTrigger": true
}
],
"media": [
{
"referenceId": "<string>",
"name": "<string>",
"description": "<string>",
"mediaType": "IMAGE",
"url": "<string>"
}
]
}
}
EOFimport requests
url = "https://app.govworx.net/api/v1/external/knowledge"
payload = {
"name": "Cardiac Arrest - Adult",
"provider": "APCO",
"externalId": "apco-card-cardiac-arrest-adult",
"externalVersion": "v1.0",
"description": "APCO standard protocol for adult cardiac arrest.",
"knowledgeType": "GUIDE_CARD",
"publish": "true",
"apiControl": {
"questions": "false",
"incidentType": "false",
"spokenInstructions": "false",
"cadActions": "false",
"smsMessages": "false",
"dispatchTriggers": "false"
},
"isAllCallers": "false",
"interview": {
"id": "<string>",
"name": "Cardiac Arrest - Adult",
"intent": "Caller reports an unresponsive adult with no pulse.",
"service": "MEDICAL",
"isRoot": True,
"disciplines": [
{
"id": 123,
"name": "<string>"
}
],
"questionList": [
{
"id": 123,
"referenceId": "q-1a2b3c4d",
"text": "Is the patient breathing normally?",
"intent": "<string>",
"lowQualityCriteria": "<string>",
"highQualityCriteria": "<string>",
"evaluatable": True,
"useInAssist": True,
"isCritical": True,
"required": True,
"relatedQuestions": [
{
"id": 123,
"displayCriteria": "<string>",
"questionList": "<unknown>"
}
]
}
]
},
"actions": {
"id": "<string>",
"name": "Cardiac Arrest - Actions",
"purpose": "<string>",
"disciplines": [
{
"id": 123,
"name": "<string>"
}
],
"spokenInstructions": [
{
"referenceId": "si-1a2b3c4d",
"instruction": "Place the heel of one hand on the center of the chest.",
"sequence": 123,
"conditionedOn": "<string>",
"referenceMedia": "<string>",
"evaluatable": True,
"useInAssist": True,
"required": True,
"isCritical": True
}
],
"cadActions": [
{
"referenceId": "ca-1a2b3c4d",
"instruction": "Enter call type CARDIAC.",
"role": "CALLTAKER",
"conditionedOn": "<string>",
"sequence": 123,
"evaluatable": True,
"useInAssist": True,
"required": True
}
],
"smsMessages": [
{
"referenceId": "sms-1a2b3c4d",
"message": "We've dispatched help. Stay on the line.",
"mediaRef": "<string>",
"conditionedOn": "<string>",
"sequence": 123
}
],
"dispatchTriggers": [
{
"referenceId": "dt-1a2b3c4d",
"dispatchCode": "29B",
"condition": "<string>",
"sequence": 123,
"pinnedCode": True,
"fallbackTrigger": True
}
],
"media": [
{
"referenceId": "<string>",
"name": "<string>",
"description": "<string>",
"mediaType": "IMAGE",
"url": "<string>"
}
]
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Cardiac Arrest - Adult',
provider: 'APCO',
externalId: 'apco-card-cardiac-arrest-adult',
externalVersion: 'v1.0',
description: 'APCO standard protocol for adult cardiac arrest.',
knowledgeType: 'GUIDE_CARD',
publish: 'true',
apiControl: {
questions: 'false',
incidentType: 'false',
spokenInstructions: 'false',
cadActions: 'false',
smsMessages: 'false',
dispatchTriggers: 'false'
},
isAllCallers: 'false',
interview: {
id: '<string>',
name: 'Cardiac Arrest - Adult',
intent: 'Caller reports an unresponsive adult with no pulse.',
service: 'MEDICAL',
isRoot: true,
disciplines: [{id: 123, name: '<string>'}],
questionList: [
{
id: 123,
referenceId: 'q-1a2b3c4d',
text: 'Is the patient breathing normally?',
intent: '<string>',
lowQualityCriteria: '<string>',
highQualityCriteria: '<string>',
evaluatable: true,
useInAssist: true,
isCritical: true,
required: true,
relatedQuestions: [{id: 123, displayCriteria: '<string>', questionList: '<unknown>'}]
}
]
},
actions: {
id: '<string>',
name: 'Cardiac Arrest - Actions',
purpose: '<string>',
disciplines: [{id: 123, name: '<string>'}],
spokenInstructions: [
{
referenceId: 'si-1a2b3c4d',
instruction: 'Place the heel of one hand on the center of the chest.',
sequence: 123,
conditionedOn: '<string>',
referenceMedia: '<string>',
evaluatable: true,
useInAssist: true,
required: true,
isCritical: true
}
],
cadActions: [
{
referenceId: 'ca-1a2b3c4d',
instruction: 'Enter call type CARDIAC.',
role: 'CALLTAKER',
conditionedOn: '<string>',
sequence: 123,
evaluatable: true,
useInAssist: true,
required: true
}
],
smsMessages: [
{
referenceId: 'sms-1a2b3c4d',
message: 'We\'ve dispatched help. Stay on the line.',
mediaRef: '<string>',
conditionedOn: '<string>',
sequence: 123
}
],
dispatchTriggers: [
{
referenceId: 'dt-1a2b3c4d',
dispatchCode: '29B',
condition: '<string>',
sequence: 123,
pinnedCode: true,
fallbackTrigger: true
}
],
media: [
{
referenceId: '<string>',
name: '<string>',
description: '<string>',
mediaType: 'IMAGE',
url: '<string>'
}
]
}
})
};
fetch('https://app.govworx.net/api/v1/external/knowledge', 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://app.govworx.net/api/v1/external/knowledge",
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' => 'Cardiac Arrest - Adult',
'provider' => 'APCO',
'externalId' => 'apco-card-cardiac-arrest-adult',
'externalVersion' => 'v1.0',
'description' => 'APCO standard protocol for adult cardiac arrest.',
'knowledgeType' => 'GUIDE_CARD',
'publish' => 'true',
'apiControl' => [
'questions' => 'false',
'incidentType' => 'false',
'spokenInstructions' => 'false',
'cadActions' => 'false',
'smsMessages' => 'false',
'dispatchTriggers' => 'false'
],
'isAllCallers' => 'false',
'interview' => [
'id' => '<string>',
'name' => 'Cardiac Arrest - Adult',
'intent' => 'Caller reports an unresponsive adult with no pulse.',
'service' => 'MEDICAL',
'isRoot' => true,
'disciplines' => [
[
'id' => 123,
'name' => '<string>'
]
],
'questionList' => [
[
'id' => 123,
'referenceId' => 'q-1a2b3c4d',
'text' => 'Is the patient breathing normally?',
'intent' => '<string>',
'lowQualityCriteria' => '<string>',
'highQualityCriteria' => '<string>',
'evaluatable' => true,
'useInAssist' => true,
'isCritical' => true,
'required' => true,
'relatedQuestions' => [
[
'id' => 123,
'displayCriteria' => '<string>',
'questionList' => '<unknown>'
]
]
]
]
],
'actions' => [
'id' => '<string>',
'name' => 'Cardiac Arrest - Actions',
'purpose' => '<string>',
'disciplines' => [
[
'id' => 123,
'name' => '<string>'
]
],
'spokenInstructions' => [
[
'referenceId' => 'si-1a2b3c4d',
'instruction' => 'Place the heel of one hand on the center of the chest.',
'sequence' => 123,
'conditionedOn' => '<string>',
'referenceMedia' => '<string>',
'evaluatable' => true,
'useInAssist' => true,
'required' => true,
'isCritical' => true
]
],
'cadActions' => [
[
'referenceId' => 'ca-1a2b3c4d',
'instruction' => 'Enter call type CARDIAC.',
'role' => 'CALLTAKER',
'conditionedOn' => '<string>',
'sequence' => 123,
'evaluatable' => true,
'useInAssist' => true,
'required' => true
]
],
'smsMessages' => [
[
'referenceId' => 'sms-1a2b3c4d',
'message' => 'We\'ve dispatched help. Stay on the line.',
'mediaRef' => '<string>',
'conditionedOn' => '<string>',
'sequence' => 123
]
],
'dispatchTriggers' => [
[
'referenceId' => 'dt-1a2b3c4d',
'dispatchCode' => '29B',
'condition' => '<string>',
'sequence' => 123,
'pinnedCode' => true,
'fallbackTrigger' => true
]
],
'media' => [
[
'referenceId' => '<string>',
'name' => '<string>',
'description' => '<string>',
'mediaType' => 'IMAGE',
'url' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://app.govworx.net/api/v1/external/knowledge"
payload := strings.NewReader("{\n \"name\": \"Cardiac Arrest - Adult\",\n \"provider\": \"APCO\",\n \"externalId\": \"apco-card-cardiac-arrest-adult\",\n \"externalVersion\": \"v1.0\",\n \"description\": \"APCO standard protocol for adult cardiac arrest.\",\n \"knowledgeType\": \"GUIDE_CARD\",\n \"publish\": \"true\",\n \"apiControl\": {\n \"questions\": \"false\",\n \"incidentType\": \"false\",\n \"spokenInstructions\": \"false\",\n \"cadActions\": \"false\",\n \"smsMessages\": \"false\",\n \"dispatchTriggers\": \"false\"\n },\n \"isAllCallers\": \"false\",\n \"interview\": {\n \"id\": \"<string>\",\n \"name\": \"Cardiac Arrest - Adult\",\n \"intent\": \"Caller reports an unresponsive adult with no pulse.\",\n \"service\": \"MEDICAL\",\n \"isRoot\": true,\n \"disciplines\": [\n {\n \"id\": 123,\n \"name\": \"<string>\"\n }\n ],\n \"questionList\": [\n {\n \"id\": 123,\n \"referenceId\": \"q-1a2b3c4d\",\n \"text\": \"Is the patient breathing normally?\",\n \"intent\": \"<string>\",\n \"lowQualityCriteria\": \"<string>\",\n \"highQualityCriteria\": \"<string>\",\n \"evaluatable\": true,\n \"useInAssist\": true,\n \"isCritical\": true,\n \"required\": true,\n \"relatedQuestions\": [\n {\n \"id\": 123,\n \"displayCriteria\": \"<string>\",\n \"questionList\": \"<unknown>\"\n }\n ]\n }\n ]\n },\n \"actions\": {\n \"id\": \"<string>\",\n \"name\": \"Cardiac Arrest - Actions\",\n \"purpose\": \"<string>\",\n \"disciplines\": [\n {\n \"id\": 123,\n \"name\": \"<string>\"\n }\n ],\n \"spokenInstructions\": [\n {\n \"referenceId\": \"si-1a2b3c4d\",\n \"instruction\": \"Place the heel of one hand on the center of the chest.\",\n \"sequence\": 123,\n \"conditionedOn\": \"<string>\",\n \"referenceMedia\": \"<string>\",\n \"evaluatable\": true,\n \"useInAssist\": true,\n \"required\": true,\n \"isCritical\": true\n }\n ],\n \"cadActions\": [\n {\n \"referenceId\": \"ca-1a2b3c4d\",\n \"instruction\": \"Enter call type CARDIAC.\",\n \"role\": \"CALLTAKER\",\n \"conditionedOn\": \"<string>\",\n \"sequence\": 123,\n \"evaluatable\": true,\n \"useInAssist\": true,\n \"required\": true\n }\n ],\n \"smsMessages\": [\n {\n \"referenceId\": \"sms-1a2b3c4d\",\n \"message\": \"We've dispatched help. Stay on the line.\",\n \"mediaRef\": \"<string>\",\n \"conditionedOn\": \"<string>\",\n \"sequence\": 123\n }\n ],\n \"dispatchTriggers\": [\n {\n \"referenceId\": \"dt-1a2b3c4d\",\n \"dispatchCode\": \"29B\",\n \"condition\": \"<string>\",\n \"sequence\": 123,\n \"pinnedCode\": true,\n \"fallbackTrigger\": true\n }\n ],\n \"media\": [\n {\n \"referenceId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"mediaType\": \"IMAGE\",\n \"url\": \"<string>\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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://app.govworx.net/api/v1/external/knowledge")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Cardiac Arrest - Adult\",\n \"provider\": \"APCO\",\n \"externalId\": \"apco-card-cardiac-arrest-adult\",\n \"externalVersion\": \"v1.0\",\n \"description\": \"APCO standard protocol for adult cardiac arrest.\",\n \"knowledgeType\": \"GUIDE_CARD\",\n \"publish\": \"true\",\n \"apiControl\": {\n \"questions\": \"false\",\n \"incidentType\": \"false\",\n \"spokenInstructions\": \"false\",\n \"cadActions\": \"false\",\n \"smsMessages\": \"false\",\n \"dispatchTriggers\": \"false\"\n },\n \"isAllCallers\": \"false\",\n \"interview\": {\n \"id\": \"<string>\",\n \"name\": \"Cardiac Arrest - Adult\",\n \"intent\": \"Caller reports an unresponsive adult with no pulse.\",\n \"service\": \"MEDICAL\",\n \"isRoot\": true,\n \"disciplines\": [\n {\n \"id\": 123,\n \"name\": \"<string>\"\n }\n ],\n \"questionList\": [\n {\n \"id\": 123,\n \"referenceId\": \"q-1a2b3c4d\",\n \"text\": \"Is the patient breathing normally?\",\n \"intent\": \"<string>\",\n \"lowQualityCriteria\": \"<string>\",\n \"highQualityCriteria\": \"<string>\",\n \"evaluatable\": true,\n \"useInAssist\": true,\n \"isCritical\": true,\n \"required\": true,\n \"relatedQuestions\": [\n {\n \"id\": 123,\n \"displayCriteria\": \"<string>\",\n \"questionList\": \"<unknown>\"\n }\n ]\n }\n ]\n },\n \"actions\": {\n \"id\": \"<string>\",\n \"name\": \"Cardiac Arrest - Actions\",\n \"purpose\": \"<string>\",\n \"disciplines\": [\n {\n \"id\": 123,\n \"name\": \"<string>\"\n }\n ],\n \"spokenInstructions\": [\n {\n \"referenceId\": \"si-1a2b3c4d\",\n \"instruction\": \"Place the heel of one hand on the center of the chest.\",\n \"sequence\": 123,\n \"conditionedOn\": \"<string>\",\n \"referenceMedia\": \"<string>\",\n \"evaluatable\": true,\n \"useInAssist\": true,\n \"required\": true,\n \"isCritical\": true\n }\n ],\n \"cadActions\": [\n {\n \"referenceId\": \"ca-1a2b3c4d\",\n \"instruction\": \"Enter call type CARDIAC.\",\n \"role\": \"CALLTAKER\",\n \"conditionedOn\": \"<string>\",\n \"sequence\": 123,\n \"evaluatable\": true,\n \"useInAssist\": true,\n \"required\": true\n }\n ],\n \"smsMessages\": [\n {\n \"referenceId\": \"sms-1a2b3c4d\",\n \"message\": \"We've dispatched help. Stay on the line.\",\n \"mediaRef\": \"<string>\",\n \"conditionedOn\": \"<string>\",\n \"sequence\": 123\n }\n ],\n \"dispatchTriggers\": [\n {\n \"referenceId\": \"dt-1a2b3c4d\",\n \"dispatchCode\": \"29B\",\n \"condition\": \"<string>\",\n \"sequence\": 123,\n \"pinnedCode\": true,\n \"fallbackTrigger\": true\n }\n ],\n \"media\": [\n {\n \"referenceId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"mediaType\": \"IMAGE\",\n \"url\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.govworx.net/api/v1/external/knowledge")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Cardiac Arrest - Adult\",\n \"provider\": \"APCO\",\n \"externalId\": \"apco-card-cardiac-arrest-adult\",\n \"externalVersion\": \"v1.0\",\n \"description\": \"APCO standard protocol for adult cardiac arrest.\",\n \"knowledgeType\": \"GUIDE_CARD\",\n \"publish\": \"true\",\n \"apiControl\": {\n \"questions\": \"false\",\n \"incidentType\": \"false\",\n \"spokenInstructions\": \"false\",\n \"cadActions\": \"false\",\n \"smsMessages\": \"false\",\n \"dispatchTriggers\": \"false\"\n },\n \"isAllCallers\": \"false\",\n \"interview\": {\n \"id\": \"<string>\",\n \"name\": \"Cardiac Arrest - Adult\",\n \"intent\": \"Caller reports an unresponsive adult with no pulse.\",\n \"service\": \"MEDICAL\",\n \"isRoot\": true,\n \"disciplines\": [\n {\n \"id\": 123,\n \"name\": \"<string>\"\n }\n ],\n \"questionList\": [\n {\n \"id\": 123,\n \"referenceId\": \"q-1a2b3c4d\",\n \"text\": \"Is the patient breathing normally?\",\n \"intent\": \"<string>\",\n \"lowQualityCriteria\": \"<string>\",\n \"highQualityCriteria\": \"<string>\",\n \"evaluatable\": true,\n \"useInAssist\": true,\n \"isCritical\": true,\n \"required\": true,\n \"relatedQuestions\": [\n {\n \"id\": 123,\n \"displayCriteria\": \"<string>\",\n \"questionList\": \"<unknown>\"\n }\n ]\n }\n ]\n },\n \"actions\": {\n \"id\": \"<string>\",\n \"name\": \"Cardiac Arrest - Actions\",\n \"purpose\": \"<string>\",\n \"disciplines\": [\n {\n \"id\": 123,\n \"name\": \"<string>\"\n }\n ],\n \"spokenInstructions\": [\n {\n \"referenceId\": \"si-1a2b3c4d\",\n \"instruction\": \"Place the heel of one hand on the center of the chest.\",\n \"sequence\": 123,\n \"conditionedOn\": \"<string>\",\n \"referenceMedia\": \"<string>\",\n \"evaluatable\": true,\n \"useInAssist\": true,\n \"required\": true,\n \"isCritical\": true\n }\n ],\n \"cadActions\": [\n {\n \"referenceId\": \"ca-1a2b3c4d\",\n \"instruction\": \"Enter call type CARDIAC.\",\n \"role\": \"CALLTAKER\",\n \"conditionedOn\": \"<string>\",\n \"sequence\": 123,\n \"evaluatable\": true,\n \"useInAssist\": true,\n \"required\": true\n }\n ],\n \"smsMessages\": [\n {\n \"referenceId\": \"sms-1a2b3c4d\",\n \"message\": \"We've dispatched help. Stay on the line.\",\n \"mediaRef\": \"<string>\",\n \"conditionedOn\": \"<string>\",\n \"sequence\": 123\n }\n ],\n \"dispatchTriggers\": [\n {\n \"referenceId\": \"dt-1a2b3c4d\",\n \"dispatchCode\": \"29B\",\n \"condition\": \"<string>\",\n \"sequence\": 123,\n \"pinnedCode\": true,\n \"fallbackTrigger\": true\n }\n ],\n \"media\": [\n {\n \"referenceId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"mediaType\": \"IMAGE\",\n \"url\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 12345,
"name": "Cardiac Arrest - Adult",
"description": "<string>",
"source": "API_IMPORT",
"provider": "APCO",
"knowledgeType": "GUIDE_CARD",
"externalId": "apco-card-cardiac-arrest-adult",
"publishedVersion": 3,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"versions": [
{
"version": 3,
"externalVersion": "v1.2.0",
"isPublished": true,
"description": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"publishedAt": "2023-11-07T05:31:56Z",
"apiControl": {
"questions": "false",
"incidentType": "false",
"spokenInstructions": "false",
"cadActions": "false",
"smsMessages": "false",
"dispatchTriggers": "false"
},
"interview": {
"id": "<string>",
"name": "Cardiac Arrest - Adult",
"intent": "Caller reports an unresponsive adult with no pulse.",
"service": "MEDICAL",
"isRoot": true,
"disciplines": [
{
"id": 123,
"name": "<string>"
}
],
"questionList": [
{
"id": 123,
"referenceId": "q-1a2b3c4d",
"text": "Is the patient breathing normally?",
"intent": "<string>",
"lowQualityCriteria": "<string>",
"highQualityCriteria": "<string>",
"evaluatable": true,
"useInAssist": true,
"isCritical": true,
"required": true,
"relatedQuestions": [
{
"id": 123,
"displayCriteria": "<string>",
"questionList": "<unknown>"
}
]
}
]
},
"actions": {
"id": "<string>",
"name": "Cardiac Arrest - Actions",
"purpose": "<string>",
"disciplines": [
{
"id": 123,
"name": "<string>"
}
],
"spokenInstructions": [
{
"referenceId": "si-1a2b3c4d",
"instruction": "Place the heel of one hand on the center of the chest.",
"sequence": 123,
"conditionedOn": "<string>",
"referenceMedia": "<string>",
"evaluatable": true,
"useInAssist": true,
"required": true,
"isCritical": true
}
],
"cadActions": [
{
"referenceId": "ca-1a2b3c4d",
"instruction": "Enter call type CARDIAC.",
"role": "CALLTAKER",
"conditionedOn": "<string>",
"sequence": 123,
"evaluatable": true,
"useInAssist": true,
"required": true
}
],
"smsMessages": [
{
"referenceId": "sms-1a2b3c4d",
"message": "We've dispatched help. Stay on the line.",
"mediaRef": "<string>",
"conditionedOn": "<string>",
"sequence": 123
}
],
"dispatchTriggers": [
{
"referenceId": "dt-1a2b3c4d",
"dispatchCode": "29B",
"condition": "<string>",
"sequence": 123,
"pinnedCode": true,
"fallbackTrigger": true
}
],
"media": [
{
"referenceId": "<string>",
"name": "<string>",
"description": "<string>",
"mediaType": "IMAGE",
"url": "<string>"
}
],
"links": [
{
"id": 123,
"referenceId": "lk-1a2b3c4d",
"displayCriteria": "<string>",
"targetSectionId": 123,
"targetDocumentName": "<string>",
"targetKnowledgeType": "<string>",
"targetKnowledgeId": 123
}
]
}
}
]
}Knowledge
Create Knowledge entry
Create a new Knowledge entry with its first version. The externalId + provider pair must be unique for the tenant (409 if a duplicate exists).
GovWorx generates a stable referenceId for every item in every content list and echoes them back in the response. Store all referenceId values — they are required to update existing items in place on future append calls.
Section ownership is declared via a single top-level apiControl object. Each flag defaults to false (GovWorx-owned) when absent or when apiControl is omitted entirely. Flags are immutable after creation — delete and recreate to change them.
If publish is true (default), the created version is immediately published and available to GovWorx runtime consumers.
POST
/
api
/
v1
/
external
/
knowledge
Create Knowledge entry
curl --request POST \
--url https://app.govworx.net/api/v1/external/knowledge \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"name": "Cardiac Arrest - Adult",
"provider": "APCO",
"externalId": "apco-card-cardiac-arrest-adult",
"externalVersion": "v1.0",
"description": "APCO standard protocol for adult cardiac arrest.",
"knowledgeType": "GUIDE_CARD",
"publish": "true",
"apiControl": {
"questions": "false",
"incidentType": "false",
"spokenInstructions": "false",
"cadActions": "false",
"smsMessages": "false",
"dispatchTriggers": "false"
},
"isAllCallers": "false",
"interview": {
"id": "<string>",
"name": "Cardiac Arrest - Adult",
"intent": "Caller reports an unresponsive adult with no pulse.",
"service": "MEDICAL",
"isRoot": true,
"disciplines": [
{
"id": 123,
"name": "<string>"
}
],
"questionList": [
{
"id": 123,
"referenceId": "q-1a2b3c4d",
"text": "Is the patient breathing normally?",
"intent": "<string>",
"lowQualityCriteria": "<string>",
"highQualityCriteria": "<string>",
"evaluatable": true,
"useInAssist": true,
"isCritical": true,
"required": true,
"relatedQuestions": [
{
"id": 123,
"displayCriteria": "<string>",
"questionList": "<unknown>"
}
]
}
]
},
"actions": {
"id": "<string>",
"name": "Cardiac Arrest - Actions",
"purpose": "<string>",
"disciplines": [
{
"id": 123,
"name": "<string>"
}
],
"spokenInstructions": [
{
"referenceId": "si-1a2b3c4d",
"instruction": "Place the heel of one hand on the center of the chest.",
"sequence": 123,
"conditionedOn": "<string>",
"referenceMedia": "<string>",
"evaluatable": true,
"useInAssist": true,
"required": true,
"isCritical": true
}
],
"cadActions": [
{
"referenceId": "ca-1a2b3c4d",
"instruction": "Enter call type CARDIAC.",
"role": "CALLTAKER",
"conditionedOn": "<string>",
"sequence": 123,
"evaluatable": true,
"useInAssist": true,
"required": true
}
],
"smsMessages": [
{
"referenceId": "sms-1a2b3c4d",
"message": "We've dispatched help. Stay on the line.",
"mediaRef": "<string>",
"conditionedOn": "<string>",
"sequence": 123
}
],
"dispatchTriggers": [
{
"referenceId": "dt-1a2b3c4d",
"dispatchCode": "29B",
"condition": "<string>",
"sequence": 123,
"pinnedCode": true,
"fallbackTrigger": true
}
],
"media": [
{
"referenceId": "<string>",
"name": "<string>",
"description": "<string>",
"mediaType": "IMAGE",
"url": "<string>"
}
]
}
}
EOFimport requests
url = "https://app.govworx.net/api/v1/external/knowledge"
payload = {
"name": "Cardiac Arrest - Adult",
"provider": "APCO",
"externalId": "apco-card-cardiac-arrest-adult",
"externalVersion": "v1.0",
"description": "APCO standard protocol for adult cardiac arrest.",
"knowledgeType": "GUIDE_CARD",
"publish": "true",
"apiControl": {
"questions": "false",
"incidentType": "false",
"spokenInstructions": "false",
"cadActions": "false",
"smsMessages": "false",
"dispatchTriggers": "false"
},
"isAllCallers": "false",
"interview": {
"id": "<string>",
"name": "Cardiac Arrest - Adult",
"intent": "Caller reports an unresponsive adult with no pulse.",
"service": "MEDICAL",
"isRoot": True,
"disciplines": [
{
"id": 123,
"name": "<string>"
}
],
"questionList": [
{
"id": 123,
"referenceId": "q-1a2b3c4d",
"text": "Is the patient breathing normally?",
"intent": "<string>",
"lowQualityCriteria": "<string>",
"highQualityCriteria": "<string>",
"evaluatable": True,
"useInAssist": True,
"isCritical": True,
"required": True,
"relatedQuestions": [
{
"id": 123,
"displayCriteria": "<string>",
"questionList": "<unknown>"
}
]
}
]
},
"actions": {
"id": "<string>",
"name": "Cardiac Arrest - Actions",
"purpose": "<string>",
"disciplines": [
{
"id": 123,
"name": "<string>"
}
],
"spokenInstructions": [
{
"referenceId": "si-1a2b3c4d",
"instruction": "Place the heel of one hand on the center of the chest.",
"sequence": 123,
"conditionedOn": "<string>",
"referenceMedia": "<string>",
"evaluatable": True,
"useInAssist": True,
"required": True,
"isCritical": True
}
],
"cadActions": [
{
"referenceId": "ca-1a2b3c4d",
"instruction": "Enter call type CARDIAC.",
"role": "CALLTAKER",
"conditionedOn": "<string>",
"sequence": 123,
"evaluatable": True,
"useInAssist": True,
"required": True
}
],
"smsMessages": [
{
"referenceId": "sms-1a2b3c4d",
"message": "We've dispatched help. Stay on the line.",
"mediaRef": "<string>",
"conditionedOn": "<string>",
"sequence": 123
}
],
"dispatchTriggers": [
{
"referenceId": "dt-1a2b3c4d",
"dispatchCode": "29B",
"condition": "<string>",
"sequence": 123,
"pinnedCode": True,
"fallbackTrigger": True
}
],
"media": [
{
"referenceId": "<string>",
"name": "<string>",
"description": "<string>",
"mediaType": "IMAGE",
"url": "<string>"
}
]
}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Cardiac Arrest - Adult',
provider: 'APCO',
externalId: 'apco-card-cardiac-arrest-adult',
externalVersion: 'v1.0',
description: 'APCO standard protocol for adult cardiac arrest.',
knowledgeType: 'GUIDE_CARD',
publish: 'true',
apiControl: {
questions: 'false',
incidentType: 'false',
spokenInstructions: 'false',
cadActions: 'false',
smsMessages: 'false',
dispatchTriggers: 'false'
},
isAllCallers: 'false',
interview: {
id: '<string>',
name: 'Cardiac Arrest - Adult',
intent: 'Caller reports an unresponsive adult with no pulse.',
service: 'MEDICAL',
isRoot: true,
disciplines: [{id: 123, name: '<string>'}],
questionList: [
{
id: 123,
referenceId: 'q-1a2b3c4d',
text: 'Is the patient breathing normally?',
intent: '<string>',
lowQualityCriteria: '<string>',
highQualityCriteria: '<string>',
evaluatable: true,
useInAssist: true,
isCritical: true,
required: true,
relatedQuestions: [{id: 123, displayCriteria: '<string>', questionList: '<unknown>'}]
}
]
},
actions: {
id: '<string>',
name: 'Cardiac Arrest - Actions',
purpose: '<string>',
disciplines: [{id: 123, name: '<string>'}],
spokenInstructions: [
{
referenceId: 'si-1a2b3c4d',
instruction: 'Place the heel of one hand on the center of the chest.',
sequence: 123,
conditionedOn: '<string>',
referenceMedia: '<string>',
evaluatable: true,
useInAssist: true,
required: true,
isCritical: true
}
],
cadActions: [
{
referenceId: 'ca-1a2b3c4d',
instruction: 'Enter call type CARDIAC.',
role: 'CALLTAKER',
conditionedOn: '<string>',
sequence: 123,
evaluatable: true,
useInAssist: true,
required: true
}
],
smsMessages: [
{
referenceId: 'sms-1a2b3c4d',
message: 'We\'ve dispatched help. Stay on the line.',
mediaRef: '<string>',
conditionedOn: '<string>',
sequence: 123
}
],
dispatchTriggers: [
{
referenceId: 'dt-1a2b3c4d',
dispatchCode: '29B',
condition: '<string>',
sequence: 123,
pinnedCode: true,
fallbackTrigger: true
}
],
media: [
{
referenceId: '<string>',
name: '<string>',
description: '<string>',
mediaType: 'IMAGE',
url: '<string>'
}
]
}
})
};
fetch('https://app.govworx.net/api/v1/external/knowledge', 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://app.govworx.net/api/v1/external/knowledge",
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' => 'Cardiac Arrest - Adult',
'provider' => 'APCO',
'externalId' => 'apco-card-cardiac-arrest-adult',
'externalVersion' => 'v1.0',
'description' => 'APCO standard protocol for adult cardiac arrest.',
'knowledgeType' => 'GUIDE_CARD',
'publish' => 'true',
'apiControl' => [
'questions' => 'false',
'incidentType' => 'false',
'spokenInstructions' => 'false',
'cadActions' => 'false',
'smsMessages' => 'false',
'dispatchTriggers' => 'false'
],
'isAllCallers' => 'false',
'interview' => [
'id' => '<string>',
'name' => 'Cardiac Arrest - Adult',
'intent' => 'Caller reports an unresponsive adult with no pulse.',
'service' => 'MEDICAL',
'isRoot' => true,
'disciplines' => [
[
'id' => 123,
'name' => '<string>'
]
],
'questionList' => [
[
'id' => 123,
'referenceId' => 'q-1a2b3c4d',
'text' => 'Is the patient breathing normally?',
'intent' => '<string>',
'lowQualityCriteria' => '<string>',
'highQualityCriteria' => '<string>',
'evaluatable' => true,
'useInAssist' => true,
'isCritical' => true,
'required' => true,
'relatedQuestions' => [
[
'id' => 123,
'displayCriteria' => '<string>',
'questionList' => '<unknown>'
]
]
]
]
],
'actions' => [
'id' => '<string>',
'name' => 'Cardiac Arrest - Actions',
'purpose' => '<string>',
'disciplines' => [
[
'id' => 123,
'name' => '<string>'
]
],
'spokenInstructions' => [
[
'referenceId' => 'si-1a2b3c4d',
'instruction' => 'Place the heel of one hand on the center of the chest.',
'sequence' => 123,
'conditionedOn' => '<string>',
'referenceMedia' => '<string>',
'evaluatable' => true,
'useInAssist' => true,
'required' => true,
'isCritical' => true
]
],
'cadActions' => [
[
'referenceId' => 'ca-1a2b3c4d',
'instruction' => 'Enter call type CARDIAC.',
'role' => 'CALLTAKER',
'conditionedOn' => '<string>',
'sequence' => 123,
'evaluatable' => true,
'useInAssist' => true,
'required' => true
]
],
'smsMessages' => [
[
'referenceId' => 'sms-1a2b3c4d',
'message' => 'We\'ve dispatched help. Stay on the line.',
'mediaRef' => '<string>',
'conditionedOn' => '<string>',
'sequence' => 123
]
],
'dispatchTriggers' => [
[
'referenceId' => 'dt-1a2b3c4d',
'dispatchCode' => '29B',
'condition' => '<string>',
'sequence' => 123,
'pinnedCode' => true,
'fallbackTrigger' => true
]
],
'media' => [
[
'referenceId' => '<string>',
'name' => '<string>',
'description' => '<string>',
'mediaType' => 'IMAGE',
'url' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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://app.govworx.net/api/v1/external/knowledge"
payload := strings.NewReader("{\n \"name\": \"Cardiac Arrest - Adult\",\n \"provider\": \"APCO\",\n \"externalId\": \"apco-card-cardiac-arrest-adult\",\n \"externalVersion\": \"v1.0\",\n \"description\": \"APCO standard protocol for adult cardiac arrest.\",\n \"knowledgeType\": \"GUIDE_CARD\",\n \"publish\": \"true\",\n \"apiControl\": {\n \"questions\": \"false\",\n \"incidentType\": \"false\",\n \"spokenInstructions\": \"false\",\n \"cadActions\": \"false\",\n \"smsMessages\": \"false\",\n \"dispatchTriggers\": \"false\"\n },\n \"isAllCallers\": \"false\",\n \"interview\": {\n \"id\": \"<string>\",\n \"name\": \"Cardiac Arrest - Adult\",\n \"intent\": \"Caller reports an unresponsive adult with no pulse.\",\n \"service\": \"MEDICAL\",\n \"isRoot\": true,\n \"disciplines\": [\n {\n \"id\": 123,\n \"name\": \"<string>\"\n }\n ],\n \"questionList\": [\n {\n \"id\": 123,\n \"referenceId\": \"q-1a2b3c4d\",\n \"text\": \"Is the patient breathing normally?\",\n \"intent\": \"<string>\",\n \"lowQualityCriteria\": \"<string>\",\n \"highQualityCriteria\": \"<string>\",\n \"evaluatable\": true,\n \"useInAssist\": true,\n \"isCritical\": true,\n \"required\": true,\n \"relatedQuestions\": [\n {\n \"id\": 123,\n \"displayCriteria\": \"<string>\",\n \"questionList\": \"<unknown>\"\n }\n ]\n }\n ]\n },\n \"actions\": {\n \"id\": \"<string>\",\n \"name\": \"Cardiac Arrest - Actions\",\n \"purpose\": \"<string>\",\n \"disciplines\": [\n {\n \"id\": 123,\n \"name\": \"<string>\"\n }\n ],\n \"spokenInstructions\": [\n {\n \"referenceId\": \"si-1a2b3c4d\",\n \"instruction\": \"Place the heel of one hand on the center of the chest.\",\n \"sequence\": 123,\n \"conditionedOn\": \"<string>\",\n \"referenceMedia\": \"<string>\",\n \"evaluatable\": true,\n \"useInAssist\": true,\n \"required\": true,\n \"isCritical\": true\n }\n ],\n \"cadActions\": [\n {\n \"referenceId\": \"ca-1a2b3c4d\",\n \"instruction\": \"Enter call type CARDIAC.\",\n \"role\": \"CALLTAKER\",\n \"conditionedOn\": \"<string>\",\n \"sequence\": 123,\n \"evaluatable\": true,\n \"useInAssist\": true,\n \"required\": true\n }\n ],\n \"smsMessages\": [\n {\n \"referenceId\": \"sms-1a2b3c4d\",\n \"message\": \"We've dispatched help. Stay on the line.\",\n \"mediaRef\": \"<string>\",\n \"conditionedOn\": \"<string>\",\n \"sequence\": 123\n }\n ],\n \"dispatchTriggers\": [\n {\n \"referenceId\": \"dt-1a2b3c4d\",\n \"dispatchCode\": \"29B\",\n \"condition\": \"<string>\",\n \"sequence\": 123,\n \"pinnedCode\": true,\n \"fallbackTrigger\": true\n }\n ],\n \"media\": [\n {\n \"referenceId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"mediaType\": \"IMAGE\",\n \"url\": \"<string>\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
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://app.govworx.net/api/v1/external/knowledge")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Cardiac Arrest - Adult\",\n \"provider\": \"APCO\",\n \"externalId\": \"apco-card-cardiac-arrest-adult\",\n \"externalVersion\": \"v1.0\",\n \"description\": \"APCO standard protocol for adult cardiac arrest.\",\n \"knowledgeType\": \"GUIDE_CARD\",\n \"publish\": \"true\",\n \"apiControl\": {\n \"questions\": \"false\",\n \"incidentType\": \"false\",\n \"spokenInstructions\": \"false\",\n \"cadActions\": \"false\",\n \"smsMessages\": \"false\",\n \"dispatchTriggers\": \"false\"\n },\n \"isAllCallers\": \"false\",\n \"interview\": {\n \"id\": \"<string>\",\n \"name\": \"Cardiac Arrest - Adult\",\n \"intent\": \"Caller reports an unresponsive adult with no pulse.\",\n \"service\": \"MEDICAL\",\n \"isRoot\": true,\n \"disciplines\": [\n {\n \"id\": 123,\n \"name\": \"<string>\"\n }\n ],\n \"questionList\": [\n {\n \"id\": 123,\n \"referenceId\": \"q-1a2b3c4d\",\n \"text\": \"Is the patient breathing normally?\",\n \"intent\": \"<string>\",\n \"lowQualityCriteria\": \"<string>\",\n \"highQualityCriteria\": \"<string>\",\n \"evaluatable\": true,\n \"useInAssist\": true,\n \"isCritical\": true,\n \"required\": true,\n \"relatedQuestions\": [\n {\n \"id\": 123,\n \"displayCriteria\": \"<string>\",\n \"questionList\": \"<unknown>\"\n }\n ]\n }\n ]\n },\n \"actions\": {\n \"id\": \"<string>\",\n \"name\": \"Cardiac Arrest - Actions\",\n \"purpose\": \"<string>\",\n \"disciplines\": [\n {\n \"id\": 123,\n \"name\": \"<string>\"\n }\n ],\n \"spokenInstructions\": [\n {\n \"referenceId\": \"si-1a2b3c4d\",\n \"instruction\": \"Place the heel of one hand on the center of the chest.\",\n \"sequence\": 123,\n \"conditionedOn\": \"<string>\",\n \"referenceMedia\": \"<string>\",\n \"evaluatable\": true,\n \"useInAssist\": true,\n \"required\": true,\n \"isCritical\": true\n }\n ],\n \"cadActions\": [\n {\n \"referenceId\": \"ca-1a2b3c4d\",\n \"instruction\": \"Enter call type CARDIAC.\",\n \"role\": \"CALLTAKER\",\n \"conditionedOn\": \"<string>\",\n \"sequence\": 123,\n \"evaluatable\": true,\n \"useInAssist\": true,\n \"required\": true\n }\n ],\n \"smsMessages\": [\n {\n \"referenceId\": \"sms-1a2b3c4d\",\n \"message\": \"We've dispatched help. Stay on the line.\",\n \"mediaRef\": \"<string>\",\n \"conditionedOn\": \"<string>\",\n \"sequence\": 123\n }\n ],\n \"dispatchTriggers\": [\n {\n \"referenceId\": \"dt-1a2b3c4d\",\n \"dispatchCode\": \"29B\",\n \"condition\": \"<string>\",\n \"sequence\": 123,\n \"pinnedCode\": true,\n \"fallbackTrigger\": true\n }\n ],\n \"media\": [\n {\n \"referenceId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"mediaType\": \"IMAGE\",\n \"url\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.govworx.net/api/v1/external/knowledge")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Cardiac Arrest - Adult\",\n \"provider\": \"APCO\",\n \"externalId\": \"apco-card-cardiac-arrest-adult\",\n \"externalVersion\": \"v1.0\",\n \"description\": \"APCO standard protocol for adult cardiac arrest.\",\n \"knowledgeType\": \"GUIDE_CARD\",\n \"publish\": \"true\",\n \"apiControl\": {\n \"questions\": \"false\",\n \"incidentType\": \"false\",\n \"spokenInstructions\": \"false\",\n \"cadActions\": \"false\",\n \"smsMessages\": \"false\",\n \"dispatchTriggers\": \"false\"\n },\n \"isAllCallers\": \"false\",\n \"interview\": {\n \"id\": \"<string>\",\n \"name\": \"Cardiac Arrest - Adult\",\n \"intent\": \"Caller reports an unresponsive adult with no pulse.\",\n \"service\": \"MEDICAL\",\n \"isRoot\": true,\n \"disciplines\": [\n {\n \"id\": 123,\n \"name\": \"<string>\"\n }\n ],\n \"questionList\": [\n {\n \"id\": 123,\n \"referenceId\": \"q-1a2b3c4d\",\n \"text\": \"Is the patient breathing normally?\",\n \"intent\": \"<string>\",\n \"lowQualityCriteria\": \"<string>\",\n \"highQualityCriteria\": \"<string>\",\n \"evaluatable\": true,\n \"useInAssist\": true,\n \"isCritical\": true,\n \"required\": true,\n \"relatedQuestions\": [\n {\n \"id\": 123,\n \"displayCriteria\": \"<string>\",\n \"questionList\": \"<unknown>\"\n }\n ]\n }\n ]\n },\n \"actions\": {\n \"id\": \"<string>\",\n \"name\": \"Cardiac Arrest - Actions\",\n \"purpose\": \"<string>\",\n \"disciplines\": [\n {\n \"id\": 123,\n \"name\": \"<string>\"\n }\n ],\n \"spokenInstructions\": [\n {\n \"referenceId\": \"si-1a2b3c4d\",\n \"instruction\": \"Place the heel of one hand on the center of the chest.\",\n \"sequence\": 123,\n \"conditionedOn\": \"<string>\",\n \"referenceMedia\": \"<string>\",\n \"evaluatable\": true,\n \"useInAssist\": true,\n \"required\": true,\n \"isCritical\": true\n }\n ],\n \"cadActions\": [\n {\n \"referenceId\": \"ca-1a2b3c4d\",\n \"instruction\": \"Enter call type CARDIAC.\",\n \"role\": \"CALLTAKER\",\n \"conditionedOn\": \"<string>\",\n \"sequence\": 123,\n \"evaluatable\": true,\n \"useInAssist\": true,\n \"required\": true\n }\n ],\n \"smsMessages\": [\n {\n \"referenceId\": \"sms-1a2b3c4d\",\n \"message\": \"We've dispatched help. Stay on the line.\",\n \"mediaRef\": \"<string>\",\n \"conditionedOn\": \"<string>\",\n \"sequence\": 123\n }\n ],\n \"dispatchTriggers\": [\n {\n \"referenceId\": \"dt-1a2b3c4d\",\n \"dispatchCode\": \"29B\",\n \"condition\": \"<string>\",\n \"sequence\": 123,\n \"pinnedCode\": true,\n \"fallbackTrigger\": true\n }\n ],\n \"media\": [\n {\n \"referenceId\": \"<string>\",\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"mediaType\": \"IMAGE\",\n \"url\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"id": 12345,
"name": "Cardiac Arrest - Adult",
"description": "<string>",
"source": "API_IMPORT",
"provider": "APCO",
"knowledgeType": "GUIDE_CARD",
"externalId": "apco-card-cardiac-arrest-adult",
"publishedVersion": 3,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"versions": [
{
"version": 3,
"externalVersion": "v1.2.0",
"isPublished": true,
"description": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"publishedAt": "2023-11-07T05:31:56Z",
"apiControl": {
"questions": "false",
"incidentType": "false",
"spokenInstructions": "false",
"cadActions": "false",
"smsMessages": "false",
"dispatchTriggers": "false"
},
"interview": {
"id": "<string>",
"name": "Cardiac Arrest - Adult",
"intent": "Caller reports an unresponsive adult with no pulse.",
"service": "MEDICAL",
"isRoot": true,
"disciplines": [
{
"id": 123,
"name": "<string>"
}
],
"questionList": [
{
"id": 123,
"referenceId": "q-1a2b3c4d",
"text": "Is the patient breathing normally?",
"intent": "<string>",
"lowQualityCriteria": "<string>",
"highQualityCriteria": "<string>",
"evaluatable": true,
"useInAssist": true,
"isCritical": true,
"required": true,
"relatedQuestions": [
{
"id": 123,
"displayCriteria": "<string>",
"questionList": "<unknown>"
}
]
}
]
},
"actions": {
"id": "<string>",
"name": "Cardiac Arrest - Actions",
"purpose": "<string>",
"disciplines": [
{
"id": 123,
"name": "<string>"
}
],
"spokenInstructions": [
{
"referenceId": "si-1a2b3c4d",
"instruction": "Place the heel of one hand on the center of the chest.",
"sequence": 123,
"conditionedOn": "<string>",
"referenceMedia": "<string>",
"evaluatable": true,
"useInAssist": true,
"required": true,
"isCritical": true
}
],
"cadActions": [
{
"referenceId": "ca-1a2b3c4d",
"instruction": "Enter call type CARDIAC.",
"role": "CALLTAKER",
"conditionedOn": "<string>",
"sequence": 123,
"evaluatable": true,
"useInAssist": true,
"required": true
}
],
"smsMessages": [
{
"referenceId": "sms-1a2b3c4d",
"message": "We've dispatched help. Stay on the line.",
"mediaRef": "<string>",
"conditionedOn": "<string>",
"sequence": 123
}
],
"dispatchTriggers": [
{
"referenceId": "dt-1a2b3c4d",
"dispatchCode": "29B",
"condition": "<string>",
"sequence": 123,
"pinnedCode": true,
"fallbackTrigger": true
}
],
"media": [
{
"referenceId": "<string>",
"name": "<string>",
"description": "<string>",
"mediaType": "IMAGE",
"url": "<string>"
}
],
"links": [
{
"id": 123,
"referenceId": "lk-1a2b3c4d",
"displayCriteria": "<string>",
"targetSectionId": 123,
"targetDocumentName": "<string>",
"targetKnowledgeType": "<string>",
"targetKnowledgeId": 123
}
]
}
}
]
}Body
application/json
Create a new Knowledge entry along with its first version. Provide at least one of interview or actions.
Human-readable name for the Knowledge entry (e.g., the guide card title).
Example:
"Cardiac Arrest - Adult"
Identifier of the organization authoring this Knowledge entry. Common values include APCO, PowerPhone, IAED, or a tenant-internal name for in-house authoring.
Maximum string length:
255Example:
"APCO"
Partner-supplied identifier. Stored verbatim and unique per provider/tenant. Used to look up the GovWorx internal id and for idempotency on retries.
Maximum string length:
255Example:
"apco-card-cardiac-arrest-adult"
Partner-supplied version label for this submission. Free-form short string; stored alongside the version for traceability.
Maximum string length:
64Example:
"v1.0"
Optional description shown in the GovWorx UI.
Example:
"APCO standard protocol for adult cardiac arrest."
Classification of the Knowledge entry. Defaults to GUIDE_CARD. Only GUIDE_CARD and INSTRUCTION_CARD are supported; any other value is rejected. GUIDE_CARD carries interview + action content; INSTRUCTION_CARD carries action content only.
Available options:
GUIDE_CARD, INSTRUCTION_CARD Example:
"GUIDE_CARD"
If true (default), publishes the created version immediately so it becomes available to runtime consumers.
Declares which sections of this Knowledge entry are owned by the external API. All flags default to false (GovWorx-controlled) when absent. Flags are immutable after creation — to change ownership, delete and recreate the entry. See KnowledgeApiControl for per-flag details.
Show child attributes
Show child attributes
If true, marks this entry as the tenant's all-callers guide card (single per tenant). Default false.
Interview (question list) content. Required for GUIDE_CARD; not supported on INSTRUCTION_CARD. At least one of interview or actions must be present. GovWorx generates a stable referenceId (q-{8 hex}) for every question — the response echoes these back. Store them; echo them on future appends to update existing questions in place. Ownership of the question list is declared via the top-level apiControl.questions flag.
Show child attributes
Show child attributes
Action set content for the guide card or instruction card. At least one of interview or actions must be present. GovWorx generates stable referenceIds for every item (si-, ca-, sms-, dt- prefixes) — the response echoes these back. Store them; echo them on future appends to update existing items. Per-sub-section ownership is declared via the top-level apiControl flags.
Show child attributes
Show child attributes
Response
Knowledge entry created. The first version is always version 1, with description 'Created via external API'. If publish=true (default) the version is immediately active. Response includes all GovWorx-generated referenceIds — store them for future appends.
Detail view of a Knowledge entry, including its version list.
GovWorx internal Knowledge id. Use this in subsequent API calls.
Example:
12345
Human-readable name of the Knowledge entry.
Example:
"Cardiac Arrest - Adult"
Optional description shown in the GovWorx UI.
Source of the entry. API_IMPORT indicates it was loaded via this API.
Example:
"API_IMPORT"
Identifier of the organization that authored this Knowledge entry. Common values include APCO, PowerPhone, IAED, or a tenant-internal name for in-house authoring.
Example:
"APCO"
Classification of the Knowledge entry.
Available options:
GUIDE_CARD, INSTRUCTION_CARD, POLICY, MEMO_BRIEFING, TRAINING, GENERAL_KNOWLEDGE, NON_EMERGENCY_LINE_ABILITY Example:
"GUIDE_CARD"
Partner-supplied identifier if one was provided on create.
Example:
"apco-card-cardiac-arrest-adult"
Version number of the currently published version, or null if none is published.
Example:
3
UTC timestamp when this entry was created (i.e., when GovWorx received and stored the first version).
UTC timestamp when this entry was last modified — a new version was added, the published version changed, or metadata was updated.
All versions for this Knowledge entry, including their interview and action content.
Show child attributes
Show child attributes
⌘I