Publish one or more artifacts from the workspace given by the X-Workspace-Id header or workspaceId query parameter, all-or-nothing

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/publish \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --header 'X-Workspace-Id: <x-workspace-id>' \
  --data '
{
  "artifacts": [
    {
      "id": "<string>"
    }
  ]
}
'

import requests

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

payload = { "artifacts": [{ "id": "<string>" }] }
headers = {
    "X-Workspace-Id": "<x-workspace-id>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Workspace-Id': '<x-workspace-id>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify({artifacts: [{id: '<string>'}]})
};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/publish",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'artifacts' => [
        [
                'id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/vnd.composer.v3+json",
    "X-Workspace-Id: <x-workspace-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"artifacts\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ]\n}")

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

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/publish")
  .header("X-Workspace-Id", "<x-workspace-id>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"artifacts\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["X-Workspace-Id"] = '<x-workspace-id>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n  \"artifacts\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ]\n}"

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

{
  "status": "PUBLISHED",
  "workspaceStatus": "OPEN",
  "publishedAt": "2023-11-07T05:31:56Z",
  "publishedBy": "<string>",
  "account": "<string>",
  "results": [
    {
      "artifactId": "<string>",
      "type": "SOURCE",
      "publishMode": "CREATE_NEW",
      "status": "SUCCESS",
      "publishDetails": {
        "originId": "<string>",
        "resultingArtifactId": "<string>",
        "matchedBy": "NAME",
        "scope": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z"
      },
      "error": "<string>"
    }
  ]
}

{
  "status": "PUBLISHED",
  "workspaceStatus": "OPEN",
  "publishedAt": "2023-11-07T05:31:56Z",
  "publishedBy": "<string>",
  "account": "<string>",
  "results": [
    {
      "artifactId": "<string>",
      "type": "SOURCE",
      "publishMode": "CREATE_NEW",
      "status": "SUCCESS",
      "publishDetails": {
        "originId": "<string>",
        "resultingArtifactId": "<string>",
        "matchedBy": "NAME",
        "scope": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z"
      },
      "error": "<string>"
    }
  ]
}

{
  "status": "PUBLISHED",
  "workspaceStatus": "OPEN",
  "publishedAt": "2023-11-07T05:31:56Z",
  "publishedBy": "<string>",
  "account": "<string>",
  "results": [
    {
      "artifactId": "<string>",
      "type": "SOURCE",
      "publishMode": "CREATE_NEW",
      "status": "SUCCESS",
      "publishDetails": {
        "originId": "<string>",
        "resultingArtifactId": "<string>",
        "matchedBy": "NAME",
        "scope": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z"
      },
      "error": "<string>"
    }
  ]
}

{
  "status": "PUBLISHED",
  "workspaceStatus": "OPEN",
  "publishedAt": "2023-11-07T05:31:56Z",
  "publishedBy": "<string>",
  "account": "<string>",
  "results": [
    {
      "artifactId": "<string>",
      "type": "SOURCE",
      "publishMode": "CREATE_NEW",
      "status": "SUCCESS",
      "publishDetails": {
        "originId": "<string>",
        "resultingArtifactId": "<string>",
        "matchedBy": "NAME",
        "scope": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z"
      },
      "error": "<string>"
    }
  ]
}

{
  "status": "PUBLISHED",
  "workspaceStatus": "OPEN",
  "publishedAt": "2023-11-07T05:31:56Z",
  "publishedBy": "<string>",
  "account": "<string>",
  "results": [
    {
      "artifactId": "<string>",
      "type": "SOURCE",
      "publishMode": "CREATE_NEW",
      "status": "SUCCESS",
      "publishDetails": {
        "originId": "<string>",
        "resultingArtifactId": "<string>",
        "matchedBy": "NAME",
        "scope": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z"
      },
      "error": "<string>"
    }
  ]
}

Publish one or more artifacts from the workspace given by the X-Workspace-Id header or workspaceId query parameter, all-or-nothing

curl --request POST \
  --url http://10.2.4.166:8080/composer/api/publish \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/vnd.composer.v3+json' \
  --header 'X-Workspace-Id: <x-workspace-id>' \
  --data '
{
  "artifacts": [
    {
      "id": "<string>"
    }
  ]
}
'

import requests

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

payload = { "artifacts": [{ "id": "<string>" }] }
headers = {
    "X-Workspace-Id": "<x-workspace-id>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/vnd.composer.v3+json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Workspace-Id': '<x-workspace-id>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/vnd.composer.v3+json'
  },
  body: JSON.stringify({artifacts: [{id: '<string>'}]})
};

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

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "8080",
  CURLOPT_URL => "http://10.2.4.166:8080/composer/api/publish",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'artifacts' => [
        [
                'id' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/vnd.composer.v3+json",
    "X-Workspace-Id: <x-workspace-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"artifacts\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ]\n}")

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

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

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://10.2.4.166:8080/composer/api/publish")
  .header("X-Workspace-Id", "<x-workspace-id>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/vnd.composer.v3+json")
  .body("{\n  \"artifacts\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["X-Workspace-Id"] = '<x-workspace-id>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/vnd.composer.v3+json'
request.body = "{\n  \"artifacts\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ]\n}"

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

{
  "status": "PUBLISHED",
  "workspaceStatus": "OPEN",
  "publishedAt": "2023-11-07T05:31:56Z",
  "publishedBy": "<string>",
  "account": "<string>",
  "results": [
    {
      "artifactId": "<string>",
      "type": "SOURCE",
      "publishMode": "CREATE_NEW",
      "status": "SUCCESS",
      "publishDetails": {
        "originId": "<string>",
        "resultingArtifactId": "<string>",
        "matchedBy": "NAME",
        "scope": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z"
      },
      "error": "<string>"
    }
  ]
}

{
  "status": "PUBLISHED",
  "workspaceStatus": "OPEN",
  "publishedAt": "2023-11-07T05:31:56Z",
  "publishedBy": "<string>",
  "account": "<string>",
  "results": [
    {
      "artifactId": "<string>",
      "type": "SOURCE",
      "publishMode": "CREATE_NEW",
      "status": "SUCCESS",
      "publishDetails": {
        "originId": "<string>",
        "resultingArtifactId": "<string>",
        "matchedBy": "NAME",
        "scope": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z"
      },
      "error": "<string>"
    }
  ]
}

{
  "status": "PUBLISHED",
  "workspaceStatus": "OPEN",
  "publishedAt": "2023-11-07T05:31:56Z",
  "publishedBy": "<string>",
  "account": "<string>",
  "results": [
    {
      "artifactId": "<string>",
      "type": "SOURCE",
      "publishMode": "CREATE_NEW",
      "status": "SUCCESS",
      "publishDetails": {
        "originId": "<string>",
        "resultingArtifactId": "<string>",
        "matchedBy": "NAME",
        "scope": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z"
      },
      "error": "<string>"
    }
  ]
}

{
  "status": "PUBLISHED",
  "workspaceStatus": "OPEN",
  "publishedAt": "2023-11-07T05:31:56Z",
  "publishedBy": "<string>",
  "account": "<string>",
  "results": [
    {
      "artifactId": "<string>",
      "type": "SOURCE",
      "publishMode": "CREATE_NEW",
      "status": "SUCCESS",
      "publishDetails": {
        "originId": "<string>",
        "resultingArtifactId": "<string>",
        "matchedBy": "NAME",
        "scope": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z"
      },
      "error": "<string>"
    }
  ]
}

{
  "status": "PUBLISHED",
  "workspaceStatus": "OPEN",
  "publishedAt": "2023-11-07T05:31:56Z",
  "publishedBy": "<string>",
  "account": "<string>",
  "results": [
    {
      "artifactId": "<string>",
      "type": "SOURCE",
      "publishMode": "CREATE_NEW",
      "status": "SUCCESS",
      "publishDetails": {
        "originId": "<string>",
        "resultingArtifactId": "<string>",
        "matchedBy": "NAME",
        "scope": "<string>",
        "publishedAt": "2023-11-07T05:31:56Z"
      },
      "error": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Headers

X-Workspace-Id

string

required

Scopes this request to the given workspace. Takes priority over the workspaceId query parameter. When omitted, falls back to account scope.

Body

application/vnd.composer.v3+json

Publish one or more workspace artifacts, all-or-nothing

artifacts

object[]

Show child attributes

Response

Result of an all-or-nothing publish batch

status

enum<string>

Outcome of the overall publish batch

Available options:

PUBLISHED,

FAILED

workspaceStatus

enum<string>

Available options:

OPEN,

PUBLISHED

publishedAt

string<date-time>

publishedBy

string

account

string

results

object[]

Show child attributes

Release Notes

Administer

Connect to Data

Present Data

Embed and Extend

Reference

Publish one or more artifacts from the workspace given by the X-Workspace-Id header or workspaceId query parameter, all-or-nothing

Authorizations

Headers

Body

Response