Create or update an item
curl --request PUT \
--url https://platform.dev.timeback.com/case/1.1/CFItems/{sourcedId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"item": {
"identifier": "<string>",
"fullStatement": "<string>",
"uri": "<string>",
"lastChangeDateTime": "2023-11-07T05:31:56Z",
"CFDocumentURI": {
"title": "<string>",
"identifier": "<string>",
"uri": "<string>"
},
"alternativeLabel": "<string>",
"CFItemType": "<string>",
"humanCodingScheme": "<string>",
"listEnumeration": "<string>",
"abbreviatedStatement": "<string>",
"conceptKeywords": [
"<string>"
],
"notes": "<string>",
"language": "<string>",
"educationLevel": [
"<string>"
],
"subject": [
"<string>"
],
"subjectURI": [
{
"title": "<string>",
"identifier": "<string>",
"uri": "<string>"
}
],
"extensions": {},
"statusStartDate": "2023-12-25",
"statusEndDate": "2023-12-25"
}
}
'import requests
url = "https://platform.dev.timeback.com/case/1.1/CFItems/{sourcedId}"
payload = { "item": {
"identifier": "<string>",
"fullStatement": "<string>",
"uri": "<string>",
"lastChangeDateTime": "2023-11-07T05:31:56Z",
"CFDocumentURI": {
"title": "<string>",
"identifier": "<string>",
"uri": "<string>"
},
"alternativeLabel": "<string>",
"CFItemType": "<string>",
"humanCodingScheme": "<string>",
"listEnumeration": "<string>",
"abbreviatedStatement": "<string>",
"conceptKeywords": ["<string>"],
"notes": "<string>",
"language": "<string>",
"educationLevel": ["<string>"],
"subject": ["<string>"],
"subjectURI": [
{
"title": "<string>",
"identifier": "<string>",
"uri": "<string>"
}
],
"extensions": {},
"statusStartDate": "2023-12-25",
"statusEndDate": "2023-12-25"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
item: {
identifier: '<string>',
fullStatement: '<string>',
uri: '<string>',
lastChangeDateTime: '2023-11-07T05:31:56Z',
CFDocumentURI: {title: '<string>', identifier: '<string>', uri: '<string>'},
alternativeLabel: '<string>',
CFItemType: '<string>',
humanCodingScheme: '<string>',
listEnumeration: '<string>',
abbreviatedStatement: '<string>',
conceptKeywords: ['<string>'],
notes: '<string>',
language: '<string>',
educationLevel: ['<string>'],
subject: ['<string>'],
subjectURI: [{title: '<string>', identifier: '<string>', uri: '<string>'}],
extensions: {},
statusStartDate: '2023-12-25',
statusEndDate: '2023-12-25'
}
})
};
fetch('https://platform.dev.timeback.com/case/1.1/CFItems/{sourcedId}', 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://platform.dev.timeback.com/case/1.1/CFItems/{sourcedId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'item' => [
'identifier' => '<string>',
'fullStatement' => '<string>',
'uri' => '<string>',
'lastChangeDateTime' => '2023-11-07T05:31:56Z',
'CFDocumentURI' => [
'title' => '<string>',
'identifier' => '<string>',
'uri' => '<string>'
],
'alternativeLabel' => '<string>',
'CFItemType' => '<string>',
'humanCodingScheme' => '<string>',
'listEnumeration' => '<string>',
'abbreviatedStatement' => '<string>',
'conceptKeywords' => [
'<string>'
],
'notes' => '<string>',
'language' => '<string>',
'educationLevel' => [
'<string>'
],
'subject' => [
'<string>'
],
'subjectURI' => [
[
'title' => '<string>',
'identifier' => '<string>',
'uri' => '<string>'
]
],
'extensions' => [
],
'statusStartDate' => '2023-12-25',
'statusEndDate' => '2023-12-25'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://platform.dev.timeback.com/case/1.1/CFItems/{sourcedId}"
payload := strings.NewReader("{\n \"item\": {\n \"identifier\": \"<string>\",\n \"fullStatement\": \"<string>\",\n \"uri\": \"<string>\",\n \"lastChangeDateTime\": \"2023-11-07T05:31:56Z\",\n \"CFDocumentURI\": {\n \"title\": \"<string>\",\n \"identifier\": \"<string>\",\n \"uri\": \"<string>\"\n },\n \"alternativeLabel\": \"<string>\",\n \"CFItemType\": \"<string>\",\n \"humanCodingScheme\": \"<string>\",\n \"listEnumeration\": \"<string>\",\n \"abbreviatedStatement\": \"<string>\",\n \"conceptKeywords\": [\n \"<string>\"\n ],\n \"notes\": \"<string>\",\n \"language\": \"<string>\",\n \"educationLevel\": [\n \"<string>\"\n ],\n \"subject\": [\n \"<string>\"\n ],\n \"subjectURI\": [\n {\n \"title\": \"<string>\",\n \"identifier\": \"<string>\",\n \"uri\": \"<string>\"\n }\n ],\n \"extensions\": {},\n \"statusStartDate\": \"2023-12-25\",\n \"statusEndDate\": \"2023-12-25\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://platform.dev.timeback.com/case/1.1/CFItems/{sourcedId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"item\": {\n \"identifier\": \"<string>\",\n \"fullStatement\": \"<string>\",\n \"uri\": \"<string>\",\n \"lastChangeDateTime\": \"2023-11-07T05:31:56Z\",\n \"CFDocumentURI\": {\n \"title\": \"<string>\",\n \"identifier\": \"<string>\",\n \"uri\": \"<string>\"\n },\n \"alternativeLabel\": \"<string>\",\n \"CFItemType\": \"<string>\",\n \"humanCodingScheme\": \"<string>\",\n \"listEnumeration\": \"<string>\",\n \"abbreviatedStatement\": \"<string>\",\n \"conceptKeywords\": [\n \"<string>\"\n ],\n \"notes\": \"<string>\",\n \"language\": \"<string>\",\n \"educationLevel\": [\n \"<string>\"\n ],\n \"subject\": [\n \"<string>\"\n ],\n \"subjectURI\": [\n {\n \"title\": \"<string>\",\n \"identifier\": \"<string>\",\n \"uri\": \"<string>\"\n }\n ],\n \"extensions\": {},\n \"statusStartDate\": \"2023-12-25\",\n \"statusEndDate\": \"2023-12-25\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.dev.timeback.com/case/1.1/CFItems/{sourcedId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"item\": {\n \"identifier\": \"<string>\",\n \"fullStatement\": \"<string>\",\n \"uri\": \"<string>\",\n \"lastChangeDateTime\": \"2023-11-07T05:31:56Z\",\n \"CFDocumentURI\": {\n \"title\": \"<string>\",\n \"identifier\": \"<string>\",\n \"uri\": \"<string>\"\n },\n \"alternativeLabel\": \"<string>\",\n \"CFItemType\": \"<string>\",\n \"humanCodingScheme\": \"<string>\",\n \"listEnumeration\": \"<string>\",\n \"abbreviatedStatement\": \"<string>\",\n \"conceptKeywords\": [\n \"<string>\"\n ],\n \"notes\": \"<string>\",\n \"language\": \"<string>\",\n \"educationLevel\": [\n \"<string>\"\n ],\n \"subject\": [\n \"<string>\"\n ],\n \"subjectURI\": [\n {\n \"title\": \"<string>\",\n \"identifier\": \"<string>\",\n \"uri\": \"<string>\"\n }\n ],\n \"extensions\": {},\n \"statusStartDate\": \"2023-12-25\",\n \"statusEndDate\": \"2023-12-25\"\n }\n}"
response = http.request(request)
puts response.read_body{
"imsx_codeMajor": "success",
"imsx_severity": "status",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "fullsuccess"
}
]
}
}{
"imsx_codeMajor": "success",
"imsx_severity": "status",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "fullsuccess"
}
]
}
}CASE
Create or update an item
Creates a new item or updates an existing one with the given sourcedId
PUT
/
case
/
1.1
/
CFItems
/
{sourcedId}
Create or update an item
curl --request PUT \
--url https://platform.dev.timeback.com/case/1.1/CFItems/{sourcedId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"item": {
"identifier": "<string>",
"fullStatement": "<string>",
"uri": "<string>",
"lastChangeDateTime": "2023-11-07T05:31:56Z",
"CFDocumentURI": {
"title": "<string>",
"identifier": "<string>",
"uri": "<string>"
},
"alternativeLabel": "<string>",
"CFItemType": "<string>",
"humanCodingScheme": "<string>",
"listEnumeration": "<string>",
"abbreviatedStatement": "<string>",
"conceptKeywords": [
"<string>"
],
"notes": "<string>",
"language": "<string>",
"educationLevel": [
"<string>"
],
"subject": [
"<string>"
],
"subjectURI": [
{
"title": "<string>",
"identifier": "<string>",
"uri": "<string>"
}
],
"extensions": {},
"statusStartDate": "2023-12-25",
"statusEndDate": "2023-12-25"
}
}
'import requests
url = "https://platform.dev.timeback.com/case/1.1/CFItems/{sourcedId}"
payload = { "item": {
"identifier": "<string>",
"fullStatement": "<string>",
"uri": "<string>",
"lastChangeDateTime": "2023-11-07T05:31:56Z",
"CFDocumentURI": {
"title": "<string>",
"identifier": "<string>",
"uri": "<string>"
},
"alternativeLabel": "<string>",
"CFItemType": "<string>",
"humanCodingScheme": "<string>",
"listEnumeration": "<string>",
"abbreviatedStatement": "<string>",
"conceptKeywords": ["<string>"],
"notes": "<string>",
"language": "<string>",
"educationLevel": ["<string>"],
"subject": ["<string>"],
"subjectURI": [
{
"title": "<string>",
"identifier": "<string>",
"uri": "<string>"
}
],
"extensions": {},
"statusStartDate": "2023-12-25",
"statusEndDate": "2023-12-25"
} }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
item: {
identifier: '<string>',
fullStatement: '<string>',
uri: '<string>',
lastChangeDateTime: '2023-11-07T05:31:56Z',
CFDocumentURI: {title: '<string>', identifier: '<string>', uri: '<string>'},
alternativeLabel: '<string>',
CFItemType: '<string>',
humanCodingScheme: '<string>',
listEnumeration: '<string>',
abbreviatedStatement: '<string>',
conceptKeywords: ['<string>'],
notes: '<string>',
language: '<string>',
educationLevel: ['<string>'],
subject: ['<string>'],
subjectURI: [{title: '<string>', identifier: '<string>', uri: '<string>'}],
extensions: {},
statusStartDate: '2023-12-25',
statusEndDate: '2023-12-25'
}
})
};
fetch('https://platform.dev.timeback.com/case/1.1/CFItems/{sourcedId}', 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://platform.dev.timeback.com/case/1.1/CFItems/{sourcedId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'item' => [
'identifier' => '<string>',
'fullStatement' => '<string>',
'uri' => '<string>',
'lastChangeDateTime' => '2023-11-07T05:31:56Z',
'CFDocumentURI' => [
'title' => '<string>',
'identifier' => '<string>',
'uri' => '<string>'
],
'alternativeLabel' => '<string>',
'CFItemType' => '<string>',
'humanCodingScheme' => '<string>',
'listEnumeration' => '<string>',
'abbreviatedStatement' => '<string>',
'conceptKeywords' => [
'<string>'
],
'notes' => '<string>',
'language' => '<string>',
'educationLevel' => [
'<string>'
],
'subject' => [
'<string>'
],
'subjectURI' => [
[
'title' => '<string>',
'identifier' => '<string>',
'uri' => '<string>'
]
],
'extensions' => [
],
'statusStartDate' => '2023-12-25',
'statusEndDate' => '2023-12-25'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://platform.dev.timeback.com/case/1.1/CFItems/{sourcedId}"
payload := strings.NewReader("{\n \"item\": {\n \"identifier\": \"<string>\",\n \"fullStatement\": \"<string>\",\n \"uri\": \"<string>\",\n \"lastChangeDateTime\": \"2023-11-07T05:31:56Z\",\n \"CFDocumentURI\": {\n \"title\": \"<string>\",\n \"identifier\": \"<string>\",\n \"uri\": \"<string>\"\n },\n \"alternativeLabel\": \"<string>\",\n \"CFItemType\": \"<string>\",\n \"humanCodingScheme\": \"<string>\",\n \"listEnumeration\": \"<string>\",\n \"abbreviatedStatement\": \"<string>\",\n \"conceptKeywords\": [\n \"<string>\"\n ],\n \"notes\": \"<string>\",\n \"language\": \"<string>\",\n \"educationLevel\": [\n \"<string>\"\n ],\n \"subject\": [\n \"<string>\"\n ],\n \"subjectURI\": [\n {\n \"title\": \"<string>\",\n \"identifier\": \"<string>\",\n \"uri\": \"<string>\"\n }\n ],\n \"extensions\": {},\n \"statusStartDate\": \"2023-12-25\",\n \"statusEndDate\": \"2023-12-25\"\n }\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://platform.dev.timeback.com/case/1.1/CFItems/{sourcedId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"item\": {\n \"identifier\": \"<string>\",\n \"fullStatement\": \"<string>\",\n \"uri\": \"<string>\",\n \"lastChangeDateTime\": \"2023-11-07T05:31:56Z\",\n \"CFDocumentURI\": {\n \"title\": \"<string>\",\n \"identifier\": \"<string>\",\n \"uri\": \"<string>\"\n },\n \"alternativeLabel\": \"<string>\",\n \"CFItemType\": \"<string>\",\n \"humanCodingScheme\": \"<string>\",\n \"listEnumeration\": \"<string>\",\n \"abbreviatedStatement\": \"<string>\",\n \"conceptKeywords\": [\n \"<string>\"\n ],\n \"notes\": \"<string>\",\n \"language\": \"<string>\",\n \"educationLevel\": [\n \"<string>\"\n ],\n \"subject\": [\n \"<string>\"\n ],\n \"subjectURI\": [\n {\n \"title\": \"<string>\",\n \"identifier\": \"<string>\",\n \"uri\": \"<string>\"\n }\n ],\n \"extensions\": {},\n \"statusStartDate\": \"2023-12-25\",\n \"statusEndDate\": \"2023-12-25\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.dev.timeback.com/case/1.1/CFItems/{sourcedId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"item\": {\n \"identifier\": \"<string>\",\n \"fullStatement\": \"<string>\",\n \"uri\": \"<string>\",\n \"lastChangeDateTime\": \"2023-11-07T05:31:56Z\",\n \"CFDocumentURI\": {\n \"title\": \"<string>\",\n \"identifier\": \"<string>\",\n \"uri\": \"<string>\"\n },\n \"alternativeLabel\": \"<string>\",\n \"CFItemType\": \"<string>\",\n \"humanCodingScheme\": \"<string>\",\n \"listEnumeration\": \"<string>\",\n \"abbreviatedStatement\": \"<string>\",\n \"conceptKeywords\": [\n \"<string>\"\n ],\n \"notes\": \"<string>\",\n \"language\": \"<string>\",\n \"educationLevel\": [\n \"<string>\"\n ],\n \"subject\": [\n \"<string>\"\n ],\n \"subjectURI\": [\n {\n \"title\": \"<string>\",\n \"identifier\": \"<string>\",\n \"uri\": \"<string>\"\n }\n ],\n \"extensions\": {},\n \"statusStartDate\": \"2023-12-25\",\n \"statusEndDate\": \"2023-12-25\"\n }\n}"
response = http.request(request)
puts response.read_body{
"imsx_codeMajor": "success",
"imsx_severity": "status",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "fullsuccess"
}
]
}
}{
"imsx_codeMajor": "success",
"imsx_severity": "status",
"imsx_description": "<string>",
"imsx_CodeMinor": {
"imsx_codeMinorField": [
{
"imsx_codeMinorFieldName": "TargetEndSystem",
"imsx_codeMinorFieldValue": "fullsuccess"
}
]
}
}Authorizations
OAuth 2.0 client credentials flow. Contact timeback@trilogy.com to request credentials for your application.
Path Parameters
Unique identifier of the CASE entity
Body
application/json
CFItem object to be created
A CASE item outside the context of a CFPackage
Show child attributes
Show child attributes
Response
Successful operation
⌘I