(experimental) Creates a new snippet

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/snippets \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "type": "TEXT",
  "data": {
    "markdown": "### Lorem ipsum dolor sit amet"
  }
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/snippets"

payload = {
    "type": "TEXT",
    "data": { "markdown": "### Lorem ipsum dolor sit amet" }
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify({type: 'TEXT', data: {markdown: '### Lorem ipsum dolor sit amet'}})
};

fetch('http://10.2.4.166:8080/composer/api/snippets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/snippets",
  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([
    'type' => 'TEXT',
    'data' => [
        'markdown' => '### Lorem ipsum dolor sit amet'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/vnd.composer.v3+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 := "http://10.2.4.166:8080/composer/api/snippets"

	payload := strings.NewReader("{\n  \"type\": \"TEXT\",\n  \"data\": {\n    \"markdown\": \"### Lorem ipsum dolor sit amet\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/vnd.composer.v3+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/snippets")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"type\": \"TEXT\",\n  \"data\": {\n    \"markdown\": \"### Lorem ipsum dolor sit amet\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/snippets")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n  \"type\": \"TEXT\",\n  \"data\": {\n    \"markdown\": \"### Lorem ipsum dolor sit amet\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "type": "TEXT",
  "id": "59ba04795b542f60838ce0ea",
  "data": {
    "markdown": "### Lorem ipsum dolor sit amet"
  },
  "auditable": {
    "createdByUserId": "59ba04795b542f60838ce0e1",
    "createdByUserName": "user_name",
    "createdDate": "2023-11-07T05:31:56Z",
    "lastModifiedByUserId": "59ba04795b542f60838ce0e2",
    "lastModifiedDate": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "path": "<string>"
}

(experimental) Creates a new snippet

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/snippets \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --data '
{
  "type": "TEXT",
  "data": {
    "markdown": "### Lorem ipsum dolor sit amet"
  }
}
'

import requests

url = "http://10.2.4.166:8080/composer/api/snippets"

payload = {
    "type": "TEXT",
    "data": { "markdown": "### Lorem ipsum dolor sit amet" }
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify({type: 'TEXT', data: {markdown: '### Lorem ipsum dolor sit amet'}})
};

fetch('http://10.2.4.166:8080/composer/api/snippets', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/snippets",
  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([
    'type' => 'TEXT',
    'data' => [
        'markdown' => '### Lorem ipsum dolor sit amet'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/vnd.composer.v3+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 := "http://10.2.4.166:8080/composer/api/snippets"

	payload := strings.NewReader("{\n  \"type\": \"TEXT\",\n  \"data\": {\n    \"markdown\": \"### Lorem ipsum dolor sit amet\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/vnd.composer.v3+json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/snippets")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"type\": \"TEXT\",\n  \"data\": {\n    \"markdown\": \"### Lorem ipsum dolor sit amet\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://10.2.4.166:8080/composer/api/snippets")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n  \"type\": \"TEXT\",\n  \"data\": {\n    \"markdown\": \"### Lorem ipsum dolor sit amet\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "type": "TEXT",
  "id": "59ba04795b542f60838ce0ea",
  "data": {
    "markdown": "### Lorem ipsum dolor sit amet"
  },
  "auditable": {
    "createdByUserId": "59ba04795b542f60838ce0e1",
    "createdByUserName": "user_name",
    "createdDate": "2023-11-07T05:31:56Z",
    "lastModifiedByUserId": "59ba04795b542f60838ce0e2",
    "lastModifiedDate": "2023-11-07T05:31:56Z"
  }
}

{
  "error": "<string>",
  "details": "<string>",
  "message": "<string>",
  "path": "<string>",
  "status": "<string>",
  "code": "<string>",
  "errorCode": "<string>",
  "timestamp": "<string>",
  "problems": [
    {
      "name": "<string>",
      "message": "<string>",
      "level": "ERROR",
      "dependencies": {}
    }
  ]
}

{
  "timestamp": "2023-11-07T05:31:56Z",
  "status": 123,
  "error": "<string>",
  "message": "<string>",
  "path": "<string>"
}

Authorizations

Authorization

string

header

required

HTTP Basic authentication using global administrator credentials (username and password).

Body

application/vnd.composer.v3+json

type

enum<string>

required

Snippet type

Available options:

FILTER,

TEXT

Example:

"TEXT"

data

object

Data can contain any object with arbitrary number of fields inside

Show child attributes

Example:

{
  "markdown": "### Lorem ipsum dolor sit amet"
}

Response

The snippet was created

type

enum<string>

required

Snippet type

Available options:

FILTER,

TEXT

Example:

"TEXT"

string

read-only

Unique identifier of the snippet

Example:

"59ba04795b542f60838ce0ea"

data

object

Data can contain any object with arbitrary number of fields inside

Show child attributes

Example:

{
  "markdown": "### Lorem ipsum dolor sit amet"
}

auditable

object

read-only

Contains information about users and time of creating and updating this object

Show child attributes

Release Notes

Administer

Connect to Data

Present Data

Embed and Extend

Reference

(experimental) Creates a new snippet

Authorizations

Body

Response