機械翻訳について
  1. Redwoodユーザー・エクスペリエンスによるナレッジ管理のREST API
  2. タスク
  3. 検索

サービス・リクエスト別にナレッジ記事を取得

post

/search

このメソッドは、Oracle Knowledgeリポジトリからナレッジ記事のリストを返します。

リクエスト

この操作にはリクエスト・パラメータがありません。

サポートされるメディア・タイプ
リクエスト本文 - application/json ()
ルート・スキーマ : スキーマ
タイプ: object
ペイロードBOの検索
ソースを表示
ネストされたスキーマ : serviceRequest
すべて一致
ソースを表示
ネストされたスキーマ : ServiceRequestBO
タイプ: object
サービス・リクエストBO
ソースを表示
ネストされたスキーマ : サービス・リクエスト・カスタム項目
タイプ: array
タイトル: Service Request Custom Fields

サービス・リクエスト・カスタム・フィールド。

ソースを表示
例

トップに戻る

レスポンス

サポートされるメディア・タイプ

200 レスポンス

OK
本文( )
ルート・スキーマ : SearchResultList
タイプ: object
ソースを表示
  • Facets
    タイトル: Facets
    使用可能なその他のプロパティ: SearchFacetBO
    名前別のSearchFacetBOリストのマップ。
  • タイトル: Has More
    デフォルト値: false
    コレクションにこのリクエストで返されたより多くのアイテムが含まれているかどうかを示すブール。 デフォルトはfalseです。
  • Items
    タイトル: Items
    基準を満たすリクエストされたリソースのコレクション。
  • タイトル: Limit
    この結果が制限されるアイテムの数。 ページ区切りのオフセットとともに使用されます。
  • Links
  • タイトル: Offset
    この結果セットが開始するアイテム・インデックス。 ページ区切り制限と組み合せて使用されます。
  • タイトル: Search Transaction ID
    各リクエストの一意の検索トランザクションID。
  • タイトル: Total Results
    使用された条件を満たす使用可能なアイテムの数。 この属性は、totalResults=trueを問合せ文字列に追加して明示的にリクエストする必要があります。
ネストされたスキーマ : ファセット
タイプ: object
タイトル: Facets
追加プロパティの許可
ソースを表示
名前別のSearchFacetBOリストのマップ。
ソースを表示
  • タイトル: Facet
    キーは、製品またはカテゴリまたは任意の文字列です
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
基準を満たすリクエストされたリソースのコレクション。
ソースを表示
ネストされたスキーマ : SearchFacetBO
タイプ: object
ソースを表示
ネストされたスキーマ : 組織ID
タイプ: object
タイトル: Organization Id
製品の組織ID。
ネストされたスキーマ : カテゴリ階層
タイプ: object
タイトル: Category Hierarchy
>のデリミタを含むカテゴリ階層
ネストされたスキーマ : SearchResultItem
タイプ: object
BOモードのドキュメント: SearchResultItemBO
ソースを表示
  • タイトル: Answer ID
    読取り専用: true
    ロケール内の記事の一意の識別子。
  • articleStatus
  • タイトル: Auto Check In
    読取り専用: true
    デフォルト値: false
    保存後に記事を自動的にチェックインする必要があるかどうかを示します。
  • basedLocale
  • Categories
    タイトル: Categories
    記事に関連付けられたカテゴリのリスト。
  • タイトル: Checked Out
    読取り専用: true
    デフォルト値: false
    作成者がドキュメントを編集のためにチェックアウトまたはロックした日時。
  • checkedOutBy
  • contentType
  • タイトル: Create Date
    読取り専用: true
    この記事が最初に作成された日時。
  • 創造者
  • タイトル: Date Added
    読取り専用: true
    この記事バージョンが作成された日時。
  • タイトル: Date Modified
    読取り専用: true
    この記事が最後に変更された日時。
  • タイトル: Display End Date
    記事がエンド・ユーザーに表示されないようにする日時。
  • タイトル: Display Review Date
    レビューを実行できる作者によるレビューが記事に必要な日時。
  • タイトル: Display Start Date
    記事がエンド・ユーザーに表示されるようになる日時。
  • タイトル: Document ID
    読取り専用: true
    人間に最も使用可能な記事の一意の識別子。
  • タイトル: Answer Excerpt
    ユーザーの問合せに一致する回答からのスニペット
  • Highlighting
    タイトル: Highlighting
    追加プロパティの許可: additionalProperties
    記事の内容の抜粋。
  • タイトル: Last Modified Date
    読取り専用: true
    この記事が最後に変更された日時。
  • lastModifier
  • Links
  • ロケール
  • 持ち主
  • タイトル: Pending
    読取り専用: true
    デフォルト値: false
    この記事バージョンが将来稼働するようにスケジュールされているかどうかを示します。 ほとんどの記事バージョンでは、値はfalseです。
  • Products
    タイトル: Products
    記事に関連付けられた製品のリスト。
  • タイトル: Publish Date
    読取り専用: true
    この記事バージョンが公開された日時。
  • タイトル: Published
    読取り専用: true
    デフォルト値: false
    この記事バージョンが公開されているかどうかを示します。 公開済バージョン以外のすべてのバージョンがある場合、デフォルト値はfalseです。
  • タイトル: Published Version
    読取り専用: true
    最大長: 50
    この記事にリクエストされたロケールで公開済バージョンがある場合、このフィールドには公開済記事バージョンのバージョン番号が含まれます。
  • タイトル: Rank Position
    クリックスルのためのランキング位置
  • タイトル: Record ID
    読取り専用: true
    記事の一意の識別子。 このIDは、記事のすべてのロケールのすべてのバージョンで同じであり、プログラムで使用することをお薦めします。
  • タイトル: Score
    スコアは、結果の記事をソートするために使用されます。 記事のスコアが高いほど、記事の関連性が高くなります。
  • タイトル: Source Type
    ソース・タイプは文書タイプの識別に使用されます。
  • タイトル: Title
    読取り専用: true
    最大長: 4000
    ドキュメントのタイトル。
  • User Groups
    タイトル: User Groups
    コンテンツに割り当てられたユーザー・グループ。 割り当てられたユーザー・グループのメンバーのみがコンテンツにアクセスできます。 デフォルト値は全員です。
  • タイトル: Version
    読取り専用: true
    最大長: 50
    記事のバージョン。
  • タイトル: Version ID
    読取り専用: true
    最大長: 64
    特定のロケールの記事の特定のバージョンの一意の識別子。 このフィールドは、q問合せパラメータを使用して作成された問合せでは使用できません。
  • タイトル: Version State
    読取り専用: true
    バージョンの状態。指定可能な値は、SCHEDULED、LIVE、EXPIRED、DRAFTです。
  • Views
    タイトル: Views
    読取り専用: true
    コンテンツに割り当てられたビュー。 コンテンツにビューが割り当てられているユーザー、またはコンテンツが保存されているコンテンツ・タイプは、そのコンテンツにのみアクセスできます。
  • workflowStep
ネストされたスキーマ : articleStatus
すべて一致
ソースを表示
  • ArticleStatusKeyBO
    BOモードのドキュメント: ArticleStatusKeyBO
  • タイトル: Article Status

    記事ステータス。

      articleStatus.refKeyパラメータを渡すと、サービス・レスポンスは、リクエストで指定された記事ステータスのコンテンツ・オブジェクト(デフォルトでPUBLISHED)と一致します。

      articleStatusパラメータのURIの例を次に示します:

    • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT'

      • OR

    • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+in+('DRAFT', 'WORK_IN_PROGRESS')

      • 次のURIの例は、contentStateが最新であるコンテンツ・オブジェクトを返します:

    • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatus.referenceKey+eq+'DRAFT' and contentState eq 'LATEST'

      • 次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクトを返します:

    • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+eq+'IM_NULL_ARTICLE_STATUS'

      • 次のURIの例は、記事ステータスが割り当てられていないコンテンツ・オブジェクト、およびドラフト記事ステータスが割り当てられているコンテンツ・オブジェクトを返します:

    • http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=articleStatusRefKey+in+('IM_NULL_ARTICLE_STATUS', 'DRAFT')

      • 指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。


      指定したarticleStatus問合せに一致するコンテンツ・オブジェクトがない場合、レスポンスには、レコードなしで200 OKのステータスが含まれます。

ネストされたスキーマ : basedLocale
すべて一致
ソースを表示
  • LocaleKeyBO
    BOモードのドキュメント : LocaleKeyBO:

    ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

  • タイトル: Based Locale
    ドキュメントのローカライズされたバージョンの作成に使用されるソース・ロケール。 このフィールドは、コンテンツにローカライズされたバージョンがある場合にのみ表示されます。
ネストされたスキーマ : カテゴリ
タイプ: array
タイトル: Categories
記事に関連付けられたカテゴリのリスト。
ソースを表示
ネストされたスキーマ : checkedOutBy
すべて一致
ソースを表示
  • UserKeyBO
    BOモードのドキュメント: UserKeyBO
  • タイトル: Checked Out By
    読取り専用: true

    最後のコンテンツ・チェックアウトを実行したユーザーまたは作成者。 次に、checkedOutBy問合せパラメータで使用できるサブフィールドを示します:

    • checkedOutBy.recordId : checkedOutByオブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
      http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=checkedOutBy.recordId eq '{id}'
    • checkedOutBy.email : User's email.
    • checkedOutBy.firstName : ユーザーの名。
    • checkedOutBy.lastName : ユーザーの姓。
    • checkedOutBy.login : User's login.
ネストされたスキーマ : contentType
すべて一致
ソースを表示
  • ContentTypeKeyBO
    BOモードのドキュメント: ContentTypeKeyBO
  • タイトル: Content Type

    コンテンツの分類および保存先となるチャネル。 次に、contentType問合せパラメータで使用できるサブフィールドを示します:

    • contentType.recordId : ContentTypeオブジェクトの一意の識別子。
    • contentType.referenceKey : ContentTypeオブジェクトの参照キー。 ContentTypeオブジェクトは、複数の言語をサポートしています。 このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。 コンテンツ・タイプのFAQの記事をリクエストする例については、URIを使用してコールを送信します:
      http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=contentType.referenceKey eq 'FAQ'
    • contentType.allowRecommendations : このフラグは、エンド・ユーザーがコンテンツに対して推奨を作成できるコンテンツ・タイプを示します。 また、推奨コンテンツをコンテンツ・タイプに関連付けることができるかどうかも示します。
ネストされたスキーマ : 創造者
すべて一致
ソースを表示
  • UserKeyBO
    BOモードのドキュメント: UserKeyBO
  • タイトル: Creator
    読取り専用: true

    最初にドキュメントを作成または作成したユーザー。 作成者問合せパラメータで使用できるサブフィールドは次のとおりです:

    • creator.recordId : 作成者オブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
      http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=creator.recordId eq '{id}'
    • creator.email : User's email.
    • creator.firstName : ユーザーの名。
    • creator.lastName : ユーザーの姓。
    • creator.login : User's login.
ネストされたスキーマ : 強調表示
タイプ: object
タイトル: Highlighting
追加プロパティの許可
ソースを表示
記事の内容の抜粋。
ネストされたスキーマ : lastModifier
すべて一致
ソースを表示
  • UserKeyBO
    BOモードのドキュメント: UserKeyBO
  • タイトル: Last Modifier
    読取り専用: true

    最後のコンテンツ変更を実行したユーザーまたは作成者。 次に、lastModifier問合せパラメータで使用できるサブフィールドを示します:

    • lastModifier.recordId : lastModifierオブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
      http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=lastModifier.recordId eq '{id}'
    • lastModifier.email : User's email.
    • lastModifier.firstName : ユーザーの名。
    • lastModifier.lastName : ユーザーの姓。
    • lastModifier.login : User's login.
ネストされたスキーマ : ロケール
すべて一致
ソースを表示
  • LocaleKeyBO
    BOモードのドキュメント : LocaleKeyBO:

    ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

  • タイトル: Locale

    ドキュメントのバージョンのロケール。 ロケール・コードは、Localeオブジェクトに関連付けられた言語と国を表します。 次のサブフィールドをロケール問合せパラメータで使用できます:

    • locale.recordId : ロケール・オブジェクトの一意の識別子。 たとえば、Spanish-Spainロケールで記事をリクエストするには、URIを使用してコールを送信します:
      http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=locale.recordId eq 'es_ES'
ネストされたスキーマ : 持ち主
すべて一致
ソースを表示
  • UserKeyBO
    BOモードのドキュメント: UserKeyBO
  • タイトル: Owner
    読取り専用: true

    ドキュメントを所有または担当するユーザーまたは作成者。 次に、オーナー問合せパラメータで使用できるサブフィールドを示します:

    • owner.recordId : 所有者オブジェクトの一意の識別子。 たとえば、一意のIDを持つ記事をリクエストするには、URIを使用してコールを発行します:
      http://${pageContext.request.serverName}:${pageContext.request.serverPort}${pageContext.request.contextPath}/api/content?q=owner.recordId eq '{id}'
    • owner.email : ユーザーのeメール。
    • owner.firstName : ユーザーの名。
    • owner.lastName : ユーザーの姓。
    • owner.login : User's login.
ネストされたスキーマ : 製品
タイプ: array
タイトル: Products
記事に関連付けられた製品のリスト。
ソースを表示
ネストされたスキーマ : ユーザー・グループ
タイプ: array
タイトル: User Groups
コンテンツに割り当てられたユーザー・グループ。 割り当てられたユーザー・グループのメンバーのみがコンテンツにアクセスできます。 デフォルト値は全員です。
ソースを表示
ネストされたスキーマ : ビュー
タイプ: array
タイトル: Views
読取り専用: true
コンテンツに割り当てられたビュー。 コンテンツにビューが割り当てられているユーザー、またはコンテンツが保存されているコンテンツ・タイプは、そのコンテンツにのみアクセスできます。
ソースを表示
ネストされたスキーマ : workflowStep
すべて一致
ソースを表示
  • WorkflowStepDataBO
    BOモードのドキュメント: WorkflowStepDataBO
  • タイトル: Workflow Step
    読取り専用: true
    ドキュメント・バージョンが現在存在しているワークフローのステップ。
ネストされたスキーマ : ArticleStatusKeyBO
タイプ: object
BOモードのドキュメント: ArticleStatusKeyBO
ソースを表示
  • Links
  • タイトル: Name
    読取り専用: true
    最小長: 1
    最大長: 255
    ArticleStatusオブジェクトのローカライズされた名前。 名前フィールドはソートにのみ使用できます。
  • タイトル: Record Id
    ArticleStatusオブジェクトの一意の識別子。
  • タイトル: Reference Key
    最大長: 255
    ArticleStatusオブジェクトの参照キー。 ArticleStatusオブジェクトは、複数の言語をサポートしています。 このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。
ネストされたスキーマ : LocaleKeyBO
タイプ: object
BOモードのドキュメント : LocaleKeyBO:

ロケールのローカライズされた名前は現在提供されていません(つまり、日本語は常に日本語であり、アラビア語でローカライズされることはありません)

ソースを表示
  • Links
  • タイトル: Locale Desc
    読取り専用: true
    最大長: 100
    Localeオブジェクトが表す言語と国に関する説明。
  • タイトル: Record Id
    ロケール・オブジェクトの一意の識別子。
ネストされたスキーマ : カタログ
タイプ: object
BOモードのドキュメント: CategoryBO
ソースを表示
ネストされたスキーマ : UserKeyBO
タイプ: object
BOモードのドキュメント: UserKeyBO
ソースを表示
  • タイトル: Can Assign tasks
    このユーザーがタスクを他のユーザーに割り当てることができるかどうかを返します。
  • Content Type Privileges
    タイトル: Content Type Privileges
    このフィールドは、ユーザーが所有するすべてのcontenttype権限のリストを返します
  • タイトル: Email
    最大長: 100
    ユーザーの電子メール・アドレス
  • タイトル: External Id
    読取り専用: true
    ExternalIdは、外部システムからの対応するユーザーのIDです。 ExternalTypeとともに、このシステムからのユーザーと外部システムのユーザーとの間のギャップを埋めるために使用できます。
  • Functional Privileges of user
    タイトル: Functional Privileges of user
    追加プロパティの許可: additionalProperties
    このフィールドは、ユーザーが所有するすべての権限のリストを返します
  • Links
  • タイトル: Login
    最大長: 100
    ユーザーのログイン
  • タイトル: Name
    読取り専用: true
    最大長: 100
    ユーザーのフルネーム
  • タイトル: Record Id
    読取り専用: true
    ユーザーの一意の識別子
ネストされたスキーマ : コンテンツ・タイプ権限
タイプ: array
タイトル: Content Type Privileges
このフィールドは、ユーザーが所有するすべてのcontenttype権限のリストを返します
ソースを表示
ネストされたスキーマ : ユーザーの機能権限
タイプ: object
タイトル: Functional Privileges of user
追加プロパティの許可
ソースを表示
このフィールドは、ユーザーが所有するすべての権限のリストを返します
ネストされたスキーマ : CompositeContentTypeBO
タイプ: object
ContentTypeBOおよびそのフラット化されたリレーションの複合。 行にさらに内容を追加できることに注意してください
ソースを表示
ネストされたスキーマ : WorkflowStepsコンポジットBO
タイプ: array
タイトル: WorkflowSteps Composite BO
このコンテンツ・タイプにマップされたWorkflowStepsおよびそのコンテンツに対するユーザー権限
ソースを表示
ネストされたスキーマ : contentTypeKeyBO
すべて一致
ソースを表示
ネストされたスキーマ : 権限のリスト
タイプ: array
タイトル: List Of Privilege
ContentTypeの権限のリスト
ソースを表示
ネストされたスキーマ : CompositeWorkflowStepBO
タイプ: object
このステップに対するユーザー権限を持つWorkflowStepBOのコンポジット。
ソースを表示
ネストされたスキーマ : 権限のリスト
タイプ: array
タイトル: List Of Privilege
WorkflowStepの権限のリスト
ソースを表示
ネストされたスキーマ : WorkflowStepKeyBO
すべて一致
ソースを表示
ネストされたスキーマ : WorkflowStepKeyBO
タイプ: object
BOモードのドキュメント: WorkflowStepKeyBO
ソースを表示
  • Links
  • タイトル: Name
    最大長: 255
    ワークフロー・ステップのローカライズされた名前
  • タイトル: Record Id
    読取り専用: true
    WORKFLOWSTEP表からのGUID
  • タイトル: Reference Key
    最小長: 1
    最大長: 100
    ワークフロー・ステップのローカライズされていない名前
  • タイトル: WorkflowRecord Id
    読取り専用: true
    WORKFLOW表からのGUID
ネストされたスキーマ : ContentTypeKeyBO
タイプ: object
BOモードのドキュメント: ContentTypeKeyBO
ソースを表示
  • タイトル: Description
    最大長: 255
    ContentTypeオブジェクトの説明。 コンテンツ・タイプは複数の言語をサポートしています。 このフィールドは、ユーザーが指定した言語に関連付けられているオブジェクトを識別します。
  • Links
  • タイトル: Name
    最小長: 1
    最大長: 255
    ContentTypeオブジェクトの名前。 名前フィールドはソートにのみ使用できます。 コンテンツ・タイプは複数の言語をサポートしています。 このフィールドは、ユーザーが指定した言語に関連付けられているオブジェクトを識別します。
  • タイトル: Record Id
    読取り専用: true
    ContentTypeオブジェクトの一意の識別子。
  • タイトル: Reference Key
    最小長: 1
    最大長: 255
    ContentTypeオブジェクトの参照キー。 ContentTypeオブジェクトは、複数の言語をサポートしています。 このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。
  • タイトル: Stripe Cd
    最大長: 30
    ストライプ・コードを示す参照コード。
  • タイトル: Usage Code
    読取り専用: true
    最大長: 30
    製品使用コードを示す参照コードです。
  • ワークフロー
ネストされたスキーマ : ワークフロー
すべて一致
ソースを表示
  • WorkflowKeyBO
  • タイトル: Workflow
    コンテンツ・タイプでのコンテンツ・オーサリング中に作成者が使用できるワークフロー定義。
ネストされたスキーマ : WorkflowKeyBO
タイプ: object
ソースを表示
ネストされたスキーマ : additionalProperties
タイプ: array
ソースを表示
ネストされたスキーマ : CatalogProduct
タイプ: object
BOモードのドキュメント: CatalogProductBO
ソースを表示
ネストされたスキーマ : UserGroupKeyBO
タイプ: object
BOモードのドキュメント: UserGroupKeyBO
ソースを表示
  • Links
  • タイトル: Name
    読取り専用: true
    最大長: 255
    ユーザー・グループのローカライズされた名前。 名前フィールドはソートにのみ使用できます。
  • タイトル: Record Id
    userGroupsリソースを表すTAG表の一意の識別子
  • タイトル: Reference Key
    最大長: 255
    ユーザー・グループのローカライズされていない名前
  • タイトル: Stripe CD
    読取り専用: true
    最大長: 30
    UserGroupのストライプ
ネストされたスキーマ : ViewKeyBO
タイプ: object
BOモードのドキュメント: ViewKeyBO
ソースを表示
  • Links
  • タイトル: Name
    最大長: 255
    ビューのローカライズ名
  • タイトル: Record Id
    読取り専用: true
    ビュー定義を含むSITE表のGUID
  • タイトル: Reference Key
    最小長: 1
    最大長: 255
    ビューのローカライズされていない参照キー
  • タイトル: Stripe CD
    最大長: 30
    ビューのストライプ
ネストされたスキーマ : WorkflowStepDataBO
タイプ: object
BOモードのドキュメント: WorkflowStepDataBO
ソースを表示
「トップに戻る」