Jump to

• Request
• Response

Get the lineage of a viewpoint

get

/epm/rest/v1/views/{viewId}/viewpoints/{viewpointId}/lineage

Request

Path Parameters

• viewId(required): string(uuid)
  The id of the view
• viewpointId(required): string(uuid)
  The id of the viewpoint

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : ViewLineage

Type: object

Show Source

• links: array links
  Read Only: true
• subscriptionLineageLinks: array subscriptionLineageLinks
  Read Only: true

  The list of subscriptions used in this lineage.
• viewLineageNodes: array viewLineageNodes
  Read Only: true

  The list of views used in this lineage.

{
    "type":"object",
    "properties":{
        "viewLineageNodes":{
            "type":"array",
            "description":"The list of views used in this lineage.",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/ViewLineageNode"
            }
        },
        "subscriptionLineageLinks":{
            "type":"array",
            "description":"The list of subscriptions used in this lineage.",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/SubscriptionLineageLink"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

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

Nested Schema : subscriptionLineageLinks

Type: array

Read Only: true

The list of subscriptions used in this lineage.

Show Source

• Array of: object SubscriptionLineageLink
  Subscription details for viewpoint lineage diagram

{
    "type":"array",
    "description":"The list of subscriptions used in this lineage.",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/SubscriptionLineageLink"
    }
}

Nested Schema : viewLineageNodes

Type: array

Read Only: true

The list of views used in this lineage.

Show Source

• Array of: object ViewLineageNode

{
    "type":"array",
    "description":"The list of views used in this lineage.",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/ViewLineageNode"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• method: string
• rel: string
• templated: boolean

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "templated":{
            "type":"boolean"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : SubscriptionLineageLink

Type: object

Subscription details for viewpoint lineage diagram

Show Source

• allowedActions: array allowedActions
• alternateAssignees: array alternateAssignees
• assigneeName: string
• copyActionText: string
• copyActionType: string
  Allowed Values: [ "NONE", "PROPERTIES", "MODEL_AFTER" ]
• createdBy: string
• createdByUser: object User
• description: string
• errors: array errors
• etagValue: string
• expression: object JsonNode
• id: string(uuid)
  Read Only: true
• ignoreSourceParent: boolean
• includedActionsText: string
• inclusionProperty: object InclusionProperty
• inclusionPropertyText: string
• lastModifiedBy: string
• links: array links
  Read Only: true
• modifiedByUser: object User
• name: string
  Read Only: true
• nodeConditionText: string
• propertiesToMatch: array propertiesToMatch
• propertiesToMatchText: string
• sourceApplication: object IdNameLink
• sourceDimension: object IdNameLink
• sourceView: object IdNameLink
• sourceViewpoint: object IdNameLink
• targetApplication: object IdNameLink
• targetDimension: object IdNameLink
• targetView: object IdNameLink
• targetViewpoint: object IdNameLink
• timeCreated: integer(int64)
• timeModified: integer(int64)
• topNodes: array topNodes
• topNodesText: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "readOnly":true
        },
        "sourceView":{
            "readOnly":true,
            "$ref":"#/definitions/IdNameLink"
        },
        "sourceViewpoint":{
            "readOnly":true,
            "$ref":"#/definitions/IdNameLink"
        },
        "targetView":{
            "readOnly":true,
            "$ref":"#/definitions/IdNameLink"
        },
        "targetViewpoint":{
            "readOnly":true,
            "$ref":"#/definitions/IdNameLink"
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "description":{
            "type":"string"
        },
        "sourceApplication":{
            "$ref":"#/definitions/IdNameLink"
        },
        "sourceDimension":{
            "$ref":"#/definitions/IdNameLink"
        },
        "targetApplication":{
            "$ref":"#/definitions/IdNameLink"
        },
        "targetDimension":{
            "$ref":"#/definitions/IdNameLink"
        },
        "assigneeName":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "lastModifiedBy":{
            "type":"string"
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64"
        },
        "timeModified":{
            "type":"integer",
            "format":"int64"
        },
        "topNodes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SubscriptionTopNode"
            }
        },
        "topNodesText":{
            "type":"string"
        },
        "allowedActions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "includedActionsText":{
            "type":"string"
        },
        "expression":{
            "$ref":"#/definitions/JsonNode"
        },
        "nodeConditionText":{
            "type":"string"
        },
        "alternateAssignees":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AlternateAssignee"
            }
        },
        "inclusionProperty":{
            "$ref":"#/definitions/InclusionProperty"
        },
        "inclusionPropertyText":{
            "type":"string"
        },
        "createdByUser":{
            "$ref":"#/definitions/User"
        },
        "modifiedByUser":{
            "$ref":"#/definitions/User"
        },
        "copyActionType":{
            "type":"string",
            "enum":[
                "NONE",
                "PROPERTIES",
                "MODEL_AFTER"
            ]
        },
        "copyActionText":{
            "type":"string"
        },
        "propertiesToMatch":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IdNameLink"
            }
        },
        "propertiesToMatchText":{
            "type":"string"
        },
        "ignoreSourceParent":{
            "type":"boolean"
        },
        "etagValue":{
            "type":"string"
        },
        "errors":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    },
    "description":"Subscription details for viewpoint lineage diagram"
}

Nested Schema : allowedActions

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : alternateAssignees

Type: array

Show Source

• Array of: object AlternateAssignee

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

Nested Schema : User

Type: object

Show Source

• artifactAssignments: array artifactAssignments
• associatedRoles: array associatedRoles
• dataManagerOnAny: boolean
• emailAddresses: array emailAddresses
• epmIdleSessionTimeout: integer(int32)
• firstName: string
• fullName: string
• grantPermission: string
  Allowed Values: [ "OWNER", "DATAMANAGER", "PARTICIPANT", "APPROVER", "NOTIFIED", "COMMITTER", "NONE", "METADATAMANAGER" ]
• homePageLayoutName: string
• id: string(uuid)
• lastName: string
• links: array links
• nameInitials: string
• preferences: object Preferences
• ssoToken: string
• userName: string
• userServiceAdministrator: boolean

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "userName":{
            "type":"string"
        },
        "fullName":{
            "type":"string"
        },
        "firstName":{
            "type":"string"
        },
        "lastName":{
            "type":"string"
        },
        "ssoToken":{
            "type":"string"
        },
        "emailAddresses":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "associatedRoles":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Role"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "preferences":{
            "$ref":"#/definitions/Preferences"
        },
        "nameInitials":{
            "type":"string"
        },
        "grantPermission":{
            "type":"string",
            "enum":[
                "OWNER",
                "DATAMANAGER",
                "PARTICIPANT",
                "APPROVER",
                "NOTIFIED",
                "COMMITTER",
                "NONE",
                "METADATAMANAGER"
            ]
        },
        "dataManagerOnAny":{
            "type":"boolean"
        },
        "userServiceAdministrator":{
            "type":"boolean"
        },
        "epmIdleSessionTimeout":{
            "type":"integer",
            "format":"int32"
        },
        "homePageLayoutName":{
            "type":"string"
        },
        "artifactAssignments":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ArtifactAssignment"
            }
        }
    }
}

Nested Schema : errors

Type: array

Show Source

• Array of: object Error

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

Nested Schema : JsonNode

Type: object

Nested Schema : InclusionProperty

Type: object

Show Source

• propertyId: object Link
• value: string
  Read Only: true

{
    "type":"object",
    "properties":{
        "propertyId":{
            "readOnly":true,
            "$ref":"#/definitions/Link"
        },
        "value":{
            "type":"string",
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

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

Nested Schema : propertiesToMatch

Type: array

Show Source

• Array of: object IdNameLink

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

Nested Schema : IdNameLink

Type: object

Show Source

• description: string
  Read Only: true
• id: string(uuid)
• links: array links
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : topNodes

Type: array

Show Source

• Array of: object SubscriptionTopNode

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

Nested Schema : AlternateAssignee

Type: object

Show Source

• alternateAssigneeType: string
  Read Only: true

  Allowed Values: [ "GROUP", "USER" ]
• fullName: string
  Read Only: true
• groupId: string(uuid)
  Read Only: true
• groupName: string
  Read Only: true
• links: array links
  Read Only: true
• sortOrder: integer(int32)
  Read Only: true
• userId: string(uuid)
  Read Only: true
• userName: string
  Read Only: true

{
    "type":"object",
    "properties":{
        "userId":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "groupId":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "userName":{
            "type":"string",
            "readOnly":true
        },
        "fullName":{
            "type":"string",
            "readOnly":true
        },
        "groupName":{
            "type":"string",
            "readOnly":true
        },
        "sortOrder":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "alternateAssigneeType":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "GROUP",
                "USER"
            ]
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

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

Nested Schema : artifactAssignments

Type: array

Show Source

• Array of: object ArtifactAssignment

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

Nested Schema : associatedRoles

Type: array

Show Source

• Array of: object Role

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

Nested Schema : emailAddresses

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Preferences

Type: object

Show Source

• actAsThisRole: string
  Allowed Values: [ "USER", "SERVICE_ADMINISTRATOR" ]
• delegateToUserId: string(uuid)
• languageTag: string
• links: array links
• outOfOffice: boolean
• profilePictureId: string(uuid)
• timeZone: object TimeZone

{
    "type":"object",
    "properties":{
        "profilePictureId":{
            "type":"string",
            "format":"uuid"
        },
        "timeZone":{
            "$ref":"#/definitions/TimeZone"
        },
        "languageTag":{
            "type":"string"
        },
        "outOfOffice":{
            "type":"boolean"
        },
        "delegateToUserId":{
            "type":"string",
            "format":"uuid"
        },
        "actAsThisRole":{
            "type":"string",
            "enum":[
                "USER",
                "SERVICE_ADMINISTRATOR"
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : ArtifactAssignment

Type: object

Show Source

• artifact: object Artifact
• sortOrder: integer(int32)
• visible: boolean

{
    "type":"object",
    "properties":{
        "artifact":{
            "$ref":"#/definitions/Artifact"
        },
        "sortOrder":{
            "type":"integer",
            "format":"int32"
        },
        "visible":{
            "type":"boolean"
        }
    }
}

Nested Schema : Artifact

Type: object

Show Source

• id: string(uuid)
• name: string
• type: string
  Allowed Values: [ "CLUSTER", "CARD" ]

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "CLUSTER",
                "CARD"
            ]
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : Role

Type: object

Show Source

• id: string
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : TimeZone

Type: object

Show Source

• displayName: string
• dstsavings: integer(int32)
• id: string
• rawOffset: integer(int32)

{
    "type":"object",
    "properties":{
        "displayName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "rawOffset":{
            "type":"integer",
            "format":"int32"
        },
        "dstsavings":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : Error

Type: object

Show Source

• message: string

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : SubscriptionTopNode

Type: object

Show Source

• description: string
  Read Only: true
• id: string(uuid)
• invalid: boolean
• links: array links
• name: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "invalid":{
            "type":"boolean"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : ViewLineageNode

Type: object

Show Source

• id: string(uuid)
  Read Only: true
• level: integer(int32)
  Read Only: true
• links: array links
  Read Only: true
• name: string
  Read Only: true
• viewpoints: array viewpoints
  Read Only: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "readOnly":true
        },
        "level":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "viewpoints":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/IdNameLink"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

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

Nested Schema : viewpoints

Type: array

Read Only: true

Show Source

• Array of: object IdNameLink

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/IdNameLink"
    }
}

403 Response

Forbidden access to viewpoint

404 Response

Viewpoint not found

Back to Top