Jump to

• Request
• Response

Get a filtered list of hybrid links.

get

/social/api/v1/hybridlinks

Request

Supported Media Types

• application/json

Body ()

Specify a filter to query.

Root Schema : XV1HybridLinkFilterInfo

Type: object

V1 Hybrid Link Filter Information DTO.

Show Source

• applicationInstanceID(optional): string
  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.
• hybridLinkIDs(optional): array hybridLinkIDs
  The list of hybrid link IDs.
• resourceIDs(optional): array resourceIDs
  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.

{
    "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"
            }
        }
    }
}

Nested Schema : hybridLinkIDs

Type: array

The list of hybrid link IDs.

Show Source

• Array of: string
  The list of hybrid link IDs.

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

Nested Schema : resourceIDs

Type: array

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.

Show Source

• Array of:
  An object's unique identifier from a long integer representation.

{
    "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"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : XV1HybridLinkListInfo

Type: object

V1 Hybrid Link List Information DTO.

Show Source

• hasMore(optional): boolean
  If true, there are more items to be returned.
• items(optional): array items
  The hybrid links being returned.
• nextURL(optional): string(url)
  Next page URL for the list. Null if this is the last page.
• previousURL(optional): string(url)
  Previous page URL for the list. Null if this is the first page.
• total(optional): integer(int32)
  If specified, this is the total number of available items. Null if the total is unknown.

{
    "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"
        }
    }
}

Nested Schema : items

Type: array

The hybrid links being returned.

Show Source

• Array of: object XV1HybridLinkInfo
  V1 Hybrid Link Information DTO.

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

Nested Schema : XV1HybridLinkInfo

Type: object

V1 Hybrid Link Information DTO.

Show Source

• applicationInstanceID(optional): string
  The instance ID of the application for which the hybrid link is created.
• hybridLinkID(optional): string
  The hybrid link ID.
• resourceID(optional):
  An object's unique identifier from a long integer representation.

{
    "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"
        }
    }
}

Back to Top