ワークスペース保存
curl --request PUT \
--url https://api.example.com/v1/data-apps/{app_id}/workspace \
--header 'Content-Type: application/json' \
--data '
{
"manifest": "<string>",
"files": {},
"secrets": {},
"expected_revision": 123
}
'import requests
url = "https://api.example.com/v1/data-apps/{app_id}/workspace"
payload = {
"manifest": "<string>",
"files": {},
"secrets": {},
"expected_revision": 123
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({manifest: '<string>', files: {}, secrets: {}, expected_revision: 123})
};
fetch('https://api.example.com/v1/data-apps/{app_id}/workspace', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/data-apps/{app_id}/workspace",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'manifest' => '<string>',
'files' => [
],
'secrets' => [
],
'expected_revision' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/data-apps/{app_id}/workspace"
payload := strings.NewReader("{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {},\n \"expected_revision\": 123\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.example.com/v1/data-apps/{app_id}/workspace")
.header("Content-Type", "application/json")
.body("{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {},\n \"expected_revision\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/data-apps/{app_id}/workspace")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {},\n \"expected_revision\": 123\n}"
response = http.request(request)
puts response.read_body{
"app_name": "<string>",
"app_id": "<string>",
"namespace": "<string>",
"revision": 123,
"valid": true,
"issues": [
{
"path": "<string>",
"message": "<string>"
}
],
"missing_secrets": [
"<string>"
],
"secrets_deferred": [
"<string>"
],
"name_reused_from": "<string>"
}Publishing
ワークスペース保存
可変下書き(ワークスペース)を保存。無効内容も保存可。検証結果付き。
PUT
/
v1
/
data-apps
/
{app_id}
/
workspace
ワークスペース保存
curl --request PUT \
--url https://api.example.com/v1/data-apps/{app_id}/workspace \
--header 'Content-Type: application/json' \
--data '
{
"manifest": "<string>",
"files": {},
"secrets": {},
"expected_revision": 123
}
'import requests
url = "https://api.example.com/v1/data-apps/{app_id}/workspace"
payload = {
"manifest": "<string>",
"files": {},
"secrets": {},
"expected_revision": 123
}
headers = {"Content-Type": "application/json"}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({manifest: '<string>', files: {}, secrets: {}, expected_revision: 123})
};
fetch('https://api.example.com/v1/data-apps/{app_id}/workspace', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/v1/data-apps/{app_id}/workspace",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'manifest' => '<string>',
'files' => [
],
'secrets' => [
],
'expected_revision' => 123
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/v1/data-apps/{app_id}/workspace"
payload := strings.NewReader("{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {},\n \"expected_revision\": 123\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://api.example.com/v1/data-apps/{app_id}/workspace")
.header("Content-Type", "application/json")
.body("{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {},\n \"expected_revision\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/data-apps/{app_id}/workspace")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"manifest\": \"<string>\",\n \"files\": {},\n \"secrets\": {},\n \"expected_revision\": 123\n}"
response = http.request(request)
puts response.read_body{
"app_name": "<string>",
"app_id": "<string>",
"namespace": "<string>",
"revision": 123,
"valid": true,
"issues": [
{
"path": "<string>",
"message": "<string>"
}
],
"missing_secrets": [
"<string>"
],
"secrets_deferred": [
"<string>"
],
"name_reused_from": "<string>"
}PUT https://api-datahub.octoparse.com/v1/data-apps/{app_id}/workspace
認証:APIキー必須(Authorization: Bearer <API Key>)。App 作者のみ。他者は 404。
App の可変下書きを保存。検証失敗でも保存は拒否されない: 完全検証は走り、結果(valid と issues)が返る。無効な下書きも保持され、直して再保存できる。
App 識別子は初回保存で暗黙作成 — 独立の「App 作成」エンドポイントはない。ハードゲートで 400 になるのは 3 つだけ: アカウントにユーザー名がある、ペイロードがサイズ内、app_name がまだ取られていない。
expected_revision は楽観ロック(409 revision-conflict)で、複数タブの静かな上書きを防ぐ。添付シークレットはこの保存が有効なときだけ格納。無効な保存で名前だけ残さない。
リクエスト
パスパラメータ
string
必須
App 参照:
app_<hex> または <namespace>/<app_name>。 初回保存では後者を使う。リクエスト body
string
必須
生マニフェストテキスト。
object
添付ファイル: キーは相対パス、値はテキスト。
object
シークレット名→平文。この保存が有効なときのみ格納。
integer
期待する現下書きリビジョン。不一致は
409。リクエスト例
curl -X PUT \
-H "Authorization: Bearer $OCTOPARSE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"manifest": "spec_version: \"0.2\"\n…", "files": {}, "expected_revision": 3}' \
"https://api-datahub.octoparse.com/v1/data-apps/carol/reviews-query/workspace"
レスポンス
200 成功
{
"data": {
"app_name": "string",
"app_id": "string",
"namespace": "string",
"revision": 0,
"valid": false,
"issues": [
{
"path": "string",
"message": "string"
}
],
"missing_secrets": [
"string"
],
"secrets_deferred": [
"string"
],
"name_reused_from": "string"
}
}
data に包まれます。フィールド:
string
必須
—
string
必須
Stable app id.
string
—
integer
必須
保存後の下書きリビジョン。
boolean
必須
現内容が検証を通ったか。
string[]
—
string[]
この保存が無効なため格納されなかったシークレット名。
string
—
エラー
| HTTP | code | category | Description |
|---|---|---|---|
| 401 | unauthorized | forbidden | API キー欠落または無効。 |
| 400 | username-required | invalid_input | アカウントにまだユーザー名がなく <username>/<app_name> を構成できない。 |
| 409 | revision-conflict | invalid_input | expected_revision が現下書きリビジョンと一致しない — 同時編集。 |
| 400 | invalid-app-name | invalid_input | Name fails naming rules or is a reserved word. |
| 409 | app-name-reserved | forbidden | 他者の履歴バインドが名前を保持(ユーザー名移管後 30 日凍結)。 |
| 413 | payload-too-large | invalid_input | リクエスト body がサイズ上限超過。 |
{"error": {code, category, message, retryable}} です。エラー を参照。