コンテンツにスキップ

作成¶

POST /api/v1/notes_v2/create

概要¶

新バージョンのノートを作成します。

Body リクエストパラメータ¶

パラメータ名	型	必須	説明
title	string	Y	ノートタイトル空の値を許可: False
content	string	Y	Markdown 本文空の値を許可: False
tags	array		タグリスト空の値を許可: False
tagKV	json		キー値タグ空の値を許可: False
isPublic	int		公開設定。1 は公開、0 は非公開。デフォルトは 1 空の値を許可: False
extend	json		Studio 業務拡張フィールド空の値を許可: False
noteType	string		ノートタイプ。normal は通常ノート、runbook は操作手順書。デフォルトは normal 空の値を許可: False 選択可能な値: ['normal', 'runbook']

パラメータ補足説明¶

このAPIを使用して新バージョンのノートを作成します。リクエストボディには少なくとも title と content を含める必要があります。tags、tagKV、isPublic、extend はオプションです。

ノートの保存パスや noteUUID は送信する必要はありません。作成成功後、レスポンスから noteUUID を読み取ってください。
isPublic を指定しない場合、デフォルトで公開ノートになります。0 を指定すると非公開ノートになります。
作成成功後、以降の取得、変更、削除はレスポンス内の noteUUID を使用します。
レスポンス内の etag は、初回編集時または削除時に ifMatch として使用できます。

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/notes_v2/create' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"title":"A","content":"# A","tags":["ops"],"tagKV":{"host":"127.0.0.1"}}'

レスポンス¶

{
    "code": 200,
    "content": {
        "noteUUID": "nbnote_xxx",
        "title": "A",
        "tags": [
            "ops"
        ],
        "tagKV": {
            "host": "127.0.0.1"
        },
        "isPublic": 1,
        "createdSource": "manual",
        "noteType": "normal",
        "etag": "etag_xxx",
        "version": 1
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-XXXX"
}