機械翻訳について

移動先

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

フィルタリングされたハイブリッド・リンクのリストを取得します。

get

/social/api/v1/hybridlinks

リクエスト

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

• application/json

本文()

問合せ対象のフィルタを指定します。

ルート・スキーマ : XV1HybridLinkFilterInfo

型: object

V1ハイブリッド・リンク・フィルタ情報DTO。

ソースを表示

• applicationInstanceID(optional): string
  ハイブリッド・リンクが作成されるアプリケーションのインスタンスID。 これは、すべての非APPIDユーザーに必須です。 単独で指定された場合、このアプリケーション・インスタンスIDに対して定義されたすべてのハイブリッド・リンクが含まれます。
• hybridLinkIDs(optional): array hybridLinkIDs
  ハイブリッド・リンクIDのリスト。
• resourceIDs(optional): array resourceIDs
  ハイブリッド・リンクが作成されるリソースIDのリスト。 指定した場合、リスト内のリソースのすべてのハイブリッド・リンクが含まれます。

{
    "description":"V1 Hybrid Link Filter Information DTO.",
    "properties":{
        "applicationInstanceID":{
            "description":"The instance ID of the application for which the hybrid link is created. This is mandatory for all non-APPID users.  If specified alone, all the hybrid links defined for this application instance ID will be included.",
            "type":"string"
        },
        "hybridLinkIDs":{
            "description":"The list of hybrid link IDs.",
            "type":"array",
            "items":{
                "description":"The list of hybrid link IDs.",
                "type":"string"
            }
        },
        "resourceIDs":{
            "description":"The list of resource IDs for which the hybrid links are created. If specified, all the hybrid links for the resources in the list will be included.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XObjectID"
            }
        }
    }
}

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

型: array

ハイブリッド・リンクIDのリスト。

ソースを表示

• Array of: string
  ハイブリッド・リンクIDのリスト。

{
    "description":"The list of hybrid link IDs.",
    "type":"array",
    "items":{
        "description":"The list of hybrid link IDs.",
        "type":"string"
    }
}

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

型: array

ハイブリッド・リンクが作成されるリソースIDのリスト。 指定した場合、リスト内のリソースのすべてのハイブリッド・リンクが含まれます。

ソースを表示

• Array of:
  オブジェクトのlong integer表現の一意識別子。

{
    "description":"The list of resource IDs for which the hybrid links are created. If specified, all the hybrid links for the resources in the list will be included.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XObjectID"
    }
}

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : XV1HybridLinkListInfo

型: object

V1ハイブリッド・リンク・リスト情報DTO。

ソースを表示

• hasMore(optional): boolean
  trueの場合、他にも返すアイテムが存在します。
• items(optional): array items
  返されるハイブリッド・リンク。
• nextURL(optional): string(url)
  リストの次のページのURL。 これが最後のページである場合はNull。
• previousURL(optional): string(url)
  リストの前のページのURL。 これが最初のページである場合はNull。
• total(optional): integer(int32)
  指定した場合、これは使用可能なアイテムの合計数です。 合計が不明な場合はNull。

{
    "description":"V1 Hybrid Link List Information DTO.",
    "properties":{
        "items":{
            "description":"The hybrid links being returned.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/XV1HybridLinkInfo"
            }
        },
        "hasMore":{
            "description":"If true, there are more items to be returned.",
            "type":"boolean"
        },
        "nextURL":{
            "description":"Next page URL for the list. Null if this is the last page.",
            "type":"string",
            "format":"url"
        },
        "previousURL":{
            "description":"Previous page URL for the list. Null if this is the first page.",
            "type":"string",
            "format":"url"
        },
        "total":{
            "description":"If specified, this is the total number of available items. Null if the total is unknown.",
            "type":"integer",
            "format":"int32"
        }
    }
}

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

型: array

返されるハイブリッド・リンク。

ソースを表示

• Array of: object XV1HybridLinkInfo
  V1ハイブリッド・リンク情報DTO。

{
    "description":"The hybrid links being returned.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/XV1HybridLinkInfo"
    }
}

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

型: object

V1ハイブリッド・リンク情報DTO。

ソースを表示

• applicationInstanceID(optional): string
  ハイブリッド・リンクが作成されるアプリケーションのインスタンスID。
• hybridLinkID(optional): string
  ハイブリッド・リンクID。
• resourceID(optional):
  オブジェクトのlong integer表現の一意識別子。

{
    "description":"V1 Hybrid Link Information DTO.",
    "properties":{
        "applicationInstanceID":{
            "description":"The instance ID of the application for which the hybrid link is created.",
            "type":"string"
        },
        "hybridLinkID":{
            "description":"The hybrid link ID.",
            "type":"string"
        },
        "resourceID":{
            "$ref":"#/definitions/XObjectID"
        }
    }
}

先頭に戻る