機械翻訳について

移動先

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

アイテムのリレーションシップのリスト

get

/content/management/api/v1.1/items/{id}/relationships

指定されたアイテムのすべての関係をリストします。

リクエスト

パス・パラメータ

• id: string
  アイテムのId。

問合せパラメータ

• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : ItemSubResourceRelationships

型: object

アイテムSubResource。

ソースを表示

• data(optional): object Relationships
  関係
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "$ref":"#/definitions/Relationships"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

ネストされたスキーマ : 関係

型: object

関係

ソースを表示

• referencedBy(optional): array referencedBy
  Idによる参照
• referencedBySitePlan(optional): object Siteplanreference
  サイト・プラン参照
• referencedBySites(optional): array referencedBySites
  サイトで参照
• references(optional): array references
  参照Id

{
    "type":"object",
    "properties":{
        "references":{
            "type":"array",
            "description":"Reference ids",
            "items":{
                "$ref":"#/definitions/References"
            }
        },
        "referencedBy":{
            "type":"array",
            "description":"Referenced by ids",
            "items":{
                "$ref":"#/definitions/References"
            }
        },
        "referencedBySites":{
            "type":"array",
            "description":"Referenced by sites",
            "items":{
                "$ref":"#/definitions/ReferencedBySites"
            }
        },
        "referencedBySitePlan":{
            "$ref":"#/definitions/Siteplanreference"
        }
    },
    "description":"Relationships"
}

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

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

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

型: array

Idによる参照

ソースを表示

• Array of: object References
  参照

{
    "type":"array",
    "description":"Referenced by ids",
    "items":{
        "$ref":"#/definitions/References"
    }
}

ネストされたスキーマ : サイト・プラン参照

型: object

サイト・プラン参照

ソースを表示

• id(optional): string
  サイト・プランのID。
• links(optional): array links

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the site plan."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Site plan reference"
}

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

型: array

サイトで参照

ソースを表示

• Array of: object ReferencedBySites
  ReferencedBySites

{
    "type":"array",
    "description":"Referenced by sites",
    "items":{
        "$ref":"#/definitions/ReferencedBySites"
    }
}

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

型: array

参照Id

ソースを表示

• Array of: object References
  参照

{
    "type":"array",
    "description":"Reference ids",
    "items":{
        "$ref":"#/definitions/References"
    }
}

ネストされたスキーマ : 参照

型: object

参照

ソースを表示

• id(optional): string
  アイテムのId。
• links(optional): array links
• reference(optional): object ItemReferenceInfo
  ItemReferenceInfo

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "reference":{
            "description":"Access information of the Referenced Item.",
            "$ref":"#/definitions/ItemReferenceInfo"
        }
    },
    "description":"References"
}

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

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

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

型: object

ItemReferenceInfo

ソースを表示

• isAccessible(optional): boolean
  アイテムがアクセス可能かどうか。

{
    "type":"object",
    "properties":{
        "isAccessible":{
            "type":"boolean",
            "description":"Whether the item is accessible."
        }
    },
    "description":"ItemReferenceInfo"
}

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

型: object

リソースのリンク。

ソースを表示

• href(optional): string
  ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
• mediaType(optional): string
  メディア・タイプ。
• method(optional): string
  ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
• profile(optional): string
  ターゲット・リソースを記述するメタデータにリンクします。
• rel(optional): string
  関連タイプ これはレスポンス取得の必須プロパティです。
• templated(optional): boolean
  URIがテンプレートであるかどうか。

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

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

型: array

ソースを表示

• Array of: object Link
  リソースのリンク。

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

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

型: object

ReferencedBySites

ソースを表示

• component(オプション): string
  品目の構成部品
• pageId(optional): string
  アイテムが追加されたページ
• site(optional): string
  アイテムが追加されたサイト

{
    "type":"object",
    "properties":{
        "site":{
            "type":"string",
            "description":"Site the item added to"
        },
        "pageId":{
            "type":"string",
            "description":"Page the item added to"
        },
        "component":{
            "type":"string",
            "description":"Component of the item"
        }
    },
    "description":"ReferencedBySites"
}

304 レスポンス

変更されていません。

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

トップに戻る

例

次の例では、cURLを使用してGETリクエストを送信することによってアイテムの関係を取得する方法を示します。

curl -X GET -H 'Accept: application/json' 'https://host:port/content/management/api/v1.1/items/{id}/relationships'

例1

アイテムidのすべての関係がリストされます: CORED98388F2AA724E27844821414B0B0447。 これは、粒度の細かい権限機能が有効になっていない場合のサンプル・レスポンスです。

/content/management/api/v1.1/items/CORED98388F2AA724E27844821414B0B0447/relationships

レスポンス本文

{
    "data": {
    "references": [
      {
        "id": "CORECE0B9A793CD54F26AF0853BBB5F49745",
        "links": [
      {
        "href": "https://host:port/content/management/api/v1.1/items/CORECE0B9A793CD54F26AF0853BBB5F49745",
        "rel": "self",
        "method": "GET",
        "mediaType": "application/json"
    }
        ]
    }
    ],
    "referencedBy": [
      {
        "id": "CORECE0B9A793CD54F26AF0853BBB5F49745",
        "links": [
      {
        "href": "https://host:port/content/management/api/v1.1/items/CORECE0B9A793CD54F26AF0853BBB5F49745",
        "rel": "self",
        "method": "GET",
        "mediaType": "application/json"
    }
        ]
    }
    ]
    },
    "links": [
    {
      "href": "https://host:port/content/management/api/v1.1/items/CORED98388F2AA724E27844821414B0B0447/relationships",
      "rel": "self",
      "method": "GET",
      "mediaType": "application/json"
    }
    ]
    }

例2

アイテムIdのすべての関係がリストされます: CORE4FDEB4C45AF34766B8CB88D25BD92D90. これは、きめ細かい権限機能が有効になっていて、ユーザーがすべての参照および表示権限を持っている場合のサンプル・レスポンスです。

/content/management/api/v1.1/items/CORE4FDEB4C45AF34766B8CB88D25BD92D90/relationships

レスポンス本文

{
	    "data": {
	        "references": [
	            {
	                "id": "CONT90C026CB999E470CAEAFE0F76BB55036",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CONT90C026CB999E470CAEAFE0F76BB55036",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            },
	            {
	                "id": "CORE878A5BEE021849D2A183CF94E64F1D9B",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CORE878A5BEE021849D2A183CF94E64F1D9B",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            },
	            {
	                "id": "CONTBAEF8D6E7C44433FB553BB53D1D0B531",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CONTBAEF8D6E7C44433FB553BB53D1D0B531",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            },
	            {
	                "id": "COREA0B53F00198F4771962526DDF83416C5",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/COREA0B53F00198F4771962526DDF83416C5",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            }
	        ],
	        "referencedBy": [
	            {
	                "id": "CORE558B93EAE0114E749E0C7550DD0635C4",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CORE558B93EAE0114E749E0C7550DD0635C4",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            },
	            {
	                "id": "CORE1A9DFBE412D04E039FDDED1AAF4D64EC",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CORE1A9DFBE412D04E039FDDED1AAF4D64EC",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            }
	        ],
	        "referencedBySites": []
	    },
	    "links": [
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/items/CORE4FDEB4C45AF34766B8CB88D25BD92D90/relationships",
	            "rel": "self",
	            "method": "GET",
	            "mediaType": "application/json"
	        }
	    ]
      }

例3

アイテムIdのすべての関係がリストされます: CORE4FDEB4C45AF34766B8CB88D25BD92D90. これは、きめ細かい権限機能が有効な場合のサンプル・レスポンスですが、ユーザーにはすべての参照に対する表示権限がなく、アイテムによって参照される権限はありません。

/content/management/api/v1.1/items/CORE4FDEB4C45AF34766B8CB88D25BD92D90/relationships

レスポンス本文

{
	    "data": {
	        "references": [
	            {
	                "id": "CONT90C026CB999E470CAEAFE0F76BB55036",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CONT90C026CB999E470CAEAFE0F76BB55036",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            },
	            {
	                "id": "CORE878A5BEE021849D2A183CF94E64F1D9B",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CORE878A5BEE021849D2A183CF94E64F1D9B",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            },
	            {
	                "id": "CONTBAEF8D6E7C44433FB553BB53D1D0B531",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CONTBAEF8D6E7C44433FB553BB53D1D0B531",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            },
	            {
	                "id": "COREA0B53F00198F4771962526DDF83416C5",
	                "reference": {
	                    "isAccessible": false
	                }
	            }
	        ],
	        "referencedBy": [
	            {
	                "id": "CORE558B93EAE0114E749E0C7550DD0635C4",
	                "reference": {
	                    "isAccessible": false
	                }
	            },
	            {
	                "id": "CORE1A9DFBE412D04E039FDDED1AAF4D64EC",
	                "links": [
	                    {
	                        "href": "http://<hostname>/content/management/api/v1.1/items/CORE1A9DFBE412D04E039FDDED1AAF4D64EC",
	                        "rel": "self",
	                        "method": "GET",
	                        "mediaType": "application/json"
	                    }
	                ],
	                "reference": {
	                    "isAccessible": true
	                }
	            }
	        ],
	        "referencedBySites": []
	    },
	    "links": [
	        {
	            "href": "http://<hostname>/content/management/api/v1.1/items/CORE4FDEB4C45AF34766B8CB88D25BD92D90/relationships",
	            "rel": "self",
	            "method": "GET",
	            "mediaType": "application/json"
	        }
	    ]
      }
    }
  ]
}

先頭に戻る