機械翻訳について
  1. Oracle Fusionサービスでのナレッジ管理のREST API
  2. タスク
  3. コンテンツ(IM)
  4. コンテンツ・タイプ

コンテンツ・タイプの取得

get

/km/api/v1/contentTypes/{id}

このメソッドは、指定されたIDパラメータを持つContentTypeオブジェクトを返します。

URIの例

このメソッドのURIの例を次に示します:

  • http://<IM_REST_API_HOST>/km/api/latest/contentTypes/{id}

    リクエストは、指定したIDパラメータをFULLモードで持つContentTypeオブジェクトを返します。

  • http://<IM_REST_API_HOST>/km/api/contentTypes/{id}?mode=KEY

    このリクエストは、KEYモードで指定したIDパラメータを持つContentTypeオブジェクトを返します。

  • http://<IM_REST_API_HOST>/km/api/contentTypes/{id}?mode=DATA

    リクエストは、DATAモードで指定したIDパラメータを持つContentTypeオブジェクトを返します。

  • http://<IM_REST_API_HOST>/km/api/contentTypes/{id}?mode=EXTENDED

    このリクエストは、EXTENDEDモードで指定したIDパラメータを持つContentTypeオブジェクトを返します。

レスポンス・エラー

  • OKDOM-GEN0001

    このエラーは、無効なIDが指定されている場合に発生します。

リクエスト

パス・パラメータ
  • 取得するオブジェクトの一意の識別子。
トップに戻る

レスポンス

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

200 レスポンス

「OK」をクリックします。
本文( )
ルート・スキーマ : ContentType
タイプ: object
タイトル: ContentType
ソースを表示
ネストされたスキーマ : カテゴリ
タイプ: array

コンテンツ・タイプで構成されたカテゴリ・オブジェクトのリストで、コンテンツ作成者がコンテンツに割り当てることができます。 カテゴリ・オブジェクトは、検索性を向上させるためにコンテンツにタグ付けまたはラベルを付けるために使用されます。

ソースを表示
ネストされたスキーマ : スキーマ
タイプ: object
タイトル: Schema
ソースを表示
ネストされたスキーマ : customMetrics
タイプ: array

コンテンツ・タイプのコンテンツに対するアクティビティの追跡に使用される測定単位。

ソースを表示
ネストされたスキーマ : localizedAttributes
タイプ: array
様々なロケールでのこのContentType名のLocalizedAttributesおよび説明のリスト
ソースを表示
ネストされたスキーマ : RatingKey
タイプ: object
タイトル: RatingKey
ソースを表示
ネストされたスキーマ : requiredCategories
タイプ: array

コンテンツ・タイプのすべてのコンテンツに必要なカテゴリ・オブジェクト。 コンテンツ作成者は、コンテンツ作成中にこれらのカテゴリをコンテンツに割り当てる必要があります。 作成者は、カテゴリを割り当てない場合、コンテンツを保存できません。

ソースを表示
ネストされたスキーマ : translationRequestLocales
タイプ: array

コンテンツ・タイプで自動翻訳リクエストが有効になっているロケール・オブジェクトのリスト。 コンテンツ・タイプは、コンテンツを公開する準備ができるたびに、特定の言語セットのコンテンツ翻訳者に翻訳リクエストを送信します。

ソースを表示
ネストされたスキーマ : userGroups
タイプ: array

コンテンツ・タイプに関連付けられたUserGroupオブジェクト。 コンテンツ作成者は、特定のレベルのアクセス権を持つユーザーがコンテンツにアクセスできるように、ユーザー・グループをコンテンツに割り当てます。

ソースを表示
ネストされたスキーマ : WorkflowKey
タイプ: object
タイトル: WorkflowKey
ソースを表示
ネストされたスキーマ : CategoryKey
タイプ: object
タイトル: CategoryKey
ソースを表示

  • このフィールドには、カテゴリの直下の子の数が返されます。

    このフィールドは、childrenCount問合せパラメータが値trueで渡された場合にのみ移入されます。

    このパラメータのURIの例は次のとおりです:

    • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?childrenCount=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY
  • カテゴリ・オブジェクトの説明

  • リポジトリ・データを外部システムと統合する際に使用される一意の識別子。

  • リポジトリ・データを外部システムと統合する際に使用されるカテゴリのタイプ。 有効なオプションは、PRODUCTおよびCATEGORYです。

  • 特定の製品の在庫組織ID。

  • links

  • カテゴリの名前。

  • カテゴリの階層位置
  • parents

    このフィールドは、カテゴリのすべての親を返します。

    このフィールドは、withParents問合せパラメータが値trueで渡された場合にのみ移入されます。

    このパラメータのURIの例は次のとおりです:

    • http://<IM_REST_API_HOST>/km/api/categories/{id}?withParents=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?withParents=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY
    • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY

  • カテゴリ・オブジェクトの一意のレコードID。

  • カテゴリ・オブジェクトの参照キー。 カテゴリ・オブジェクトは複数の言語をサポートしています。 このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。

  • これは、翻訳された名前が見つからない場合に名前がデフォルト・ロケールに変換される場合に移入されるカスタム・フィールドです。

ネストされたスキーマ : 両親
タイプ: array

このフィールドは、カテゴリのすべての親を返します。

このフィールドは、withParents問合せパラメータが値trueで渡された場合にのみ移入されます。

このパラメータのURIの例は次のとおりです:

  • http://<IM_REST_API_HOST>/km/api/categories/{id}?withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY
  • http://<IM_REST_API_HOST>/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY
ソースを表示
ネストされたスキーマ : schemaAttributes
タイプ: array
スキーマのスキーマ属性のリスト
ソースを表示
ネストされたスキーマ : SchemaAttribute
タイプ: object
タイトル: SchemaAttribute
ソースを表示
ネストされたスキーマ : 子供
タイプ: array
現在の要素の子ノードのリスト
ソースを表示
ネストされたスキーマ : localizedAttributes
タイプ: array
様々なロケールでのこのSchemaAttribute名のLocalizedAttributesおよび説明のリスト
ソースを表示
ネストされたスキーマ : schemaAttributeUserGroupList
タイプ: array
この属性を保護するために使用できるユーザー・グループのリスト。 これは、ContentTypeに割り当てられたユーザー・グループのリストのサブセットである必要があります
ソースを表示
ネストされたスキーマ : LocalizedAttributes
タイプ: object
タイトル: LocalizedAttributes
ソースを表示
ネストされたスキーマ : SchemaAttributeUserGroup
タイプ: object
タイトル: SchemaAttributeUserGroup
ソースを表示
ネストされたスキーマ : UserGroupKey
タイプ: object
タイトル: UserGroupKey
ソースを表示
ネストされたスキーマ : CustomMetricKey
タイプ: object
タイトル: CustomMetricKey
ソースを表示
  • CustomMetricオブジェクトの名前
  • CustomMetricオブジェクトの一意のレコードID。
  • CustomMetricオブジェクトの参照キー。 CustomMetricオブジェクトは、複数の言語をサポートしています。 このフィールドを使用して、すべての言語の関連オブジェクトを識別できます。
ネストされたスキーマ : LocaleKey
タイプ: object
タイトル: LocaleKey
ソースを表示
トップに戻る

例

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、指定されたIDを持つコンテンツ・タイプ・オブジェクトを検索する方法を示しています。

curl -X GET "https://<IM_REST_API_HOST>/km/api/latest/contentTypes/{id}" -u "<username:password>" -H "Accept: application/json" -H "Content-Type: application/json"

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています:

{
  "userGroups": [
    {
      "recordId": "BDEE31CAA50A4DA7B9789240028BA4E3",
      "referenceKey": "INTERNAL",
      "name": "Internal",
      "links": [
        {
          "rel": "canonical",
          "href": "http://IM_REST_API_HOST/km/api/latest/userGroups/BDEE31CAA50A4DA7B9789240028BA4E3",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        }
      ]
    }
  ],
  "customMetrics": [],
  "requiredCategories": [],
  "categories": [
    {
      "recordId": "0009447D77914B088D3DE12B76065E1B",
      "referenceKey": "FUSION_CATEGORY_300100103980692",
      "objectId": "1000",
      "name": "Category person : 1491880448742",
      "externalId": 300100103980692,
      "externalType": "CATEGORY",
      "description": "119202",
      "links": [
        {
          "rel": "canonical",
          "href": "http://IM_REST_API_HOST/km/api/latest/categories/0009447D77914B088D3DE12B76065E1B",
          "mediaType": "application/json, application/xml",
          "method": "GET"
        }
      ]
    },
  ],
  "translationRequestLocales": [],
  "recordId": "C6FAA0D5AFF442C2BED0EED8D8EDD9C0",
  "referenceKey": "SOLUTION",
  "name": "Solution",
  "links": [
    {
      "rel": "canonical",
      "href": "http://IM_REST_API_HOST/km/api/latest/contentTypes/C6FAA0D5AFF442C2BED0EED8D8EDD9C0",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    },
    {
      "rel": "collection",
      "href": "http://IM_REST_API_HOST/km/api/latest/contentTypes",
      "mediaType": "application/json, application/xml",
      "method": "GET",
      "profile": "http://IM_REST_API_HOST/km/api/latest/metadata-catalog/contentTypes"
    }
  ],
  "allowCheckOut": false,
  "allowRecommendations": false,
  "counterPrefix": "SOL",
  "dateAdded": "2017-03-24T23:53:57-0600",
  "dateModified": "2017-04-26T02:04:50-0600",
  "defaultLifespan": -1,
  "enableUserActivityLogging": false,
  "hasPriority": false,
  "hasRelatedContent": false,
  "hasTalkBack": false,
  "isEvent": false,
  "isModerated": false,
  "requireAtLeastOneProduct": false,
  "requireAtLeastOneCategory": false,
  "requireAtLeastOneUserGroup": false,
  "restrictToOneUserGroupSelection": false,
  "categoriesRequireWorkflowApproval": true,
  "userGroupRequireWorkflowApproval": true,
  "viewsRequireWorkflowApproval": true,
  "displayDatesRequireWorkflowApproval": true,
  "eventDatesRequireWorkflowApproval": true,
  "restrictAuthoringToWorkflowUser": true,
  "notifyOnWorkflowApproval": false,
  "notifyOnWorkflowRejection": false,
  "notifyGroupOnWorkflowRejection": false,
  "removeVersions": false,
  "reviewDate": -1,
  "validateHtml": false,
  "enableIndexing": true,
  "indexStatus": "LIVE",
  "rating": {
    "recordId": "72131BCD2DC94A7DAA3133D5A5E59250",
    "referenceKey": "5_STAR_RATING",
    "name": "5 Star Rating",
    "links": [
      {
        "rel": "canonical",
        "href": "http://IM_REST_API_HOST/km/api/latest/dataForms/72131BCD2DC94A7DAA3133D5A5E59250",
        "mediaType": "application/json, application/xml",
        "method": "GET"
      }
    ]
  },
  "contentSchema": {
    "schemaAttributes": [
      {
        "children": [],
        "schemaAttributeUserGroupList": [],
        "recordId": "34C25D6B395B474DAD1DCE4CFFDC467A",
        "xpath": "//SOLUTION/RESOLUTION",
        "name": "Resolution",
        "links": [
          {
            "rel": "canonical",
            "href": "http://IM_REST_API_HOST/km/api/latest/contentTypes/C6FAA0D5AFF442C2BED0EED8D8EDD9C0/contentSchema/34C25D6B395B474DAD1DCE4CFFDC467A",
            "mediaType": "application/json, application/xml",
            "method": "GET"
          }
        ],
        "requireWorkflowApproval": false,
        "allowPreselectedUserGroupChange": true,
        "counter": 0,
        "dateAdded": "2017-03-24T23:53:57-0600",
        "dateModified": "2017-03-24T23:53:57-0600",
        "enableFullTextSearch": true,
        "includeInMasterIdentifier": false,
        "isNode": false,
        "allowMultipleNodes": false,
        "isRequired": false,
        "readOnly": false,
        "enableAttributeLevelSearch": false,
        "schemaAttrType": "WYSIWYG_EDIT",
        "secureWithUserGroups": false,
        "securedFileResource": false,
        "userGroupSelectionRequired": false,
        "sortOrder": 3,
        "referenceKey": "RESOLUTION",
        "wysiwygType": "FULL"
      },
      {
        "children": [],
        "schemaAttributeUserGroupList": [],
        "recordId": "0E1621B868804CC5899C36A1C426B400",
        "xpath": "//SOLUTION/ENVIRONMENT",
        "name": "Environment",
        "links": [
          {
            "rel": "canonical",
            "href": "http://IM_REST_API_HOST/km/api/latest/contentTypes/C6FAA0D5AFF442C2BED0EED8D8EDD9C0/contentSchema/0E1621B868804CC5899C36A1C426B400",
            "mediaType": "application/json, application/xml",
            "method": "GET"
          }
        ],
        "requireWorkflowApproval": false,
        "allowPreselectedUserGroupChange": true,
        "counter": 0,
        "dateAdded": "2017-03-24T23:53:57-0600",
        "dateModified": "2017-03-24T23:53:57-0600",
        "enableFullTextSearch": true,
        "includeInMasterIdentifier": false,
        "isNode": false,
        "allowMultipleNodes": false,
        "isRequired": false,
        "readOnly": false,
        "enableAttributeLevelSearch": false,
        "schemaAttrType": "WYSIWYG_EDIT",
        "secureWithUserGroups": false,
        "securedFileResource": false,
        "userGroupSelectionRequired": false,
        "sortOrder": 4,
        "referenceKey": "ENVIRONMENT",
        "wysiwygType": "FULL"
      },
    ],
    "recordId": "BC4E496996A141048893C5F13BFAFF77",
    "dateAdded": "2017-03-24T23:53:57-0600",
    "dateModified": "2017-03-24T23:53:57-0600"
  }
}
「トップに戻る」