Content Services GraphQL API

API を使用して、リソースを作成、取得、更新、または削除します。この API は、1 回の呼び出しで必要なデータそのものを取得できるので、Web およびモバイルのアプリケーションの開発に適しています。デフォルトでは、この API は自分のサブスクリプションでプロビジョンされます。

概要
API への接続のテスト
Webhook の使用

概要

Content Services GraphQL API は、 Content Platform Engineのアプリケーション開発を簡素化する、スキーマと理解しやすい照会言語システムを提供します。型とフィールドのAPIスキーマ定義は、Content Engine Java™ APIオブジェクトモデルと密接に一致し、自然な GraphQL 開発者の消費のために必要かつ望ましい拡張がなされている。

この API では、以下の操作を行えます。

メタデータ・ディスカバリー
ドキュメントおよびフォルダーの操作
検索操作
参照操作

以下のいずれかの URL を使用して、API エンドポイントにアクセスします。お客様の購読設定に該当する URL を使用してください。

https://hostname.automationcloud.ibm.com.com/dba/environment/content-services-graphql/graphql

https://fncm-environment-hostname.automationcloud.ibm.com/content-services-graphql/graphql

ここで、environment の値は dev (開発環境)、test (テスト環境)、または run (実稼働環境) です。

API には、API の探索と対話に役立つブラウザー内に統合開発環境 (GraphiQL) があります。サブスクリプションのセットアップ方法に応じて、以下のいずれかの URL を使用して統合開発環境にアクセスします。

https://hostname.automationcloud.ibm.com/dba/environment/content-services-graphql/

https://fncm-environment-hostname.automationcloud.ibm.com/content-services-graphql/

必ず、URL の末尾に「/」を組み込んでください。

注: 統合開発環境は、実稼働環境では使用できません。

GraphQL API を使用するすべてのアプリケーションは、ヘッダーと Cookie で ECM-CS-XSRF-Token トークンを渡す必要があります。 GraphQL クライアントがトークンを生成し、それをクライアント・ブラウザーで Cookie として設定し、同じ値をユーザー・セッションに保存することをお勧めします。クライアント要求がくると、GraphQL クライアントは保存された値と照会し ECM-CS-XSRF-Token Cookie を検証します。要求が Content Services GraphQL に渡されるとき、これらの値はヘッダー ECM-CS-XSRF-Token と Cookie EM-CS-XSRF-Token にあります。

API への接続のテスト

API の GraphQL インスタンスにアクセスした後、以下の例に示すように、 Content Platform Engine への接続をテストできます。

{
  _apiInfo(repositoryIdentifier: "OS1") {
    buildDate
    buildNumber
    implementationVersion
    implementationTitle
    productVersion
    cpeInfo {
      cpeURL
      cpeUser
      repositoryName
    }
  }
}

repositoryIdentifier の値は、 Content Platform Engine オブジェクト・ストア名 (シンボル名) または ID (GUID) です。

接続が成功すると、以下の例のような応答が返されます。

{
 "data": {
  "_apiInfo": {
  "buildDate": "February 28, 2020 at 09:20",
  "buildNumber": "29",
  "implementationVersion": "20200228-0920-29-pwtest330",
  "implementationTitle": "IBM FileNet Content Services GraphQL API - content-graphql-api",
  "productVersion": "5.5.4",
  "cpeInfo": {
   "cpeURL": "http://cpe_host:port/wsi/FNCEWS40MTOM/",
   "cpeUser": "uid=admin@ibm.com,cn=users,O=IBM,C=US",
   "repositoryName": "OS1"
   }
  }
 }
}

API の開発者ガイドが使用可能です。詳細については、 Content Services GraphQL のAPI開発者ガイドを参照してください。 IBM® FileNet® P8 Platform ドキュメントを参照してください。

Webhook の使用

Content Services GraphQL API では、Webhook がサポートされます。 Webhook は、HTTP POST 要求を使用して行われるユーザー定義の HTTP コールバックです。 Content Platform Engineが、他の関心のあるアプリケーションやサービスにほぼリアルタイムの情報を提供する方法を提供します。

コールバックは、文書をリポジトリーにチェックインしたり、 Content Platform Engine オブジェクトのプロパティーを更新したりするなど、 Content Platform Engineのイベントによってトリガーできます。 Content Engine は、Webhook 用に構成されている URL に HTTP POST 要求を行います。

イベントウェブフックの詳細については、 Content Platform Engine のイベントウェブフックとコンテンツイベントウェブフックの例をご覧ください。