コンテンツの一覧を取得します。
シングル形式の場合は、コンテンツ単体を取得します。
詳細は"GET /api/v1/{endpoint}/{content_id}"を参照してください。
| endpoint required | string <string> Example: endpoint エンドポイント |
| q | string <string> Example: q=pet[eq]:cat[+]createdAt[ge]:2021-10-01 検索フィルタークエリ
| |||||||||||||||||||||||||||||||||||||||
| ids | string <string> Example: ids=unique-value-01,unique-value-02 複数コンテンツID指定クエリ
| |||||||||||||||||||||||||||||||||||||||
| limit | integer <int64> Example: limit=100 取得件数を指定します。デフォルト値は100です。 | |||||||||||||||||||||||||||||||||||||||
| offset | integer <int64> Example: offset=100 取得開始位置を指定します。デフォルト値は0です。 | |||||||||||||||||||||||||||||||||||||||
| search | string <string> Example: search=天気 通常検索 | |||||||||||||||||||||||||||||||||||||||
| s | string <string> Example: s=title,-updatedAt ソートクエリ
| |||||||||||||||||||||||||||||||||||||||
| status | integer <int64> Example: status=0 ステータス |
| Haco-Project-Draft-Token | string <string> Example: project-draft-token 未公開コンテンツを含めた一覧を取得するためのトークン |
{- "meta": {
- "total": 100,
- "limit": 100,
- "offset": 0
}, - "data": [
- {
- "id": "unique-value",
- "field": "field-value",
- "createdAt": "created-at",
- "updatedAt": "updated-at",
- "publishedAt": "published-at",
- "closedAt": "closed-at"
}
]
}コンテンツを投稿します。
| endpoint required | string <string> Example: endpoint エンドポイント |
| Haco-Write-Token required | string <string> Example: haco-write-token コンテンツを投稿・編集・削除するためのトークン |
リクエストオブジェクト
| field | string <string> key、value、型はフィールド毎に異なる |
{- "field": "field-value"
}コンテンツを投稿します。投稿済みの場合は編集します。
| endpoint required | string <string> Example: endpoint エンドポイント |
| Haco-Write-Token required | string <string> Example: haco-write-token コンテンツを投稿・編集・削除するためのトークン |
リクエストオブジェクト
| field | string <string> key、value、型はフィールド毎に異なる |
{- "field": "field-value"
}コンテンツの内容を編集します。
"PATCH /api/v1/{endpoint}/{content_id}"でも可能です。
| endpoint required | string <string> Example: endpoint エンドポイント |
| Haco-Write-Token required | string <string> Example: haco-write-token コンテンツを投稿・編集・削除するためのトークン |
リクエストオブジェクト
| field | string <string> key、value、型はフィールド毎に異なる |
{- "field": "field-value"
}指定したコンテンツを取得します。
| endpoint required | string <string> Example: endpoint エンドポイント |
| content_id required | string <string> Example: content-id コンテンツID |
| draft | string <string> Example: draft=draft-token 未公開コンテンツを取得するためのトークン |
| Haco-Project-Draft-Token | string <string> Example: project-draft-token 未公開コンテンツを含めた一覧を取得するためのトークン |
{- "id": "unique-value",
- "field": "field-value",
- "createdAt": "created-at",
- "updatedAt": "updated-at",
- "publishedAt": "published-at",
- "closedAt": "closed-at"
}指定したIDでコンテンツを投稿します。投稿済みの場合は編集します。
| endpoint required | string <string> Example: endpoint エンドポイント |
| content_id required | string <string> Example: content-id コンテンツID |
| Haco-Write-Token required | string <string> Example: haco-write-token コンテンツを投稿・編集・削除するためのトークン |
リクエストオブジェクト
| field | string <string> key、value、型はフィールド毎に異なる |
{- "field": "field-value"
}指定したコンテンツの内容を編集します。
| endpoint required | string <string> Example: endpoint エンドポイント |
| content_id required | string <string> Example: content-id コンテンツID |
| Haco-Write-Token required | string <string> Example: haco-write-token コンテンツを投稿・編集・削除するためのトークン |
リクエストオブジェクト
| field | string <string> key、value、型はフィールド毎に異なる |
{- "field": "field-value"
}