REST API for Oracle Enterprise Data Management Cloud Service

Get the lineage of a request

get

/epm/rest/v1/requests/{requestId}/lineage

Request

Path Parameters

requestId(required): string(uuid)

The id of the request

Response

Supported Media Types

application/json

200 Response

Root Schema : RequestLineage

Type: object

Show Source

links: array links

Read Only: true
requestLineageNodes: array requestLineageNodes

Read Only: true

The list of requests used in this lineage.
subscriptionInstances: array subscriptionInstances

The list of subscriptions used in this lineage.

{
    "type":"object",
    "properties":{
        "requestLineageNodes":{
            "type":"array",
            "description":"The list of requests used in this lineage.",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/RequestLineageNode"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "subscriptionInstances":{
            "type":"array",
            "description":"The list of subscriptions used in this lineage.",
            "items":{
                "$ref":"#/definitions/SubscriptionInstance"
            }
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object Link

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

Nested Schema : requestLineageNodes

Type: array

Read Only: true

The list of requests used in this lineage.

Show Source

Array of: object RequestLineageNode

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

Nested Schema : subscriptionInstances

Type: array

The list of subscriptions used in this lineage.

Show Source

Array of: object SubscriptionInstance

Subscription Instance details

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

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 : RequestLineageNode

Type: object

Show Source

autoSubmitted: boolean
id: string(uuid)

Read Only: true
incompleteSubscriptions: array incompleteSubscriptions
links: array links

Read Only: true
origin: string

Read Only: true

Allowed Values: [ "DEFINED", "INSTRUCTIVE", "INTERACTIVE", "MEMBERSHIP", "NOTIFICATION", "REMEDIATION", "SUBSCRIPTION", "CONSOLIDATION", "IMPORT", "LOAD" ]
sourceRequest: object IdNameLink
status: string

Read Only: true

Allowed Values: [ "DRAFT", "IN_FLIGHT", "PULLED_BACK", "PUSHED_BACK", "COMPLETED", "REJECTED", "WITHDRAWN", "RECALLED", "BLOCKED", "CONSOLIDATED" ]
timeCreated: integer(int64)

Read Only: true
title: string

Read Only: true
viewpoints: array viewpoints

Read Only: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "title":{
            "type":"string",
            "readOnly":true
        },
        "origin":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "DEFINED",
                "INSTRUCTIVE",
                "INTERACTIVE",
                "MEMBERSHIP",
                "NOTIFICATION",
                "REMEDIATION",
                "SUBSCRIPTION",
                "CONSOLIDATION",
                "IMPORT",
                "LOAD"
            ]
        },
        "status":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "DRAFT",
                "IN_FLIGHT",
                "PULLED_BACK",
                "PUSHED_BACK",
                "COMPLETED",
                "REJECTED",
                "WITHDRAWN",
                "RECALLED",
                "BLOCKED",
                "CONSOLIDATED"
            ]
        },
        "autoSubmitted":{
            "type":"boolean"
        },
        "sourceRequest":{
            "readOnly":true,
            "$ref":"#/definitions/IdNameLink"
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "viewpoints":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/IdNameLink"
            }
        },
        "incompleteSubscriptions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SubscriptionInstance"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : incompleteSubscriptions

Type: array

Show Source

Array of: object SubscriptionInstance

Subscription Instance details

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object Link

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

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 : viewpoints

Type: array

Read Only: true

Show Source

Array of: object IdNameLink

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

Nested Schema : SubscriptionInstance

Type: object

Subscription Instance details

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

Read Only: true
errors: array errors
etagValue: string
expression: object JsonNode
id: string(uuid)

Read Only: true
includedActionsText: string
inclusionProperty: object InclusionProperty
inclusionPropertyText: string
lastModifiedBy: string
links: array links

Read Only: true
message: string

Read Only: true
modifiedByUser: object User
name: string

Read Only: true
nodeConditionText: string
propertiesToMatch: array propertiesToMatch
propertiesToMatchText: string
sourceApplication: object IdNameLink
sourceDimension: object IdNameLink
sourceRequest: string(uuid)

Read Only: true
sourceView: object IdNameLink
sourceViewpoint: object IdNameLink
subscriptionStatus: string

Read Only: true

Allowed Values: [ "PROCESSED", "SKIPPED", "FAILED", "IN_PROGRESS" ]
targetApplication: object IdNameLink
targetDimension: object IdNameLink
targetRequest: string(uuid)

Read Only: true
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
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "sourceViewpoint":{
            "readOnly":true,
            "$ref":"#/definitions/IdNameLink"
        },
        "targetViewpoint":{
            "readOnly":true,
            "$ref":"#/definitions/IdNameLink"
        },
        "sourceRequest":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "targetRequest":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "subscriptionStatus":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "PROCESSED",
                "SKIPPED",
                "FAILED",
                "IN_PROGRESS"
            ]
        },
        "message":{
            "type":"string",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "errors":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Error"
            }
        },
        "sourceApplication":{
            "$ref":"#/definitions/IdNameLink"
        },
        "sourceDimension":{
            "$ref":"#/definitions/IdNameLink"
        },
        "sourceView":{
            "$ref":"#/definitions/IdNameLink"
        },
        "targetApplication":{
            "$ref":"#/definitions/IdNameLink"
        },
        "targetDimension":{
            "$ref":"#/definitions/IdNameLink"
        },
        "targetView":{
            "$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"
        },
        "etagValue":{
            "type":"string"
        }
    },
    "description":"Subscription Instance details"
}

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

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

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"
        },
        "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 : 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 : links

Type: array

Show Source

Array of: object Link

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

403 Response

Forbidden access to request

404 Response

Request not found

Examples

The following example shows how to retrieve associated request lineage for a request by submitting a GET request on the REST resource using cURL.

curl --user edmcs_cloud_user -X GET https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d692eb1c-d47b-404b-b26a-c9ee04777d5f/lineage

Example of the Response Body

The following example shows the contents of the response body in JSON format:

{
         "requestLineageNodes": [
             {
                 "id": "d692eb1c-d47b-404b-b26a-c9ee04777d5f",
                 "title": "Request 4118",
                 "origin": "INTERACTIVE",
                 "status": "COMPLETED",
                 "autoSubmitted": false,
                 "sourceRequest": null,
                 "timeCreated": "2023-02-23T20:06:03.185Z",
                 "viewpoints": [
                     {
                         "id": "f23d7770-8f32-44cd-adae-b8f3db5cd6ea",
                         "name": "NT1 hier",
                         "links": [
                             {
                                 "rel": "self",
                                 "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/86b1454d-58e8-47bb-ac08-40d62ede02b4/viewpoints/f23d7770-8f32-44cd-adae-b8f3db5cd6ea"
                             }
                         ]
                     }
                 ],
                 "links": [
                     {
                         "rel": "self",
                         "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d692eb1c-d47b-404b-b26a-c9ee04777d5f"
                     }
                 ]
             },
             {
                 "id": "c1f6774d-51ca-49cd-a4cb-b915432a704b",
                 "title": "Request 4119",
                 "origin": "SUBSCRIPTION",
                 "status": "DRAFT",
                 "autoSubmitted": false,
                 "sourceRequest": {
                     "id": "d692eb1c-d47b-404b-b26a-c9ee04777d5f",
                     "name": "Request 4118",
                     "description": "Request for aUni created by Barry Dylan.",
                     "links": [
                         {
                             "rel": "self",
                             "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d692eb1c-d47b-404b-b26a-c9ee04777d5f"
                         }
                     ]
                 },
                 "timeCreated": "2023-02-23T20:06:23.836Z",
                 "viewpoints": [
                     {
                         "id": "c543eabc-37f1-4a5e-a15d-49bff3493fd1",
                         "name": "NT1(1) list",
                         "links": [
                             {
                                 "rel": "self",
                                 "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/86b1454d-58e8-47bb-ac08-40d62ede02b4/viewpoints/c543eabc-37f1-4a5e-a15d-49bff3493fd1"
                             }
                         ]
                     }
                 ],
                 "links": [
                     {
                         "rel": "self",
                         "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/c1f6774d-51ca-49cd-a4cb-b915432a704b"
                     }
                 ]
             }
         ],
         "links": [
             {
                 "rel": "self",
                 "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests/d692eb1c-d47b-404b-b26a-c9ee04777d5f/lineage"
             }
         ],
         "subscriptionInstances": [
             {
                 "id": "11756efd-bdb5-4502-9941-cc59734e8332",
                 "name": "aUni | NT1 hier",
                 "sourceViewpoint": {
                     "id": "f23d7770-8f32-44cd-adae-b8f3db5cd6ea",
                     "name": "NT1 hier",
                     "links": [
                         {
                             "rel": "self",
                             "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/86b1454d-58e8-47bb-ac08-40d62ede02b4/viewpoints/f23d7770-8f32-44cd-adae-b8f3db5cd6ea"
                         }
                     ]
                 },
                 "targetViewpoint": {
                     "id": "c543eabc-37f1-4a5e-a15d-49bff3493fd1",
                     "name": "NT1(1) list",
                     "links": [
                         {
                             "rel": "self",
                             "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/86b1454d-58e8-47bb-ac08-40d62ede02b4/viewpoints/c543eabc-37f1-4a5e-a15d-49bff3493fd1"
                         }
                     ]
                 },
                 "sourceRequest": "d692eb1c-d47b-404b-b26a-c9ee04777d5f",
                 "targetRequest": "c1f6774d-51ca-49cd-a4cb-b915432a704b",
                 "subscriptionStatus": "PROCESSED",
                 "links": [
                     {
                         "rel": "self",
                         "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/subscriptions/11756efd-bdb5-4502-9941-cc59734e8332"
                     }
                 ]
             }
         ]
     }