Jump to

• Request
• Response
• Examples

Gets the viewpoints in the given view

get

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

Request

Path Parameters

• viewId: string(uuid)

Query Parameters

• expand(optional): array[string]
  Collection Format: multi

  Expands additional data in the viewpoint

  • Allowed Values: [ "items.related.nodeTypes", "items.related.nodeSets", "items.related.hierarchySets", "compatible.dimensions" ]

• q(optional): array[string]
  Collection Format: multi

  filters viewpoints by statuses and/or a dimension

  • Allowed Values: [ "objectStatus::{list of object statuses separated by comma}", "application::applicationId", "dimension::dimensionId", "nodeSet::nodeSetId", "nodeSet::nodeTypeId", "dimensionSectionType::{HIERARCHY", "NODE_TYPE", "MAP}", "permissions::{list of permissions separated by comma}" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : ItemsViewpoint

Type: object

Show Source

• count(optional): integer(int32)
• hasMore(optional): boolean
• items(optional): array items
  Read Only: true
• limit(optional): integer(int32)
• links(optional): array links
  Read Only: true
• offset(optional): integer(int32)
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Viewpoint"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "offset":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : items

Type: array

Read Only: true

Show Source

• Array of: object Viewpoint

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

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

Nested Schema : Viewpoint

Type: object

Show Source

• applicationLink(optional): object IdNameLink
• bindingType(optional): string
  Allowed Values: [ "BOUND", "NODE_SET_BOUND", "HIERARCHY_SET_BOUND", "NODE_TYPE_BOUND", "PARTIAL_NODE_TYPE_BOUND", "MAPPING_BOUND", "UNBOUND" ]
• blockoutConfiguration(optional): object BlockoutConfiguration
• compatibleDimensions(optional): array compatibleDimensions
  Unique Items Required: true
• completenessError(optional): string
• createdBy(optional): string
  This property is now deprecated and will be removed in 10/2020. Use createdByUser instead.
• createdByUser(optional): object User
• description(optional): string
• dimensionLink(optional): object IdNameLink
• hasHierarchy(optional): boolean
• hierarchySetLink(optional): object IdNameLink
• id(optional): string(uuid)
• isBound(optional): boolean
  Read Only: true
• label(optional): string
• layoutOptions(optional): object layoutOptions
  Additional Properties Allowed: additionalProperties
• links(optional): array links
• loadHistory(optional): array loadHistory
• modifiedBy(optional): string
  This property is now deprecated and will be removed in 10/2020. Use modifiedByUser instead.
• modifiedByUser(optional): object User
• name(optional): string
• nodeSetLink(optional): object IdNameLink
• nodeTypeAssignments(optional): array nodeTypeAssignments
• objectStatus(optional): string
  Allowed Values: [ "DRAFT", "ACTIVE", "SUNSET", "ARCHIVED", "DELETED" ]
• permittedActions(optional): array permittedActions
  Unique Items Required: true
• properties(optional): array properties
• propertiesByNodeType(optional): array propertiesByNodeType
• propertyOverrides(optional): object propertyOverrides
  Additional Properties Allowed: ViewpointPropertyOverride
• related(optional): object Related
• scope(optional): string
  Allowed Values: [ "MASTER", "APPLICATION" ]
• sortOrder(optional): integer(int32)
• timeCreated(optional): integer(int64)
• timeLabel(optional): object IdNameDescription
• timeLabelUri(optional): string
• timeModified(optional): integer(int64)
• usesCustomSortOrder(optional): boolean
• viewDescription(optional): string
• viewId(optional): string(uuid)
• viewName(optional): string
• viewpointClass(optional): string
  Allowed Values: [ "NORMAL", "TIME_LABELED" ]
• viewStatus(optional): string
  Allowed Values: [ "DRAFT", "ACTIVE", "SUNSET", "ARCHIVED", "DELETED" ]

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "label":{
            "type":"string"
        },
        "layoutOptions":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "hasHierarchy":{
            "type":"boolean"
        },
        "scope":{
            "type":"string",
            "enum":[
                "MASTER",
                "APPLICATION"
            ]
        },
        "createdBy":{
            "type":"string",
            "description":"This property is now deprecated and will be removed in 10/2020. Use createdByUser instead."
        },
        "modifiedBy":{
            "type":"string",
            "description":"This property is now deprecated and will be removed in 10/2020. Use modifiedByUser instead."
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64"
        },
        "timeModified":{
            "type":"integer",
            "format":"int64"
        },
        "sortOrder":{
            "type":"integer",
            "format":"int32"
        },
        "objectStatus":{
            "type":"string",
            "enum":[
                "DRAFT",
                "ACTIVE",
                "SUNSET",
                "ARCHIVED",
                "DELETED"
            ]
        },
        "nodeSetLink":{
            "$ref":"#/definitions/IdNameLink"
        },
        "hierarchySetLink":{
            "$ref":"#/definitions/IdNameLink"
        },
        "applicationLink":{
            "$ref":"#/definitions/IdNameLink"
        },
        "bindingType":{
            "type":"string",
            "enum":[
                "BOUND",
                "NODE_SET_BOUND",
                "HIERARCHY_SET_BOUND",
                "NODE_TYPE_BOUND",
                "PARTIAL_NODE_TYPE_BOUND",
                "MAPPING_BOUND",
                "UNBOUND"
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "permittedActions":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "enum":[
                    "CREATE_CONSTRAINT",
                    "CREATE_NODETYPE",
                    "CREATE_HIERARCHYSET",
                    "CREATE_NODESET",
                    "CREATE_VIEWPOINT",
                    "CREATE_REQUEST",
                    "CREATE_PROPERTY",
                    "ASSIGN_REQUEST",
                    "SUBMIT_REQUEST",
                    "PUSHBACK_REQUEST",
                    "REJECT_REQUEST",
                    "APPROVE_REQUEST",
                    "WITHDRAW_REQUEST",
                    "COMMIT_REQUEST",
                    "ADD_REQUEST_COMMENT",
                    "ADD_REQUEST_ATTACHMENT",
                    "EDIT_REQUEST_HEADER",
                    "VALIDATE",
                    "EDIT_METADATA",
                    "REINDEX",
                    "EDIT",
                    "COPY_VIEWPOINT",
                    "LOAD_VIEWPOINT",
                    "ARCHIVE",
                    "DELETE",
                    "IMPORT",
                    "EXPORT",
                    "MANAGE_GRANTS",
                    "DELETE_NODE",
                    "ADD_NODE",
                    "INSERT_NODE",
                    "REORDER_NODE",
                    "REMOVE_NODE",
                    "MOVE_NODE",
                    "RECALL_REQUEST",
                    "COPY_EXTRACT",
                    "UPDATE_VISIBILITY",
                    "COPY",
                    "QUERY",
                    "RUN_EXTRACT_PACKAGE",
                    "CREATE_EXTRACT_PACKAGE"
                ]
            }
        },
        "viewId":{
            "type":"string",
            "format":"uuid"
        },
        "viewName":{
            "type":"string"
        },
        "viewDescription":{
            "type":"string"
        },
        "viewStatus":{
            "type":"string",
            "enum":[
                "DRAFT",
                "ACTIVE",
                "SUNSET",
                "ARCHIVED",
                "DELETED"
            ]
        },
        "properties":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Property"
            }
        },
        "propertyOverrides":{
            "type":"object",
            "additionalProperties":{
                "$ref":"#/definitions/ViewpointPropertyOverride"
            }
        },
        "nodeTypeAssignments":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NodeTypeAssignment"
            }
        },
        "propertiesByNodeType":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NodeTypeProperties"
            }
        },
        "related":{
            "$ref":"#/definitions/Related"
        },
        "completenessError":{
            "type":"string"
        },
        "dimensionLink":{
            "$ref":"#/definitions/IdNameLink"
        },
        "compatibleDimensions":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string"
            }
        },
        "createdByUser":{
            "$ref":"#/definitions/User"
        },
        "modifiedByUser":{
            "$ref":"#/definitions/User"
        },
        "blockoutConfiguration":{
            "$ref":"#/definitions/BlockoutConfiguration"
        },
        "loadHistory":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ViewpointLoadHistory"
            }
        },
        "viewpointClass":{
            "type":"string",
            "enum":[
                "NORMAL",
                "TIME_LABELED"
            ]
        },
        "timeLabel":{
            "$ref":"#/definitions/IdNameDescription"
        },
        "timeLabelUri":{
            "type":"string"
        },
        "isBound":{
            "type":"boolean",
            "readOnly":true
        },
        "usesCustomSortOrder":{
            "type":"boolean"
        }
    }
}

Nested Schema : IdNameLink

Type: object

Show Source

• description(optional): string
  Read Only: true
• id(optional): string(uuid)
• links(optional): array links
• name(optional): 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 : BlockoutConfiguration

Type: object

Show Source

• enableBlockout(optional): boolean
• end(optional): integer(int64)
• grantPermissionsAllowedToCommit(optional): array grantPermissionsAllowedToCommit
• lockUnboundObjects(optional): boolean
• recurringBlockoutData(optional): object RecurringBlockoutData
• source(optional): string
  Allowed Values: [ "APPLICATION", "DIMENSION" ]
• start(optional): integer(int64)
• timeZone(optional): object ZoneId
• type(optional): string
  Allowed Values: [ "SPECIFIED", "RECURRING" ]

{
    "type":"object",
    "properties":{
        "start":{
            "type":"integer",
            "format":"int64"
        },
        "end":{
            "type":"integer",
            "format":"int64"
        },
        "lockUnboundObjects":{
            "type":"boolean"
        },
        "grantPermissionsAllowedToCommit":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "OWNER",
                    "DATAMANAGER",
                    "PARTICIPANT",
                    "APPROVER",
                    "NOTIFIED",
                    "COMMITTER",
                    "NONE",
                    "METADATAMANAGER"
                ]
            }
        },
        "enableBlockout":{
            "type":"boolean"
        },
        "type":{
            "type":"string",
            "enum":[
                "SPECIFIED",
                "RECURRING"
            ]
        },
        "timeZone":{
            "$ref":"#/definitions/ZoneId"
        },
        "recurringBlockoutData":{
            "$ref":"#/definitions/RecurringBlockoutData"
        },
        "source":{
            "type":"string",
            "enum":[
                "APPLICATION",
                "DIMENSION"
            ]
        }
    }
}

Nested Schema : compatibleDimensions

Type: array

Unique Items Required: true

Show Source

• Array of: string

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

Nested Schema : User

Type: object

Show Source

• artifactAssignments(optional): array artifactAssignments
• associatedRoles(optional): array associatedRoles
• dataManagerOnAny(optional): boolean
• emailAddresses(optional): array emailAddresses
• epmIdleSessionTimeout(optional): integer(int32)
• firstName(optional): string
• fullName(optional): string
• grantPermission(optional): string
  Allowed Values: [ "OWNER", "DATAMANAGER", "PARTICIPANT", "APPROVER", "NOTIFIED", "COMMITTER", "NONE", "METADATAMANAGER" ]
• homePageLayoutName(optional): string
• id(optional): string(uuid)
• lastName(optional): string
• links(optional): array links
• nameInitials(optional): string
• preferences(optional): object Preferences
• ssoToken(optional): string
• userName(optional): 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 : 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 : loadHistory

Type: array

Show Source

• Array of: object ViewpointLoadHistory

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

Nested Schema : nodeTypeAssignments

Type: array

Show Source

• Array of: object NodeTypeAssignment

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

Nested Schema : permittedActions

Type: array

Unique Items Required: true

Show Source

• Array of: string
  Allowed Values: [ "CREATE_CONSTRAINT", "CREATE_NODETYPE", "CREATE_HIERARCHYSET", "CREATE_NODESET", "CREATE_VIEWPOINT", "CREATE_REQUEST", "CREATE_PROPERTY", "ASSIGN_REQUEST", "SUBMIT_REQUEST", "PUSHBACK_REQUEST", "REJECT_REQUEST", "APPROVE_REQUEST", "WITHDRAW_REQUEST", "COMMIT_REQUEST", "ADD_REQUEST_COMMENT", "ADD_REQUEST_ATTACHMENT", "EDIT_REQUEST_HEADER", "VALIDATE", "EDIT_METADATA", "REINDEX", "EDIT", "COPY_VIEWPOINT", "LOAD_VIEWPOINT", "ARCHIVE", "DELETE", "IMPORT", "EXPORT", "MANAGE_GRANTS", "DELETE_NODE", "ADD_NODE", "INSERT_NODE", "REORDER_NODE", "REMOVE_NODE", "MOVE_NODE", "RECALL_REQUEST", "COPY_EXTRACT", "UPDATE_VISIBILITY", "COPY", "QUERY", "RUN_EXTRACT_PACKAGE", "CREATE_EXTRACT_PACKAGE" ]

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"string",
        "enum":[
            "CREATE_CONSTRAINT",
            "CREATE_NODETYPE",
            "CREATE_HIERARCHYSET",
            "CREATE_NODESET",
            "CREATE_VIEWPOINT",
            "CREATE_REQUEST",
            "CREATE_PROPERTY",
            "ASSIGN_REQUEST",
            "SUBMIT_REQUEST",
            "PUSHBACK_REQUEST",
            "REJECT_REQUEST",
            "APPROVE_REQUEST",
            "WITHDRAW_REQUEST",
            "COMMIT_REQUEST",
            "ADD_REQUEST_COMMENT",
            "ADD_REQUEST_ATTACHMENT",
            "EDIT_REQUEST_HEADER",
            "VALIDATE",
            "EDIT_METADATA",
            "REINDEX",
            "EDIT",
            "COPY_VIEWPOINT",
            "LOAD_VIEWPOINT",
            "ARCHIVE",
            "DELETE",
            "IMPORT",
            "EXPORT",
            "MANAGE_GRANTS",
            "DELETE_NODE",
            "ADD_NODE",
            "INSERT_NODE",
            "REORDER_NODE",
            "REMOVE_NODE",
            "MOVE_NODE",
            "RECALL_REQUEST",
            "COPY_EXTRACT",
            "UPDATE_VISIBILITY",
            "COPY",
            "QUERY",
            "RUN_EXTRACT_PACKAGE",
            "CREATE_EXTRACT_PACKAGE"
        ]
    }
}

Nested Schema : properties

Type: array

Show Source

• Array of: object Property

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

Nested Schema : propertiesByNodeType

Type: array

Show Source

• Array of: object NodeTypeProperties

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

Nested Schema : propertyOverrides

Type: object

Additional Properties Allowed

Show Source

• object ViewpointPropertyOverride

{
    "type":"object",
    "additionalProperties":{
        "$ref":"#/definitions/ViewpointPropertyOverride"
    }
}

Nested Schema : Related

Type: object

Show Source

• hierarchySets(optional): array hierarchySets
  Unique Items Required: true
• nodeSets(optional): array nodeSets
  Unique Items Required: true
• nodeTypes(optional): array nodeTypes
  Unique Items Required: true
• viewpoints(optional): array viewpoints
  Unique Items Required: true

{
    "type":"object",
    "properties":{
        "nodeTypes":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/NodeType"
            }
        },
        "nodeSets":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/NodeSet"
            }
        },
        "viewpoints":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/Viewpoint"
            }
        },
        "hierarchySets":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/HierarchySet"
            }
        }
    }
}

Nested Schema : IdNameDescription

Type: object

Show Source

• description(optional): string
• id(optional): string(uuid)
• name(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "description":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• method(optional): string
• rel(optional): string
• templated(optional): boolean

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

Nested Schema : grantPermissionsAllowedToCommit

Type: array

Show Source

• Array of: string
  Allowed Values: [ "OWNER", "DATAMANAGER", "PARTICIPANT", "APPROVER", "NOTIFIED", "COMMITTER", "NONE", "METADATAMANAGER" ]

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "OWNER",
            "DATAMANAGER",
            "PARTICIPANT",
            "APPROVER",
            "NOTIFIED",
            "COMMITTER",
            "NONE",
            "METADATAMANAGER"
        ]
    }
}

Nested Schema : RecurringBlockoutData

Type: object

Show Source

• beginOffset(optional): integer(int32)
• end(optional): integer(int64)
• endOffset(optional): integer(int32)
• rollingUnit(optional): string
  Allowed Values: [ "NONE", "END_OF_MONTH", "END_OF_YEAR", "END_OF_QUARTER", "FISCAL_QUARTER_END", "FISCAL_YEAR_END" ]
• start(optional): integer(int64)
• timeOfDay(optional): string

{
    "type":"object",
    "properties":{
        "beginOffset":{
            "type":"integer",
            "format":"int32"
        },
        "endOffset":{
            "type":"integer",
            "format":"int32"
        },
        "rollingUnit":{
            "type":"string",
            "enum":[
                "NONE",
                "END_OF_MONTH",
                "END_OF_YEAR",
                "END_OF_QUARTER",
                "FISCAL_QUARTER_END",
                "FISCAL_YEAR_END"
            ]
        },
        "timeOfDay":{
            "type":"string"
        },
        "start":{
            "type":"integer",
            "format":"int64"
        },
        "end":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : ZoneId

Type: object

Show Source

• id(optional): string
• rules(optional): object ZoneRules

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "rules":{
            "$ref":"#/definitions/ZoneRules"
        }
    }
}

Nested Schema : ZoneRules

Type: object

Show Source

• fixedOffset(optional): boolean
• transitionRules(optional): array transitionRules
• transitions(optional): array transitions

{
    "type":"object",
    "properties":{
        "transitionRules":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ZoneOffsetTransitionRule"
            }
        },
        "transitions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ZoneOffsetTransition"
            }
        },
        "fixedOffset":{
            "type":"boolean"
        }
    }
}

Nested Schema : transitionRules

Type: array

Show Source

• Array of: object ZoneOffsetTransitionRule

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

Nested Schema : transitions

Type: array

Show Source

• Array of: object ZoneOffsetTransition

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

Nested Schema : ZoneOffsetTransitionRule

Type: object

Show Source

• dayOfMonthIndicator(optional): integer(int32)
• dayOfWeek(optional): string
  Allowed Values: [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]
• localTime(optional): object LocalTime
• midnightEndOfDay(optional): boolean
• month(optional): string
  Allowed Values: [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]
• offsetAfter(optional): object ZoneOffset
• offsetBefore(optional): object ZoneOffset
• standardOffset(optional): object ZoneOffset
• timeDefinition(optional): string
  Allowed Values: [ "UTC", "WALL", "STANDARD" ]

{
    "type":"object",
    "properties":{
        "month":{
            "type":"string",
            "enum":[
                "JANUARY",
                "FEBRUARY",
                "MARCH",
                "APRIL",
                "MAY",
                "JUNE",
                "JULY",
                "AUGUST",
                "SEPTEMBER",
                "OCTOBER",
                "NOVEMBER",
                "DECEMBER"
            ]
        },
        "timeDefinition":{
            "type":"string",
            "enum":[
                "UTC",
                "WALL",
                "STANDARD"
            ]
        },
        "standardOffset":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "offsetBefore":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "offsetAfter":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "dayOfWeek":{
            "type":"string",
            "enum":[
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY",
                "SATURDAY",
                "SUNDAY"
            ]
        },
        "dayOfMonthIndicator":{
            "type":"integer",
            "format":"int32"
        },
        "localTime":{
            "$ref":"#/definitions/LocalTime"
        },
        "midnightEndOfDay":{
            "type":"boolean"
        }
    }
}

Nested Schema : LocalTime

Type: object

Show Source

• hour(optional): integer(int32)
• minute(optional): integer(int32)
• nano(optional): integer(int32)
• second(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "hour":{
            "type":"integer",
            "format":"int32"
        },
        "minute":{
            "type":"integer",
            "format":"int32"
        },
        "second":{
            "type":"integer",
            "format":"int32"
        },
        "nano":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : ZoneOffset

Type: object

Show Source

• id(optional): string
• rules(optional): object ZoneRules
• totalSeconds(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalSeconds":{
            "type":"integer",
            "format":"int32"
        },
        "id":{
            "type":"string"
        },
        "rules":{
            "$ref":"#/definitions/ZoneRules"
        }
    }
}

Nested Schema : ZoneOffsetTransition

Type: object

Show Source

• dateTimeAfter(optional): string(date-time)
• dateTimeBefore(optional): string(date-time)
• duration(optional): object Duration
• gap(optional): boolean
• instant(optional): integer(int64)
• offsetAfter(optional): object ZoneOffset
• offsetBefore(optional): object ZoneOffset
• overlap(optional): boolean

{
    "type":"object",
    "properties":{
        "offsetBefore":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "offsetAfter":{
            "$ref":"#/definitions/ZoneOffset"
        },
        "duration":{
            "$ref":"#/definitions/Duration"
        },
        "dateTimeBefore":{
            "type":"string",
            "format":"date-time"
        },
        "instant":{
            "type":"integer",
            "format":"int64"
        },
        "gap":{
            "type":"boolean"
        },
        "overlap":{
            "type":"boolean"
        },
        "dateTimeAfter":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : Duration

Type: object

Show Source

• nano(optional): integer(int32)
• negative(optional): boolean
• seconds(optional): integer(int64)
• units(optional): array units
• zero(optional): boolean

{
    "type":"object",
    "properties":{
        "seconds":{
            "type":"integer",
            "format":"int64"
        },
        "nano":{
            "type":"integer",
            "format":"int32"
        },
        "negative":{
            "type":"boolean"
        },
        "zero":{
            "type":"boolean"
        },
        "units":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/TemporalUnit"
            }
        }
    }
}

Nested Schema : units

Type: array

Show Source

• Array of: object TemporalUnit

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

Nested Schema : TemporalUnit

Type: object

Show Source

• dateBased(optional): boolean
• duration(optional): object Duration
• durationEstimated(optional): boolean
• timeBased(optional): boolean

{
    "type":"object",
    "properties":{
        "duration":{
            "$ref":"#/definitions/Duration"
        },
        "timeBased":{
            "type":"boolean"
        },
        "dateBased":{
            "type":"boolean"
        },
        "durationEstimated":{
            "type":"boolean"
        }
    }
}

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(optional): string
• links(optional): array links
• outOfOffice(optional): boolean
• profilePictureId(optional): string(uuid)
• timeZone(optional): 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(optional): object Artifact
• sortOrder(optional): integer(int32)
• visible(optional): boolean

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

Nested Schema : Artifact

Type: object

Show Source

• id(optional): string(uuid)
• name(optional): string
• type(optional): 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(optional): string
• name(optional): 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(optional): string
• dstsavings(optional): integer(int32)
• id(optional): string
• rawOffset(optional): integer(int32)

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

Nested Schema : ViewpointLoadHistory

Type: object

Show Source

• connectionId(optional): string(uuid)
• connectionName(optional): string
• endTime(optional): integer(int64)
• importOption(optional): string
  Allowed Values: [ "ResetDimension", "ReplaceNodes", "Merge" ]
• links(optional): array links
• loadId(optional): string(uuid)
• messages(optional): array messages
• ranBy(optional): string
• startTime(optional): integer(int64)
• status(optional): string
  Allowed Values: [ "PENDING", "COMPLETED", "ERROR", "RUNNING" ]
• syncDescription(optional): string
• syncId(optional): string(uuid)

{
    "type":"object",
    "properties":{
        "syncId":{
            "type":"string",
            "format":"uuid"
        },
        "loadId":{
            "type":"string",
            "format":"uuid"
        },
        "connectionId":{
            "type":"string",
            "format":"uuid"
        },
        "syncDescription":{
            "type":"string"
        },
        "ranBy":{
            "type":"string"
        },
        "startTime":{
            "type":"integer",
            "format":"int64"
        },
        "endTime":{
            "type":"integer",
            "format":"int64"
        },
        "importOption":{
            "type":"string",
            "enum":[
                "ResetDimension",
                "ReplaceNodes",
                "Merge"
            ]
        },
        "status":{
            "type":"string",
            "enum":[
                "PENDING",
                "COMPLETED",
                "ERROR",
                "RUNNING"
            ]
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "connectionName":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : messages

Type: array

Show Source

• Array of: string

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

Nested Schema : NodeTypeAssignment

Type: object

Show Source

• allowedActions(optional): object AllowedActions
• nodeTypeId(optional): string(uuid)
• propertyOverrides(optional): array propertyOverrides
• relatedViewpoints(optional): array relatedViewpoints
  Unique Items Required: true

{
    "type":"object",
    "properties":{
        "nodeTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "allowedActions":{
            "$ref":"#/definitions/AllowedActions"
        },
        "propertyOverrides":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PropertyOverride"
            }
        },
        "relatedViewpoints":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    }
}

Nested Schema : AllowedActions

Type: object

Show Source

• add(optional): boolean
• delete(optional): boolean
• insert(optional): boolean
• move(optional): boolean
• remove(optional): boolean
• reorder(optional): boolean

{
    "type":"object",
    "properties":{
        "add":{
            "type":"boolean"
        },
        "insert":{
            "type":"boolean"
        },
        "move":{
            "type":"boolean"
        },
        "remove":{
            "type":"boolean"
        },
        "delete":{
            "type":"boolean"
        },
        "reorder":{
            "type":"boolean"
        }
    }
}

Nested Schema : propertyOverrides

Type: array

Show Source

• Array of: object PropertyOverride

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

Nested Schema : relatedViewpoints

Type: array

Unique Items Required: true

Show Source

• Array of: string(uuid)

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Nested Schema : PropertyOverride

Type: object

Show Source

• displayAsColumn(optional): boolean
• displayForLocations(optional): boolean
• instructions(optional): string
• label(optional): string
• sortOrder(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "label":{
            "type":"string"
        },
        "instructions":{
            "type":"string"
        },
        "sortOrder":{
            "type":"integer",
            "format":"int32"
        },
        "displayAsColumn":{
            "type":"boolean"
        },
        "displayForLocations":{
            "type":"boolean"
        }
    }
}

Nested Schema : Property

Type: object

Show Source

• aggregateDefaultType(optional): string
  Read Only: true
• aggregateInheritanceMode(optional): string
  Read Only: true

  Allowed Values: [ "NONE", "POSITIONAL" ]
• allowBlankEntry(optional): boolean
  Read Only: true
• allowedValues(optional): array allowedValues
  Read Only: true
• allowedValuesUsed(optional): boolean
  Read Only: true
• dataType(optional): string
  Read Only: true
• defaultOnly(optional): boolean
  Read Only: true
• defaultType(optional): string
  Read Only: true
• defaultValue(optional): object defaultValue
  Read Only: true
• description(optional): string
• hasDerivedOverride(optional): boolean
• id(optional): string(uuid)
  Read Only: true
• inheritanceMode(optional): string
  Read Only: true

  Allowed Values: [ "NONE", "POSITIONAL" ]
• isValidForConstraint(optional): boolean
  Read Only: true
• level(optional): string
  Read Only: true
• links(optional): array links
  Read Only: true
• name(optional): string
• namespace(optional): string
  Read Only: true
• overrides(optional): array overrides
• parameters(optional): array parameters
  Read Only: true
• permittedActions(optional): array permittedActions
  Unique Items Required: true
• sortOrder(optional): integer(int32)
  Read Only: true
• templateMode(optional): string
  Read Only: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "namespace":{
            "type":"string",
            "readOnly":true
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "dataType":{
            "type":"string",
            "readOnly":true
        },
        "defaultType":{
            "type":"string",
            "readOnly":true
        },
        "aggregateDefaultType":{
            "type":"string",
            "readOnly":true
        },
        "defaultOnly":{
            "type":"boolean",
            "readOnly":true
        },
        "defaultValue":{
            "type":"object",
            "readOnly":true
        },
        "inheritanceMode":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "NONE",
                "POSITIONAL"
            ]
        },
        "aggregateInheritanceMode":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "NONE",
                "POSITIONAL"
            ]
        },
        "hasDerivedOverride":{
            "type":"boolean"
        },
        "allowedValuesUsed":{
            "type":"boolean",
            "readOnly":true
        },
        "allowBlankEntry":{
            "type":"boolean",
            "readOnly":true
        },
        "allowedValues":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/AllowedPropertyValue"
            }
        },
        "parameters":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/PropertyParameterValue"
            }
        },
        "sortOrder":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "level":{
            "type":"string",
            "readOnly":true
        },
        "templateMode":{
            "type":"string",
            "readOnly":true
        },
        "isValidForConstraint":{
            "type":"boolean",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "permittedActions":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "enum":[
                    "CREATE_CONSTRAINT",
                    "CREATE_NODETYPE",
                    "CREATE_HIERARCHYSET",
                    "CREATE_NODESET",
                    "CREATE_VIEWPOINT",
                    "CREATE_REQUEST",
                    "CREATE_PROPERTY",
                    "ASSIGN_REQUEST",
                    "SUBMIT_REQUEST",
                    "PUSHBACK_REQUEST",
                    "REJECT_REQUEST",
                    "APPROVE_REQUEST",
                    "WITHDRAW_REQUEST",
                    "COMMIT_REQUEST",
                    "ADD_REQUEST_COMMENT",
                    "ADD_REQUEST_ATTACHMENT",
                    "EDIT_REQUEST_HEADER",
                    "VALIDATE",
                    "EDIT_METADATA",
                    "REINDEX",
                    "EDIT",
                    "COPY_VIEWPOINT",
                    "LOAD_VIEWPOINT",
                    "ARCHIVE",
                    "DELETE",
                    "IMPORT",
                    "EXPORT",
                    "MANAGE_GRANTS",
                    "DELETE_NODE",
                    "ADD_NODE",
                    "INSERT_NODE",
                    "REORDER_NODE",
                    "REMOVE_NODE",
                    "MOVE_NODE",
                    "RECALL_REQUEST",
                    "COPY_EXTRACT",
                    "UPDATE_VISIBILITY",
                    "COPY",
                    "QUERY",
                    "RUN_EXTRACT_PACKAGE",
                    "CREATE_EXTRACT_PACKAGE"
                ]
            }
        },
        "overrides":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ApplicationOverride"
            }
        }
    }
}

Nested Schema : allowedValues

Type: array

Read Only: true

Show Source

• Array of: object AllowedPropertyValue

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

Nested Schema : defaultValue

Type: object

Read Only: 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 : overrides

Type: array

Show Source

• Array of: object ApplicationOverride

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

Nested Schema : parameters

Type: array

Read Only: true

Show Source

• Array of: object PropertyParameterValue

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

Nested Schema : permittedActions

Type: array

Unique Items Required: true

Show Source

• Array of: string
  Allowed Values: [ "CREATE_CONSTRAINT", "CREATE_NODETYPE", "CREATE_HIERARCHYSET", "CREATE_NODESET", "CREATE_VIEWPOINT", "CREATE_REQUEST", "CREATE_PROPERTY", "ASSIGN_REQUEST", "SUBMIT_REQUEST", "PUSHBACK_REQUEST", "REJECT_REQUEST", "APPROVE_REQUEST", "WITHDRAW_REQUEST", "COMMIT_REQUEST", "ADD_REQUEST_COMMENT", "ADD_REQUEST_ATTACHMENT", "EDIT_REQUEST_HEADER", "VALIDATE", "EDIT_METADATA", "REINDEX", "EDIT", "COPY_VIEWPOINT", "LOAD_VIEWPOINT", "ARCHIVE", "DELETE", "IMPORT", "EXPORT", "MANAGE_GRANTS", "DELETE_NODE", "ADD_NODE", "INSERT_NODE", "REORDER_NODE", "REMOVE_NODE", "MOVE_NODE", "RECALL_REQUEST", "COPY_EXTRACT", "UPDATE_VISIBILITY", "COPY", "QUERY", "RUN_EXTRACT_PACKAGE", "CREATE_EXTRACT_PACKAGE" ]

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"string",
        "enum":[
            "CREATE_CONSTRAINT",
            "CREATE_NODETYPE",
            "CREATE_HIERARCHYSET",
            "CREATE_NODESET",
            "CREATE_VIEWPOINT",
            "CREATE_REQUEST",
            "CREATE_PROPERTY",
            "ASSIGN_REQUEST",
            "SUBMIT_REQUEST",
            "PUSHBACK_REQUEST",
            "REJECT_REQUEST",
            "APPROVE_REQUEST",
            "WITHDRAW_REQUEST",
            "COMMIT_REQUEST",
            "ADD_REQUEST_COMMENT",
            "ADD_REQUEST_ATTACHMENT",
            "EDIT_REQUEST_HEADER",
            "VALIDATE",
            "EDIT_METADATA",
            "REINDEX",
            "EDIT",
            "COPY_VIEWPOINT",
            "LOAD_VIEWPOINT",
            "ARCHIVE",
            "DELETE",
            "IMPORT",
            "EXPORT",
            "MANAGE_GRANTS",
            "DELETE_NODE",
            "ADD_NODE",
            "INSERT_NODE",
            "REORDER_NODE",
            "REMOVE_NODE",
            "MOVE_NODE",
            "RECALL_REQUEST",
            "COPY_EXTRACT",
            "UPDATE_VISIBILITY",
            "COPY",
            "QUERY",
            "RUN_EXTRACT_PACKAGE",
            "CREATE_EXTRACT_PACKAGE"
        ]
    }
}

Nested Schema : AllowedPropertyValue

Type: object

Show Source

• label(optional): string
  Read Only: true
• value(optional): object value
  Read Only: true

{
    "type":"object",
    "properties":{
        "value":{
            "type":"object",
            "readOnly":true
        },
        "label":{
            "type":"string",
            "readOnly":true
        }
    }
}

Nested Schema : value

Type: object

Read Only: true

Nested Schema : ApplicationOverride

Type: object

Show Source

• allowBlankEntry(optional): boolean
  Read Only: true
• allowedPropertyValues(optional): array allowedPropertyValues
• allowedValuesUsed(optional): boolean
  Read Only: true
• application(optional): object IdNameLink
• defaultOnly(optional): boolean
  Read Only: true
• defaultType(optional): string
  Read Only: true

  Allowed Values: [ "NONE", "SPECIFIED", "SYSTEM", "DERIVED", "CALC_AND_STORE", "DERIVED_AND_STORED" ]
• defaultValue(optional): object defaultValue
  Read Only: true
• inheritanceMode(optional): string
  Read Only: true

  Allowed Values: [ "NONE", "POSITIONAL" ]
• links(optional): array links
  Read Only: true
• lockOnCommit(optional): boolean
  Read Only: true
• nodeTypeOverrides(optional): array nodeTypeOverrides
  Read Only: true
• parameterValues(optional): array parameterValues

{
    "type":"object",
    "properties":{
        "defaultValue":{
            "type":"object",
            "readOnly":true
        },
        "defaultType":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "NONE",
                "SPECIFIED",
                "SYSTEM",
                "DERIVED",
                "CALC_AND_STORE",
                "DERIVED_AND_STORED"
            ]
        },
        "defaultOnly":{
            "type":"boolean",
            "readOnly":true
        },
        "inheritanceMode":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "NONE",
                "POSITIONAL"
            ]
        },
        "allowedValuesUsed":{
            "type":"boolean",
            "readOnly":true
        },
        "allowBlankEntry":{
            "type":"boolean",
            "readOnly":true
        },
        "lockOnCommit":{
            "type":"boolean",
            "readOnly":true
        },
        "application":{
            "readOnly":true,
            "$ref":"#/definitions/IdNameLink"
        },
        "nodeTypeOverrides":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/NodeTypeOverride"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "allowedPropertyValues":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AllowedPropertyValue"
            }
        },
        "parameterValues":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PropertyParameterValue"
            }
        }
    }
}

Nested Schema : allowedPropertyValues

Type: array

Show Source

• Array of: object AllowedPropertyValue

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

Nested Schema : defaultValue

Type: object

Read Only: 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 : nodeTypeOverrides

Type: array

Read Only: true

Show Source

• Array of: object NodeTypeOverride

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

Nested Schema : parameterValues

Type: array

Show Source

• Array of: object PropertyParameterValue

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

Nested Schema : NodeTypeOverride

Type: object

Show Source

• dimensionName(optional): string
  Read Only: true
• nodeType(optional): object IdNameLink
• parameterValues(optional): array parameterValues

{
    "type":"object",
    "properties":{
        "nodeType":{
            "readOnly":true,
            "$ref":"#/definitions/IdNameLink"
        },
        "dimensionName":{
            "type":"string",
            "readOnly":true
        },
        "parameterValues":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PropertyNodeTypeOverrideValue"
            }
        }
    }
}

Nested Schema : parameterValues

Type: array

Show Source

• Array of: object PropertyNodeTypeOverrideValue

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

Nested Schema : PropertyNodeTypeOverrideValue

Type: object

Show Source

• description(optional): string
• id(optional): string
• labels(optional): array labels
• name(optional): string
• value(optional): object value

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "value":{
            "type":"object"
        },
        "labels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : labels

Type: array

Show Source

• Array of: string

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

Nested Schema : value

Type: object

Nested Schema : PropertyParameterValue

Type: object

Show Source

• description(optional): string
• id(optional): string
• labels(optional): array labels
• name(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "labels":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : labels

Type: array

Show Source

• Array of: string

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

Nested Schema : NodeTypeProperties

Type: object

Show Source

• nodeTypeUri(optional): string
• propertyIds(optional): array propertyIds
  Unique Items Required: true

{
    "type":"object",
    "properties":{
        "nodeTypeUri":{
            "type":"string"
        },
        "propertyIds":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : propertyIds

Type: array

Unique Items Required: true

Show Source

• Array of: string

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

Nested Schema : ViewpointPropertyOverride

Type: object

Show Source

• displayAsColumn(optional): boolean
• displayForLocations(optional): boolean
  Read Only: true
• instructions(optional): string
• label(optional): string
• propertyId(optional): string(uuid)
• propertyUri(optional): string
  Read Only: true
• sortOrder(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "propertyUri":{
            "type":"string",
            "readOnly":true
        },
        "label":{
            "type":"string"
        },
        "propertyId":{
            "type":"string",
            "format":"uuid"
        },
        "instructions":{
            "type":"string"
        },
        "sortOrder":{
            "type":"integer",
            "format":"int32"
        },
        "displayAsColumn":{
            "type":"boolean"
        },
        "displayForLocations":{
            "type":"boolean",
            "readOnly":true
        }
    }
}

Nested Schema : hierarchySets

Type: array

Unique Items Required: true

Show Source

• Array of: object HierarchySet
  Hierarchy Set model that would be returned as response

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/HierarchySet"
    }
}

Nested Schema : nodeSets

Type: array

Unique Items Required: true

Show Source

• Array of: object NodeSet
  Node Set model that would be returned as response

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/NodeSet"
    }
}

Nested Schema : nodeTypes

Type: array

Unique Items Required: true

Show Source

• Array of: object NodeType

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/NodeType"
    }
}

Nested Schema : viewpoints

Type: array

Unique Items Required: true

Show Source

• Array of: object Viewpoint

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/Viewpoint"
    }
}

Nested Schema : HierarchySet

Type: object

Hierarchy Set model that would be returned as response

Show Source

• allowSharedNodes(optional): boolean
• application(optional): object Application
• assignedNodeTypes(optional): array assignedNodeTypes
• bindingType(optional): string
  Allowed Values: [ "BOUND", "NODE_SET_BOUND", "HIERARCHY_SET_BOUND", "NODE_TYPE_BOUND", "PARTIAL_NODE_TYPE_BOUND", "MAPPING_BOUND", "UNBOUND" ]
• bottomNodeSort(optional): string
  Allowed Values: [ "ALPHANUMERIC", "CUSTOM" ]
• completenessError(optional): string
• createdByUser(optional): object User
• description(optional): string
• dimension(optional): object Dimension
  Dimension model that would be returned as response
• dimensionSectionAllowedSharedNodes(optional): boolean
• groupingType(optional): string
  Allowed Values: [ "DEFAULT", "PARENT_NODE_FIRST" ]
• id(optional): string(uuid)
• isBound(optional): boolean
  Read Only: true
• links(optional): array links
• mappingBound(optional): boolean
• modifiedByUser(optional): object User
• name(optional): string
• objectStatus(optional): string
  Allowed Values: [ "DRAFT", "ACTIVE", "SUNSET", "ARCHIVED", "DELETED" ]
• permittedActions(optional): array permittedActions
  Unique Items Required: true
• related(optional): object Related
• scope(optional): string
  Allowed Values: [ "MASTER", "APPLICATION" ]
• timeCreated(optional): integer(int64)
• timeModified(optional): integer(int64)
• useCustomSortOrder(optional): boolean

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64"
        },
        "timeModified":{
            "type":"integer",
            "format":"int64"
        },
        "application":{
            "$ref":"#/definitions/Application"
        },
        "assignedNodeTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/HierarchySetNodeTypeAssignment"
            }
        },
        "allowSharedNodes":{
            "type":"boolean"
        },
        "useCustomSortOrder":{
            "type":"boolean"
        },
        "scope":{
            "type":"string",
            "enum":[
                "MASTER",
                "APPLICATION"
            ]
        },
        "objectStatus":{
            "type":"string",
            "enum":[
                "DRAFT",
                "ACTIVE",
                "SUNSET",
                "ARCHIVED",
                "DELETED"
            ]
        },
        "related":{
            "$ref":"#/definitions/Related"
        },
        "dimension":{
            "$ref":"#/definitions/Dimension"
        },
        "bindingType":{
            "type":"string",
            "enum":[
                "BOUND",
                "NODE_SET_BOUND",
                "HIERARCHY_SET_BOUND",
                "NODE_TYPE_BOUND",
                "PARTIAL_NODE_TYPE_BOUND",
                "MAPPING_BOUND",
                "UNBOUND"
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "mappingBound":{
            "type":"boolean"
        },
        "completenessError":{
            "type":"string"
        },
        "dimensionSectionAllowedSharedNodes":{
            "type":"boolean"
        },
        "permittedActions":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "enum":[
                    "CREATE_CONSTRAINT",
                    "CREATE_NODETYPE",
                    "CREATE_HIERARCHYSET",
                    "CREATE_NODESET",
                    "CREATE_VIEWPOINT",
                    "CREATE_REQUEST",
                    "CREATE_PROPERTY",
                    "ASSIGN_REQUEST",
                    "SUBMIT_REQUEST",
                    "PUSHBACK_REQUEST",
                    "REJECT_REQUEST",
                    "APPROVE_REQUEST",
                    "WITHDRAW_REQUEST",
                    "COMMIT_REQUEST",
                    "ADD_REQUEST_COMMENT",
                    "ADD_REQUEST_ATTACHMENT",
                    "EDIT_REQUEST_HEADER",
                    "VALIDATE",
                    "EDIT_METADATA",
                    "REINDEX",
                    "EDIT",
                    "COPY_VIEWPOINT",
                    "LOAD_VIEWPOINT",
                    "ARCHIVE",
                    "DELETE",
                    "IMPORT",
                    "EXPORT",
                    "MANAGE_GRANTS",
                    "DELETE_NODE",
                    "ADD_NODE",
                    "INSERT_NODE",
                    "REORDER_NODE",
                    "REMOVE_NODE",
                    "MOVE_NODE",
                    "RECALL_REQUEST",
                    "COPY_EXTRACT",
                    "UPDATE_VISIBILITY",
                    "COPY",
                    "QUERY",
                    "RUN_EXTRACT_PACKAGE",
                    "CREATE_EXTRACT_PACKAGE"
                ]
            }
        },
        "groupingType":{
            "type":"string",
            "enum":[
                "DEFAULT",
                "PARENT_NODE_FIRST"
            ]
        },
        "bottomNodeSort":{
            "type":"string",
            "enum":[
                "ALPHANUMERIC",
                "CUSTOM"
            ]
        },
        "createdByUser":{
            "$ref":"#/definitions/User"
        },
        "modifiedByUser":{
            "$ref":"#/definitions/User"
        },
        "isBound":{
            "type":"boolean",
            "readOnly":true
        }
    },
    "description":"Hierarchy Set model that would be returned as response"
}

Nested Schema : Application

Type: object

Show Source

• applicationMetadata(optional): object ApplicationMetadata
• blockoutConfiguration(optional): object BlockoutConfiguration
• connections(optional): string
• createdBy(optional): string
  This property is now deprecated and will be removed in 10/2020. Use createdByUser instead.
• createdByUser(optional): object User
• description(optional): string
• dimensions(optional): array dimensions
• hasPermissionToPrimaryView(optional): boolean
• hasUnappliedAnswers(optional): boolean
• id(optional): string(uuid)
• inProgressSlotAnswers(optional): string
• isBound(optional): boolean
  Read Only: true
• links(optional): array links
• modifiedBy(optional): string
  This property is now deprecated and will be removed in 10/2020. Use modifiedByUser instead.
• modifiedByUser(optional): object User
• name(optional): string
• objectStatus(optional): string
  Allowed Values: [ "DRAFT", "ACTIVE", "SUNSET", "ARCHIVED", "DELETED" ]
• permittedActions(optional): array permittedActions
  Unique Items Required: true
• primaryConnection(optional): object IdNameDescription
• primaryView(optional): object IdNameLink
• slotAnswers(optional): string
• supportedDirection(optional): string
  Allowed Values: [ "BOTH", "IMPORT", "EXPORT", "NONE" ]
• supportsConnections(optional): boolean
• timeCreated(optional): integer(int64)
• timeModified(optional): integer(int64)
• type(optional): object ApplicationType
• upgradeTargets(optional): array upgradeTargets
• workflowDisabledOption(optional): object WorkflowDisabledOption

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64"
        },
        "timeModified":{
            "type":"integer",
            "format":"int64"
        },
        "objectStatus":{
            "type":"string",
            "enum":[
                "DRAFT",
                "ACTIVE",
                "SUNSET",
                "ARCHIVED",
                "DELETED"
            ]
        },
        "upgradeTargets":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IdNameLink"
            }
        },
        "createdBy":{
            "type":"string",
            "description":"This property is now deprecated and will be removed in 10/2020. Use createdByUser instead."
        },
        "modifiedBy":{
            "type":"string",
            "description":"This property is now deprecated and will be removed in 10/2020. Use modifiedByUser instead."
        },
        "hasUnappliedAnswers":{
            "type":"boolean"
        },
        "type":{
            "$ref":"#/definitions/ApplicationType"
        },
        "primaryView":{
            "$ref":"#/definitions/IdNameLink"
        },
        "supportedDirection":{
            "type":"string",
            "enum":[
                "BOTH",
                "IMPORT",
                "EXPORT",
                "NONE"
            ]
        },
        "permittedActions":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "enum":[
                    "CREATE_CONSTRAINT",
                    "CREATE_NODETYPE",
                    "CREATE_HIERARCHYSET",
                    "CREATE_NODESET",
                    "CREATE_VIEWPOINT",
                    "CREATE_REQUEST",
                    "CREATE_PROPERTY",
                    "ASSIGN_REQUEST",
                    "SUBMIT_REQUEST",
                    "PUSHBACK_REQUEST",
                    "REJECT_REQUEST",
                    "APPROVE_REQUEST",
                    "WITHDRAW_REQUEST",
                    "COMMIT_REQUEST",
                    "ADD_REQUEST_COMMENT",
                    "ADD_REQUEST_ATTACHMENT",
                    "EDIT_REQUEST_HEADER",
                    "VALIDATE",
                    "EDIT_METADATA",
                    "REINDEX",
                    "EDIT",
                    "COPY_VIEWPOINT",
                    "LOAD_VIEWPOINT",
                    "ARCHIVE",
                    "DELETE",
                    "IMPORT",
                    "EXPORT",
                    "MANAGE_GRANTS",
                    "DELETE_NODE",
                    "ADD_NODE",
                    "INSERT_NODE",
                    "REORDER_NODE",
                    "REMOVE_NODE",
                    "MOVE_NODE",
                    "RECALL_REQUEST",
                    "COPY_EXTRACT",
                    "UPDATE_VISIBILITY",
                    "COPY",
                    "QUERY",
                    "RUN_EXTRACT_PACKAGE",
                    "CREATE_EXTRACT_PACKAGE"
                ]
            }
        },
        "hasPermissionToPrimaryView":{
            "type":"boolean"
        },
        "primaryConnection":{
            "$ref":"#/definitions/IdNameDescription"
        },
        "supportsConnections":{
            "type":"boolean"
        },
        "createdByUser":{
            "$ref":"#/definitions/User"
        },
        "modifiedByUser":{
            "$ref":"#/definitions/User"
        },
        "slotAnswers":{
            "type":"string"
        },
        "inProgressSlotAnswers":{
            "type":"string"
        },
        "dimensions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Dimension"
            }
        },
        "connections":{
            "type":"string"
        },
        "blockoutConfiguration":{
            "$ref":"#/definitions/BlockoutConfiguration"
        },
        "applicationMetadata":{
            "$ref":"#/definitions/ApplicationMetadata"
        },
        "workflowDisabledOption":{
            "$ref":"#/definitions/WorkflowDisabledOption"
        },
        "isBound":{
            "type":"boolean",
            "readOnly":true
        }
    }
}

Nested Schema : assignedNodeTypes

Type: array

Show Source

• Array of: object HierarchySetNodeTypeAssignment

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

Nested Schema : Dimension

Type: object

Dimension model that would be returned as response

Show Source

• applicationLink(optional): object IdNameLink
• applicationTypeId(optional): string(uuid)
  Read Only: true
• bindings(optional): array bindings
  Read Only: true
• blockoutConfiguration(optional): object BlockoutConfiguration
• canAddBinding(optional): boolean
  Read Only: true
• canAddMappingBinding(optional): boolean
  Read Only: true
• connected(optional): boolean
  Read Only: true
• createdBy(optional): string
  Read Only: true

  This property is now deprecated and will be removed in 10/2020. Use createdByUser instead.
• createdByUser(optional): object User
• description(optional): string
  Read Only: true
• dimensionType(optional): string
  Read Only: true
• externalName(optional): string
  Read Only: true
• id(optional): string(uuid)
  Read Only: true
• importExportSettings(optional): object DimensionImportExportSettings
  Discriminator: type

  Dimension Import/Export settings
• isBound(optional): boolean
  Read Only: true
• links(optional): array links
  Read Only: true
• modifiedBy(optional): string
  Read Only: true

  This property is now deprecated and will be removed in 10/2020. Use modifiedByUser instead.
• modifiedByUser(optional): object User
• name(optional): string
  Read Only: true
• objectStatus(optional): string
  Read Only: true

  Allowed Values: [ "DRAFT", "ACTIVE", "SUNSET", "ARCHIVED", "DELETED" ]
• permittedActions(optional): array permittedActions
  Read Only: true

  Unique Items Required: true
• supportedDirection(optional): string
  Read Only: true

  Allowed Values: [ "BOTH", "IMPORT", "EXPORT", "NONE" ]
• supportsExtracts(optional): boolean
  Read Only: true
• supportsMapping(optional): boolean
  Read Only: true
• supportsMappingExport(optional): boolean
  Read Only: true
• supportsTemplateExport(optional): boolean
  Read Only: true
• timeCreated(optional): integer(int64)
  Read Only: true
• timeModified(optional): integer(int64)
  Read Only: true
• validationSettings(optional): array validationSettings
  Read Only: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "dimensionType":{
            "type":"string",
            "readOnly":true
        },
        "connected":{
            "type":"boolean",
            "readOnly":true
        },
        "objectStatus":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "DRAFT",
                "ACTIVE",
                "SUNSET",
                "ARCHIVED",
                "DELETED"
            ]
        },
        "applicationLink":{
            "readOnly":true,
            "$ref":"#/definitions/IdNameLink"
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "timeModified":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "description":"This property is now deprecated and will be removed in 10/2020. Use createdByUser instead.",
            "readOnly":true
        },
        "modifiedBy":{
            "type":"string",
            "description":"This property is now deprecated and will be removed in 10/2020. Use modifiedByUser instead.",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "permittedActions":{
            "type":"array",
            "readOnly":true,
            "uniqueItems":true,
            "items":{
                "type":"string",
                "enum":[
                    "CREATE_CONSTRAINT",
                    "CREATE_NODETYPE",
                    "CREATE_HIERARCHYSET",
                    "CREATE_NODESET",
                    "CREATE_VIEWPOINT",
                    "CREATE_REQUEST",
                    "CREATE_PROPERTY",
                    "ASSIGN_REQUEST",
                    "SUBMIT_REQUEST",
                    "PUSHBACK_REQUEST",
                    "REJECT_REQUEST",
                    "APPROVE_REQUEST",
                    "WITHDRAW_REQUEST",
                    "COMMIT_REQUEST",
                    "ADD_REQUEST_COMMENT",
                    "ADD_REQUEST_ATTACHMENT",
                    "EDIT_REQUEST_HEADER",
                    "VALIDATE",
                    "EDIT_METADATA",
                    "REINDEX",
                    "EDIT",
                    "COPY_VIEWPOINT",
                    "LOAD_VIEWPOINT",
                    "ARCHIVE",
                    "DELETE",
                    "IMPORT",
                    "EXPORT",
                    "MANAGE_GRANTS",
                    "DELETE_NODE",
                    "ADD_NODE",
                    "INSERT_NODE",
                    "REORDER_NODE",
                    "REMOVE_NODE",
                    "MOVE_NODE",
                    "RECALL_REQUEST",
                    "COPY_EXTRACT",
                    "UPDATE_VISIBILITY",
                    "COPY",
                    "QUERY",
                    "RUN_EXTRACT_PACKAGE",
                    "CREATE_EXTRACT_PACKAGE"
                ]
            }
        },
        "bindings":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/DimensionBinding"
            }
        },
        "isBound":{
            "type":"boolean",
            "readOnly":true
        },
        "canAddBinding":{
            "type":"boolean",
            "readOnly":true
        },
        "canAddMappingBinding":{
            "type":"boolean",
            "readOnly":true
        },
        "supportedDirection":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "BOTH",
                "IMPORT",
                "EXPORT",
                "NONE"
            ]
        },
        "externalName":{
            "type":"string",
            "readOnly":true
        },
        "importExportSettings":{
            "readOnly":true,
            "$ref":"#/definitions/DimensionImportExportSettings"
        },
        "supportsMapping":{
            "type":"boolean",
            "readOnly":true
        },
        "supportsMappingExport":{
            "type":"boolean",
            "readOnly":true
        },
        "supportsTemplateExport":{
            "type":"boolean",
            "readOnly":true
        },
        "validationSettings":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/ValidationSetting"
            }
        },
        "createdByUser":{
            "readOnly":true,
            "$ref":"#/definitions/User"
        },
        "modifiedByUser":{
            "readOnly":true,
            "$ref":"#/definitions/User"
        },
        "supportsExtracts":{
            "type":"boolean",
            "readOnly":true
        },
        "applicationTypeId":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "blockoutConfiguration":{
            "readOnly":true,
            "$ref":"#/definitions/BlockoutConfiguration"
        }
    },
    "description":"Dimension model that would be returned as response"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : permittedActions

Type: array

Unique Items Required: true

Show Source

• Array of: string
  Allowed Values: [ "CREATE_CONSTRAINT", "CREATE_NODETYPE", "CREATE_HIERARCHYSET", "CREATE_NODESET", "CREATE_VIEWPOINT", "CREATE_REQUEST", "CREATE_PROPERTY", "ASSIGN_REQUEST", "SUBMIT_REQUEST", "PUSHBACK_REQUEST", "REJECT_REQUEST", "APPROVE_REQUEST", "WITHDRAW_REQUEST", "COMMIT_REQUEST", "ADD_REQUEST_COMMENT", "ADD_REQUEST_ATTACHMENT", "EDIT_REQUEST_HEADER", "VALIDATE", "EDIT_METADATA", "REINDEX", "EDIT", "COPY_VIEWPOINT", "LOAD_VIEWPOINT", "ARCHIVE", "DELETE", "IMPORT", "EXPORT", "MANAGE_GRANTS", "DELETE_NODE", "ADD_NODE", "INSERT_NODE", "REORDER_NODE", "REMOVE_NODE", "MOVE_NODE", "RECALL_REQUEST", "COPY_EXTRACT", "UPDATE_VISIBILITY", "COPY", "QUERY", "RUN_EXTRACT_PACKAGE", "CREATE_EXTRACT_PACKAGE" ]

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"string",
        "enum":[
            "CREATE_CONSTRAINT",
            "CREATE_NODETYPE",
            "CREATE_HIERARCHYSET",
            "CREATE_NODESET",
            "CREATE_VIEWPOINT",
            "CREATE_REQUEST",
            "CREATE_PROPERTY",
            "ASSIGN_REQUEST",
            "SUBMIT_REQUEST",
            "PUSHBACK_REQUEST",
            "REJECT_REQUEST",
            "APPROVE_REQUEST",
            "WITHDRAW_REQUEST",
            "COMMIT_REQUEST",
            "ADD_REQUEST_COMMENT",
            "ADD_REQUEST_ATTACHMENT",
            "EDIT_REQUEST_HEADER",
            "VALIDATE",
            "EDIT_METADATA",
            "REINDEX",
            "EDIT",
            "COPY_VIEWPOINT",
            "LOAD_VIEWPOINT",
            "ARCHIVE",
            "DELETE",
            "IMPORT",
            "EXPORT",
            "MANAGE_GRANTS",
            "DELETE_NODE",
            "ADD_NODE",
            "INSERT_NODE",
            "REORDER_NODE",
            "REMOVE_NODE",
            "MOVE_NODE",
            "RECALL_REQUEST",
            "COPY_EXTRACT",
            "UPDATE_VISIBILITY",
            "COPY",
            "QUERY",
            "RUN_EXTRACT_PACKAGE",
            "CREATE_EXTRACT_PACKAGE"
        ]
    }
}

Nested Schema : ApplicationMetadata

Type: object

Nested Schema : dimensions

Type: array

Show Source

• Array of: object Dimension
  Dimension model that would be returned as response

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : permittedActions

Type: array

Unique Items Required: true

Show Source

• Array of: string
  Allowed Values: [ "CREATE_CONSTRAINT", "CREATE_NODETYPE", "CREATE_HIERARCHYSET", "CREATE_NODESET", "CREATE_VIEWPOINT", "CREATE_REQUEST", "CREATE_PROPERTY", "ASSIGN_REQUEST", "SUBMIT_REQUEST", "PUSHBACK_REQUEST", "REJECT_REQUEST", "APPROVE_REQUEST", "WITHDRAW_REQUEST", "COMMIT_REQUEST", "ADD_REQUEST_COMMENT", "ADD_REQUEST_ATTACHMENT", "EDIT_REQUEST_HEADER", "VALIDATE", "EDIT_METADATA", "REINDEX", "EDIT", "COPY_VIEWPOINT", "LOAD_VIEWPOINT", "ARCHIVE", "DELETE", "IMPORT", "EXPORT", "MANAGE_GRANTS", "DELETE_NODE", "ADD_NODE", "INSERT_NODE", "REORDER_NODE", "REMOVE_NODE", "MOVE_NODE", "RECALL_REQUEST", "COPY_EXTRACT", "UPDATE_VISIBILITY", "COPY", "QUERY", "RUN_EXTRACT_PACKAGE", "CREATE_EXTRACT_PACKAGE" ]

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"string",
        "enum":[
            "CREATE_CONSTRAINT",
            "CREATE_NODETYPE",
            "CREATE_HIERARCHYSET",
            "CREATE_NODESET",
            "CREATE_VIEWPOINT",
            "CREATE_REQUEST",
            "CREATE_PROPERTY",
            "ASSIGN_REQUEST",
            "SUBMIT_REQUEST",
            "PUSHBACK_REQUEST",
            "REJECT_REQUEST",
            "APPROVE_REQUEST",
            "WITHDRAW_REQUEST",
            "COMMIT_REQUEST",
            "ADD_REQUEST_COMMENT",
            "ADD_REQUEST_ATTACHMENT",
            "EDIT_REQUEST_HEADER",
            "VALIDATE",
            "EDIT_METADATA",
            "REINDEX",
            "EDIT",
            "COPY_VIEWPOINT",
            "LOAD_VIEWPOINT",
            "ARCHIVE",
            "DELETE",
            "IMPORT",
            "EXPORT",
            "MANAGE_GRANTS",
            "DELETE_NODE",
            "ADD_NODE",
            "INSERT_NODE",
            "REORDER_NODE",
            "REMOVE_NODE",
            "MOVE_NODE",
            "RECALL_REQUEST",
            "COPY_EXTRACT",
            "UPDATE_VISIBILITY",
            "COPY",
            "QUERY",
            "RUN_EXTRACT_PACKAGE",
            "CREATE_EXTRACT_PACKAGE"
        ]
    }
}

Nested Schema : ApplicationType

Type: object

Show Source

• description(optional): string
• id(optional): string(uuid)
• links(optional): array links
• name(optional): string

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

Nested Schema : upgradeTargets

Type: array

Show Source

• Array of: object IdNameLink

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

Nested Schema : WorkflowDisabledOption

Type: object

Show Source

• enabled(optional): boolean
• submittedBy(optional): array submittedBy
  Unique Items Required: true

{
    "type":"object",
    "properties":{
        "enabled":{
            "type":"boolean"
        },
        "submittedBy":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/User"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : submittedBy

Type: array

Unique Items Required: true

Show Source

• Array of: object User

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/User"
    }
}

Nested Schema : HierarchySetNodeTypeAssignment

Type: object

Show Source

• allowedAsRoot(optional): boolean
  Read Only: true
• allowedChildNodeTypes(optional): array allowedChildNodeTypes
  Read Only: true
• alternateQualifiers(optional): array alternateQualifiers
• application(optional): object Application
• bindingType(optional): string
  Read Only: true

  Allowed Values: [ "BOUND", "NODE_SET_BOUND", "HIERARCHY_SET_BOUND", "NODE_TYPE_BOUND", "PARTIAL_NODE_TYPE_BOUND", "MAPPING_BOUND", "UNBOUND" ]
• childNodeTypeOption(optional): string
  Read Only: true

  Allowed Values: [ "ALL", "NONE", "SPECIFIED" ]
• class(optional): string
  Read Only: true

  Allowed Values: [ "LOOKUP", "LEGACY_GL", "NORMAL", "USER", "USER_ROLLUP" ]
• combination(optional): boolean
• compatibleBoundHierarchySets(optional): array compatibleBoundHierarchySets
  Unique Items Required: true
• compatibleBoundNodeSets(optional): array compatibleBoundNodeSets
  Unique Items Required: true
• converters(optional): array converters
• createdByUser(optional): object User
• defaultQualifier(optional): string
• description(optional): string
  Read Only: true
• dimension(optional): object Dimension
  Dimension model that would be returned as response
• id(optional): string(uuid)
  Read Only: true
• isBound(optional): boolean
  Read Only: true
• links(optional): array links
  Read Only: true
• modifiedByUser(optional): object User
• name(optional): string
  Read Only: true
• objectStatus(optional): string
  Read Only: true

  Allowed Values: [ "DRAFT", "ACTIVE", "SUNSET", "ARCHIVED", "DELETED" ]
• permittedActions(optional): array permittedActions
  Unique Items Required: true
• propertyDefinitions(optional): array propertyDefinitions
• qualifierPosition(optional): string
  Allowed Values: [ "PREFIX", "SUFFIX" ]
• related(optional): object Related
• scope(optional): string
  Read Only: true

  Allowed Values: [ "MASTER", "APPLICATION" ]
• sortOrder(optional): integer(int32)
  Read Only: true
• timeCreated(optional): integer(int64)
  Read Only: true
• timeModified(optional): integer(int64)
  Read Only: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "scope":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "MASTER",
                "APPLICATION"
            ]
        },
        "objectStatus":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "DRAFT",
                "ACTIVE",
                "SUNSET",
                "ARCHIVED",
                "DELETED"
            ]
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "timeModified":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "application":{
            "readOnly":true,
            "$ref":"#/definitions/Application"
        },
        "dimension":{
            "$ref":"#/definitions/Dimension"
        },
        "bindingType":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "BOUND",
                "NODE_SET_BOUND",
                "HIERARCHY_SET_BOUND",
                "NODE_TYPE_BOUND",
                "PARTIAL_NODE_TYPE_BOUND",
                "MAPPING_BOUND",
                "UNBOUND"
            ]
        },
        "permittedActions":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "enum":[
                    "CREATE_CONSTRAINT",
                    "CREATE_NODETYPE",
                    "CREATE_HIERARCHYSET",
                    "CREATE_NODESET",
                    "CREATE_VIEWPOINT",
                    "CREATE_REQUEST",
                    "CREATE_PROPERTY",
                    "ASSIGN_REQUEST",
                    "SUBMIT_REQUEST",
                    "PUSHBACK_REQUEST",
                    "REJECT_REQUEST",
                    "APPROVE_REQUEST",
                    "WITHDRAW_REQUEST",
                    "COMMIT_REQUEST",
                    "ADD_REQUEST_COMMENT",
                    "ADD_REQUEST_ATTACHMENT",
                    "EDIT_REQUEST_HEADER",
                    "VALIDATE",
                    "EDIT_METADATA",
                    "REINDEX",
                    "EDIT",
                    "COPY_VIEWPOINT",
                    "LOAD_VIEWPOINT",
                    "ARCHIVE",
                    "DELETE",
                    "IMPORT",
                    "EXPORT",
                    "MANAGE_GRANTS",
                    "DELETE_NODE",
                    "ADD_NODE",
                    "INSERT_NODE",
                    "REORDER_NODE",
                    "REMOVE_NODE",
                    "MOVE_NODE",
                    "RECALL_REQUEST",
                    "COPY_EXTRACT",
                    "UPDATE_VISIBILITY",
                    "COPY",
                    "QUERY",
                    "RUN_EXTRACT_PACKAGE",
                    "CREATE_EXTRACT_PACKAGE"
                ]
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "allowedAsRoot":{
            "type":"boolean",
            "readOnly":true
        },
        "childNodeTypeOption":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "ALL",
                "NONE",
                "SPECIFIED"
            ]
        },
        "allowedChildNodeTypes":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/IdNameLink"
            }
        },
        "sortOrder":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "isBound":{
            "type":"boolean",
            "readOnly":true
        },
        "class":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "LOOKUP",
                "LEGACY_GL",
                "NORMAL",
                "USER",
                "USER_ROLLUP"
            ]
        },
        "compatibleBoundNodeSets":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string"
            }
        },
        "compatibleBoundHierarchySets":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string"
            }
        },
        "propertyDefinitions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NodeTypeProperty"
            }
        },
        "converters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Converter"
            }
        },
        "related":{
            "$ref":"#/definitions/Related"
        },
        "defaultQualifier":{
            "type":"string"
        },
        "alternateQualifiers":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "qualifierPosition":{
            "type":"string",
            "enum":[
                "PREFIX",
                "SUFFIX"
            ]
        },
        "createdByUser":{
            "$ref":"#/definitions/User"
        },
        "modifiedByUser":{
            "$ref":"#/definitions/User"
        },
        "combination":{
            "type":"boolean"
        }
    }
}

Nested Schema : allowedChildNodeTypes

Type: array

Read Only: true

Show Source

• Array of: object IdNameLink

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

Nested Schema : alternateQualifiers

Type: array

Show Source

• Array of: string

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

Nested Schema : compatibleBoundHierarchySets

Type: array

Unique Items Required: true

Show Source

• Array of: string

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

Nested Schema : compatibleBoundNodeSets

Type: array

Unique Items Required: true

Show Source

• Array of: string

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

Nested Schema : converters

Type: array

Show Source

• Array of: object Converter

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

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

Nested Schema : permittedActions

Type: array

Unique Items Required: true

Show Source

• Array of: string
  Allowed Values: [ "CREATE_CONSTRAINT", "CREATE_NODETYPE", "CREATE_HIERARCHYSET", "CREATE_NODESET", "CREATE_VIEWPOINT", "CREATE_REQUEST", "CREATE_PROPERTY", "ASSIGN_REQUEST", "SUBMIT_REQUEST", "PUSHBACK_REQUEST", "REJECT_REQUEST", "APPROVE_REQUEST", "WITHDRAW_REQUEST", "COMMIT_REQUEST", "ADD_REQUEST_COMMENT", "ADD_REQUEST_ATTACHMENT", "EDIT_REQUEST_HEADER", "VALIDATE", "EDIT_METADATA", "REINDEX", "EDIT", "COPY_VIEWPOINT", "LOAD_VIEWPOINT", "ARCHIVE", "DELETE", "IMPORT", "EXPORT", "MANAGE_GRANTS", "DELETE_NODE", "ADD_NODE", "INSERT_NODE", "REORDER_NODE", "REMOVE_NODE", "MOVE_NODE", "RECALL_REQUEST", "COPY_EXTRACT", "UPDATE_VISIBILITY", "COPY", "QUERY", "RUN_EXTRACT_PACKAGE", "CREATE_EXTRACT_PACKAGE" ]

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"string",
        "enum":[
            "CREATE_CONSTRAINT",
            "CREATE_NODETYPE",
            "CREATE_HIERARCHYSET",
            "CREATE_NODESET",
            "CREATE_VIEWPOINT",
            "CREATE_REQUEST",
            "CREATE_PROPERTY",
            "ASSIGN_REQUEST",
            "SUBMIT_REQUEST",
            "PUSHBACK_REQUEST",
            "REJECT_REQUEST",
            "APPROVE_REQUEST",
            "WITHDRAW_REQUEST",
            "COMMIT_REQUEST",
            "ADD_REQUEST_COMMENT",
            "ADD_REQUEST_ATTACHMENT",
            "EDIT_REQUEST_HEADER",
            "VALIDATE",
            "EDIT_METADATA",
            "REINDEX",
            "EDIT",
            "COPY_VIEWPOINT",
            "LOAD_VIEWPOINT",
            "ARCHIVE",
            "DELETE",
            "IMPORT",
            "EXPORT",
            "MANAGE_GRANTS",
            "DELETE_NODE",
            "ADD_NODE",
            "INSERT_NODE",
            "REORDER_NODE",
            "REMOVE_NODE",
            "MOVE_NODE",
            "RECALL_REQUEST",
            "COPY_EXTRACT",
            "UPDATE_VISIBILITY",
            "COPY",
            "QUERY",
            "RUN_EXTRACT_PACKAGE",
            "CREATE_EXTRACT_PACKAGE"
        ]
    }
}

Nested Schema : propertyDefinitions

Type: array

Show Source

• Array of: object NodeTypeProperty

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

Nested Schema : Converter

Type: object

Show Source

• conversion(optional): array conversion
• fromNodeType(optional): object SimpleNodeType
• id(optional): string(uuid)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "fromNodeType":{
            "$ref":"#/definitions/SimpleNodeType"
        },
        "conversion":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PropertyConversion"
            }
        }
    }
}

Nested Schema : conversion

Type: array

Show Source

• Array of: object PropertyConversion

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

Nested Schema : SimpleNodeType

Type: object

Show Source

• application(optional): object IdNameLink
• description(optional): string
  Read Only: true
• id(optional): string(uuid)
• links(optional): array links
• name(optional): string
• nodeTypeClass(optional): string
  Allowed Values: [ "LOOKUP", "LEGACY_GL", "NORMAL", "USER", "USER_ROLLUP" ]
• properties(optional): array properties

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "application":{
            "$ref":"#/definitions/IdNameLink"
        },
        "properties":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IdNameLink"
            }
        },
        "nodeTypeClass":{
            "type":"string",
            "enum":[
                "LOOKUP",
                "LEGACY_GL",
                "NORMAL",
                "USER",
                "USER_ROLLUP"
            ]
        }
    }
}

Nested Schema : PropertyConversion

Type: object

Show Source

• expression(optional): object JsonNode
• fromPropertyId(optional): string(uuid)
• targetReadOnly(optional): boolean
• toPropertyId(optional): string(uuid)

{
    "type":"object",
    "properties":{
        "fromPropertyId":{
            "type":"string",
            "format":"uuid"
        },
        "toPropertyId":{
            "type":"string",
            "format":"uuid"
        },
        "expression":{
            "$ref":"#/definitions/JsonNode"
        },
        "targetReadOnly":{
            "type":"boolean"
        }
    }
}

Nested Schema : JsonNode

Type: object

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : properties

Type: array

Show Source

• Array of: object IdNameLink

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

Nested Schema : NodeTypeProperty

Type: object

Show Source

• dataType(optional): string
  Read Only: true
• defaultOnly(optional): boolean
  Read Only: true
• deletable(optional): boolean
  Read Only: true
• description(optional): string
  Read Only: true
• id(optional): string(uuid)
  Read Only: true
• links(optional): array links
  Read Only: true
• name(optional): string
  Read Only: true
• namespace(optional): string
  Read Only: true
• queryable(optional): boolean
  Read Only: true
• required(optional): boolean
  Read Only: true
• sortOrder(optional): integer(int32)
  Read Only: true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "readOnly":true
        },
        "namespace":{
            "type":"string",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "dataType":{
            "type":"string",
            "readOnly":true
        },
        "defaultOnly":{
            "type":"boolean",
            "readOnly":true
        },
        "deletable":{
            "type":"boolean",
            "readOnly":true
        },
        "required":{
            "type":"boolean",
            "readOnly":true
        },
        "sortOrder":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "queryable":{
            "type":"boolean",
            "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 : bindings

Type: array

Read Only: true

Show Source

• Array of: object DimensionBinding

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

Nested Schema : DimensionImportExportSettings

Type: object

Discriminator: type

Dimension Import/Export settings

Show Source

• type: string
  Read Only: true

  Allowed Values: [ "DEFAULT", "FCGL" ]

  Type is set to "DEFAULT" for standard settings, "FCGL" for Financial Cloud Import/Export options.

{
    "type":"object",
    "required":[
        "type"
    ],
    "discriminator":"type",
    "properties":{
        "type":{
            "type":"string",
            "description":"Type is set to \"DEFAULT\" for standard settings, \"FCGL\" for Financial Cloud Import/Export options.",
            "readOnly":true,
            "enum":[
                "DEFAULT",
                "FCGL"
            ]
        }
    },
    "description":"Dimension Import/Export settings"
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

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

Nested Schema : permittedActions

Type: array

Read Only: true

Unique Items Required: true

Show Source

• Array of: string
  Allowed Values: [ "CREATE_CONSTRAINT", "CREATE_NODETYPE", "CREATE_HIERARCHYSET", "CREATE_NODESET", "CREATE_VIEWPOINT", "CREATE_REQUEST", "CREATE_PROPERTY", "ASSIGN_REQUEST", "SUBMIT_REQUEST", "PUSHBACK_REQUEST", "REJECT_REQUEST", "APPROVE_REQUEST", "WITHDRAW_REQUEST", "COMMIT_REQUEST", "ADD_REQUEST_COMMENT", "ADD_REQUEST_ATTACHMENT", "EDIT_REQUEST_HEADER", "VALIDATE", "EDIT_METADATA", "REINDEX", "EDIT", "COPY_VIEWPOINT", "LOAD_VIEWPOINT", "ARCHIVE", "DELETE", "IMPORT", "EXPORT", "MANAGE_GRANTS", "DELETE_NODE", "ADD_NODE", "INSERT_NODE", "REORDER_NODE", "REMOVE_NODE", "MOVE_NODE", "RECALL_REQUEST", "COPY_EXTRACT", "UPDATE_VISIBILITY", "COPY", "QUERY", "RUN_EXTRACT_PACKAGE", "CREATE_EXTRACT_PACKAGE" ]

{
    "type":"array",
    "readOnly":true,
    "uniqueItems":true,
    "items":{
        "type":"string",
        "enum":[
            "CREATE_CONSTRAINT",
            "CREATE_NODETYPE",
            "CREATE_HIERARCHYSET",
            "CREATE_NODESET",
            "CREATE_VIEWPOINT",
            "CREATE_REQUEST",
            "CREATE_PROPERTY",
            "ASSIGN_REQUEST",
            "SUBMIT_REQUEST",
            "PUSHBACK_REQUEST",
            "REJECT_REQUEST",
            "APPROVE_REQUEST",
            "WITHDRAW_REQUEST",
            "COMMIT_REQUEST",
            "ADD_REQUEST_COMMENT",
            "ADD_REQUEST_ATTACHMENT",
            "EDIT_REQUEST_HEADER",
            "VALIDATE",
            "EDIT_METADATA",
            "REINDEX",
            "EDIT",
            "COPY_VIEWPOINT",
            "LOAD_VIEWPOINT",
            "ARCHIVE",
            "DELETE",
            "IMPORT",
            "EXPORT",
            "MANAGE_GRANTS",
            "DELETE_NODE",
            "ADD_NODE",
            "INSERT_NODE",
            "REORDER_NODE",
            "REMOVE_NODE",
            "MOVE_NODE",
            "RECALL_REQUEST",
            "COPY_EXTRACT",
            "UPDATE_VISIBILITY",
            "COPY",
            "QUERY",
            "RUN_EXTRACT_PACKAGE",
            "CREATE_EXTRACT_PACKAGE"
        ]
    }
}

Nested Schema : validationSettings

Type: array

Read Only: true

Show Source

• Array of: object ValidationSetting

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

Nested Schema : DimensionBinding

Type: object

Show Source

• bindingType(optional): string
  Read Only: true
• description(optional): string
  Read Only: true
• id(optional): string(uuid)
  Read Only: true
• lastExportInfo(optional): object DimensionSyncHistory
• lastImportInfo(optional): object DimensionSyncHistory
• links(optional): array links
  Read Only: true
• name(optional): string
  Read Only: true
• slotAnswers(optional): string
  Read Only: true
• supportsSettings(optional): boolean
  Read Only: true
• view(optional): object IdNameLink
• viewpoint(optional): object IdNameLink

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "name":{
            "type":"string",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "lastExportInfo":{
            "readOnly":true,
            "$ref":"#/definitions/DimensionSyncHistory"
        },
        "lastImportInfo":{
            "readOnly":true,
            "$ref":"#/definitions/DimensionSyncHistory"
        },
        "slotAnswers":{
            "type":"string",
            "readOnly":true
        },
        "viewpoint":{
            "readOnly":true,
            "$ref":"#/definitions/IdNameLink"
        },
        "bindingType":{
            "type":"string",
            "readOnly":true
        },
        "view":{
            "readOnly":true,
            "$ref":"#/definitions/IdNameLink"
        },
        "supportsSettings":{
            "type":"boolean",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : DimensionSyncHistory

Type: object

Show Source

• connectionId(optional): string(uuid)
• connectionName(optional): string
• direction(optional): string
  Allowed Values: [ "BOTH", "IMPORT", "EXPORT", "NONE" ]
• endTime(optional): integer(int64)
• importOption(optional): string
  Allowed Values: [ "ResetDimension", "ReplaceNodes", "Merge" ]
• links(optional): array links
• messages(optional): array messages
• publicApiFlag(optional): boolean
• ranBy(optional): string
• requestId(optional): string(uuid)
• requestSummary(optional): object Request
  A Request models changes to apply to a View
• startTime(optional): integer(int64)
• status(optional): string
  Allowed Values: [ "PENDING", "COMPLETED", "ERROR", "RUNNING" ]
• success(optional): boolean
• syncDescription(optional): string
• syncId(optional): string(uuid)
• syncType(optional): string
  Allowed Values: [ "FULL", "INCREMENTAL" ]
• taskHistory(optional): array taskHistory

{
    "type":"object",
    "properties":{
        "syncId":{
            "type":"string",
            "format":"uuid"
        },
        "connectionId":{
            "type":"string",
            "format":"uuid"
        },
        "syncDescription":{
            "type":"string"
        },
        "ranBy":{
            "type":"string"
        },
        "startTime":{
            "type":"integer",
            "format":"int64"
        },
        "endTime":{
            "type":"integer",
            "format":"int64"
        },
        "direction":{
            "type":"string",
            "enum":[
                "BOTH",
                "IMPORT",
                "EXPORT",
                "NONE"
            ]
        },
        "syncType":{
            "type":"string",
            "enum":[
                "FULL",
                "INCREMENTAL"
            ]
        },
        "success":{
            "type":"boolean"
        },
        "connectionName":{
            "type":"string"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "requestId":{
            "type":"string",
            "format":"uuid"
        },
        "requestSummary":{
            "$ref":"#/definitions/Request"
        },
        "status":{
            "type":"string",
            "enum":[
                "PENDING",
                "COMPLETED",
                "ERROR",
                "RUNNING"
            ]
        },
        "taskHistory":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DimensionSyncTaskHistory"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "importOption":{
            "type":"string",
            "enum":[
                "ResetDimension",
                "ReplaceNodes",
                "Merge"
            ]
        },
        "publicApiFlag":{
            "type":"boolean"
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : messages

Type: array

Show Source

• Array of: string

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

Nested Schema : Request

Type: object

A Request models changes to apply to a View

Show Source

• actionCount(optional): integer(int32)
  Read Only: true
• ageInDays(optional): integer(int64)
  Read Only: true
• approvalUsers(optional): array approvalUsers
  Read Only: true
• assignedTo(optional): string
  Read Only: true

  This property is now deprecated and will be removed in 10/2020. Use assignedToUser instead.
• assignedToUser(optional): object User
• attachmentCount(optional): integer(int32)
  Read Only: true
• autoSubmitted(optional): boolean
• blockedUntil(optional): integer(int64)
  Read Only: true
• commentCount(optional): integer(int32)
  Read Only: true
• commitUsers(optional): array commitUsers
  Read Only: true
• consolidationRequest(optional): object IdNameDescription
• consolidationRequestNumber(optional): integer(int32)
  Read Only: true
• consolidationRequestStatus(optional): string
  Read Only: true

  Allowed Values: [ "DRAFT", "IN_FLIGHT", "PULLED_BACK", "PUSHED_BACK", "COMPLETED", "REJECTED", "WITHDRAWN", "RECALLED", "BLOCKED", "CONSOLIDATED" ]
• createdBy(optional): string
  Read Only: true

  This property is now deprecated and will be removed in 10/2020. Use createdByUser instead.
• createdByUser(optional): object User
• description(optional): string
  Read Only: true
• hasViewAccess(optional): boolean
  Read Only: true
• id(optional): string(uuid)
  Read Only: true
• initialSubmit(optional): integer(int64)
  Read Only: true
• inviteeUsers(optional): array inviteeUsers
  Read Only: true
• itemCount(optional): integer(int32)
  Read Only: true
• links(optional): array links
  Read Only: true
• modifiedBy(optional): string
  Read Only: true

  This property is now deprecated and will be removed in 10/2020. Use modifiedByUser instead.
• modifiedByUser(optional): object User
• notes(optional): string
  Read Only: true
• origin(optional): string
  Read Only: true

  Allowed Values: [ "DEFINED", "INSTRUCTIVE", "INTERACTIVE", "MEMBERSHIP", "NOTIFICATION", "REMEDIATION", "SUBSCRIPTION", "CONSOLIDATION", "IMPORT", "LOAD" ]
• owner(optional): object User
• requestNumber(optional): integer(int32)
  Read Only: true
• requestType(optional): string
  Read Only: true

  Allowed Values: [ "DEFINED", "INSTRUCTIVE", "INTERACTIVE", "MEMBERSHIP", "NOTIFICATION", "REMEDIATION", "SUBSCRIPTION", "CONSOLIDATION", "IMPORT", "LOAD" ]
• sourceRequest(optional): object IdNameLink
• stage(optional): string
  Read Only: true

  Allowed Values: [ "SUBMIT", "REVIEW", "ENRICH", "APPROVE", "COMMIT", "CLOSED" ]
• status(optional): string
  Read Only: true

  Allowed Values: [ "DRAFT", "IN_FLIGHT", "PULLED_BACK", "PUSHED_BACK", "COMPLETED", "REJECTED", "WITHDRAWN", "RECALLED", "BLOCKED", "CONSOLIDATED" ]
• submittedBy(optional): string
  Read Only: true

  This property is now deprecated and will be removed in 10/2020. Use submittedByUser instead.
• submittedByUser(optional): object User
• subscriptions(optional): array subscriptions
  Read Only: true
• timeCreated(optional): integer(int64)
  Read Only: true
• timeModified(optional): integer(int64)
  Read Only: true
• timeSubmitted(optional): integer(int64)
  Read Only: true
• title(optional): string
  Read Only: true
• validationErrorCount(optional): integer(int32)
  Read Only: true
• validTransitionActions(optional): array validTransitionActions
  Read Only: true
• valWarningCountOnClose(optional): integer(int32)
  Read Only: true

  If the request is closed, the number of validation warnings that existed, and were allowed, at the time it was closed.
• viewId(optional): string(uuid)
  Read Only: true
• viewName(optional): string
  Read Only: true
• viewStatus(optional): string
  Read Only: true

  Allowed Values: [ "DRAFT", "ACTIVE", "SUNSET", "ARCHIVED", "DELETED" ]

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "title":{
            "type":"string",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "readOnly":true
        },
        "origin":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "DEFINED",
                "INSTRUCTIVE",
                "INTERACTIVE",
                "MEMBERSHIP",
                "NOTIFICATION",
                "REMEDIATION",
                "SUBSCRIPTION",
                "CONSOLIDATION",
                "IMPORT",
                "LOAD"
            ]
        },
        "requestType":{
            "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"
            ]
        },
        "stage":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "SUBMIT",
                "REVIEW",
                "ENRICH",
                "APPROVE",
                "COMMIT",
                "CLOSED"
            ]
        },
        "requestNumber":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "timeModified":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "timeSubmitted":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "createdBy":{
            "type":"string",
            "description":"This property is now deprecated and will be removed in 10/2020. Use createdByUser instead.",
            "readOnly":true
        },
        "modifiedBy":{
            "type":"string",
            "description":"This property is now deprecated and will be removed in 10/2020. Use modifiedByUser instead.",
            "readOnly":true
        },
        "submittedBy":{
            "type":"string",
            "description":"This property is now deprecated and will be removed in 10/2020. Use submittedByUser instead.",
            "readOnly":true
        },
        "assignedTo":{
            "type":"string",
            "description":"This property is now deprecated and will be removed in 10/2020. Use assignedToUser instead.",
            "readOnly":true
        },
        "inviteeUsers":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/User"
            }
        },
        "approvalUsers":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/User"
            }
        },
        "commitUsers":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/User"
            }
        },
        "notes":{
            "type":"string",
            "readOnly":true
        },
        "itemCount":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "commentCount":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "validationErrorCount":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "attachmentCount":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "actionCount":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "viewId":{
            "type":"string",
            "format":"uuid",
            "readOnly":true
        },
        "viewName":{
            "type":"string",
            "readOnly":true
        },
        "hasViewAccess":{
            "type":"boolean",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "consolidationRequestNumber":{
            "type":"integer",
            "format":"int32",
            "readOnly":true
        },
        "consolidationRequestStatus":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "DRAFT",
                "IN_FLIGHT",
                "PULLED_BACK",
                "PUSHED_BACK",
                "COMPLETED",
                "REJECTED",
                "WITHDRAWN",
                "RECALLED",
                "BLOCKED",
                "CONSOLIDATED"
            ]
        },
        "consolidationRequest":{
            "readOnly":true,
            "$ref":"#/definitions/IdNameDescription"
        },
        "initialSubmit":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "validTransitionActions":{
            "type":"array",
            "readOnly":true,
            "items":{
                "type":"string",
                "enum":[
                    "SUBMIT",
                    "APPROVE",
                    "PUSHBACK",
                    "REJECT",
                    "WITHDRAW",
                    "RECALL",
                    "COMMIT"
                ]
            }
        },
        "viewStatus":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "DRAFT",
                "ACTIVE",
                "SUNSET",
                "ARCHIVED",
                "DELETED"
            ]
        },
        "ageInDays":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "createdByUser":{
            "readOnly":true,
            "$ref":"#/definitions/User"
        },
        "modifiedByUser":{
            "readOnly":true,
            "$ref":"#/definitions/User"
        },
        "submittedByUser":{
            "readOnly":true,
            "$ref":"#/definitions/User"
        },
        "assignedToUser":{
            "readOnly":true,
            "$ref":"#/definitions/User"
        },
        "owner":{
            "$ref":"#/definitions/User"
        },
        "sourceRequest":{
            "readOnly":true,
            "$ref":"#/definitions/IdNameLink"
        },
        "subscriptions":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/IdNameLink"
            }
        },
        "blockedUntil":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "valWarningCountOnClose":{
            "type":"integer",
            "format":"int32",
            "description":"If the request is closed, the number of validation warnings that existed, and were allowed, at the time it was closed.",
            "readOnly":true
        },
        "autoSubmitted":{
            "type":"boolean"
        }
    },
    "description":"A Request models changes to apply to a View"
}

Nested Schema : taskHistory

Type: array

Show Source

• Array of: object DimensionSyncTaskHistory

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

Nested Schema : approvalUsers

Type: array

Read Only: true

Show Source

• Array of: object User

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

Nested Schema : commitUsers

Type: array

Read Only: true

Show Source

• Array of: object User

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

Nested Schema : inviteeUsers

Type: array

Read Only: true

Show Source

• Array of: object User

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

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

Nested Schema : subscriptions

Type: array

Read Only: true

Show Source

• Array of: object IdNameLink

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

Nested Schema : validTransitionActions

Type: array

Read Only: true

Show Source

• Array of: string
  Allowed Values: [ "SUBMIT", "APPROVE", "PUSHBACK", "REJECT", "WITHDRAW", "RECALL", "COMMIT" ]

{
    "type":"array",
    "readOnly":true,
    "items":{
        "type":"string",
        "enum":[
            "SUBMIT",
            "APPROVE",
            "PUSHBACK",
            "REJECT",
            "WITHDRAW",
            "RECALL",
            "COMMIT"
        ]
    }
}

Nested Schema : DimensionSyncTaskHistory

Type: object

Show Source

• duration(optional): string
  Read Only: true
• endTime(optional): integer(int64)
• messages(optional): array messages
• startTime(optional): integer(int64)
• status(optional): string
  Allowed Values: [ "PENDING", "COMPLETED", "ERROR", "RUNNING" ]
• syncId(optional): string(uuid)
• taskKey(optional): string
  Read Only: true
• taskName(optional): string

{
    "type":"object",
    "properties":{
        "syncId":{
            "type":"string",
            "format":"uuid"
        },
        "taskName":{
            "type":"string"
        },
        "taskKey":{
            "type":"string",
            "readOnly":true
        },
        "status":{
            "type":"string",
            "enum":[
                "PENDING",
                "COMPLETED",
                "ERROR",
                "RUNNING"
            ]
        },
        "startTime":{
            "type":"integer",
            "format":"int64"
        },
        "endTime":{
            "type":"integer",
            "format":"int64"
        },
        "duration":{
            "type":"string",
            "readOnly":true
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

• Array of: string

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

Nested Schema : ValidationSetting

Type: object

Show Source

• approveSeverity(optional): string
  Allowed Values: [ "ERROR", "WARNING", "IGNORE" ]
• commitSeverity(optional): string
  Allowed Values: [ "ERROR", "WARNING", "IGNORE" ]
• description(optional): string
• executionState(optional): string
  Allowed Values: [ "ENABLED", "DISABLED" ]
• id(optional): string
• name(optional): string
• submitSeverity(optional): string
  Allowed Values: [ "ERROR", "WARNING", "IGNORE" ]
• validationScope(optional): string
  Allowed Values: [ "APPLICATION", "NODE_TYPE", "HIERARCHY_SET", "DIMENSION", "ADAPTER" ]
• viewpointSeverity(optional): string
  Allowed Values: [ "ERROR", "WARNING", "IGNORE" ]

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "executionState":{
            "type":"string",
            "enum":[
                "ENABLED",
                "DISABLED"
            ]
        },
        "validationScope":{
            "type":"string",
            "enum":[
                "APPLICATION",
                "NODE_TYPE",
                "HIERARCHY_SET",
                "DIMENSION",
                "ADAPTER"
            ]
        },
        "viewpointSeverity":{
            "type":"string",
            "enum":[
                "ERROR",
                "WARNING",
                "IGNORE"
            ]
        },
        "commitSeverity":{
            "type":"string",
            "enum":[
                "ERROR",
                "WARNING",
                "IGNORE"
            ]
        },
        "approveSeverity":{
            "type":"string",
            "enum":[
                "ERROR",
                "WARNING",
                "IGNORE"
            ]
        },
        "submitSeverity":{
            "type":"string",
            "enum":[
                "ERROR",
                "WARNING",
                "IGNORE"
            ]
        }
    }
}

Nested Schema : NodeSet

Type: object

Node Set model that would be returned as response

Show Source

• application(optional): object Application
• bindingType(optional): string
  Allowed Values: [ "BOUND", "NODE_SET_BOUND", "HIERARCHY_SET_BOUND", "NODE_TYPE_BOUND", "PARTIAL_NODE_TYPE_BOUND", "MAPPING_BOUND", "UNBOUND" ]
• completenessError(optional): string
• createdByUser(optional): object User
• description(optional): string
• dimension(optional): object Dimension
  Dimension model that would be returned as response
• hierarchySet(optional): object HierarchySet
  Hierarchy Set model that would be returned as response
• id(optional): string(uuid)
• isBound(optional): boolean
  Read Only: true
• links(optional): array links
• modifiedByUser(optional): object User
• name(optional): string
• nodeTypes(optional): array nodeTypes
• objectStatus(optional): string
  Allowed Values: [ "DRAFT", "ACTIVE", "SUNSET", "ARCHIVED", "DELETED" ]
• permittedActions(optional): array permittedActions
  Unique Items Required: true
• predicate(optional): string
• related(optional): object Related
• scope(optional): string
  Allowed Values: [ "MASTER", "APPLICATION" ]
• sourceType(optional): string
• timeCreated(optional): integer(int64)
• timeModified(optional): integer(int64)
• topNodes(optional): array topNodes

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "sourceType":{
            "type":"string"
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64"
        },
        "timeModified":{
            "type":"integer",
            "format":"int64"
        },
        "predicate":{
            "type":"string"
        },
        "scope":{
            "type":"string",
            "enum":[
                "MASTER",
                "APPLICATION"
            ]
        },
        "objectStatus":{
            "type":"string",
            "enum":[
                "DRAFT",
                "ACTIVE",
                "SUNSET",
                "ARCHIVED",
                "DELETED"
            ]
        },
        "application":{
            "$ref":"#/definitions/Application"
        },
        "dimension":{
            "$ref":"#/definitions/Dimension"
        },
        "bindingType":{
            "type":"string",
            "enum":[
                "BOUND",
                "NODE_SET_BOUND",
                "HIERARCHY_SET_BOUND",
                "NODE_TYPE_BOUND",
                "PARTIAL_NODE_TYPE_BOUND",
                "MAPPING_BOUND",
                "UNBOUND"
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "hierarchySet":{
            "$ref":"#/definitions/HierarchySet"
        },
        "topNodes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Node"
            }
        },
        "nodeTypes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NodeType"
            }
        },
        "completenessError":{
            "type":"string"
        },
        "createdByUser":{
            "$ref":"#/definitions/User"
        },
        "modifiedByUser":{
            "$ref":"#/definitions/User"
        },
        "related":{
            "$ref":"#/definitions/Related"
        },
        "permittedActions":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "enum":[
                    "CREATE_CONSTRAINT",
                    "CREATE_NODETYPE",
                    "CREATE_HIERARCHYSET",
                    "CREATE_NODESET",
                    "CREATE_VIEWPOINT",
                    "CREATE_REQUEST",
                    "CREATE_PROPERTY",
                    "ASSIGN_REQUEST",
                    "SUBMIT_REQUEST",
                    "PUSHBACK_REQUEST",
                    "REJECT_REQUEST",
                    "APPROVE_REQUEST",
                    "WITHDRAW_REQUEST",
                    "COMMIT_REQUEST",
                    "ADD_REQUEST_COMMENT",
                    "ADD_REQUEST_ATTACHMENT",
                    "EDIT_REQUEST_HEADER",
                    "VALIDATE",
                    "EDIT_METADATA",
                    "REINDEX",
                    "EDIT",
                    "COPY_VIEWPOINT",
                    "LOAD_VIEWPOINT",
                    "ARCHIVE",
                    "DELETE",
                    "IMPORT",
                    "EXPORT",
                    "MANAGE_GRANTS",
                    "DELETE_NODE",
                    "ADD_NODE",
                    "INSERT_NODE",
                    "REORDER_NODE",
                    "REMOVE_NODE",
                    "MOVE_NODE",
                    "RECALL_REQUEST",
                    "COPY_EXTRACT",
                    "UPDATE_VISIBILITY",
                    "COPY",
                    "QUERY",
                    "RUN_EXTRACT_PACKAGE",
                    "CREATE_EXTRACT_PACKAGE"
                ]
            }
        },
        "isBound":{
            "type":"boolean",
            "readOnly":true
        }
    },
    "description":"Node Set model that would be returned as response"
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : nodeTypes

Type: array

Show Source

• Array of: object NodeType

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

Nested Schema : permittedActions

Type: array

Unique Items Required: true

Show Source

• Array of: string
  Allowed Values: [ "CREATE_CONSTRAINT", "CREATE_NODETYPE", "CREATE_HIERARCHYSET", "CREATE_NODESET", "CREATE_VIEWPOINT", "CREATE_REQUEST", "CREATE_PROPERTY", "ASSIGN_REQUEST", "SUBMIT_REQUEST", "PUSHBACK_REQUEST", "REJECT_REQUEST", "APPROVE_REQUEST", "WITHDRAW_REQUEST", "COMMIT_REQUEST", "ADD_REQUEST_COMMENT", "ADD_REQUEST_ATTACHMENT", "EDIT_REQUEST_HEADER", "VALIDATE", "EDIT_METADATA", "REINDEX", "EDIT", "COPY_VIEWPOINT", "LOAD_VIEWPOINT", "ARCHIVE", "DELETE", "IMPORT", "EXPORT", "MANAGE_GRANTS", "DELETE_NODE", "ADD_NODE", "INSERT_NODE", "REORDER_NODE", "REMOVE_NODE", "MOVE_NODE", "RECALL_REQUEST", "COPY_EXTRACT", "UPDATE_VISIBILITY", "COPY", "QUERY", "RUN_EXTRACT_PACKAGE", "CREATE_EXTRACT_PACKAGE" ]

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"string",
        "enum":[
            "CREATE_CONSTRAINT",
            "CREATE_NODETYPE",
            "CREATE_HIERARCHYSET",
            "CREATE_NODESET",
            "CREATE_VIEWPOINT",
            "CREATE_REQUEST",
            "CREATE_PROPERTY",
            "ASSIGN_REQUEST",
            "SUBMIT_REQUEST",
            "PUSHBACK_REQUEST",
            "REJECT_REQUEST",
            "APPROVE_REQUEST",
            "WITHDRAW_REQUEST",
            "COMMIT_REQUEST",
            "ADD_REQUEST_COMMENT",
            "ADD_REQUEST_ATTACHMENT",
            "EDIT_REQUEST_HEADER",
            "VALIDATE",
            "EDIT_METADATA",
            "REINDEX",
            "EDIT",
            "COPY_VIEWPOINT",
            "LOAD_VIEWPOINT",
            "ARCHIVE",
            "DELETE",
            "IMPORT",
            "EXPORT",
            "MANAGE_GRANTS",
            "DELETE_NODE",
            "ADD_NODE",
            "INSERT_NODE",
            "REORDER_NODE",
            "REMOVE_NODE",
            "MOVE_NODE",
            "RECALL_REQUEST",
            "COPY_EXTRACT",
            "UPDATE_VISIBILITY",
            "COPY",
            "QUERY",
            "RUN_EXTRACT_PACKAGE",
            "CREATE_EXTRACT_PACKAGE"
        ]
    }
}

Nested Schema : topNodes

Type: array

Show Source

• Array of: object Node

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

Nested Schema : NodeType

Type: object

Show Source

• alternateQualifiers(optional): array alternateQualifiers
• application(optional): object Application
• bindingType(optional): string
  Allowed Values: [ "BOUND", "NODE_SET_BOUND", "HIERARCHY_SET_BOUND", "NODE_TYPE_BOUND", "PARTIAL_NODE_TYPE_BOUND", "MAPPING_BOUND", "UNBOUND" ]
• class(optional): string
  Read Only: true

  Allowed Values: [ "LOOKUP", "LEGACY_GL", "NORMAL", "USER", "USER_ROLLUP" ]
• combination(optional): boolean
• compatibleBoundHierarchySets(optional): array compatibleBoundHierarchySets
  Unique Items Required: true
• compatibleBoundNodeSets(optional): array compatibleBoundNodeSets
  Unique Items Required: true
• converters(optional): array converters
• createdByUser(optional): object User
• defaultQualifier(optional): string
• description(optional): string
• dimension(optional): object Dimension
  Dimension model that would be returned as response
• id(optional): string(uuid)
• isBound(optional): boolean
  Read Only: true
• links(optional): array links
• modifiedByUser(optional): object User
• name(optional): string
• objectStatus(optional): string
  Allowed Values: [ "DRAFT", "ACTIVE", "SUNSET", "ARCHIVED", "DELETED" ]
• permittedActions(optional): array permittedActions
  Unique Items Required: true
• propertyDefinitions(optional): array propertyDefinitions
• qualifierPosition(optional): string
  Allowed Values: [ "PREFIX", "SUFFIX" ]
• related(optional): object Related
• scope(optional): string
  Allowed Values: [ "MASTER", "APPLICATION" ]
• timeCreated(optional): integer(int64)
• timeModified(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "scope":{
            "type":"string",
            "enum":[
                "MASTER",
                "APPLICATION"
            ]
        },
        "objectStatus":{
            "type":"string",
            "enum":[
                "DRAFT",
                "ACTIVE",
                "SUNSET",
                "ARCHIVED",
                "DELETED"
            ]
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64"
        },
        "timeModified":{
            "type":"integer",
            "format":"int64"
        },
        "application":{
            "$ref":"#/definitions/Application"
        },
        "dimension":{
            "$ref":"#/definitions/Dimension"
        },
        "bindingType":{
            "type":"string",
            "enum":[
                "BOUND",
                "NODE_SET_BOUND",
                "HIERARCHY_SET_BOUND",
                "NODE_TYPE_BOUND",
                "PARTIAL_NODE_TYPE_BOUND",
                "MAPPING_BOUND",
                "UNBOUND"
            ]
        },
        "permittedActions":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "enum":[
                    "CREATE_CONSTRAINT",
                    "CREATE_NODETYPE",
                    "CREATE_HIERARCHYSET",
                    "CREATE_NODESET",
                    "CREATE_VIEWPOINT",
                    "CREATE_REQUEST",
                    "CREATE_PROPERTY",
                    "ASSIGN_REQUEST",
                    "SUBMIT_REQUEST",
                    "PUSHBACK_REQUEST",
                    "REJECT_REQUEST",
                    "APPROVE_REQUEST",
                    "WITHDRAW_REQUEST",
                    "COMMIT_REQUEST",
                    "ADD_REQUEST_COMMENT",
                    "ADD_REQUEST_ATTACHMENT",
                    "EDIT_REQUEST_HEADER",
                    "VALIDATE",
                    "EDIT_METADATA",
                    "REINDEX",
                    "EDIT",
                    "COPY_VIEWPOINT",
                    "LOAD_VIEWPOINT",
                    "ARCHIVE",
                    "DELETE",
                    "IMPORT",
                    "EXPORT",
                    "MANAGE_GRANTS",
                    "DELETE_NODE",
                    "ADD_NODE",
                    "INSERT_NODE",
                    "REORDER_NODE",
                    "REMOVE_NODE",
                    "MOVE_NODE",
                    "RECALL_REQUEST",
                    "COPY_EXTRACT",
                    "UPDATE_VISIBILITY",
                    "COPY",
                    "QUERY",
                    "RUN_EXTRACT_PACKAGE",
                    "CREATE_EXTRACT_PACKAGE"
                ]
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "compatibleBoundNodeSets":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string"
            }
        },
        "compatibleBoundHierarchySets":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string"
            }
        },
        "propertyDefinitions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NodeTypeProperty"
            }
        },
        "converters":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Converter"
            }
        },
        "related":{
            "$ref":"#/definitions/Related"
        },
        "defaultQualifier":{
            "type":"string"
        },
        "alternateQualifiers":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "qualifierPosition":{
            "type":"string",
            "enum":[
                "PREFIX",
                "SUFFIX"
            ]
        },
        "createdByUser":{
            "$ref":"#/definitions/User"
        },
        "modifiedByUser":{
            "$ref":"#/definitions/User"
        },
        "combination":{
            "type":"boolean"
        },
        "isBound":{
            "type":"boolean",
            "readOnly":true
        },
        "class":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "LOOKUP",
                "LEGACY_GL",
                "NORMAL",
                "USER",
                "USER_ROLLUP"
            ]
        }
    }
}

Nested Schema : alternateQualifiers

Type: array

Show Source

• Array of: string

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

Nested Schema : compatibleBoundHierarchySets

Type: array

Unique Items Required: true

Show Source

• Array of: string

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

Nested Schema : compatibleBoundNodeSets

Type: array

Unique Items Required: true

Show Source

• Array of: string

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

Nested Schema : converters

Type: array

Show Source

• Array of: object Converter

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : permittedActions

Type: array

Unique Items Required: true

Show Source

• Array of: string
  Allowed Values: [ "CREATE_CONSTRAINT", "CREATE_NODETYPE", "CREATE_HIERARCHYSET", "CREATE_NODESET", "CREATE_VIEWPOINT", "CREATE_REQUEST", "CREATE_PROPERTY", "ASSIGN_REQUEST", "SUBMIT_REQUEST", "PUSHBACK_REQUEST", "REJECT_REQUEST", "APPROVE_REQUEST", "WITHDRAW_REQUEST", "COMMIT_REQUEST", "ADD_REQUEST_COMMENT", "ADD_REQUEST_ATTACHMENT", "EDIT_REQUEST_HEADER", "VALIDATE", "EDIT_METADATA", "REINDEX", "EDIT", "COPY_VIEWPOINT", "LOAD_VIEWPOINT", "ARCHIVE", "DELETE", "IMPORT", "EXPORT", "MANAGE_GRANTS", "DELETE_NODE", "ADD_NODE", "INSERT_NODE", "REORDER_NODE", "REMOVE_NODE", "MOVE_NODE", "RECALL_REQUEST", "COPY_EXTRACT", "UPDATE_VISIBILITY", "COPY", "QUERY", "RUN_EXTRACT_PACKAGE", "CREATE_EXTRACT_PACKAGE" ]

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"string",
        "enum":[
            "CREATE_CONSTRAINT",
            "CREATE_NODETYPE",
            "CREATE_HIERARCHYSET",
            "CREATE_NODESET",
            "CREATE_VIEWPOINT",
            "CREATE_REQUEST",
            "CREATE_PROPERTY",
            "ASSIGN_REQUEST",
            "SUBMIT_REQUEST",
            "PUSHBACK_REQUEST",
            "REJECT_REQUEST",
            "APPROVE_REQUEST",
            "WITHDRAW_REQUEST",
            "COMMIT_REQUEST",
            "ADD_REQUEST_COMMENT",
            "ADD_REQUEST_ATTACHMENT",
            "EDIT_REQUEST_HEADER",
            "VALIDATE",
            "EDIT_METADATA",
            "REINDEX",
            "EDIT",
            "COPY_VIEWPOINT",
            "LOAD_VIEWPOINT",
            "ARCHIVE",
            "DELETE",
            "IMPORT",
            "EXPORT",
            "MANAGE_GRANTS",
            "DELETE_NODE",
            "ADD_NODE",
            "INSERT_NODE",
            "REORDER_NODE",
            "REMOVE_NODE",
            "MOVE_NODE",
            "RECALL_REQUEST",
            "COPY_EXTRACT",
            "UPDATE_VISIBILITY",
            "COPY",
            "QUERY",
            "RUN_EXTRACT_PACKAGE",
            "CREATE_EXTRACT_PACKAGE"
        ]
    }
}

Nested Schema : propertyDefinitions

Type: array

Show Source

• Array of: object NodeTypeProperty

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

Nested Schema : Node

Type: object

Show Source

• childCount(optional): integer(int32)
• description(optional): string
• hasChildren(optional): boolean
• id(optional): string(uuid)
• links(optional): array links
• location(optional): string
  This property is now deprecated and will be removed in 10/2020. Use path instead.
• locationsByParentId(optional): object locationsByParentId
  Additional Properties Allowed: additionalProperties

  This property is now deprecated and will be removed in 10/2020. Use path instead.
• name(optional): string
• nodeType(optional): object IdNameLink
• parentName(optional): string
• parentNodeId(optional): string(uuid)
• parentNodeTypeId(optional): string(uuid)
• path(optional): array path
• relationshipId(optional): string(uuid)
• requestItem(optional): object RequestItem
  A Request Item is a collection of actions to apply to a particular node as part of aRequest
• targetForNodeProperty(optional): 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 and will be removed in 10/2020. Use path instead."
        },
        "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"
        },
        "locationsByParentId":{
            "type":"object",
            "description":"This property is now deprecated and will be removed in 10/2020. Use path instead.",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "targetForNodeProperty":{
            "type":"boolean"
        },
        "childCount":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : locationsByParentId

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "description":"This property is now deprecated and will be removed in 10/2020. Use path instead.",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

This property is now deprecated and will be removed in 10/2020. Use path instead.

Nested Schema : path

Type: array

Show Source

• Array of: object IdNameLink

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

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(optional): integer(int32)
• actions(optional): array actions
• actionSummary(optional): string
• applicationName(optional): string
• createdBy(optional): string
• description(optional): string
• id(optional): string(uuid)
• links(optional): array links
• modifiedBy(optional): string
• name(optional): string
• nodeTypeId(optional): string(uuid)
• nodeTypeName(optional): string
• policies(optional): array policies
• timeCreated(optional): integer(int64)
• timeModified(optional): integer(int64)
• validations(optional): 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"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "policies":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PolicyInfo"
            }
        }
    },
    "description":"A Request Item is a collection of actions to apply to a particular node as part of aRequest"
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

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

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 : 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(optional): object JsonNode
• id(optional): string(uuid)
  Read Only: true
• layoutOptions(optional): object layoutOptions
  Additional Properties Allowed: additionalProperties
• links(optional): array links
• nodeTypeName(optional): string
• parentName(optional): string
• parentNodeId(optional): string(uuid)
  id of the parent node this action was performed under, if any
• propertyLevel(optional): string
• summary(optional): string
• type(optional): string
  Read Only: true

  Allowed Values: [ "addNode", "insertNode", "removeNode", "moveNode", "deleteNode", "renameNode", "updateNodeProp", "reorderNode" ]
• viewpointId(optional): string(uuid)
• viewpointName(optional): string
• viewpointUri(optional): 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 : 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 : PolicyInfo

Type: object

Show Source

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

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

Nested Schema : ValidationResult

Type: object

The result of validation

Show Source

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

  The severity of the validation issue (ERROR or WARNING) for the stage at which the validation failed.
• timeCreated(optional): integer(int64)
• type(optional): string
  Allowed Values: [ "ERROR" ]
• userCanResolve(optional): 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"
            ]
        },
        "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"
    }
}

Back to Top

Examples

The following example shows how to retrieve all the viewpoints of a COPY_VIEWPOINT 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/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints

Example of the Response Body

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

{
    "items": [
        {
            "id": "cb579c5f-fcc3-4920-b975-3fb133cfbcdc",
            "name": "Account",
            "description": "Account dimension for EPBCS",
            "layoutOptions": {
                "defaultLayout": "HIERARCHICAL"
            },
            "hasHierarchy": true,
            "scope": "APPLICATION",
            "createdBy": "demoadmin",
            "modifiedBy": "Casey.Brown",
            "timeCreated": "2017-11-08T16:27:18.278Z",
            "timeModified": "2019-04-22T20:48:04.629Z",
            "sortOrder": 0,
            "objectStatus": "ACTIVE",
            "nodeSetLink": {
                "id": "9d0a4b24-b96d-430a-b9f3-b1e033bd0eb3",
                "name": "Account",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/nodeSets/9d0a4b24-b96d-430a-b9f3-b1e033bd0eb3"
                    }
                ]
            },
            "applicationLink": {
                "id": "e63e92c4-4727-4999-97f2-50498cb40ec7",
                "name": "Corporate Planning",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7"
                    }
                ]
            },
            "bindingType": "BOUND",
            "links": [
                {
                    "rel": "delete",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/cb579c5f-fcc3-4920-b975-3fb133cfbcdc",
                    "method": "DELETE"
                },
                {
                    "rel": "edit",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/cb579c5f-fcc3-4920-b975-3fb133cfbcdc",
                    "method": "PUT"
                },
                {
                    "rel": "copy",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/copyAt/{targetViewpointId}",
                    "templated": true,
                    "method": "POST"
                },
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/cb579c5f-fcc3-4920-b975-3fb133cfbcdc"
                },
                {
                    "rel": "computed",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/cb579c5f-fcc3-4920-b975-3fb133cfbcdc/computed"
                },
                {
                    "rel": "download",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/cb579c5f-fcc3-4920-b975-3fb133cfbcdc/download"
                },
                {
                    "rel": "view",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10"
                },
                {
                    "rel": "nodeSet",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/nodeSets/9d0a4b24-b96d-430a-b9f3-b1e033bd0eb3"
                },
                {
                    "rel": "application",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7"
                },
                {
                    "rel": "hierarchySet",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/hierarchySets/bf81bafd-ab68-42ef-845e-5c4b2a76108e"
                },
                {
                    "rel": "validate",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/cb579c5f-fcc3-4920-b975-3fb133cfbcdc/validations",
                    "method": "POST"
                },
                {
                    "rel": "searchNodes",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/cb579c5f-fcc3-4920-b975-3fb133cfbcdc/nodes/search",
                    "method": "POST"
                },
                {
                    "rel": "permittedUsers",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/cb579c5f-fcc3-4920-b975-3fb133cfbcdc/permittedUsers",
                    "method": "GET"
                },
                {
                    "rel": "nodes",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/cb579c5f-fcc3-4920-b975-3fb133cfbcdc/nodes?q={q}&fromId={fromId}&toId={toId}&limit={limit}&orderBy={orderBy}&expand={expand}",
                    "templated": true
                },
                {
                    "rel": "node",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/cb579c5f-fcc3-4920-b975-3fb133cfbcdc/nodes/{nodeId}?q={q}&expand={expand}",
                    "templated": true
                },
                {
                    "rel": "relationships",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/cb579c5f-fcc3-4920-b975-3fb133cfbcdc/nodes/{nodeId}/relationships?q={q}",
                    "templated": true
                },
                {
                    "rel": "topNodes",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/cb579c5f-fcc3-4920-b975-3fb133cfbcdc/nodes?q=top"
                },
                {
                    "rel": "compare",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/cb579c5f-fcc3-4920-b975-3fb133cfbcdc/compare",
                    "method": "POST"
                }
            ],
            "permittedActions": [
                "ARCHIVE",
                "DELETE",
                "EDIT_METADATA",
                "COPY_VIEWPOINT"
            ],
            "viewName": "Corporate Planning",
            "viewDescription": "Corporate Planning",
            "dimensionLink": {
                "id": "cdc22d88-8b47-4521-8f16-5edcc31e3f77",
                "name": "Account",
                "description": "Account dimension for EPBCS",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/dimensions/cdc22d88-8b47-4521-8f16-5edcc31e3f77"
                    }
                ]
            },
            "isBound": true
        },
        {
            "id": "b52ad796-bbde-4590-ad0b-d92ddc12c21a",
            "name": "Entity",
            "description": "Entity dimension for EPBCS",
            "layoutOptions": {
                "defaultLayout": "HIERARCHICAL"
            },
            "hasHierarchy": true,
            "scope": "APPLICATION",
            "createdBy": "demoadmin",
            "modifiedBy": "Casey.Brown",
            "timeCreated": "2017-11-08T16:27:18.278Z",
            "timeModified": "2019-04-22T20:48:04.629Z",
            "sortOrder": 1,
            "objectStatus": "ACTIVE",
            "nodeSetLink": {
                "id": "87279e92-4e43-4a0f-97e5-a9ce5e4ca3a2",
                "name": "Entity",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/nodeSets/87279e92-4e43-4a0f-97e5-a9ce5e4ca3a2"
                    }
                ]
            },
            "applicationLink": {
                "id": "e63e92c4-4727-4999-97f2-50498cb40ec7",
                "name": "Corporate Planning",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7"
                    }
                ]
            },
            "bindingType": "BOUND",
            "links": [
                {
                    "rel": "delete",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/b52ad796-bbde-4590-ad0b-d92ddc12c21a",
                    "method": "DELETE"
                },
                {
                    "rel": "edit",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/b52ad796-bbde-4590-ad0b-d92ddc12c21a",
                    "method": "PUT"
                },
                {
                    "rel": "copy",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/copyAt/{targetViewpointId}",
                    "templated": true,
                    "method": "POST"
                },
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/b52ad796-bbde-4590-ad0b-d92ddc12c21a"
                },
                {
                    "rel": "computed",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/b52ad796-bbde-4590-ad0b-d92ddc12c21a/computed"
                },
                {
                    "rel": "download",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/b52ad796-bbde-4590-ad0b-d92ddc12c21a/download"
                },
                {
                    "rel": "view",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10"
                },
                {
                    "rel": "nodeSet",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/nodeSets/87279e92-4e43-4a0f-97e5-a9ce5e4ca3a2"
                },
                {
                    "rel": "application",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7"
                },
                {
                    "rel": "hierarchySet",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/hierarchySets/b711d4f8-e5de-4a55-9790-3edc0503419e"
                },
                {
                    "rel": "validate",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/b52ad796-bbde-4590-ad0b-d92ddc12c21a/validations",
                    "method": "POST"
                },
                {
                    "rel": "searchNodes",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/b52ad796-bbde-4590-ad0b-d92ddc12c21a/nodes/search",
                    "method": "POST"
                },
                {
                    "rel": "permittedUsers",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/b52ad796-bbde-4590-ad0b-d92ddc12c21a/permittedUsers",
                    "method": "GET"
                },
                {
                    "rel": "nodes",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/b52ad796-bbde-4590-ad0b-d92ddc12c21a/nodes?q={q}&fromId={fromId}&toId={toId}&limit={limit}&orderBy={orderBy}&expand={expand}",
                    "templated": true
                },
                {
                    "rel": "node",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/b52ad796-bbde-4590-ad0b-d92ddc12c21a/nodes/{nodeId}?q={q}&expand={expand}",
                    "templated": true
                },
                {
                    "rel": "relationships",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/b52ad796-bbde-4590-ad0b-d92ddc12c21a/nodes/{nodeId}/relationships?q={q}",
                    "templated": true
                },
                {
                    "rel": "topNodes",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/b52ad796-bbde-4590-ad0b-d92ddc12c21a/nodes?q=top"
                },
                {
                    "rel": "compare",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/b52ad796-bbde-4590-ad0b-d92ddc12c21a/compare",
                    "method": "POST"
                }
            ],
            "permittedActions": [
                "ARCHIVE",
                "DELETE",
                "EDIT_METADATA",
                "COPY_VIEWPOINT"
            ],
            "viewName": "Corporate Planning",
            "viewDescription": "Corporate Planning",
            "dimensionLink": {
                "id": "5f4f2fb4-cc46-4a44-b680-7e832d3cb6cb",
                "name": "Entity",
                "description": "Entity dimension for EPBCS",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/dimensions/5f4f2fb4-cc46-4a44-b680-7e832d3cb6cb"
                    }
                ]
            },
            "isBound": true
        },
        {
            "id": "ea17a046-05bc-44ef-b2c6-fa00ec738c6c",
            "name": "Product",
            "description": "Product dimension for EPBCS",
            "layoutOptions": {
                "defaultLayout": "HIERARCHICAL"
            },
            "hasHierarchy": true,
            "scope": "APPLICATION",
            "createdBy": "demoadmin",
            "modifiedBy": "Casey.Brown",
            "timeCreated": "2017-11-08T16:27:18.278Z",
            "timeModified": "2019-04-22T20:48:04.629Z",
            "sortOrder": 2,
            "objectStatus": "ACTIVE",
            "nodeSetLink": {
                "id": "7474b7cd-7ed1-41ea-9eef-f8cb20666365",
                "name": "Product",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/nodeSets/7474b7cd-7ed1-41ea-9eef-f8cb20666365"
                    }
                ]
            },
            "applicationLink": {
                "id": "e63e92c4-4727-4999-97f2-50498cb40ec7",
                "name": "Corporate Planning",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7"
                    }
                ]
            },
            "bindingType": "BOUND",
            "links": [
                {
                    "rel": "delete",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/ea17a046-05bc-44ef-b2c6-fa00ec738c6c",
                    "method": "DELETE"
                },
                {
                    "rel": "edit",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/ea17a046-05bc-44ef-b2c6-fa00ec738c6c",
                    "method": "PUT"
                },
                {
                    "rel": "copy",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/copyAt/{targetViewpointId}",
                    "templated": true,
                    "method": "POST"
                },
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/ea17a046-05bc-44ef-b2c6-fa00ec738c6c"
                },
                {
                    "rel": "computed",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/ea17a046-05bc-44ef-b2c6-fa00ec738c6c/computed"
                },
                {
                    "rel": "download",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/ea17a046-05bc-44ef-b2c6-fa00ec738c6c/download"
                },
                {
                    "rel": "view",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10"
                },
                {
                    "rel": "nodeSet",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/nodeSets/7474b7cd-7ed1-41ea-9eef-f8cb20666365"
                },
                {
                    "rel": "application",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7"
                },
                {
                    "rel": "hierarchySet",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/hierarchySets/19bd6f3b-9ac5-42ff-b213-6f8491ac5a7d"
                },
                {
                    "rel": "validate",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/ea17a046-05bc-44ef-b2c6-fa00ec738c6c/validations",
                    "method": "POST"
                },
                {
                    "rel": "searchNodes",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/ea17a046-05bc-44ef-b2c6-fa00ec738c6c/nodes/search",
                    "method": "POST"
                },
                {
                    "rel": "permittedUsers",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/ea17a046-05bc-44ef-b2c6-fa00ec738c6c/permittedUsers",
                    "method": "GET"
                },
                {
                    "rel": "nodes",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/ea17a046-05bc-44ef-b2c6-fa00ec738c6c/nodes?q={q}&fromId={fromId}&toId={toId}&limit={limit}&orderBy={orderBy}&expand={expand}",
                    "templated": true
                },
                {
                    "rel": "node",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/ea17a046-05bc-44ef-b2c6-fa00ec738c6c/nodes/{nodeId}?q={q}&expand={expand}",
                    "templated": true
                },
                {
                    "rel": "relationships",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/ea17a046-05bc-44ef-b2c6-fa00ec738c6c/nodes/{nodeId}/relationships?q={q}",
                    "templated": true
                },
                {
                    "rel": "topNodes",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/ea17a046-05bc-44ef-b2c6-fa00ec738c6c/nodes?q=top"
                },
                {
                    "rel": "compare",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/ea17a046-05bc-44ef-b2c6-fa00ec738c6c/compare",
                    "method": "POST"
                }
            ],
            "permittedActions": [
                "ARCHIVE",
                "DELETE",
                "EDIT_METADATA",
                "COPY_VIEWPOINT"
            ],
            "viewName": "Corporate Planning",
            "viewDescription": "Corporate Planning",
            "dimensionLink": {
                "id": "db31cf05-6144-49a7-9ac1-1cb51b51b9d8",
                "name": "Product",
                "description": "Product dimension for EPBCS",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/dimensions/db31cf05-6144-49a7-9ac1-1cb51b51b9d8"
                    }
                ]
            },
            "isBound": true
        },
        {
            "id": "0be2487c-3984-4fe4-a0df-99bffbfa11c6",
            "name": "Cost Center",
            "description": "Cost Center dimension for EPBCS",
            "layoutOptions": {
                "defaultLayout": "HIERARCHICAL"
            },
            "hasHierarchy": true,
            "scope": "APPLICATION",
            "createdBy": "demoadmin",
            "modifiedBy": "Casey.Brown",
            "timeCreated": "2017-11-16T21:18:24.670Z",
            "timeModified": "2019-04-22T20:48:04.629Z",
            "sortOrder": 3,
            "objectStatus": "ACTIVE",
            "nodeSetLink": {
                "id": "b97cca1c-97d3-48cf-916c-59c588867da4",
                "name": "Cost Center",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/nodeSets/b97cca1c-97d3-48cf-916c-59c588867da4"
                    }
                ]
            },
            "applicationLink": {
                "id": "e63e92c4-4727-4999-97f2-50498cb40ec7",
                "name": "Corporate Planning",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7"
                    }
                ]
            },
            "bindingType": "BOUND",
            "links": [
                {
                    "rel": "delete",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/0be2487c-3984-4fe4-a0df-99bffbfa11c6",
                    "method": "DELETE"
                },
                {
                    "rel": "edit",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/0be2487c-3984-4fe4-a0df-99bffbfa11c6",
                    "method": "PUT"
                },
                {
                    "rel": "copy",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/copyAt/{targetViewpointId}",
                    "templated": true,
                    "method": "POST"
                },
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/0be2487c-3984-4fe4-a0df-99bffbfa11c6"
                },
                {
                    "rel": "computed",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/0be2487c-3984-4fe4-a0df-99bffbfa11c6/computed"
                },
                {
                    "rel": "download",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/0be2487c-3984-4fe4-a0df-99bffbfa11c6/download"
                },
                {
                    "rel": "view",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10"
                },
                {
                    "rel": "nodeSet",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/nodeSets/b97cca1c-97d3-48cf-916c-59c588867da4"
                },
                {
                    "rel": "application",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/applications/e63e92c4-4727-4999-97f2-50498cb40ec7"
                },
                {
                    "rel": "hierarchySet",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/hierarchySets/bfa62e17-c42a-41d0-a095-8c8b157703ae"
                },
                {
                    "rel": "validate",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/0be2487c-3984-4fe4-a0df-99bffbfa11c6/validations",
                    "method": "POST"
                },
                {
                    "rel": "searchNodes",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/0be2487c-3984-4fe4-a0df-99bffbfa11c6/nodes/search",
                    "method": "POST"
                },
                {
                    "rel": "permittedUsers",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/0be2487c-3984-4fe4-a0df-99bffbfa11c6/permittedUsers",
                    "method": "GET"
                },
                {
                    "rel": "nodes",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/0be2487c-3984-4fe4-a0df-99bffbfa11c6/nodes?q={q}&fromId={fromId}&toId={toId}&limit={limit}&orderBy={orderBy}&expand={expand}",
                    "templated": true
                },
                {
                    "rel": "node",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/0be2487c-3984-4fe4-a0df-99bffbfa11c6/nodes/{nodeId}?q={q}&expand={expand}",
                    "templated": true
                },
                {
                    "rel": "relationships",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/0be2487c-3984-4fe4-a0df-99bffbfa11c6/nodes/{nodeId}/relationships?q={q}",
                    "templated": true
                },
                {
                    "rel": "topNodes",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/0be2487c-3984-4fe4-a0df-99bffbfa11c6/nodes?q=top"
                },
                {
                    "rel": "compare",
                    "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/0be2487c-3984-4fe4-a0df-99bffbfa11c6/compare",
                    "method": "POST"
                }
            ],
            "permittedActions": [
                "ARCHIVE",
                "DELETE",
                "EDIT_METADATA",
                "COPY_VIEWPOINT"
            ],
            "viewName": "Corporate Planning",
            "viewDescription": "Corporate Planning",
            "dimensionLink": {
                "id": "3182f1b5-8d22-446e-b266-0097859343cd",
                "name": "Cost Center",
                "description": "Cost Center dimension for EPBCS",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/dimensions/3182f1b5-8d22-446e-b266-0097859343cd"
                    }
                ]
            },
            "isBound": true
        }
    ],
    "links": [
        {
            "rel": "edit",
            "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints",
            "method": "PUT"
        },
        {
            "rel": "copy",
            "href": "https://servername.fa.us2.oraclecloud.com:9000/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints/copyAt/{targetViewpointId}",
            "templated": true,
            "method": "POST"
        }
    ],
    "hasMore": false,
    "totalResults": 4,
    "limit": 0,
    "count": 4
}

Back to Top