Create or update a document

curl --request PUT \
  --url https://platform.dev.timeback.com/case/1.1/CFDocuments/{sourcedId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "<string>",
  "uri": "<string>",
  "creator": "<string>",
  "title": "<string>",
  "caseVersion": "1.1",
  "lastChangeDateTime": "2023-11-07T05:31:56Z",
  "frameworkType": "<string>",
  "officialSourceURL": "<string>",
  "publisher": "<string>",
  "description": "<string>",
  "subject": [
    "<string>"
  ],
  "subjectURI": [
    {
      "title": "<string>",
      "identifier": "<string>",
      "uri": "<string>"
    }
  ],
  "language": "<string>",
  "version": "<string>",
  "adoptionStatus": "<string>",
  "statusStartDate": "2023-12-25",
  "statusEndDate": "2023-12-25",
  "notes": "<string>",
  "extensions": {}
}
'

import requests

url = "https://platform.dev.timeback.com/case/1.1/CFDocuments/{sourcedId}"

payload = {
    "identifier": "<string>",
    "uri": "<string>",
    "creator": "<string>",
    "title": "<string>",
    "caseVersion": "1.1",
    "lastChangeDateTime": "2023-11-07T05:31:56Z",
    "frameworkType": "<string>",
    "officialSourceURL": "<string>",
    "publisher": "<string>",
    "description": "<string>",
    "subject": ["<string>"],
    "subjectURI": [
        {
            "title": "<string>",
            "identifier": "<string>",
            "uri": "<string>"
        }
    ],
    "language": "<string>",
    "version": "<string>",
    "adoptionStatus": "<string>",
    "statusStartDate": "2023-12-25",
    "statusEndDate": "2023-12-25",
    "notes": "<string>",
    "extensions": {}
}
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({
    identifier: '<string>',
    uri: '<string>',
    creator: '<string>',
    title: '<string>',
    caseVersion: '1.1',
    lastChangeDateTime: '2023-11-07T05:31:56Z',
    frameworkType: '<string>',
    officialSourceURL: '<string>',
    publisher: '<string>',
    description: '<string>',
    subject: ['<string>'],
    subjectURI: [{title: '<string>', identifier: '<string>', uri: '<string>'}],
    language: '<string>',
    version: '<string>',
    adoptionStatus: '<string>',
    statusStartDate: '2023-12-25',
    statusEndDate: '2023-12-25',
    notes: '<string>',
    extensions: {}
  })
};

fetch('https://platform.dev.timeback.com/case/1.1/CFDocuments/{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/CFDocuments/{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([
    'identifier' => '<string>',
    'uri' => '<string>',
    'creator' => '<string>',
    'title' => '<string>',
    'caseVersion' => '1.1',
    'lastChangeDateTime' => '2023-11-07T05:31:56Z',
    'frameworkType' => '<string>',
    'officialSourceURL' => '<string>',
    'publisher' => '<string>',
    'description' => '<string>',
    'subject' => [
        '<string>'
    ],
    'subjectURI' => [
        [
                'title' => '<string>',
                'identifier' => '<string>',
                'uri' => '<string>'
        ]
    ],
    'language' => '<string>',
    'version' => '<string>',
    'adoptionStatus' => '<string>',
    'statusStartDate' => '2023-12-25',
    'statusEndDate' => '2023-12-25',
    'notes' => '<string>',
    'extensions' => [
        
    ]
  ]),
  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/CFDocuments/{sourcedId}"

	payload := strings.NewReader("{\n  \"identifier\": \"<string>\",\n  \"uri\": \"<string>\",\n  \"creator\": \"<string>\",\n  \"title\": \"<string>\",\n  \"caseVersion\": \"1.1\",\n  \"lastChangeDateTime\": \"2023-11-07T05:31:56Z\",\n  \"frameworkType\": \"<string>\",\n  \"officialSourceURL\": \"<string>\",\n  \"publisher\": \"<string>\",\n  \"description\": \"<string>\",\n  \"subject\": [\n    \"<string>\"\n  ],\n  \"subjectURI\": [\n    {\n      \"title\": \"<string>\",\n      \"identifier\": \"<string>\",\n      \"uri\": \"<string>\"\n    }\n  ],\n  \"language\": \"<string>\",\n  \"version\": \"<string>\",\n  \"adoptionStatus\": \"<string>\",\n  \"statusStartDate\": \"2023-12-25\",\n  \"statusEndDate\": \"2023-12-25\",\n  \"notes\": \"<string>\",\n  \"extensions\": {}\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/CFDocuments/{sourcedId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"identifier\": \"<string>\",\n  \"uri\": \"<string>\",\n  \"creator\": \"<string>\",\n  \"title\": \"<string>\",\n  \"caseVersion\": \"1.1\",\n  \"lastChangeDateTime\": \"2023-11-07T05:31:56Z\",\n  \"frameworkType\": \"<string>\",\n  \"officialSourceURL\": \"<string>\",\n  \"publisher\": \"<string>\",\n  \"description\": \"<string>\",\n  \"subject\": [\n    \"<string>\"\n  ],\n  \"subjectURI\": [\n    {\n      \"title\": \"<string>\",\n      \"identifier\": \"<string>\",\n      \"uri\": \"<string>\"\n    }\n  ],\n  \"language\": \"<string>\",\n  \"version\": \"<string>\",\n  \"adoptionStatus\": \"<string>\",\n  \"statusStartDate\": \"2023-12-25\",\n  \"statusEndDate\": \"2023-12-25\",\n  \"notes\": \"<string>\",\n  \"extensions\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.dev.timeback.com/case/1.1/CFDocuments/{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  \"identifier\": \"<string>\",\n  \"uri\": \"<string>\",\n  \"creator\": \"<string>\",\n  \"title\": \"<string>\",\n  \"caseVersion\": \"1.1\",\n  \"lastChangeDateTime\": \"2023-11-07T05:31:56Z\",\n  \"frameworkType\": \"<string>\",\n  \"officialSourceURL\": \"<string>\",\n  \"publisher\": \"<string>\",\n  \"description\": \"<string>\",\n  \"subject\": [\n    \"<string>\"\n  ],\n  \"subjectURI\": [\n    {\n      \"title\": \"<string>\",\n      \"identifier\": \"<string>\",\n      \"uri\": \"<string>\"\n    }\n  ],\n  \"language\": \"<string>\",\n  \"version\": \"<string>\",\n  \"adoptionStatus\": \"<string>\",\n  \"statusStartDate\": \"2023-12-25\",\n  \"statusEndDate\": \"2023-12-25\",\n  \"notes\": \"<string>\",\n  \"extensions\": {}\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"
      }
    ]
  }
}

PUT

case

1.1

CFDocuments

{sourcedId}

Create or update a document

curl --request PUT \
  --url https://platform.dev.timeback.com/case/1.1/CFDocuments/{sourcedId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "<string>",
  "uri": "<string>",
  "creator": "<string>",
  "title": "<string>",
  "caseVersion": "1.1",
  "lastChangeDateTime": "2023-11-07T05:31:56Z",
  "frameworkType": "<string>",
  "officialSourceURL": "<string>",
  "publisher": "<string>",
  "description": "<string>",
  "subject": [
    "<string>"
  ],
  "subjectURI": [
    {
      "title": "<string>",
      "identifier": "<string>",
      "uri": "<string>"
    }
  ],
  "language": "<string>",
  "version": "<string>",
  "adoptionStatus": "<string>",
  "statusStartDate": "2023-12-25",
  "statusEndDate": "2023-12-25",
  "notes": "<string>",
  "extensions": {}
}
'

import requests

url = "https://platform.dev.timeback.com/case/1.1/CFDocuments/{sourcedId}"

payload = {
    "identifier": "<string>",
    "uri": "<string>",
    "creator": "<string>",
    "title": "<string>",
    "caseVersion": "1.1",
    "lastChangeDateTime": "2023-11-07T05:31:56Z",
    "frameworkType": "<string>",
    "officialSourceURL": "<string>",
    "publisher": "<string>",
    "description": "<string>",
    "subject": ["<string>"],
    "subjectURI": [
        {
            "title": "<string>",
            "identifier": "<string>",
            "uri": "<string>"
        }
    ],
    "language": "<string>",
    "version": "<string>",
    "adoptionStatus": "<string>",
    "statusStartDate": "2023-12-25",
    "statusEndDate": "2023-12-25",
    "notes": "<string>",
    "extensions": {}
}
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({
    identifier: '<string>',
    uri: '<string>',
    creator: '<string>',
    title: '<string>',
    caseVersion: '1.1',
    lastChangeDateTime: '2023-11-07T05:31:56Z',
    frameworkType: '<string>',
    officialSourceURL: '<string>',
    publisher: '<string>',
    description: '<string>',
    subject: ['<string>'],
    subjectURI: [{title: '<string>', identifier: '<string>', uri: '<string>'}],
    language: '<string>',
    version: '<string>',
    adoptionStatus: '<string>',
    statusStartDate: '2023-12-25',
    statusEndDate: '2023-12-25',
    notes: '<string>',
    extensions: {}
  })
};

fetch('https://platform.dev.timeback.com/case/1.1/CFDocuments/{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/CFDocuments/{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([
    'identifier' => '<string>',
    'uri' => '<string>',
    'creator' => '<string>',
    'title' => '<string>',
    'caseVersion' => '1.1',
    'lastChangeDateTime' => '2023-11-07T05:31:56Z',
    'frameworkType' => '<string>',
    'officialSourceURL' => '<string>',
    'publisher' => '<string>',
    'description' => '<string>',
    'subject' => [
        '<string>'
    ],
    'subjectURI' => [
        [
                'title' => '<string>',
                'identifier' => '<string>',
                'uri' => '<string>'
        ]
    ],
    'language' => '<string>',
    'version' => '<string>',
    'adoptionStatus' => '<string>',
    'statusStartDate' => '2023-12-25',
    'statusEndDate' => '2023-12-25',
    'notes' => '<string>',
    'extensions' => [
        
    ]
  ]),
  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/CFDocuments/{sourcedId}"

	payload := strings.NewReader("{\n  \"identifier\": \"<string>\",\n  \"uri\": \"<string>\",\n  \"creator\": \"<string>\",\n  \"title\": \"<string>\",\n  \"caseVersion\": \"1.1\",\n  \"lastChangeDateTime\": \"2023-11-07T05:31:56Z\",\n  \"frameworkType\": \"<string>\",\n  \"officialSourceURL\": \"<string>\",\n  \"publisher\": \"<string>\",\n  \"description\": \"<string>\",\n  \"subject\": [\n    \"<string>\"\n  ],\n  \"subjectURI\": [\n    {\n      \"title\": \"<string>\",\n      \"identifier\": \"<string>\",\n      \"uri\": \"<string>\"\n    }\n  ],\n  \"language\": \"<string>\",\n  \"version\": \"<string>\",\n  \"adoptionStatus\": \"<string>\",\n  \"statusStartDate\": \"2023-12-25\",\n  \"statusEndDate\": \"2023-12-25\",\n  \"notes\": \"<string>\",\n  \"extensions\": {}\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/CFDocuments/{sourcedId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"identifier\": \"<string>\",\n  \"uri\": \"<string>\",\n  \"creator\": \"<string>\",\n  \"title\": \"<string>\",\n  \"caseVersion\": \"1.1\",\n  \"lastChangeDateTime\": \"2023-11-07T05:31:56Z\",\n  \"frameworkType\": \"<string>\",\n  \"officialSourceURL\": \"<string>\",\n  \"publisher\": \"<string>\",\n  \"description\": \"<string>\",\n  \"subject\": [\n    \"<string>\"\n  ],\n  \"subjectURI\": [\n    {\n      \"title\": \"<string>\",\n      \"identifier\": \"<string>\",\n      \"uri\": \"<string>\"\n    }\n  ],\n  \"language\": \"<string>\",\n  \"version\": \"<string>\",\n  \"adoptionStatus\": \"<string>\",\n  \"statusStartDate\": \"2023-12-25\",\n  \"statusEndDate\": \"2023-12-25\",\n  \"notes\": \"<string>\",\n  \"extensions\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://platform.dev.timeback.com/case/1.1/CFDocuments/{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  \"identifier\": \"<string>\",\n  \"uri\": \"<string>\",\n  \"creator\": \"<string>\",\n  \"title\": \"<string>\",\n  \"caseVersion\": \"1.1\",\n  \"lastChangeDateTime\": \"2023-11-07T05:31:56Z\",\n  \"frameworkType\": \"<string>\",\n  \"officialSourceURL\": \"<string>\",\n  \"publisher\": \"<string>\",\n  \"description\": \"<string>\",\n  \"subject\": [\n    \"<string>\"\n  ],\n  \"subjectURI\": [\n    {\n      \"title\": \"<string>\",\n      \"identifier\": \"<string>\",\n      \"uri\": \"<string>\"\n    }\n  ],\n  \"language\": \"<string>\",\n  \"version\": \"<string>\",\n  \"adoptionStatus\": \"<string>\",\n  \"statusStartDate\": \"2023-12-25\",\n  \"statusEndDate\": \"2023-12-25\",\n  \"notes\": \"<string>\",\n  \"extensions\": {}\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

Authorization

string

header

required

OAuth 2.0 client credentials flow. Contact timeback@trilogy.com to request credentials for your application.

Path Parameters

sourcedId

string

required

Unique identifier of the CASE entity

Body

application/json

A CASE document

identifier

string

required

The unique identifier for this document

uri

string<uri>

required

URI that identifies this CASE entity

creator

string

required

The creator of the document

title

string

required

The title of the document

caseVersion

enum<string>

required

The CASE version for the CFDocument. Currently, the only expected value is 1.1 since this field does not exist for previous versions

Available options:

1.1

lastChangeDateTime

string<date-time>

required

Date/time when the entity was last modified

frameworkType

string

Specify the framework type of the CFDocument

officialSourceURL

string<uri>

URL of the official source of this document

publisher

string

The publisher of the document

description

string

A human readable description of the document

subject

string[]

List of subjects covered by this document

subjectURI

object[]

List of subject references for this document

Show child attributes

language

string

Language code for this document

version

string

Version of the document

adoptionStatus

string

Current adoption status of the document

statusStartDate

string<date>

Start date of the current status

statusEndDate

string<date>

End date of the current status

licenseURI

object

A generic link type containing identifier, uri and title

Show child attributes

notes

string

Additional notes about the document

extensions

object

Additional properties for the document

CFPackageURI

object

A generic link type containing identifier, uri and title

Show child attributes

Response

Successful operation

⌘I