Create Reference
curl --request POST \
--url https://app.octavehq.com/api/v2/reference/create \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"name": "Large filesharing service",
"internalName": "Dropbox",
"description": "Leading cloud storage and file sharing company",
"data": {
"businessModel": [
"<string>"
],
"theirChallenge": [
"<string>"
],
"howTheyUseUs": [
"<string>"
],
"whyTheyChoseUs": [
"<string>"
],
"impactTheySaw": [
"<string>"
],
"stakeholdersInvolved": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
},
"primaryOfferingOId": "o_123456",
"linkingStrategy": {
"mode": "ALL"
}
}
'import requests
url = "https://app.octavehq.com/api/v2/reference/create"
payload = {
"name": "Large filesharing service",
"internalName": "Dropbox",
"description": "Leading cloud storage and file sharing company",
"data": {
"businessModel": ["<string>"],
"theirChallenge": ["<string>"],
"howTheyUseUs": ["<string>"],
"whyTheyChoseUs": ["<string>"],
"impactTheySaw": ["<string>"],
"stakeholdersInvolved": ["<string>"],
"customFields": [
{
"title": "<string>",
"value": ["<string>"]
}
],
"additionalProperties": {}
},
"primaryOfferingOId": "o_123456",
"linkingStrategy": { "mode": "ALL" }
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Large filesharing service',
internalName: 'Dropbox',
description: 'Leading cloud storage and file sharing company',
data: {
businessModel: ['<string>'],
theirChallenge: ['<string>'],
howTheyUseUs: ['<string>'],
whyTheyChoseUs: ['<string>'],
impactTheySaw: ['<string>'],
stakeholdersInvolved: ['<string>'],
customFields: [{title: '<string>', value: ['<string>']}],
additionalProperties: {}
},
primaryOfferingOId: 'o_123456',
linkingStrategy: {mode: 'ALL'}
})
};
fetch('https://app.octavehq.com/api/v2/reference/create', 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.octavehq.com/api/v2/reference/create",
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' => 'Large filesharing service',
'internalName' => 'Dropbox',
'description' => 'Leading cloud storage and file sharing company',
'data' => [
'businessModel' => [
'<string>'
],
'theirChallenge' => [
'<string>'
],
'howTheyUseUs' => [
'<string>'
],
'whyTheyChoseUs' => [
'<string>'
],
'impactTheySaw' => [
'<string>'
],
'stakeholdersInvolved' => [
'<string>'
],
'customFields' => [
[
'title' => '<string>',
'value' => [
'<string>'
]
]
],
'additionalProperties' => [
]
],
'primaryOfferingOId' => 'o_123456',
'linkingStrategy' => [
'mode' => 'ALL'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://app.octavehq.com/api/v2/reference/create"
payload := strings.NewReader("{\n \"name\": \"Large filesharing service\",\n \"internalName\": \"Dropbox\",\n \"description\": \"Leading cloud storage and file sharing company\",\n \"data\": {\n \"businessModel\": [\n \"<string>\"\n ],\n \"theirChallenge\": [\n \"<string>\"\n ],\n \"howTheyUseUs\": [\n \"<string>\"\n ],\n \"whyTheyChoseUs\": [\n \"<string>\"\n ],\n \"impactTheySaw\": [\n \"<string>\"\n ],\n \"stakeholdersInvolved\": [\n \"<string>\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ],\n \"additionalProperties\": {}\n },\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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://app.octavehq.com/api/v2/reference/create")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Large filesharing service\",\n \"internalName\": \"Dropbox\",\n \"description\": \"Leading cloud storage and file sharing company\",\n \"data\": {\n \"businessModel\": [\n \"<string>\"\n ],\n \"theirChallenge\": [\n \"<string>\"\n ],\n \"howTheyUseUs\": [\n \"<string>\"\n ],\n \"whyTheyChoseUs\": [\n \"<string>\"\n ],\n \"impactTheySaw\": [\n \"<string>\"\n ],\n \"stakeholdersInvolved\": [\n \"<string>\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ],\n \"additionalProperties\": {}\n },\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/reference/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Large filesharing service\",\n \"internalName\": \"Dropbox\",\n \"description\": \"Leading cloud storage and file sharing company\",\n \"data\": {\n \"businessModel\": [\n \"<string>\"\n ],\n \"theirChallenge\": [\n \"<string>\"\n ],\n \"howTheyUseUs\": [\n \"<string>\"\n ],\n \"whyTheyChoseUs\": [\n \"<string>\"\n ],\n \"impactTheySaw\": [\n \"<string>\"\n ],\n \"stakeholdersInvolved\": [\n \"<string>\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ],\n \"additionalProperties\": {}\n },\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n }\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "r_1234",
"createdAt": "2021-01-01",
"data": {
"businessModel": [
"<string>"
],
"theirChallenge": [
"<string>"
],
"howTheyUseUs": [
"<string>"
],
"whyTheyChoseUs": [
"<string>"
],
"impactTheySaw": [
"<string>"
],
"stakeholdersInvolved": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
},
"user": {
"oId": "u_1234",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "w_1234"
},
"name": "Large filesharing service",
"internalName": "Dropbox",
"updatedAt": "2021-01-01",
"deletedAt": "2021-01-01",
"archivedAt": "2021-01-01",
"description": "Description of the reference",
"active": true,
"unrecognized": false
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Reference
Create Reference
Create a new customer reference
POST
/
api
/
v2
/
reference
/
create
Create Reference
curl --request POST \
--url https://app.octavehq.com/api/v2/reference/create \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"name": "Large filesharing service",
"internalName": "Dropbox",
"description": "Leading cloud storage and file sharing company",
"data": {
"businessModel": [
"<string>"
],
"theirChallenge": [
"<string>"
],
"howTheyUseUs": [
"<string>"
],
"whyTheyChoseUs": [
"<string>"
],
"impactTheySaw": [
"<string>"
],
"stakeholdersInvolved": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
},
"primaryOfferingOId": "o_123456",
"linkingStrategy": {
"mode": "ALL"
}
}
'import requests
url = "https://app.octavehq.com/api/v2/reference/create"
payload = {
"name": "Large filesharing service",
"internalName": "Dropbox",
"description": "Leading cloud storage and file sharing company",
"data": {
"businessModel": ["<string>"],
"theirChallenge": ["<string>"],
"howTheyUseUs": ["<string>"],
"whyTheyChoseUs": ["<string>"],
"impactTheySaw": ["<string>"],
"stakeholdersInvolved": ["<string>"],
"customFields": [
{
"title": "<string>",
"value": ["<string>"]
}
],
"additionalProperties": {}
},
"primaryOfferingOId": "o_123456",
"linkingStrategy": { "mode": "ALL" }
}
headers = {
"api_key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Large filesharing service',
internalName: 'Dropbox',
description: 'Leading cloud storage and file sharing company',
data: {
businessModel: ['<string>'],
theirChallenge: ['<string>'],
howTheyUseUs: ['<string>'],
whyTheyChoseUs: ['<string>'],
impactTheySaw: ['<string>'],
stakeholdersInvolved: ['<string>'],
customFields: [{title: '<string>', value: ['<string>']}],
additionalProperties: {}
},
primaryOfferingOId: 'o_123456',
linkingStrategy: {mode: 'ALL'}
})
};
fetch('https://app.octavehq.com/api/v2/reference/create', 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.octavehq.com/api/v2/reference/create",
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' => 'Large filesharing service',
'internalName' => 'Dropbox',
'description' => 'Leading cloud storage and file sharing company',
'data' => [
'businessModel' => [
'<string>'
],
'theirChallenge' => [
'<string>'
],
'howTheyUseUs' => [
'<string>'
],
'whyTheyChoseUs' => [
'<string>'
],
'impactTheySaw' => [
'<string>'
],
'stakeholdersInvolved' => [
'<string>'
],
'customFields' => [
[
'title' => '<string>',
'value' => [
'<string>'
]
]
],
'additionalProperties' => [
]
],
'primaryOfferingOId' => 'o_123456',
'linkingStrategy' => [
'mode' => 'ALL'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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://app.octavehq.com/api/v2/reference/create"
payload := strings.NewReader("{\n \"name\": \"Large filesharing service\",\n \"internalName\": \"Dropbox\",\n \"description\": \"Leading cloud storage and file sharing company\",\n \"data\": {\n \"businessModel\": [\n \"<string>\"\n ],\n \"theirChallenge\": [\n \"<string>\"\n ],\n \"howTheyUseUs\": [\n \"<string>\"\n ],\n \"whyTheyChoseUs\": [\n \"<string>\"\n ],\n \"impactTheySaw\": [\n \"<string>\"\n ],\n \"stakeholdersInvolved\": [\n \"<string>\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ],\n \"additionalProperties\": {}\n },\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("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://app.octavehq.com/api/v2/reference/create")
.header("api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Large filesharing service\",\n \"internalName\": \"Dropbox\",\n \"description\": \"Leading cloud storage and file sharing company\",\n \"data\": {\n \"businessModel\": [\n \"<string>\"\n ],\n \"theirChallenge\": [\n \"<string>\"\n ],\n \"howTheyUseUs\": [\n \"<string>\"\n ],\n \"whyTheyChoseUs\": [\n \"<string>\"\n ],\n \"impactTheySaw\": [\n \"<string>\"\n ],\n \"stakeholdersInvolved\": [\n \"<string>\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ],\n \"additionalProperties\": {}\n },\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.octavehq.com/api/v2/reference/create")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Large filesharing service\",\n \"internalName\": \"Dropbox\",\n \"description\": \"Leading cloud storage and file sharing company\",\n \"data\": {\n \"businessModel\": [\n \"<string>\"\n ],\n \"theirChallenge\": [\n \"<string>\"\n ],\n \"howTheyUseUs\": [\n \"<string>\"\n ],\n \"whyTheyChoseUs\": [\n \"<string>\"\n ],\n \"impactTheySaw\": [\n \"<string>\"\n ],\n \"stakeholdersInvolved\": [\n \"<string>\"\n ],\n \"customFields\": [\n {\n \"title\": \"<string>\",\n \"value\": [\n \"<string>\"\n ]\n }\n ],\n \"additionalProperties\": {}\n },\n \"primaryOfferingOId\": \"o_123456\",\n \"linkingStrategy\": {\n \"mode\": \"ALL\"\n }\n}"
response = http.request(request)
puts response.read_body{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"data": {
"oId": "r_1234",
"createdAt": "2021-01-01",
"data": {
"businessModel": [
"<string>"
],
"theirChallenge": [
"<string>"
],
"howTheyUseUs": [
"<string>"
],
"whyTheyChoseUs": [
"<string>"
],
"impactTheySaw": [
"<string>"
],
"stakeholdersInvolved": [
"<string>"
],
"customFields": [
{
"title": "<string>",
"value": [
"<string>"
]
}
],
"additionalProperties": {}
},
"user": {
"oId": "u_1234",
"firstName": "John",
"lastName": "Doe"
},
"workspace": {
"oId": "w_1234"
},
"name": "Large filesharing service",
"internalName": "Dropbox",
"updatedAt": "2021-01-01",
"deletedAt": "2021-01-01",
"archivedAt": "2021-01-01",
"description": "Description of the reference",
"active": true,
"unrecognized": false
}
}{
"_metadata": {
"requestId": "requestId",
"timestamp": "2021-01-01T00:00:00.000Z",
"usage": 0,
"message": "message"
},
"message": "<string>"
}Authorizations
Body
application/json
Reference creation data
The external facing name of the reference
Minimum string length:
1Example:
"Large filesharing service"
The internal name of the reference
Example:
"Dropbox"
A description of the reference
Example:
"Leading cloud storage and file sharing company"
Additional reference data
Show child attributes
Show child attributes
Primary Offering to use as context when creating reference. If not provided, the primary company attached to the Workspace will be used.
Example:
"o_123456"
Strategy for linking this reference to offerings (products/services)
- Option 1
- Option 2
Show child attributes
Show child attributes
⌘I