Jump to

• Request
• Response

List immediate (direct) relationships for a target

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/targets/{targetId}/immediateRelationships

Lists direct relationships for the specified target. You can filter by source/destination target name/type and association type.

Request

Path Parameters

• targetId(required): string
  the target id

Query Parameters

• assocType: array[string]
  List of association types (for example: uses, used_by, hosted_by).
• containerSnapshotId: string
  Container snapshot identifier (optional).
• destTargetName: string
  Destination target name filter (optional).
• destTargetType: string
  Destination target type filter (optional).
• limit: integer(int32)
  Minimum Value: 1

  Maximum Value: 2000

  to limit the number of rows returned. If the result set is greater follow the previous and next links in the results.

  Example:

  20

• page: string
  system generated page token used in the self, next and previous links.
• sort: string
  Sort results as field:direction (example: id:ASC).

  Example:

  id:ASC

• sourceTargetName: string
  Source target name filter (optional).
• sourceTargetType: string
  Source target type filter (optional).

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : TargetImmediateCollection

Type: object

Paged list of immediate (direct) relationship summaries.

Show Source

• count(required): integer
  Number of items returned in this response.
• items(required): array items
  Immediate relationship summaries.
• links(required): object links
  Result set navigation links.

{
    "x-em-sdk-level":"emSDK",
    "description":"Paged list of immediate (direct) relationship summaries.",
    "type":"object",
    "required":[
        "links",
        "count",
        "items"
    ],
    "properties":{
        "links":{
            "type":"object",
            "description":"Result set navigation links.",
            "required":[
                "self"
            ],
            "properties":{
                "self":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the current page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/targets/TARGETID/associations?page=THIS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "previous":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the previous page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/targets/TARGETID/associations?page=THE_PREVIOUS_PAGE_TOKEN"
                            }
                        }
                    ]
                },
                "next":{
                    "allOf":[
                        {
                            "$ref":"#/components/schemas/Link"
                        },
                        {
                            "description":"Link to the next page in the result set."
                        },
                        {
                            "example":{
                                "href":"/em/api/targets/TARGETID/associations?page=THE_NEXT_PAGE_TOKEN"
                            }
                        }
                    ]
                }
            }
        },
        "count":{
            "type":"integer",
            "description":"Number of items returned in this response."
        },
        "items":{
            "type":"array",
            "description":"Immediate relationship summaries.",
            "items":{
                "$ref":"#/components/schemas/ImmediateSummary"
            }
        }
    }
}

Nested Schema : items

Type: array

Immediate relationship summaries.

Show Source

• Array of: object ImmediateSummary
  Summary of an immediate relationship (source/destination and association type).

{
    "type":"array",
    "description":"Immediate relationship summaries.",
    "items":{
        "$ref":"#/components/schemas/ImmediateSummary"
    }
}

Nested Schema : links

Type: object

Result set navigation links.

Show Source

• next: next
• previous: previous
• self(required): self

{
    "type":"object",
    "description":"Result set navigation links.",
    "required":[
        "self"
    ],
    "properties":{
        "self":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the current page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/targets/TARGETID/associations?page=THIS_PAGE_TOKEN"
                    }
                }
            ]
        },
        "previous":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the previous page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/targets/TARGETID/associations?page=THE_PREVIOUS_PAGE_TOKEN"
                    }
                }
            ]
        },
        "next":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Link"
                },
                {
                    "description":"Link to the next page in the result set."
                },
                {
                    "example":{
                        "href":"/em/api/targets/TARGETID/associations?page=THE_NEXT_PAGE_TOKEN"
                    }
                }
            ]
        }
    }
}

Nested Schema : ImmediateSummary

Type: object

Summary of an immediate relationship (source/destination and association type).

Show Source

• assocType: string
  Association type.

  Example: assocType
• assocTypeDisplayName: string
  Association type display name.

  Example: AssocTypeDisplayName
• destTargetId: string
  Destination target identifier.

  Example: DestTargetId
• destTargetName: string
  Destination target name.

  Example: DestTargetName
• destTargetType: string
  Destination target type.

  Example: DestTargetType
• destTargetTypeDisplayName: string
  Destination target type display name.

  Example: DestTargetTypeDisplayName
• sourceTargetId: string
  Source target identifier.

  Example: SourceTargetId
• sourceTargetName: string
  Source target name.

  Example: SourceTargetName
• sourceTargetType: string
  Source target type.

  Example: SourceTargetType
• sourceTargetTypeDisplayName: string
  Source target type display name.

  Example: SourceTargetTypeDisplayName

{
    "x-em-sdk-level":"emSDK",
    "description":"Summary of an immediate relationship (source/destination and association type).",
    "type":"object",
    "properties":{
        "sourceTargetId":{
            "type":"string",
            "description":"Source target identifier.",
            "example":"SourceTargetId"
        },
        "sourceTargetName":{
            "type":"string",
            "description":"Source target name.",
            "example":"SourceTargetName"
        },
        "sourceTargetType":{
            "type":"string",
            "description":"Source target type.",
            "example":"SourceTargetType"
        },
        "sourceTargetTypeDisplayName":{
            "type":"string",
            "description":"Source target type display name.",
            "example":"SourceTargetTypeDisplayName"
        },
        "assocType":{
            "type":"string",
            "description":"Association type.",
            "example":"assocType"
        },
        "assocTypeDisplayName":{
            "type":"string",
            "description":"Association type display name.",
            "example":"AssocTypeDisplayName"
        },
        "destTargetId":{
            "type":"string",
            "description":"Destination target identifier.",
            "example":"DestTargetId"
        },
        "destTargetName":{
            "type":"string",
            "description":"Destination target name.",
            "example":"DestTargetName"
        },
        "destTargetType":{
            "type":"string",
            "description":"Destination target type.",
            "example":"DestTargetType"
        },
        "destTargetTypeDisplayName":{
            "type":"string",
            "description":"Destination target type display name.",
            "example":"DestTargetTypeDisplayName"
        }
    }
}

Nested Schema : next

Match All

Link to the next page in the result set.

Show Source

• object Link
  A link
• Link to the next page in the result set.
• Example: { "href":"/em/api/targets/TARGETID/associations?page=THE_NEXT_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the next page in the result set."
        },
        {
            "example":{
                "href":"/em/api/targets/TARGETID/associations?page=THE_NEXT_PAGE_TOKEN"
            }
        }
    ]
}

Nested Schema : previous

Match All

Link to the previous page in the result set.

Show Source

• object Link
  A link
• Link to the previous page in the result set.
• Example: { "href":"/em/api/targets/TARGETID/associations?page=THE_PREVIOUS_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the previous page in the result set."
        },
        {
            "example":{
                "href":"/em/api/targets/TARGETID/associations?page=THE_PREVIOUS_PAGE_TOKEN"
            }
        }
    ]
}

Nested Schema : self

Match All

Link to the current page in the result set.

Show Source

• object Link
  A link
• Link to the current page in the result set.
• Example: { "href":"/em/api/targets/TARGETID/associations?page=THIS_PAGE_TOKEN" }

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Link"
        },
        {
            "description":"Link to the current page in the result set."
        },
        {
            "example":{
                "href":"/em/api/targets/TARGETID/associations?page=THIS_PAGE_TOKEN"
            }
        }
    ]
}

Nested Schema : Link

Type: object

A link

Show Source

• href(required): string
  URL for link

{
    "description":"A link",
    "type":"object",
    "required":[
        "href"
    ],
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for link"
        }
    }
}

401 Response

client is not authenticated

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

500 Response

internal error serving the request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

503 Response

indicates that a required service is not available.

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  customer facing error code
• details: array details
  (Optional) List of additional details for the errors found.
• message(required): string
  customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

• Array of: object ErrorDetail
  listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

• message(required): string
  specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

Back to Top