Content Fabric API v1.0.0

Configuration URLs:

• Main Fabric: https://main.net955305.contentfabric.io

• Test Fabric: https://main.net955210.contentfabric.io

Authentication

• HTTP Authentication, scheme: bearer

  {
    "qspace_id":  "SPACE-ID",
    "qlib_id": "LIBRARY-ID",
    "addr": "BLOCKCHAIN-ADDRESS",
    "tx_id" : "BLOCKCHAIN-TRANSACTION-ID"
  }

• HTTP Authentication, scheme: basic

  See bearer authentication above.

Content Space

The Content Space represents an instance of a content fabric network. It is associated with a blockchain smart contract that governs permissions and authorization within the space.

Get Space Config

Code samples

# You can also use wget
curl -X GET https://main.net955305.contentfabric.io/config \
  -H 'Accept: application/json'

GET https://main.net955305.contentfabric.io/config HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/json

var headers = {
  'Accept':'application/json'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/config',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json'

};

fetch('https://main.net955305.contentfabric.io/config',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json'
}

result = RestClient.get 'https://main.net955305.contentfabric.io/config',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://main.net955305.contentfabric.io/config', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/config");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://main.net955305.contentfabric.io/config", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://main.net955305.contentfabric.io/config', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /config

Retrieve the configuration of the content space determined from the Host header of the request. The space name is the first label of the DNS name found in the Host header value. For example, when making a request with the URL https://main.net955305.contentfabric.io/config, the configuration for the space main will be returned.

The response contains seed URLs for the content fabric API and the distributed ledger API that can be used by the client to communicate with that space. The returned seed URLs are selected based on the geo location of the requesting client.

Seed URLs are also filtered by the access protocol that was used for this request. If the call was made with https://.../config, for example, only https URLs will be returned. Likewise a call to http://.../config will return only http URLs.

Parameters

Detailed descriptions

qspace: The space name for which the configuration is requested. Overrides the space name determined from the Host header.

proto: The protocol name to use in filtering seed API URLs. Overrides the protocol of the request itself. Specifying no value or an empty value disables filtering (i.e. ?proto or ?proto=)

elvgeo: The geo location name to use for the seed URL lookup. Overrides the default geo location determined from the calling client's IP address.

self: If specified, the content fabric node handling the request returns itself as the only seed node instead of the regular seed nodes.

Enumerated Values

Example responses

200 Response

{
  "node_id": "inod3jzKHgsuaBu3cqKu7t4N2fLLdkC4",
  "network": {
    "id": "inetGhR8rniCY8Uzgj8xNHyUBS",
    "seed_nodes": {
      "fabric_api": [
        "https://host-64-146-28-142.test.contentfabric.io",
        "https://host-64-145-252-6.test.contentfabric.io",
        "https://host-64-133-145-232.test.contentfabric.io"
      ],
      "ethereum_api": [
        "https://host-64-146-28-142.test.contentfabric.io/eth/",
        "https://host-64-145-252-6.test.contentfabric.io/eth/",
        "https://host-64-133-145-232.test.contentfabric.io/eth/"
      ]
    },
    "authority": {
      "type": "",
      "ethereum": null
    }
  },
  "qspace": {
    "id": "ispc2zqa4gZ8N3DH1QWakR2e5UowDLF1",
    "names": [
      "main"
    ],
    "type": "Ethereum",
    "ethereum": {
      "network_id": 955210,
      "url": "http://127.0.0.2:8545",
      "public_key": "knodwQV5xpcEenkCmhL8TRUREYwyWKpiJgGMxU2iodxtcbiP",
      "rpc_seed_nodes": [
        "64.137.243.135:8545",
        "64.136.19.5:8545"
      ]
    }
  }
}

Responses

Get Space Metadata

Code samples

# You can also use wget
curl -X GET https://main.net955305.contentfabric.io/qspace/meta \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://main.net955305.contentfabric.io/qspace/meta HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qspace/meta',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qspace/meta',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://main.net955305.contentfabric.io/qspace/meta',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://main.net955305.contentfabric.io/qspace/meta', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qspace/meta");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://main.net955305.contentfabric.io/qspace/meta", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://main.net955305.contentfabric.io/qspace/meta', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /qspace/meta

Retrieve the metadata of the content space specified in the authentication token.

Example responses

200 Response

{}

Responses

Response Headers

Replace Space Metadata

Code samples

# You can also use wget
curl -X PUT https://main.net955305.contentfabric.io/qspace/meta \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT https://main.net955305.contentfabric.io/qspace/meta HTTP/1.1
Host: main.net955305.contentfabric.io
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qspace/meta',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "name": "ACME Content Space",
  "description": "A private content space for ACME, Inc."
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qspace/meta',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://main.net955305.contentfabric.io/qspace/meta',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://main.net955305.contentfabric.io/qspace/meta', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qspace/meta");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://main.net955305.contentfabric.io/qspace/meta", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://main.net955305.contentfabric.io/qspace/meta', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /qspace/meta

Replace the existing metadata metadata of the content space specified in the authentication token.

Body parameter

{
  "name": "ACME Content Space",
  "description": "A private content space for ACME, Inc."
}

Parameters

Example responses

401 Response

{
  "errors": [
    {
      "op": "authentication",
      "kind": "invalid",
      "cause": "authorization header missing",
      "stacktrace": "..."
    }
  ]
}

Responses

Response Headers

Get Space Metadata Subtree

Code samples

# You can also use wget
curl -X GET https://main.net955305.contentfabric.io/qspace/meta/{path} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://main.net955305.contentfabric.io/qspace/meta/{path} HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qspace/meta/{path}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qspace/meta/{path}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://main.net955305.contentfabric.io/qspace/meta/{path}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://main.net955305.contentfabric.io/qspace/meta/{path}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qspace/meta/{path}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://main.net955305.contentfabric.io/qspace/meta/{path}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://main.net955305.contentfabric.io/qspace/meta/{path}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /qspace/meta/{path}

Retrieve the content space metadata subtree at the given path.

Parameters

Example responses

200 Response

{}

Responses

Response Headers

Replace Space Metadata Subtree

Code samples

# You can also use wget
curl -X PUT https://main.net955305.contentfabric.io/qspace/meta/{path} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT https://main.net955305.contentfabric.io/qspace/meta/{path} HTTP/1.1
Host: main.net955305.contentfabric.io
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qspace/meta/{path}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "name": "ACME Content Space",
  "description": "A private content space for ACME, Inc."
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qspace/meta/{path}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://main.net955305.contentfabric.io/qspace/meta/{path}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://main.net955305.contentfabric.io/qspace/meta/{path}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qspace/meta/{path}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://main.net955305.contentfabric.io/qspace/meta/{path}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://main.net955305.contentfabric.io/qspace/meta/{path}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /qspace/meta/{path}

Replace the existing content space metadata at the given path.

Body parameter

{
  "name": "ACME Content Space",
  "description": "A private content space for ACME, Inc."
}

Parameters

Example responses

401 Response

{
  "errors": [
    {
      "op": "authentication",
      "kind": "invalid",
      "cause": "authorization header missing",
      "stacktrace": "..."
    }
  ]
}

Responses

Response Headers

Content Libraries

Content Libraries

List Libraries

Code samples

# You can also use wget
curl -X GET https://main.net955305.contentfabric.io/qlibs \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://main.net955305.contentfabric.io/qlibs HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://main.net955305.contentfabric.io/qlibs',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://main.net955305.contentfabric.io/qlibs', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://main.net955305.contentfabric.io/qlibs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://main.net955305.contentfabric.io/qlibs', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /qlibs

List all content libraries.

Example responses

200 Response

[
  "ilibPACFbXkPSawEKi7KnfwCfb",
  "ilibPAFjkXc4C3xajfjkZt6Kgm"
]

Responses

Response Headers

Create Library

Code samples

# You can also use wget
curl -X POST https://main.net955305.contentfabric.io/qlibs \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://main.net955305.contentfabric.io/qlibs HTTP/1.1
Host: main.net955305.contentfabric.io
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "meta": {
    "name": "ACME Advertisement Library",
    "description": "ACME Advertisement Library is a collection of all advertisement material produced for ACME, Inc."
  },
  "private_meta": {
    "instructions": "Publishing content to the library is governed by internal corporate policy ACME-IP-3897."
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://main.net955305.contentfabric.io/qlibs',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://main.net955305.contentfabric.io/qlibs', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://main.net955305.contentfabric.io/qlibs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://main.net955305.contentfabric.io/qlibs', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /qlibs

Create a new content library. The library ID will be generated automatically.
The content library accepts public and private metadata.

• Public metadata is stored in the content space and is returned when listing content libraries.
• Private metadata is stored in a content object that is created automatically for the content library.

The ID of the library's content object matches the ID of the library, but has a different ID prefix (i.e. ilibALz6VjbpBdkRbte5CPPhJi vs. iq__ALz6VjbpBdkRbte5CPPhJi).

The library content object is a regular content object that can store arbitrary data in addition to metadata, for example a library logo or other graphical content needed to render the library in a user interface.

Use the Create Content Version API call to modify it.

Body parameter

{
  "meta": {
    "name": "ACME Advertisement Library",
    "description": "ACME Advertisement Library is a collection of all advertisement material produced for ACME, Inc."
  },
  "private_meta": {
    "instructions": "Publishing content to the library is governed by internal corporate policy ACME-IP-3897."
  }
}

Parameters

Detailed descriptions

body: All fields of the content library creation request are optional.

Example responses

201 Response

{
  "id": "ilibALz6VjbpBdkRbte5CPPhJi",
  "qid": "iq__ALz6VjbpBdkRbte5CPPhJi"
}

Responses

Response Headers

Create Library with ID

Code samples

# You can also use wget
curl -X PUT https://main.net955305.contentfabric.io/qlibs/{qlibid} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT https://main.net955305.contentfabric.io/qlibs/{qlibid} HTTP/1.1
Host: main.net955305.contentfabric.io
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "meta": {
    "name": "ACME Advertisement Library",
    "description": "ACME Advertisement Library is a collection of all advertisement material produced for ACME, Inc."
  },
  "private_meta": {
    "instructions": "Publishing content to the library is governed by internal corporate policy ACME-IP-3897."
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://main.net955305.contentfabric.io/qlibs/{qlibid}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://main.net955305.contentfabric.io/qlibs/{qlibid}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://main.net955305.contentfabric.io/qlibs/{qlibid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://main.net955305.contentfabric.io/qlibs/{qlibid}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /qlibs/{qlibid}

Create a new content library with the specified library ID.
The content library accepts public and private metadata.

• Public metadata is stored in the content space and is returned when listing content libraries.
• Private metadata is stored in a content object that is created automatically for the content library.

The ID of the library's content object matches the ID of the library, but has a different ID prefix (i.e. ilibALz6VjbpBdkRbte5CPPhJi vs. iq__ALz6VjbpBdkRbte5CPPhJi).

The library content object is a regular content object that can store arbitrary data in addition to metadata, for example a library logo or other graphical content needed to render the library in a user interface.

Use the Create Content Version API call to modify it.

Body parameter

{
  "meta": {
    "name": "ACME Advertisement Library",
    "description": "ACME Advertisement Library is a collection of all advertisement material produced for ACME, Inc."
  },
  "private_meta": {
    "instructions": "Publishing content to the library is governed by internal corporate policy ACME-IP-3897."
  }
}

Parameters

Detailed descriptions

body: All fields of the content library creation request are optional.

Example responses

201 Response

{
  "id": "ilibALz6VjbpBdkRbte5CPPhJi",
  "qid": "iq__ALz6VjbpBdkRbte5CPPhJi"
}

Responses

Response Headers

Describe Library

Code samples

# You can also use wget
curl -X GET https://main.net955305.contentfabric.io/qlibs/{qlibid} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://main.net955305.contentfabric.io/qlibs/{qlibid} HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://main.net955305.contentfabric.io/qlibs/{qlibid}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://main.net955305.contentfabric.io/qlibs/{qlibid}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://main.net955305.contentfabric.io/qlibs/{qlibid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://main.net955305.contentfabric.io/qlibs/{qlibid}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /qlibs/{qlibid}

Retrieve information about a given content library.

Parameters

Example responses

200 Response

{
  "id": "ilibALz6VjbpBdkRbte5CPPhJi",
  "qid": "iq__ALz6VjbpBdkRbte5CPPhJi",
  "meta": {
    "name": "ACME Advertisement Library",
    "description": "ACME Advertisement Library is a collection of all advertisement material produced for ACME, Inc."
  }
}

Responses

Response Headers

Delete Library

Code samples

# You can also use wget
curl -X DELETE https://main.net955305.contentfabric.io/qlibs/{qlibid} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://main.net955305.contentfabric.io/qlibs/{qlibid} HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://main.net955305.contentfabric.io/qlibs/{qlibid}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://main.net955305.contentfabric.io/qlibs/{qlibid}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://main.net955305.contentfabric.io/qlibs/{qlibid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://main.net955305.contentfabric.io/qlibs/{qlibid}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /qlibs/{qlibid}

Delete the given content library.

Parameters

Example responses

401 Response

{
  "errors": [
    {
      "op": "authentication",
      "kind": "invalid",
      "cause": "authorization header missing",
      "stacktrace": "..."
    }
  ]
}

Responses

Response Headers

Get Public Metadata

Code samples

# You can also use wget
curl -X GET https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /qlibs/{qlibid}/meta

Retrieve public metadata of the content library.

Parameters

Example responses

200 Response

{}

Responses

Response Headers

Replace Public Metadata

Code samples

# You can also use wget
curl -X PUT https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta HTTP/1.1
Host: main.net955305.contentfabric.io
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "name": "ACME Advertisement Library",
  "description": "A collection of all advertisement material produced for ACME, Inc."
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /qlibs/{qlibid}/meta

Replace existing public metadata of the given content library.

Body parameter

{
  "name": "ACME Advertisement Library",
  "description": "A collection of all advertisement material produced for ACME, Inc."
}

Parameters

Example responses

401 Response

{
  "errors": [
    {
      "op": "authentication",
      "kind": "invalid",
      "cause": "authorization header missing",
      "stacktrace": "..."
    }
  ]
}

Responses

Response Headers

Get Public Metadata Subtree

Code samples

# You can also use wget
curl -X GET https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta/{path} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta/{path} HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta/{path}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta/{path}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta/{path}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta/{path}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta/{path}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta/{path}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta/{path}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /qlibs/{qlibid}/meta/{path}

Retrieve public metadata subtree at the given path.

Parameters

Example responses

200 Response

{}

Responses

Response Headers

Replace Public Metadata Subtree

Code samples

# You can also use wget
curl -X PUT https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta/{path} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta/{path} HTTP/1.1
Host: main.net955305.contentfabric.io
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta/{path}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "name": "ACME Advertisement Library",
  "description": "A collection of all advertisement material produced for ACME, Inc."
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta/{path}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta/{path}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta/{path}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta/{path}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta/{path}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://main.net955305.contentfabric.io/qlibs/{qlibid}/meta/{path}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /qlibs/{qlibid}/meta/{path}

Replace the existing public metadata at the given path.

Body parameter

{
  "name": "ACME Advertisement Library",
  "description": "A collection of all advertisement material produced for ACME, Inc."
}

Parameters

Example responses

401 Response

{
  "errors": [
    {
      "op": "authentication",
      "kind": "invalid",
      "cause": "authorization header missing",
      "stacktrace": "..."
    }
  ]
}

Responses

Response Headers

Content Objects

A Content Object is the main entity in the content fabric. It combines binary data, user-provided metadata, and custom behavior in the form of executable bitcode.

List Content Objects

Code samples

# You can also use wget
curl -X GET https://main.net955305.contentfabric.io/qlibs/{qlibid}/q \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://main.net955305.contentfabric.io/qlibs/{qlibid}/q HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/q");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/q", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://main.net955305.contentfabric.io/qlibs/{qlibid}/q', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /qlibs/{qlibid}/q

List all finalized contents within the given content library.

The follwoing query parameters allow customizing the listing.

Sorting

Sorting Examples

?sort_by=/public/name
  &sort_case_sensitive=true
  &sort_descending=true

?sort_by=/public/type
  &sort_by=/public/name

• Query param sort_by: metadata path to the value to sort on. Multiple instances allowed. Sorting is performed in lexical order on the first (most recent) version of each content.
• Query param sort_case_sensitive: enable case-sensitive sorting. Disabled by default.
• Query param sort_descending: false for ascending sort order, true for descending sort order. Default: false (ascending)

Generic Filtering

Generic Filtering Examples

Examples:
?filter=/public/name::season%201

?filter=/public/name:co:season%201
  &filter=/type:eq:episode

• Query param filter: a metadata path separated with a comparator from the value to match. Multiple instances allowed.

Comparators:

• ::, :co: contains
• :nc: not contains
• :eq: equals
• :ne: not equals
• :lt: less than
• :le: less than or equal
• :gt: greater than
• :ge: greater than or equal

Notes:

• values MUST be percent-encoded.
• metadata paths SHOULD be percent-encoded as well (even though the URI "query" string specifically allows forward slashes /)

Additional Filtering

Additional Filtering Examples

?filter_by_user=true
  &latest_version_only=false

• Query param filter_by_user: tag without value or bool to suppress contents that are not accessible for the user making the request. Default: true.

• Query param latest_version_only: tag without value or bool to retrieve only the latest content version per content ID. Default: true.

Selection

Selection Examples

?select=/public

?select=/public/name
  &select=/public/description
  &select=/public/thumbnail

Query param select: path of metadata subtree to return. If the query parameter is specified multiple times, the results of each expression are merged.

Removal

Removal Examples

?remove=/public/description

?select=/public
  &remove=/public/description
  &remove=/public/thumbnail

Query param remove: path of metadata subtree to remove from the result. May be specified multiple times.

Paging

Paging Examples

?start=20
  &limit=10

• Query param start: index of the first content object to retrieve. Leave empty to retrieve the first content.
• Query param limit: integer specifying the number of contents to return. Default: 100.

Parameters

Detailed descriptions

sort_by: Metadata path to the value to sort on. Multiple instances allowed. Sorting is performed in lexical order on the first (most recent) version of each content.

filter: A metadata path separated with a comparator from the value to match. Multiple instances allowed.

Examples:

• ?filter=/public/name::season%201
• ?filter=/public/name:co:season%201&filter=/type:eq:episode

Operators:

• ::, :co: contains
• :nc: not contains
• :eq: equals
• :ne: not equals
• :lt: less than
• :le: less than or equal
• :gt: greater than
• :ge: greater than or equal

Notes:

• values MUST be percent-encoded.
• metadata paths SHOULD be percent-encoded as well (even though the URI "query" string specifically allows forward slashes /)

filter_by_user: Suppress contents that are not accessible for the user making the request.

latest_version_only: Retrieve only the latest content version per content ID.

select: Metadata path to the subtree to retrieve. May be specified multiple times.

remove: Metadata path of the subtree to remove from the result. May be specified multiple times.

start: Index of the first content object to retrieve. Leave empty to retrieve the first content.

limit: Integer specifying the number of contents to return.

Example responses

200 Response

{
  "contents": [
    {
      "id": "iq__6D1qLem852ggNcEYcAyvgT",
      "versions": [
        {
          "id": "iq__6D1qLem852ggNcEYcAyvgT",
          "hash": "hq__QmZPdxKM4wyvHG4En3LoAtZ9cQE9KL2MVNsEN17etCN2cA",
          "type": "hq__QmRDQwpgAMkc3TDsnvwmv2VSgg3zqNNFcMWKSdxxMX4QxU",
          "meta": {
            "genre": "Animation",
            "title": "Finding Dory",
            "year": 2016
          }
        }
      ]
    },
    {
      "id": "iq__L9LkebHK3QQ7q3rWxmWs55",
      "versions": [
        {
          "id": "iq__L9LkebHK3QQ7q3rWxmWs55",
          "hash": "hq__QmRDQwpgAMkc3TDsnvwmv2VSgg3zqNNFcMWKSdxxMX4QxU",
          "type": "",
          "meta": {
            "bitcode": "video.bc"
          }
        }
      ]
    }
  ],
  "paging": {
    "first": "0",
    "last": "10",
    "next": "5",
    "previous": "0",
    "items": 12,
    "current": 0,
    "pages": 3,
    "limit": 5
  }
}

Responses

Response Headers

Create Draft Content

Code samples

# You can also use wget
curl -X POST https://main.net955305.contentfabric.io/qlibs/{qlibid}/q \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://main.net955305.contentfabric.io/qlibs/{qlibid}/q HTTP/1.1
Host: main.net955305.contentfabric.io
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "type": "hq__QmRDQwpgAMkc3TDsnvwmv2VSgg3zqNNFcMWKSdxxMX4QxU",
  "meta": {
    "genre": "sci-fi",
    "year": "2018"
  },
  "copy_from": "hq__QmPLzvrE9cmWJv6wcXczTwRsYok8znbnKMjYjd8gAUtJgD"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/q");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/q", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://main.net955305.contentfabric.io/qlibs/{qlibid}/q', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /qlibs/{qlibid}/q

Create a new content object

Body parameter

{
  "type": "hq__QmRDQwpgAMkc3TDsnvwmv2VSgg3zqNNFcMWKSdxxMX4QxU",
  "meta": {
    "genre": "sci-fi",
    "year": "2018"
  },
  "copy_from": "hq__QmPLzvrE9cmWJv6wcXczTwRsYok8znbnKMjYjd8gAUtJgD"
}

Parameters

Detailed descriptions

body: All fields of the content creation request are optional.

Example responses

201 Response

{
  "id": "iq__EigNHQ5cFjBFjTtrG39Yco",
  "type": "hq__QmRDQwpgAMkc3TDsnvwmv2VSgg3zqNNFcMWKSdxxMX4QxU",
  "write_token": "tqw_GAQdkSsjXirpDpWsADWQTxbZMsVxwcPK9"
}

Responses

Response Headers

Create Draft Content with ID

Code samples

# You can also use wget
curl -X PUT https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qid} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qid} HTTP/1.1
Host: main.net955305.contentfabric.io
Content-Type: application/json
Accept: application/json

var headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qid}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "type": "hq__QmRDQwpgAMkc3TDsnvwmv2VSgg3zqNNFcMWKSdxxMX4QxU",
  "meta": {
    "genre": "sci-fi",
    "year": "2018"
  },
  "copy_from": "hq__QmPLzvrE9cmWJv6wcXczTwRsYok8znbnKMjYjd8gAUtJgD"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qid}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qid}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qid}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qid}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qid}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qid}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /qlibs/{qlibid}/q/{qid}

Create a new content object, using the provided Content ID.

Body parameter

{
  "type": "hq__QmRDQwpgAMkc3TDsnvwmv2VSgg3zqNNFcMWKSdxxMX4QxU",
  "meta": {
    "genre": "sci-fi",
    "year": "2018"
  },
  "copy_from": "hq__QmPLzvrE9cmWJv6wcXczTwRsYok8znbnKMjYjd8gAUtJgD"
}

Parameters

Detailed descriptions

body: All fields of the content creation request are optional.

Example responses

201 Response

{
  "id": "iq__EigNHQ5cFjBFjTtrG39Yco",
  "type": "hq__QmRDQwpgAMkc3TDsnvwmv2VSgg3zqNNFcMWKSdxxMX4QxU",
  "write_token": "tqw_GAQdkSsjXirpDpWsADWQTxbZMsVxwcPK9"
}

Responses

Response Headers

Upload Part

Code samples

# You can also use wget
curl -X POST https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/data \
  -H 'Content-Type: application/octet-stream' \
  -H 'Accept: application/json' \
  -H 'X-Content-Fabric-Encryption-Scheme: none' \
  -H 'Authorization: Bearer {access-token}'

POST https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/data HTTP/1.1
Host: main.net955305.contentfabric.io
Content-Type: application/octet-stream
Accept: application/json
X-Content-Fabric-Encryption-Scheme: none

var headers = {
  'Content-Type':'application/octet-stream',
  'Accept':'application/json',
  'X-Content-Fabric-Encryption-Scheme':'none',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/data',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = 'null';
const headers = {
  'Content-Type':'application/octet-stream',
  'Accept':'application/json',
  'X-Content-Fabric-Encryption-Scheme':'none',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/data',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/octet-stream',
  'Accept' => 'application/json',
  'X-Content-Fabric-Encryption-Scheme' => 'none',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/data',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/octet-stream',
  'Accept': 'application/json',
  'X-Content-Fabric-Encryption-Scheme': 'none',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/data', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/octet-stream"},
        "Accept": []string{"application/json"},
        "X-Content-Fabric-Encryption-Scheme": []string{"none"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/data", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/octet-stream',
    'Accept' => 'application/json',
    'X-Content-Fabric-Encryption-Scheme' => 'none',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/data', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /qlibs/{qlibid}/q/{qwtoken}/data

Upload binary data into a new content part and finalize the part in a single call. All binary data is stored in the same part, and the part is finalized automatically. If you require more control over part creation (i.e. upload data with multiple requests, resume failed uploads, etc.), use the content part API endpoints.

Body parameter

null

Parameters

Detailed descriptions

body: The request body contains the binary data of the content part.

Example responses

201 Response

{
  "content": {
    "id": "iq__6D1qLem852ggNcEYcAyvgT",
    "write_token": "tqw_EGheZaihN4Z1DX3VE6EVGLHiSWZSM6j4n",
    "type": "hq__QmRDQwpgAMkc3TDsnvwmv2VSgg3zqNNFcMWKSdxxMX4QxU"
  },
  "part": {
    "hash": "hqp_QmYw62E6J1wUQbJrqVbbttR1Bun5KQmUJAfPks6Ctx37Bx -- if finalized",
    "write_token": "tqp_8qqHM6Jbx6JWDbpRjmvMVg6BpmnirFfBhS9s -- if draft",
    "size": 8587043
  }
}

Responses

Response Headers

Finalize Draft Content

Code samples

# You can also use wget
curl -X POST https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken} HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /qlibs/{qlibid}/q/{qwtoken}

Finalize the draft content object identified by the provided content write token. After successful finalization, the content object is addressable by its hash, but it also becomes immutable.
Subsequent modifications are nevertheless possible by creating new content versions

Parameters

Example responses

201 Response

{
  "id": "iq__6D1qLem852ggNcEYcAyvgT",
  "write_token": "tqw_EGheZaihN4Z1DX3VE6EVGLHiSWZSM6j4n",
  "type": "hq__QmRDQwpgAMkc3TDsnvwmv2VSgg3zqNNFcMWKSdxxMX4QxU",
  "size_stats": {
    "parts": 5,
    "size": "575 B",
    "size_bytes": 575
  }
}

Responses

Response Headers

Commit & Publish Content

Code samples

# You can also use wget
curl -X PUT https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhash} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PUT https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhash} HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhash}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhash}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhash}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhash}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhash}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhash}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhash}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PUT /qlibs/{qlibid}/q/{qhash}

Commit & publish the content object identified by the provided content hash to the content fabric network.

Parameters

Example responses

401 Response

{
  "errors": [
    {
      "op": "authentication",
      "kind": "invalid",
      "cause": "authorization header missing",
      "stacktrace": "..."
    }
  ]
}

Responses

Response Headers

Describe Content Object

Code samples

# You can also use wget
curl -X GET https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit} HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /qlibs/{qlibid}/q/{qhit}

Retrieve information about the given content object.

Parameters

Detailed descriptions

qhit: A content hash, ID or write token.

• The hash of a finalized content object.
• A content ID. The given ID will be resolved to the latest version of that content.
• The write token of a draft content object.

details: Retrieve additional details (currently content type hash, qlib ID, and size stats)

Example responses

200 Response

{
  "id": "iq__6D1qLem852ggNcEYcAyvgT",
  "write_token": "tqw_EGheZaihN4Z1DX3VE6EVGLHiSWZSM6j4n",
  "type": "hq__QmRDQwpgAMkc3TDsnvwmv2VSgg3zqNNFcMWKSdxxMX4QxU",
  "size_stats": {
    "parts": 5,
    "size": "575 B",
    "size_bytes": 575
  }
}

Responses

Response Headers

Delete Content Object

Code samples

# You can also use wget
curl -X DELETE https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit} HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /qlibs/{qlibid}/q/{qhit}

Delete the given content object.

Parameters

Detailed descriptions

qhit: A content hash, ID or write token.

• The hash of a finalized content object.
• A content ID. The given ID will be resolved to the latest version of that content.
• The write token of a draft content object.

Example responses

401 Response

{
  "errors": [
    {
      "op": "authentication",
      "kind": "invalid",
      "cause": "authorization header missing",
      "stacktrace": "..."
    }
  ]
}

Responses

Response Headers

Audit Content Object

Code samples

# You can also use wget
curl -X GET https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhi}/audit?salt=string \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhi}/audit?salt=string HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhi}/audit',
  method: 'get',
  data: '?salt=string',
  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhi}/audit?salt=string',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhi}/audit',
  params: {
  'salt' => 'string'
}, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhi}/audit', params={
  'salt': 'string'
}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhi}/audit?salt=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhi}/audit", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhi}/audit', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /qlibs/{qlibid}/q/{qhi}/audit

Calculate audit information for the given content object.
The audit information comprises a calculated hash that is intended to be compared to a similarly requested hash from other nodes. Successful comparison among hashes from several nodes verifies the integrity of the content object throughout the content fabric.

Parameters

Detailed descriptions

qhi: A content hash or ID.

• The hash of a finalized content object.
• A content ID. The given ID will be resolved to the latest version of that content.

Example responses

200 Response

{
  "id": "iq__GRpjaXYVqvPdHqnpLYBb5N",
  "hash": "hq__tUTXn4yZ1RtrscF5AVjdFS2u9WAtbqris46QWHUERugopgcWHCoa74v8fDc9ZtU7Udzt",
  "salt": "aGVsbG93b3JsZA==",
  "samples": [
    0.2,
    0.4,
    0.8
  ],
  "audit_hash": "KJhme-dRxpkHAH7U-ZlCqkYdhQbOG3gc_eEvWbJgK2A="
}

Responses

Response Headers

Download Part

Code samples

# You can also use wget
curl -X GET https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/data/{qphash} \
  -H 'Accept: application/octet-stream' \
  -H 'Range: bytes=1000-1999' \
  -H 'X-Content-Fabric-Decryption-Mode: none' \
  -H 'Authorization: Bearer {access-token}'

GET https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/data/{qphash} HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/octet-stream
Range: bytes=1000-1999
X-Content-Fabric-Decryption-Mode: none

var headers = {
  'Accept':'application/octet-stream',
  'Range':'bytes=1000-1999',
  'X-Content-Fabric-Decryption-Mode':'none',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/data/{qphash}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/octet-stream',
  'Range':'bytes=1000-1999',
  'X-Content-Fabric-Decryption-Mode':'none',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/data/{qphash}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/octet-stream',
  'Range' => 'bytes=1000-1999',
  'X-Content-Fabric-Decryption-Mode' => 'none',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/data/{qphash}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/octet-stream',
  'Range': 'bytes=1000-1999',
  'X-Content-Fabric-Decryption-Mode': 'none',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/data/{qphash}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/data/{qphash}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/octet-stream"},
        "Range": []string{"bytes=1000-1999"},
        "X-Content-Fabric-Decryption-Mode": []string{"none"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/data/{qphash}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/octet-stream',
    'Range' => 'bytes=1000-1999',
    'X-Content-Fabric-Decryption-Mode' => 'none',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/data/{qphash}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /qlibs/{qlibid}/q/{qhit}/data/{qphash}

Download the given part as a byte stream. Optionally, only a given byte range can be downloaded.

Parameters

Detailed descriptions

qhit: A content hash, ID or write token.

• The hash of a finalized content object.
• A content ID. The given ID will be resolved to the latest version of that content.
• The write token of a draft content object.

header-x_decryption_mode: A value that will be treated as if specified in an X-Content-Fabric-Decryption-Mode request header. Useful in cases where request headers cannot be specified, for example in HTML links.

Enumerated Values

Example responses

200 Response

401 Response

{
  "errors": [
    {
      "op": "authentication",
      "kind": "invalid",
      "cause": "authorization header missing",
      "stacktrace": "..."
    }
  ]
}

Responses

Response Schema

Response Headers

Get Part Proofs

Code samples

# You can also use wget
curl -X GET https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/data/{qphash}/proofs \
  -H 'Accept: application/json' \
  -H 'Range: bytes=1000-1999' \
  -H 'Authorization: Bearer {access-token}'

GET https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/data/{qphash}/proofs HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/json
Range: bytes=1000-1999

var headers = {
  'Accept':'application/json',
  'Range':'bytes=1000-1999',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/data/{qphash}/proofs',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Range':'bytes=1000-1999',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/data/{qphash}/proofs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Range' => 'bytes=1000-1999',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/data/{qphash}/proofs',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Range': 'bytes=1000-1999',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/data/{qphash}/proofs', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/data/{qphash}/proofs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Range": []string{"bytes=1000-1999"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/data/{qphash}/proofs", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Range' => 'bytes=1000-1999',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/data/{qphash}/proofs', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /qlibs/{qlibid}/q/{qhit}/data/{qphash}/proofs

Retrieve the proofs associated with the given part. Optionally, the proofs corresponding to only a given byte range can be retrieved.

Parameters

Detailed descriptions

qhit: A content hash, ID or write token.

• The hash of a finalized content object.
• A content ID. The given ID will be resolved to the latest version of that content.
• The write token of a draft content object.

Example responses

200 Response

{
  "root_hash": "c7ca499116e787efed246946d3461c70982c045c2b4df2b53cef32d5e122f11f",
  "proofs": [
    {
      "byte_beg": 0,
      "byte_end": 10,
      "proof": [
        "c7ca499116e787efed246946d3461c70982c045c2b4df2b53cef32d5e122f11f"
      ]
    }
  ],
  "proof_data": {
    "c7ca499116e787efed246946d3461c70982c045c2b4df2b53cef32d5e122f11f": "+FyhIDUHLBrlRjUOC/p6sR1J3G8SnnLM1X7H62cSJbvRl8jxuDgAAAAAAAAAAAAAAAAAAAAACgAAAAAAAAA1Bywa5UY1Dgv6erEdSdxvEp5yzNV+x+tnEiW70ZfI8Q=="
  }
}

Responses

Response Schema

Response Headers

Content Parts

The payload data of a content object is stored in one or several Content Parts.

List Parts

Code samples

# You can also use wget
curl -X GET https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/parts \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/parts HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/parts',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/parts',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/parts',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/parts', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/parts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/parts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/parts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /qlibs/{qlibid}/q/{qhit}/parts

Retrieve information on all content parts.

Parameters

Detailed descriptions

qhit: A content hash, ID or write token.

• The hash of a finalized content object.
• A content ID. The given ID will be resolved to the latest version of that content.
• The write token of a draft content object.

Example responses

200 Response

{
  "content": {
    "id": "iq__6D1qLem852ggNcEYcAyvgT",
    "hash": "hq__QmctSY6kRDT1GJ7S69W7Ta7PEsvyWCCZahTFDAxXmjQXXh",
    "type": "hq__QmRDQwpgAMkc3TDsnvwmv2VSgg3zqNNFcMWKSdxxMX4QxU"
  },
  "parts": [
    {
      "hash": "hqp_QmYw62E6J1wUQbJrqVbbttR1Bun5KQmUJAfPks6Ctx37Bx",
      "size": 8
    },
    {
      "hash": "hqp_QmSbmmRGN6rEVTh641Lb7mCzutXz3QrDnKGB4D31DkNTEy",
      "size": 6
    },
    {
      "hash": "hqp_QmVqc4HyLnbcZL6AdY22RuAUYJ3mCcHBnd2hz4mymKjPWf",
      "size": 6
    },
    {
      "hash": "hqp_QmepV9tKHRwvhusx5LfU6eZRXEnpX6XyjdkAUBNs1gBECE",
      "size": 6
    }
  ]
}

Responses

Response Headers

Create Draft Part

Code samples

# You can also use wget
curl -X POST https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts \
  -H 'Content-Type: application/octet-stream' \
  -H 'Accept: application/json' \
  -H 'X-Content-Fabric-Encryption-Scheme: none' \
  -H 'Authorization: Bearer {access-token}'

POST https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts HTTP/1.1
Host: main.net955305.contentfabric.io
Content-Type: application/octet-stream
Accept: application/json
X-Content-Fabric-Encryption-Scheme: none

var headers = {
  'Content-Type':'application/octet-stream',
  'Accept':'application/json',
  'X-Content-Fabric-Encryption-Scheme':'none',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = 'null';
const headers = {
  'Content-Type':'application/octet-stream',
  'Accept':'application/json',
  'X-Content-Fabric-Encryption-Scheme':'none',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/octet-stream',
  'Accept' => 'application/json',
  'X-Content-Fabric-Encryption-Scheme' => 'none',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/octet-stream',
  'Accept': 'application/json',
  'X-Content-Fabric-Encryption-Scheme': 'none',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/octet-stream"},
        "Accept": []string{"application/json"},
        "X-Content-Fabric-Encryption-Scheme": []string{"none"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/octet-stream',
    'Accept' => 'application/json',
    'X-Content-Fabric-Encryption-Scheme' => 'none',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /qlibs/{qlibid}/q/{qwtoken}/parts

Create a new draft part. The returned part write token can be used to for further operations on the part.

Body parameter

null

Parameters

Enumerated Values

Example responses

201 Response

{
  "content": {
    "id": "iq__6D1qLem852ggNcEYcAyvgT",
    "write_token": "tqw_EGheZaihN4Z1DX3VE6EVGLHiSWZSM6j4n",
    "type": "hq__QmRDQwpgAMkc3TDsnvwmv2VSgg3zqNNFcMWKSdxxMX4QxU"
  },
  "part": {
    "hash": "hqp_QmYw62E6J1wUQbJrqVbbttR1Bun5KQmUJAfPks6Ctx37Bx -- if finalized",
    "write_token": "tqp_8qqHM6Jbx6JWDbpRjmvMVg6BpmnirFfBhS9s -- if draft",
    "size": 8587043
  }
}

Responses

Response Headers

Append Data or Finalize

Code samples

# You can also use wget
curl -X POST https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts/{qpwtoken} \
  -H 'Content-Type: application/octet-stream' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts/{qpwtoken} HTTP/1.1
Host: main.net955305.contentfabric.io
Content-Type: application/octet-stream
Accept: application/json

var headers = {
  'Content-Type':'application/octet-stream',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts/{qpwtoken}',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = 'null';
const headers = {
  'Content-Type':'application/octet-stream',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts/{qpwtoken}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/octet-stream',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts/{qpwtoken}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/octet-stream',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts/{qpwtoken}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts/{qpwtoken}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/octet-stream"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts/{qpwtoken}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/octet-stream',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts/{qpwtoken}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST /qlibs/{qlibid}/q/{qwtoken}/parts/{qpwtoken}

Append data to the draft part with the given part write token. The part is finalized if no data is provided (empty request body).

Body parameter

null

Parameters

Example responses

200 Response

{
  "content": {
    "id": "iq__6D1qLem852ggNcEYcAyvgT",
    "write_token": "tqw_EGheZaihN4Z1DX3VE6EVGLHiSWZSM6j4n",
    "type": "hq__QmRDQwpgAMkc3TDsnvwmv2VSgg3zqNNFcMWKSdxxMX4QxU"
  },
  "part": {
    "hash": "hqp_QmYw62E6J1wUQbJrqVbbttR1Bun5KQmUJAfPks6Ctx37Bx -- if finalized",
    "write_token": "tqp_8qqHM6Jbx6JWDbpRjmvMVg6BpmnirFfBhS9s -- if draft",
    "size": 8587043
  }
}

Responses

Response Headers

Describe Part

Code samples

# You can also use wget
curl -X GET https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/parts/{qpht} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/parts/{qpht} HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/parts/{qpht}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/parts/{qpht}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/parts/{qpht}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/parts/{qpht}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/parts/{qpht}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/parts/{qpht}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qhit}/parts/{qpht}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET /qlibs/{qlibid}/q/{qhit}/parts/{qpht}

Retrieve information about the given part.

Parameters

Detailed descriptions

qhit: A content hash, ID or write token.

• The hash of a finalized content object.
• A content ID. The given ID will be resolved to the latest version of that content.
• The write token of a draft content object.

Example responses

200 Response

{
  "content": {
    "id": "iq__6D1qLem852ggNcEYcAyvgT",
    "write_token": "tqw_EGheZaihN4Z1DX3VE6EVGLHiSWZSM6j4n",
    "type": "hq__QmRDQwpgAMkc3TDsnvwmv2VSgg3zqNNFcMWKSdxxMX4QxU"
  },
  "part": {
    "hash": "hqp_QmYw62E6J1wUQbJrqVbbttR1Bun5KQmUJAfPks6Ctx37Bx -- if finalized",
    "write_token": "tqp_8qqHM6Jbx6JWDbpRjmvMVg6BpmnirFfBhS9s -- if draft",
    "size": 8587043
  }
}

Responses

Response Headers

Delete Part

Code samples

# You can also use wget
curl -X DELETE https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts/{qpht} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

DELETE https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts/{qpht} HTTP/1.1
Host: main.net955305.contentfabric.io
Accept: application/json

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts/{qpht}',
  method: 'delete',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts/{qpht}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete 'https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts/{qpht}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts/{qpht}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts/{qpht}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts/{qpht}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

 'application/json',
    'Authorization' => 'Bearer {access-token}',
    
    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','https://main.net955305.contentfabric.io/qlibs/{qlibid}/q/{qwtoken}/parts/{qpht}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

DELETE /qlibs/{qlibid}/q/{qwtoken}/parts/{qpht}

Delete the given part.

Parameters

Example responses

401 Response

{
  "errors": [
    {
      "op": "authentication",
      "kind": "invalid",
      "cause": "authorization header missing",
      "stacktrace": "..."
    }
  ]
}

Responses

Response Headers

Content Metadata

User-defined metadata is an arbitrary JSON structure that can be stored within a content object. The metadata can be modified as long as the content object has not been finalized. Query functionality provides efficient retrieval of subsets of the metadata.

Links

Example metadata with relative and absolute links:

{
  "name": { "/": "./meta/titles/en" },
  "titles": {
    "en": "Loop the Hoop",
    "de": "Greif den Reif",
    "fr": "Le cerceau dans le berceau"
  },
  "directors": [
    { "/": "/qfab/hq__QmbWqTrE/meta/library/directors/Andrew Hooper" },
    { "/": "/qfab/hq__QmbWqTrE/meta/library/directors/Jackie Looper" }
  ],
  "assets": {
    "poster": { "/": "./files/images/poster-1080x768.jpg" },
    "trailer": { "/": "/qfab/hq__6ABbaHWb/rep/playout/default/options.json" },
    "main": { "/": "/qfab/hq__2wBPuKYi/rep/playout/default/options.json" },
  },
  "files": { ... }
}