機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

ビューの取得

get

/km/api/v1/views/{id}

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

リクエスト

パス・パラメータ

• id: string
  取得するオブジェクトの一意の識別子。

トップに戻る

レスポンス

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

• application/json
• application/xml

200 レスポンス

「OK」をクリックします。

本文( )

ルート・スキーマ : 表示

タイプ: object

タイトル: View

ソースを表示

• categories(optional): array categories
  ビューに割り当てられたカテゴリのリスト
• dateAdded(optional): string(date-time)
  ビューが作成されたときのタイムスタンプ
• dateModified(optional): string(date-time)
  ビューの最終変更時のタイムスタンプ
• extendedProperties(optional): string
  ビューの拡張プロパティを含むXML形式の文字列。 これらは、RepositoryBOに定義されたviewSchemaに基づいている必要があります
• links(optional): array links
• localizedAttributes(optional): array localizedAttributes
  様々なロケールでのこのContentType名のLocalizedAttributesおよび説明のリスト
• name(optional): string
  ビューのローカライズ名
• objectId(optional): string
  ビューの階層を表す文字列
• parent(optional): object ViewKey
  タイトル: ViewKey
• recordId(optional): string
  ビュー定義を含むSITE表のGUID
• referenceKey(optional): string
  ビューのローカライズされていない参照キー
• stripeCD(optional): string

  ビューのストライプ

• userGroups(optional): array userGroups
  このビューに割り当てられたユーザー・グループのリスト

{
    "title":"View",
    "properties":{
        "recordId":{
            "description":"GUID of the SITE table containing the view definition",
            "type":"string"
        },
        "dateModified":{
            "description":"Timestamp when the view was last modified",
            "format":"date-time",
            "type":"string"
        },
        "parent":{
            "description":"Reference to the parent of the current view",
            "$ref":"#/definitions/ViewKey"
        },
        "dateAdded":{
            "description":"Timestamp when the view was created",
            "format":"date-time",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "stripeCD":{
            "description":"<p>Stripe of a view</p>",
            "type":"string"
        },
        "localizedAttributes":{
            "items":{
                "$ref":"#/definitions/LocalizedAttributes"
            },
            "description":"List of LocalizedAttributes of this ContentType name and description in various Locales",
            "type":"array"
        },
        "userGroups":{
            "items":{
                "$ref":"#/definitions/UserGroupKey"
            },
            "description":"List of user groups assigned to this view",
            "type":"array"
        },
        "objectId":{
            "description":"String representing the hierarchy of the view",
            "type":"string"
        },
        "referenceKey":{
            "description":"Non localized reference key for the view",
            "type":"string"
        },
        "name":{
            "description":"Localized name of the view",
            "type":"string"
        },
        "categories":{
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "description":"List of categories assigned to the view",
            "type":"array"
        },
        "extendedProperties":{
            "description":"XML formatted string containing the extended properties of the view. These need to be based on the viewSchema defined           for the RepositoryBO",
            "type":"string"
        }
    }
}

ネストされたスキーマ : カテゴリ

タイプ: array

ビューに割り当てられたカテゴリのリスト

ソースを表示

• Array of: object CategoryKey
  タイトル: CategoryKey

{
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "description":"List of categories assigned to the view",
    "type":"array"
}

ネストされたスキーマ : リンク

タイプ: array

ソースを表示

• Array of: object instanceLink
  JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

ネストされたスキーマ : localizedAttributes

タイプ: array

様々なロケールでのこのContentType名のLocalizedAttributesおよび説明のリスト

ソースを表示

• Array of: object LocalizedAttributes
  タイトル: LocalizedAttributes

{
    "items":{
        "$ref":"#/definitions/LocalizedAttributes"
    },
    "description":"List of LocalizedAttributes of this ContentType name and description in various Locales",
    "type":"array"
}

ネストされたスキーマ : ViewKey

タイプ: object

タイトル: ViewKey

ソースを表示

• links(optional): array links
• name(optional): string
  ビューのローカライズ名
• recordId(optional): string
  ビュー定義を含むSITE表のGUID
• referenceKey(optional): string
  ビューのローカライズされていない参照キー
• stripeCD(optional): string

  ビューのストライプ

{
    "title":"ViewKey",
    "properties":{
        "recordId":{
            "description":"GUID of the SITE table containing the view definition",
            "type":"string"
        },
        "referenceKey":{
            "description":"Non localized reference key for the view",
            "type":"string"
        },
        "name":{
            "description":"Localized name of the view",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "stripeCD":{
            "description":"<p>Stripe of a view</p>",
            "type":"string"
        }
    }
}

ネストされたスキーマ : userGroups

タイプ: array

このビューに割り当てられたユーザー・グループのリスト

ソースを表示

• Array of: object UserGroupKey
  タイトル: UserGroupKey

{
    "items":{
        "$ref":"#/definitions/UserGroupKey"
    },
    "description":"List of user groups assigned to this view",
    "type":"array"
}

ネストされたスキーマ : CategoryKey

タイプ: object

タイトル: CategoryKey

ソースを表示

• childrenCount(optional): integer

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

  このフィールドは、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
• description(optional): string
  カテゴリ・オブジェクトの説明
• externalId(optional): integer

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

• externalType(optional): string

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

• inventoryOrgId(optional): integer

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

• links(optional): array links
• name(optional): string

  カテゴリの名前。

• objectId(optional): string
  カテゴリの階層位置
• parents(optional): array 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
• recordId(optional): string

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

• referenceKey(optional): string

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

• responseLocale(optional): string

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

{
    "title":"CategoryKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique record ID of the Category object.</p>",
            "type":"string"
        },
        "responseLocale":{
            "description":"<p>This is a custom field that will get populated if a name is translated into the default locale when the translated name is not found.</p>",
            "type":"string"
        },
        "childrenCount":{
            "description":"<p>This field will return number of immediate children a category has.</p> <p>This field will only be populated if childrenCount query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?childrenCount=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&childrenCount=true&mode=KEY</li> </ul>",
            "type":"integer"
        },
        "externalType":{
            "description":"<p>The type of the category used while integrating the repository data with the external system. Valid options are PRODUCT and CATEGORY.</p>",
            "type":"string"
        },
        "parents":{
            "items":{
                "$ref":"#/definitions/CategoryKey"
            },
            "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>",
            "type":"array"
        },
        "referenceKey":{
            "description":"<p>The reference key for the Category object. Category objects support multiple languages. This field can be used to identify the associated objects for all languages.</p>",
            "type":"string"
        },
        "objectId":{
            "description":"The hierarchichal position of the category",
            "type":"string"
        },
        "description":{
            "description":"Description of the Category object",
            "type":"string"
        },
        "name":{
            "description":"<p>The name of the category.</p>",
            "type":"string"
        },
        "inventoryOrgId":{
            "description":"<p>The inventory organization id of the specific product.</p>",
            "type":"integer"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "externalId":{
            "description":"<p>The unique identifier used while integrating the repository data with the external system.</p>",
            "type":"integer"
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

ソースを表示

• Array of: object instanceLink
  JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

ネストされたスキーマ : 両親

タイプ: 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

ソースを表示

• Array of: object CategoryKey
  タイトル: CategoryKey

{
    "items":{
        "$ref":"#/definitions/CategoryKey"
    },
    "description":"<p>This field will return all parents of category.</p> <p>This field will only be populated if withParents query parameter is passed in with value true.</p> <p>Example URIs for the this parameter are as follows:</p> <ul> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories?q=contentTypeRefKey eq 'FAQ'&withParents=true&mode=KEY</li> <li>http://&lt;IM_REST_API_HOST&gt;/km/api/categories/{id}?childrenCount=true&withParents=true&mode=KEY</li> </ul>",
    "type":"array"
}

ネストされたスキーマ : instanceLink

タイプ: object

JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

ソースを表示

• href: string
  URI [RFC3986]またはURIテンプレート[RFC6570]。 値がURI Templateに設定されている場合、「templated」プロパティをtrueに設定する必要があります。
• mediaType(optional): string
  RFC 2046で定義された、リンク・ターゲットを説明するメディア・タイプ。
• method(optional): string
  リンクのターゲットをリクエストするためのHTTPメソッド。
• profile(optional): string
  ターゲット・リソースの参照解除時に予期されるリソースを記述する、JSONスキーマなどのリソースのメタデータへのリンク。
• rel: string
  リンクの詳細を取得するためにタイプ・プロパティに加えて使用できるリンク関係の名前。 たとえば、hrefやprofileです。
• templated(optional): boolean
  hrefプロパティがURIまたはURIテンプレートであることを指定するブール・フラグ。 プロパティがURIテンプレートの場合は、この値をtrueに設定します。 デフォルトでは、この値はfalseです。

{
    "description":"Metadata describing link description objects that MAY appear in the JSON instance representation.",
    "properties":{
        "templated":{
            "description":"Boolean flag that specifies that \"href\" property is a URI or URI Template. If the property is a URI template, set this value to true. By default, this value is false.",
            "type":"boolean"
        },
        "method":{
            "description":"HTTP method for requesting the target of the link.",
            "type":"string"
        },
        "rel":{
            "description":"Name of the link relation that, in addition to the type property, can be used to retrieve link details. For example, href or profile.",
            "type":"string"
        },
        "href":{
            "description":"URI [RFC3986] or URI Template [RFC6570]. If the value is set to URI Template, then the \"templated\" property must be set to true.",
            "type":"string"
        },
        "mediaType":{
            "description":"Media type, as defined by RFC 2046, describing the link target.",
            "type":"string"
        },
        "profile":{
            "description":"Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource..",
            "type":"string"
        }
    },
    "required":[
        "href",
        "rel"
    ],
    "type":"object"
}

ネストされたスキーマ : LocalizedAttributes

タイプ: object

タイトル: LocalizedAttributes

ソースを表示

• description(optional): string
  上のロケールでローカライズされた説明
• localeId(optional): string
  ロケールのRecordId - 通常、これはlocaleCode (en_USなど)であり、実際のGUIDではありません。
• name(optional): string
  上のロケールでローカライズされた名前

{
    "title":"LocalizedAttributes",
    "properties":{
        "localeId":{
            "description":"RecordId of the Locale - generally this is the localeCode (like en_US) and NOT a real GUID.",
            "type":"string"
        },
        "description":{
            "description":"Localized description in the above Locale",
            "type":"string"
        },
        "name":{
            "description":"Localized Name in the above Locale",
            "type":"string"
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

ソースを表示

• Array of: object instanceLink
  JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

ネストされたスキーマ : UserGroupKey

タイプ: object

タイトル: UserGroupKey

ソースを表示

• externalId(optional): integer

  外部システムからの対応するuserGroupの一意の識別子。 外部IDをExternalTypeパラメータとともに使用して、内部および外部システム内のユーザー・グループを接続できます。

• externalType(optional): string

  ExternalTypeは、外部システムからの対応するuserGroupのタイプです。

• links(optional): array links
• name(optional): string

  ユーザー・グループのローカライズされた名前。 名前フィールドはソートにのみ使用できます。

• recordId(optional): string

  userGroupsリソースを表すTAG表の一意の識別子

• referenceKey(optional): string

  ユーザー・グループのローカライズされていない名前

• stripeCD(optional): string

  UserGroupのストライプ

{
    "title":"UserGroupKey",
    "properties":{
        "recordId":{
            "description":"<p>The unique identifier from the TAG table that represent a userGroups resource</p>",
            "type":"string"
        },
        "externalType":{
            "description":"<p>The ExternalType is the type of the corresponding userGroup from an external system.</p>",
            "type":"string"
        },
        "referenceKey":{
            "description":"<p>The non localized name of the user group</p>",
            "type":"string"
        },
        "name":{
            "description":"<p>The localized name of the user group.  The name field can only be used for sorting.</p>",
            "type":"string"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/instanceLink"
            },
            "type":"array"
        },
        "stripeCD":{
            "description":"<p>Stripe for UserGroup</p>",
            "type":"string"
        },
        "externalId":{
            "description":"<p>The unique identifier of the corresponding userGroup from an external system. You can use the External ID with the ExternalType parameter to connect user groups in the internal and the the external systems.</p>",
            "type":"integer"
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

ソースを表示

• Array of: object instanceLink
  JSONインスタンス表現に表示される可能性があるリンク記述オブジェクトを記述するMetadata。

{
    "items":{
        "$ref":"#/definitions/instanceLink"
    },
    "type":"array"
}

トップに戻る

例

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

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

レスポンス本文の例

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

{
  "extendedProperties": "",
  "categories": [],
  "userGroups": [],
  "localizedAttributes": [
    {
      "localeId": "en_US",
      "name": "Knowledge"
    }
  ],
  "recordId": "FBA17E28CAAB4A7387A44BEE77240E33",
  "referenceKey": "TENANT",
  "name": "Knowledge",
  "links": [
    {
      "rel": "canonical",
      "href": "http://IM_REST_API_HOST/km/api/latest/views/FBA17E28CAAB4A7387A44BEE77240E33",
      "mediaType": "application/json, application/xml",
      "method": "GET"
    },
    {
      "rel": "collection",
      "href": "http://IM_REST_API_HOST/km/api/latest/views",
      "mediaType": "application/json, application/xml",
      "method": "GET",
      "profile": "http://IM_REST_API_HOST/km/api/latest/metadata-catalog/views"
    }
  ],
  "dateAdded": "1970-01-01T23:11:11-0800",
  "dateModified": "2017-04-24T23:18:13-0700",
  "objectId": "001"
}

「トップに戻る」