Jump to

• Request
• Response

Gets a node in a specified location of a viewpoint

get

/epm/rest/v1/views/{viewId}/viewpoints/{viewpointId}/nodes/{nodeId}/locations/{location}

Request

Path Parameters

• location(required): array
  Collection Format: csv

  Pattern: .+
• nodeId(required): string(uuid)
• viewId(required): string(uuid)
• viewpointId(required): string(uuid)

Query Parameters

• expand: array[string]
  Collection Format: multi

  populates additional data within the node

  • Allowed Values: [ "propertyValues::{none", "all", "columnVisible", "locationVisible}", "requestItem.validations", "bestLocationRtl" ]

• q: string
  filters relationship

  Allowed Values: [ "request::{requestId}" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : NodeAndPropertyValues

Type: object

Show Source

• childCount: integer(int32)
• description: string
• hasChildren: boolean
• id: string(uuid)
• links: array links
• location: string
  This property is now deprecated. Use path instead.
• locationCount: integer(int32)
• name: string
• nameDefaultType: string
  Allowed Values: [ "NONE", "SPECIFIED", "SYSTEM", "DERIVED", "CALC_AND_STORE", "DERIVED_AND_STORED" ]
• nextLocation: string
• nodeType: object IdNameLink
• parentName: string
• parentNodeId: string(uuid)
• parentNodeTypeId: string(uuid)
• path: array path
• previousLocation: string
• propertyCount: integer(int32)
• propertyValues: array propertyValues
• relationshipId: string(uuid)
• requestItem: object RequestItem
  A Request Item is a collection of actions to apply to a particular node as part of aRequest
• targetForNodeProperty: boolean

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "nodeType":{
            "$ref":"#/definitions/IdNameLink"
        },
        "requestItem":{
            "readOnly":true,
            "$ref":"#/definitions/RequestItem"
        },
        "hasChildren":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "location":{
            "type":"string",
            "description":"This property is now deprecated. Use path instead."
        },
        "nameDefaultType":{
            "type":"string",
            "enum":[
                "NONE",
                "SPECIFIED",
                "SYSTEM",
                "DERIVED",
                "CALC_AND_STORE",
                "DERIVED_AND_STORED"
            ]
        },
        "path":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IdNameLink"
            }
        },
        "relationshipId":{
            "type":"string",
            "format":"uuid"
        },
        "parentNodeId":{
            "type":"string",
            "format":"uuid"
        },
        "parentName":{
            "type":"string"
        },
        "parentNodeTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "previousLocation":{
            "type":"string"
        },
        "nextLocation":{
            "type":"string"
        },
        "locationCount":{
            "type":"integer",
            "format":"int32"
        },
        "targetForNodeProperty":{
            "type":"boolean"
        },
        "childCount":{
            "type":"integer",
            "format":"int32"
        },
        "propertyValues":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PropertyValue"
            }
        },
        "propertyCount":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "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 : path

Type: array

Show Source

• Array of: object IdNameLink

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

Nested Schema : propertyValues

Type: array

Show Source

• Array of: object PropertyValue

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

Nested Schema : RequestItem

Type: object

A Request Item is a collection of actions to apply to a particular node as part of aRequest

Show Source

• actionCount: integer(int32)
• actions: array actions
• actionSummary: string
• applicationName: string
• createdBy: string
• dataSource: object IdNameLink
• deletedAsDup: boolean
• description: string
• id: string(uuid)
• links: array links
• mergeResults: array mergeResults
• modifiedBy: string
• name: string
• nodeTypeId: string(uuid)
• nodeTypeName: string
• policies: array policies
• timeCreated: integer(int64)
• timeModified: integer(int64)
• validations: array validations

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64"
        },
        "timeModified":{
            "type":"integer",
            "format":"int64"
        },
        "createdBy":{
            "type":"string"
        },
        "modifiedBy":{
            "type":"string"
        },
        "actions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Action"
            }
        },
        "actionCount":{
            "type":"integer",
            "format":"int32"
        },
        "validations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ValidationResult"
            }
        },
        "nodeTypeName":{
            "type":"string"
        },
        "nodeTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "applicationName":{
            "type":"string"
        },
        "actionSummary":{
            "type":"string"
        },
        "dataSource":{
            "$ref":"#/definitions/IdNameLink"
        },
        "mergeResults":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/MergeResultInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "policies":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyInfo"
            }
        },
        "deletedAsDup":{
            "type":"boolean"
        }
    },
    "description":"A Request Item is a collection of actions to apply to a particular node as part of aRequest"
}

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

Type: array

Show Source

• Array of: object Link

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

Nested Schema : PropertyValue

Type: object

Show Source

• displayValue: string
• labels: array labels
• links: array links
• origin: string
  Allowed Values: [ "DEFINED", "UNDEFINED", "DEFAULT", "DERIVED", "INHERITED", "DERIVED_AND_STORED" ]
• propertyId: string(uuid)
• propertyLevel: string
  Allowed Values: [ "ANY", "NODE", "RELATIONSHIP" ]
• propertyName: string
• readOnly: boolean
• requestAction: object RequestPropertyInfo
• transformedMatchValue: string
• updatedFromRequest: boolean
• usedByMatchRule: boolean
• value: string
• viewpointLabel: string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "requestAction":{
            "$ref":"#/definitions/RequestPropertyInfo"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "labels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "origin":{
            "type":"string",
            "enum":[
                "DEFINED",
                "UNDEFINED",
                "DEFAULT",
                "DERIVED",
                "INHERITED",
                "DERIVED_AND_STORED"
            ]
        },
        "displayValue":{
            "type":"string"
        },
        "propertyName":{
            "type":"string"
        },
        "propertyId":{
            "type":"string",
            "format":"uuid"
        },
        "updatedFromRequest":{
            "type":"boolean"
        },
        "usedByMatchRule":{
            "type":"boolean"
        },
        "transformedMatchValue":{
            "type":"string"
        },
        "viewpointLabel":{
            "type":"string"
        },
        "readOnly":{
            "type":"boolean"
        },
        "propertyLevel":{
            "type":"string",
            "enum":[
                "ANY",
                "NODE",
                "RELATIONSHIP"
            ]
        }
    }
}

Nested Schema : labels

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

Type: object

Show Source

• actionType: string
  Read Only: true

  Allowed Values: [ "addNode", "insertNode", "removeNode", "moveNode", "deleteNode", "renameNode", "updateNodeProp", "reorderNode" ]
• calculatedName: boolean
  Read Only: true
• committedLabels: array committedLabels
  Read Only: true
• committedValue: string
  Read Only: true
• propertyLevel: string
  Read Only: true
• validations: array validations
  Read Only: true

{
    "type":"object",
    "properties":{
        "actionType":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "addNode",
                "insertNode",
                "removeNode",
                "moveNode",
                "deleteNode",
                "renameNode",
                "updateNodeProp",
                "reorderNode"
            ]
        },
        "committedValue":{
            "type":"string",
            "readOnly":true
        },
        "committedLabels":{
            "type":"array",
            "readOnly":true,
            "items":{
                "type":"string"
            }
        },
        "propertyLevel":{
            "type":"string",
            "readOnly":true
        },
        "validations":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/ValidationResult"
            }
        },
        "calculatedName":{
            "type":"boolean",
            "readOnly":true
        }
    }
}

Nested Schema : committedLabels

Type: array

Read Only: true

Show Source

• Array of: string

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

Nested Schema : validations

Type: array

Read Only: true

Show Source

• Array of: object ValidationResult
  The result of validation

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

Nested Schema : ValidationResult

Type: object

The result of validation

Show Source

• code: string
• links: array links
• message: string
• responsibleUserId: string(uuid)
• severity: string
  Allowed Values: [ "ERROR", "WARNING", "IGNORE", "NOT_APPLICABLE" ]

  The severity of the validation issue (ERROR or WARNING) for the stage at which the validation failed.
• timeCreated: integer(int64)
• type: string
  Allowed Values: [ "ERROR" ]
• userCanResolve: boolean

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64"
        },
        "type":{
            "type":"string",
            "enum":[
                "ERROR"
            ]
        },
        "responsibleUserId":{
            "type":"string",
            "format":"uuid"
        },
        "userCanResolve":{
            "type":"boolean"
        },
        "severity":{
            "type":"string",
            "description":"The severity of the validation issue (ERROR or WARNING) for the stage at which the validation failed.",
            "enum":[
                "ERROR",
                "WARNING",
                "IGNORE",
                "NOT_APPLICABLE"
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"The result of validation"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : actions

Type: array

Show Source

• Array of: object Action

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : mergeResults

Type: array

Show Source

• Array of: object MergeResultInfo

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

Nested Schema : policies

Type: array

Show Source

• Array of: object PolicyInfo

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

Nested Schema : validations

Type: array

Show Source

• Array of: object ValidationResult
  The result of validation

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

Nested Schema : Action

Type: object

Show Source

• extendedProperties: object JsonNode
• id: string(uuid)
  Read Only: true
• layoutOptions: object layoutOptions
  Additional Properties Allowed: additionalProperties
• links: array links
• nodeTypeName: string
• parentName: string
• parentNodeId: string(uuid)
  id of the parent node this action was performed under, if any
• propertyLevel: string
• summary: string
• type: string
  Read Only: true

  Allowed Values: [ "addNode", "insertNode", "removeNode", "moveNode", "deleteNode", "renameNode", "updateNodeProp", "reorderNode" ]
• viewpointId: string(uuid)
• viewpointName: string
• viewpointUri: string
  Read Only: true

{
    "type":"object",
    "properties":{
        "layoutOptions":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "id":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "type":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "addNode",
                "insertNode",
                "removeNode",
                "moveNode",
                "deleteNode",
                "renameNode",
                "updateNodeProp",
                "reorderNode"
            ]
        },
        "viewpointUri":{
            "type":"string",
            "readOnly":true
        },
        "parentNodeId":{
            "type":"string",
            "format":"uuid",
            "description":"id of the parent node this action was performed under, if any"
        },
        "extendedProperties":{
            "description":"customizable JSON content supplied by client",
            "$ref":"#/definitions/JsonNode"
        },
        "summary":{
            "type":"string"
        },
        "viewpointId":{
            "type":"string",
            "format":"uuid"
        },
        "viewpointName":{
            "type":"string"
        },
        "nodeTypeName":{
            "type":"string"
        },
        "parentName":{
            "type":"string"
        },
        "propertyLevel":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : JsonNode

Type: object

Nested Schema : layoutOptions

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : MergeResultInfo

Type: object

Show Source

• dataSourceName: string
  Read Only: true

  The data source name of the request item.
• links: array links
  Read Only: true
• sourceNodeName: string
  Read Only: true

  The name of the source node.

{
    "type":"object",
    "properties":{
        "dataSourceName":{
            "type":"string",
            "description":"The data source name of the request item.",
            "readOnly":true
        },
        "sourceNodeName":{
            "type":"string",
            "description":"The name of the source node.",
            "readOnly":true
        },
        "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 : PolicyInfo

Type: object

Show Source

• policyId: string(uuid)
• policyType: string
  Allowed Values: [ "APPROVAL", "NOTIFY", "COMMIT" ]

{
    "type":"object",
    "properties":{
        "policyType":{
            "type":"string",
            "enum":[
                "APPROVAL",
                "NOTIFY",
                "COMMIT"
            ]
        },
        "policyId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Back to Top