Jump to

• Request
• Response
• Examples

Get Viewpoint Extracts

get

/epm/rest/v1/extracts

Returns a list of all the extracts the user has access to.

Request

Query Parameters

• q: array[string]
  Collection Format: multi

  filters Extracts

  • Allowed Values: [ "view::{view Id to match extract view}", "integration_only::{TRUE or FALSE}", "viewpoint::{viewpoint Id to match extract viewpoint}", "application::{application Id to match validation}", "dimension::{dimension Id to match validation}", "scope::{PUBLIC or PRIVATE}" ]

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : ItemExtract

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/SimpleExtract"
            }
        },
        "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 SimpleExtract

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

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

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

Nested Schema : SimpleExtract

Type: object

Show Source

• application: object IdNameLink
• createdByUser: object User
• description: string
• dimension: object Dimension
  Dimension model that would be returned as response
• extractConnection: object ExtractConnection
• extractType: string
• fileName: string
• id: string(uuid)
• integrationOnly: boolean
• lastExtractInfo: object ExtractHistory
• links: array links
• modifiedByUser: object User
• name: string
• profileOwner: object User
• public: boolean
• timeCreated: integer(int64)
• timeModified: integer(int64)
• view: object View
• viewpoint: object Viewpoint

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "extractConnection":{
            "$ref":"#/definitions/ExtractConnection"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "viewpoint":{
            "$ref":"#/definitions/Viewpoint"
        },
        "view":{
            "$ref":"#/definitions/View"
        },
        "application":{
            "$ref":"#/definitions/IdNameLink"
        },
        "dimension":{
            "$ref":"#/definitions/Dimension"
        },
        "extractType":{
            "type":"string"
        },
        "fileName":{
            "type":"string"
        },
        "createdByUser":{
            "$ref":"#/definitions/User"
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64"
        },
        "modifiedByUser":{
            "$ref":"#/definitions/User"
        },
        "timeModified":{
            "type":"integer",
            "format":"int64"
        },
        "lastExtractInfo":{
            "$ref":"#/definitions/ExtractHistory"
        },
        "profileOwner":{
            "$ref":"#/definitions/User"
        },
        "integrationOnly":{
            "type":"boolean"
        },
        "public":{
            "type":"boolean"
        }
    }
}

Nested Schema : IdNameLink

Type: object

Show Source

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

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

Nested Schema : User

Type: object

Show Source

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

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

Nested Schema : Dimension

Type: object

Dimension model that would be returned as response

Show Source

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

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

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

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

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

  Unique Items Required: true
• supportedDirection: string
  Read Only: true

  Allowed Values: [ "BOTH", "IMPORT", "EXPORT", "NONE" ]
• supportsExtracts: boolean
  Read Only: true
• supportsMapping: boolean
  Read Only: true
• supportsMappingExport: boolean
  Read Only: true
• supportsTemplateExport: boolean
  Read Only: true
• timeCreated: integer(int64)
  Read Only: true
• timeModified: integer(int64)
  Read Only: true
• validationSettings: 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",
                    "CLOSE",
                    "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 : ExtractConnection

Type: object

Show Source

• connectionOptions: object JsonNode
• connectionSummary: object GlobalConnection

{
    "type":"object",
    "properties":{
        "connectionSummary":{
            "$ref":"#/definitions/GlobalConnection"
        },
        "connectionOptions":{
            "$ref":"#/definitions/JsonNode"
        }
    }
}

Nested Schema : ExtractHistory

Type: object

Show Source

• connectionName: string
• endTime: integer(int64)
• extractType: string
  Allowed Values: [ "DEFAULT", "INCREMENTAL", "GENERATIONAL" ]
• links: array links
• messages: array messages
• packageFlag: boolean
• packageId: string(uuid)
• packageName: string
• publicApiFlag: boolean
• ranBy: string
• startTime: integer(int64)
• status: string
  Allowed Values: [ "PENDING", "COMPLETED", "ERROR", "RUNNING" ]
• success: boolean

{
    "type":"object",
    "properties":{
        "ranBy":{
            "type":"string"
        },
        "startTime":{
            "type":"integer",
            "format":"int64"
        },
        "endTime":{
            "type":"integer",
            "format":"int64"
        },
        "success":{
            "type":"boolean"
        },
        "status":{
            "type":"string",
            "enum":[
                "PENDING",
                "COMPLETED",
                "ERROR",
                "RUNNING"
            ]
        },
        "connectionName":{
            "type":"string"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "extractType":{
            "type":"string",
            "enum":[
                "DEFAULT",
                "INCREMENTAL",
                "GENERATIONAL"
            ]
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "publicApiFlag":{
            "type":"boolean"
        },
        "packageId":{
            "type":"string",
            "format":"uuid"
        },
        "packageName":{
            "type":"string"
        },
        "packageFlag":{
            "type":"boolean"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : View

Type: object

Show Source

• createdBy: string
  This property is now deprecated and will be removed in 10/2020. Use createdByUser instead.
• createdByUser: object User
• description: string
• id: string(uuid)
• links: array links
• master: boolean
• modifiedBy: string
  This property is now deprecated and will be removed in 10/2020. Use modifiedByUser instead.
• modifiedByUser: object User
• name: string
• objectStatus: string
  Allowed Values: [ "DRAFT", "ACTIVE", "SUNSET", "ARCHIVED", "DELETED" ]
• permittedActions: array permittedActions
  Unique Items Required: true
• requestDescription: string
  Allowed Values: [ "DEFAULT", "REQUIRED" ]
• requestPlaceholder: string
• timeCreated: integer(int64)
• timeModified: integer(int64)
• usersBrowseFilter: object UsersBrowseFilter

{
    "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",
            "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."
        },
        "master":{
            "type":"boolean"
        },
        "objectStatus":{
            "type":"string",
            "enum":[
                "DRAFT",
                "ACTIVE",
                "SUNSET",
                "ARCHIVED",
                "DELETED"
            ]
        },
        "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",
                    "CLOSE",
                    "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"
                ]
            }
        },
        "createdByUser":{
            "$ref":"#/definitions/User"
        },
        "modifiedByUser":{
            "$ref":"#/definitions/User"
        },
        "usersBrowseFilter":{
            "$ref":"#/definitions/UsersBrowseFilter"
        },
        "requestDescription":{
            "type":"string",
            "enum":[
                "DEFAULT",
                "REQUIRED"
            ]
        },
        "requestPlaceholder":{
            "type":"string"
        }
    }
}

Nested Schema : Viewpoint

Type: object

Show Source

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

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Link

Type: object

Show Source

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

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

Nested Schema : artifactAssignments

Type: array

Show Source

• Array of: object ArtifactAssignment

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

Nested Schema : associatedRoles

Type: array

Show Source

• Array of: object Role

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

Nested Schema : emailAddresses

Type: array

Show Source

• Array of: string

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Preferences

Type: object

Show Source

• languageTag: string
• links: array links
• outOfOffice: boolean
• profilePictureId: string(uuid)
• timeZone: object TimeZone

{
    "type":"object",
    "properties":{
        "profilePictureId":{
            "type":"string",
            "format":"uuid"
        },
        "timeZone":{
            "$ref":"#/definitions/TimeZone"
        },
        "languageTag":{
            "type":"string"
        },
        "outOfOffice":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : ArtifactAssignment

Type: object

Show Source

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

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

Nested Schema : Artifact

Type: object

Show Source

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

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

Nested Schema : Role

Type: object

Show Source

• id: string
• name: string

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : TimeZone

Type: object

Show Source

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

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

Nested Schema : bindings

Type: array

Read Only: true

Show Source

• Array of: object DimensionBinding

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

Nested Schema : BlockoutConfiguration

Type: object

Show Source

• enableBlockout: boolean
• end: integer(int64)
• grantPermissionsAllowedToCommit: array grantPermissionsAllowedToCommit
• lockUnboundObjects: boolean
• recurringBlockoutData: object RecurringBlockoutData
• source: string
  Allowed Values: [ "APPLICATION", "DIMENSION" ]
• start: integer(int64)
• timeZone: object ZoneId
• type: 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 : DimensionImportExportSettings

Type: object

Discriminator: type

Dimension Import/Export settings

Show Source

• type(required): 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", "CLOSE", "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",
            "CLOSE",
            "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: string
  Read Only: true
• description: string
  Read Only: true
• id: string(uuid)
  Read Only: true
• lastExportInfo: object DimensionSyncHistory
• lastImportInfo: object DimensionSyncHistory
• links: array links
  Read Only: true
• name: string
  Read Only: true
• slotAnswers: string
  Read Only: true
• supportsSettings: boolean
  Read Only: true
• view: object IdNameLink
• viewpoint: 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: string(uuid)
• connectionName: string
• direction: string
  Allowed Values: [ "BOTH", "IMPORT", "EXPORT", "NONE" ]
• endTime: integer(int64)
• importOption: string
  Allowed Values: [ "ResetDimension", "ReplaceNodes", "Merge" ]
• links: array links
• messages: array messages
• publicApiFlag: boolean
• ranBy: string
• requestId: string(uuid)
• requestSummary: object Request
  A Request models changes to apply to a View
• startTime: integer(int64)
• status: string
  Allowed Values: [ "PENDING", "COMPLETED", "ERROR", "RUNNING" ]
• success: boolean
• syncDescription: string
• syncId: string(uuid)
• syncType: string
  Allowed Values: [ "FULL", "INCREMENTAL" ]
• taskHistory: 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: integer(int32)
  Read Only: true
• ageInDays: integer(int64)
  Read Only: true
• approvalUsers: array approvalUsers
  Read Only: true
• assignedTo: string
  Read Only: true

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

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

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

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

  Allowed Values: [ "DEFINED", "INSTRUCTIVE", "INTERACTIVE", "MEMBERSHIP", "NOTIFICATION", "REMEDIATION", "SUBSCRIPTION", "CONSOLIDATION", "IMPORT", "LOAD" ]
• owner: object User
• priority: string
  Read Only: true

  Allowed Values: [ "NONE", "LOW", "MEDIUM", "HIGH" ]
• requestNumber: integer(int32)
  Read Only: true
• requestType: string
  Read Only: true

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

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

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

  This property is now deprecated and will be removed in 10/2020. Use submittedByUser instead.
• submittedByUser: object User
• subscriptions: array subscriptions
  Read Only: true
• timeCreated: integer(int64)
  Read Only: true
• timeModified: integer(int64)
  Read Only: true
• timeSubmitted: integer(int64)
  Read Only: true
• title: string
  Read Only: true
• validationErrorCount: integer(int32)
  Read Only: true
• validTransitionActions: array validTransitionActions
  Read Only: true
• valWarningCountOnClose: 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: string(uuid)
  Read Only: true
• viewName: string
  Read Only: true
• viewStatus: 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
        },
        "priority":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "NONE",
                "LOW",
                "MEDIUM",
                "HIGH"
            ]
        },
        "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",
                    "CLOSE"
                ]
            }
        },
        "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 : IdNameDescription

Type: object

Show Source

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

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

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", "CLOSE" ]

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

Nested Schema : DimensionSyncTaskHistory

Type: object

Show Source

• duration: string
  Read Only: true
• endTime: integer(int64)
• messages: array messages
• startTime: integer(int64)
• status: string
  Allowed Values: [ "PENDING", "COMPLETED", "ERROR", "RUNNING" ]
• syncId: string(uuid)
• taskKey: string
  Read Only: true
• taskName: 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 : 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: integer(int32)
• end: integer(int64)
• endOffset: integer(int32)
• rollingUnit: string
  Allowed Values: [ "NONE", "END_OF_MONTH", "END_OF_YEAR", "END_OF_QUARTER", "FISCAL_QUARTER_END", "FISCAL_YEAR_END" ]
• start: integer(int64)
• timeOfDay: 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: string
• rules: object ZoneRules

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

Nested Schema : ZoneRules

Type: object

Show Source

• fixedOffset: boolean
• transitionRules: array transitionRules
• transitions: array transitions

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

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: integer(int32)
• dayOfWeek: string
  Allowed Values: [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]
• localTime: object LocalTime
• midnightEndOfDay: boolean
• month: string
  Allowed Values: [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]
• offsetAfter: object ZoneOffset
• offsetBefore: object ZoneOffset
• standardOffset: object ZoneOffset
• timeDefinition: 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"
        },
        "dayOfMonthIndicator":{
            "type":"integer",
            "format":"int32"
        },
        "localTime":{
            "$ref":"#/definitions/LocalTime"
        },
        "midnightEndOfDay":{
            "type":"boolean"
        },
        "dayOfWeek":{
            "type":"string",
            "enum":[
                "MONDAY",
                "TUESDAY",
                "WEDNESDAY",
                "THURSDAY",
                "FRIDAY",
                "SATURDAY",
                "SUNDAY"
            ]
        }
    }
}

Nested Schema : LocalTime

Type: object

Show Source

• hour: integer(int32)
• minute: integer(int32)
• nano: integer(int32)
• second: 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: string
• rules: object ZoneRules
• totalSeconds: 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: string(date-time)
• dateTimeBefore: string(date-time)
• duration: object Duration
• gap: boolean
• instant: integer(int64)
• offsetAfter: object ZoneOffset
• offsetBefore: object ZoneOffset
• overlap: boolean

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

Nested Schema : Duration

Type: object

Show Source

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

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

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: boolean
• duration: object Duration
• durationEstimated: boolean
• timeBased: boolean

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

Nested Schema : ValidationSetting

Type: object

Show Source

• approveSeverity: string
  Allowed Values: [ "ERROR", "WARNING", "IGNORE" ]
• commitSeverity: string
  Allowed Values: [ "ERROR", "WARNING", "IGNORE" ]
• description: string
• executionState: string
  Allowed Values: [ "ENABLED", "DISABLED" ]
• id: string
• name: string
• submitSeverity: string
  Allowed Values: [ "ERROR", "WARNING", "IGNORE" ]
• validationScope: string
  Allowed Values: [ "APPLICATION", "NODE_TYPE", "HIERARCHY_SET", "DIMENSION", "ADAPTER" ]
• viewpointSeverity: 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 : JsonNode

Type: object

Nested Schema : GlobalConnection

Type: object

Show Source

• connectionDetails: object Global Connection Details
  Discriminator: type

  The details specific to this connection type. All connection types include "type", the type of the connection, see the 'type' object for allowed values, "url", the updated url for the connection, "username", the updated username for the connection, and "password", the updated password for the connection. EPM connections also include "identityDomain", the updated identity domain for the connection, and "folder", the updated epm folder. UCM connections also include "identityDomain", the updated identity domain for the connection, and "defaultDocumentAccount", the updated default document account. Oracle Object Store connections also include "defaultBucket", the updated name of the default target bucket and "defaultBucket", an optional parameter for the sub folder in the target bucket.
• connectionType: string
  Read Only: true

  Allowed Values: [ "ORACLE_OBJECT_STORE", "UCM", "EPM" ]
• createdByUser: object User
• description: string
  Read Only: true
• id: string(uuid)
  Read Only: true
• links: array links
  Read Only: true
• modifiedByUser: object User
• name: string
  Read Only: true
• supportedApplications: array supportedApplications
  Read Only: true
• timeCreated: integer(int64)
  Read Only: true
• timeModified: 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
        },
        "connectionDetails":{
            "readOnly":true,
            "$ref":"#/definitions/Global Connection Details"
        },
        "connectionType":{
            "type":"string",
            "readOnly":true,
            "enum":[
                "ORACLE_OBJECT_STORE",
                "UCM",
                "EPM"
            ]
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "timeModified":{
            "type":"integer",
            "format":"int64",
            "readOnly":true
        },
        "supportedApplications":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/IdNameLink"
            }
        },
        "links":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "createdByUser":{
            "readOnly":true,
            "$ref":"#/definitions/User"
        },
        "modifiedByUser":{
            "readOnly":true,
            "$ref":"#/definitions/User"
        }
    }
}

Nested Schema : Global Connection Details

Type: object

Discriminator: type

The details specific to this connection type. All connection types include "type", the type of the connection, see the 'type' object for allowed values, "url", the updated url for the connection, "username", the updated username for the connection, and "password", the updated password for the connection. EPM connections also include "identityDomain", the updated identity domain for the connection, and "folder", the updated epm folder. UCM connections also include "identityDomain", the updated identity domain for the connection, and "defaultDocumentAccount", the updated default document account. Oracle Object Store connections also include "defaultBucket", the updated name of the default target bucket and "defaultBucket", an optional parameter for the sub folder in the target bucket.

Show Source

• type(required): string
  Read Only: true

  Allowed Values: [ "ORACLE_OBJECT_STORE", "EPM", "UCM" ]

  Type is set to "EPM" for Oracle EPM Cloud connections, "UCM" for Oracle ERP Cloud connections and "ORACLE_OBJECT_STORE" for Oracle Object Store connections.

{
    "type":"object",
    "required":[
        "type"
    ],
    "discriminator":"type",
    "properties":{
        "type":{
            "type":"string",
            "description":"Type is set to \"EPM\" for Oracle EPM Cloud connections, \"UCM\" for Oracle ERP Cloud connections and \"ORACLE_OBJECT_STORE\" for Oracle Object Store connections.",
            "readOnly":true,
            "enum":[
                "ORACLE_OBJECT_STORE",
                "EPM",
                "UCM"
            ]
        }
    },
    "description":"The details specific to this connection type. All connection types include \n\"type\", the type of the connection, see the 'type' object for allowed values, \n\"url\", the updated url for the connection, \n\"username\", the updated username for the connection, and \n\"password\", the updated password for the connection. \n\nEPM connections also include \n\"identityDomain\", the updated identity domain for the connection, and \n\"folder\", the updated epm folder. \n\nUCM connections also include \n\"identityDomain\", the updated identity domain for the connection, and \n\"defaultDocumentAccount\", the updated default document account. \n\nOracle Object Store connections also include \n\"defaultBucket\", the updated name of the default target bucket and \n\"defaultBucket\", an optional parameter for the sub folder in the target bucket."
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object Link

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

Nested Schema : supportedApplications

Type: array

Read Only: true

Show Source

• Array of: object IdNameLink

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

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 : 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", "CLOSE", "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",
            "CLOSE",
            "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 : UsersBrowseFilter

Type: object

Show Source

• filterType: string
  Allowed Values: [ "INCLUDE", "EXCLUDE", "NONE" ]
• userGroups: array userGroups
  Unique Items Required: true
• users: array users
  Unique Items Required: true

{
    "type":"object",
    "properties":{
        "users":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "userGroups":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "filterType":{
            "type":"string",
            "enum":[
                "INCLUDE",
                "EXCLUDE",
                "NONE"
            ]
        }
    }
}

Nested Schema : userGroups

Type: array

Unique Items Required: true

Show Source

• Array of: string(uuid)

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

Nested Schema : users

Type: array

Unique Items Required: true

Show Source

• Array of: string(uuid)

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

Nested Schema : compatibleDimensions

Type: array

Unique Items Required: true

Show Source

• Array of: string

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

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", "CLOSE", "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",
            "CLOSE",
            "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: array hierarchySets
  Unique Items Required: true
• nodeSets: array nodeSets
  Unique Items Required: true
• nodeTypes: array nodeTypes
  Unique Items Required: true
• viewpoints: 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 : ViewpointLoadHistory

Type: object

Show Source

• connectionId: string(uuid)
• connectionName: string
• endTime: integer(int64)
• importOption: string
  Allowed Values: [ "ResetDimension", "ReplaceNodes", "Merge" ]
• links: array links
• loadId: string(uuid)
• messages: array messages
• ranBy: string
• startTime: integer(int64)
• status: string
  Allowed Values: [ "PENDING", "COMPLETED", "ERROR", "RUNNING" ]
• syncDescription: string
• syncId: 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: object AllowedActions
• equivalentNodesFilter: object Expression
• nodeTypeId: string(uuid)
• propertyOverrides: array propertyOverrides
• relatedViewpoints: 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"
            }
        },
        "equivalentNodesFilter":{
            "$ref":"#/definitions/Expression"
        }
    }
}

Nested Schema : AllowedActions

Type: object

Show Source

• add: boolean
• delete: boolean
• insert: boolean
• move: boolean
• remove: boolean
• reorder: boolean

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

Nested Schema : Expression

Type: object

Show Source

• documentAsJson: object JsonNode

{
    "type":"object",
    "properties":{
        "documentAsJson":{
            "$ref":"#/definitions/JsonNode"
        }
    }
}

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: boolean
• displayForLocations: boolean
• instructions: string
• label: string
• sortOrder: 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: string
  Read Only: true
• aggregateInheritanceMode: string
  Read Only: true

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

  Allowed Values: [ "NONE", "POSITIONAL" ]
• isValidForConstraint: boolean
  Read Only: true
• level: string
  Read Only: true
• links: array links
  Read Only: true
• name: string
• namespace: string
  Read Only: true
• overrides: array overrides
• parameters: array parameters
  Read Only: true
• permittedActions: array permittedActions
  Unique Items Required: true
• sortOrder: integer(int32)
  Read Only: true
• templateMode: 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",
                    "CLOSE",
                    "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", "CLOSE", "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",
            "CLOSE",
            "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: string
  Read Only: true
• value: 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: boolean
  Read Only: true
• allowedPropertyValues: array allowedPropertyValues
• allowedValuesUsed: boolean
  Read Only: true
• application: object IdNameLink
• defaultOnly: boolean
  Read Only: true
• defaultType: string
  Read Only: true

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

  Allowed Values: [ "NONE", "POSITIONAL" ]
• links: array links
  Read Only: true
• lockOnCommit: boolean
  Read Only: true
• nodeTypeOverrides: array nodeTypeOverrides
  Read Only: true
• parameterValues: 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: string
  Read Only: true
• nodeType: object IdNameLink
• parameterValues: 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: string
• id: string
• labels: array labels
• name: string
• value: 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: string
• id: string
• labels: array labels
• name: string
• value: 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: string
• propertyIds: 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: boolean
• displayForLocations: boolean
  Read Only: true
• instructions: string
• label: string
• propertyId: string(uuid)
• propertyUri: string
  Read Only: true
• sortOrder: 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: boolean
• application: object Application
• assignedNodeTypes: array assignedNodeTypes
• bindingType: string
  Allowed Values: [ "BOUND", "NODE_SET_BOUND", "HIERARCHY_SET_BOUND", "NODE_TYPE_BOUND", "PARTIAL_NODE_TYPE_BOUND", "MAPPING_BOUND", "UNBOUND" ]
• bottomNodeSort: string
  Allowed Values: [ "ALPHANUMERIC", "CUSTOM" ]
• completenessError: string
• createdByUser: object User
• description: string
• dimension: object Dimension
  Dimension model that would be returned as response
• dimensionSectionAllowedSharedNodes: boolean
• groupingType: string
  Allowed Values: [ "DEFAULT", "PARENT_NODE_FIRST" ]
• id: string(uuid)
• isBound: boolean
  Read Only: true
• links: array links
• mappingBound: boolean
• modifiedByUser: object User
• name: string
• objectStatus: string
  Allowed Values: [ "DRAFT", "ACTIVE", "SUNSET", "ARCHIVED", "DELETED" ]
• permittedActions: array permittedActions
  Unique Items Required: true
• related: object Related
• scope: string
  Allowed Values: [ "MASTER", "APPLICATION" ]
• timeCreated: integer(int64)
• timeModified: integer(int64)
• useCustomSortOrder: 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",
                    "CLOSE",
                    "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: object ApplicationMetadata
• blockoutConfiguration: object BlockoutConfiguration
• connections: string
• createdBy: string
  This property is now deprecated and will be removed in 10/2020. Use createdByUser instead.
• createdByUser: object User
• description: string
• dimensions: array dimensions
• hasPermissionToPrimaryView: boolean
• hasUnappliedAnswers: boolean
• id: string(uuid)
• inProgressSlotAnswers: string
• isBound: boolean
  Read Only: true
• links: array links
• modifiedBy: string
  This property is now deprecated and will be removed in 10/2020. Use modifiedByUser instead.
• modifiedByUser: object User
• name: string
• objectStatus: string
  Allowed Values: [ "DRAFT", "ACTIVE", "SUNSET", "ARCHIVED", "DELETED" ]
• permittedActions: array permittedActions
  Unique Items Required: true
• primaryConnection: object IdNameDescription
• primaryView: object IdNameLink
• slotAnswers: string
• supportedDirection: string
  Allowed Values: [ "BOTH", "IMPORT", "EXPORT", "NONE" ]
• supportsConnections: boolean
• timeCreated: integer(int64)
• timeModified: integer(int64)
• type: object ApplicationType
• upgradeTargets: array upgradeTargets
• workflowDisabledOption: 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",
                    "CLOSE",
                    "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 : 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", "CLOSE", "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",
            "CLOSE",
            "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", "CLOSE", "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",
            "CLOSE",
            "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: string
• id: string(uuid)
• links: array links
• name: 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: boolean
• submittedBy: 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: boolean
  Read Only: true
• allowedChildNodeTypes: array allowedChildNodeTypes
  Read Only: true
• alternateQualifiers: array alternateQualifiers
• application: object Application
• bindingType: string
  Read Only: true

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

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

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

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

  Allowed Values: [ "MASTER", "APPLICATION" ]
• sortOrder: integer(int32)
  Read Only: true
• timeCreated: integer(int64)
  Read Only: true
• timeModified: 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",
                    "CLOSE",
                    "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", "CLOSE", "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",
            "CLOSE",
            "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: array conversion
• fromNodeType: object SimpleNodeType
• id: 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: object IdNameLink
• description: string
  Read Only: true
• id: string(uuid)
• links: array links
• name: string
• nodeTypeClass: string
  Allowed Values: [ "LOOKUP", "LEGACY_GL", "NORMAL", "USER", "USER_ROLLUP" ]
• properties: 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: object JsonNode
• fromPropertyId: string(uuid)
• targetReadOnly: boolean
• toPropertyId: string(uuid)

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

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: string
  Read Only: true
• defaultOnly: boolean
  Read Only: true
• deletable: boolean
  Read Only: true
• description: string
  Read Only: true
• id: string(uuid)
  Read Only: true
• links: array links
  Read Only: true
• name: string
  Read Only: true
• namespace: string
  Read Only: true
• queryable: boolean
  Read Only: true
• required: boolean
  Read Only: true
• sortOrder: 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 : NodeSet

Type: object

Node Set model that would be returned as response

Show Source

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

  Allowed Values: [ "LOOKUP", "LEGACY_GL", "NORMAL", "USER", "USER_ROLLUP" ]
• combination: boolean
• compatibleBoundHierarchySets: array compatibleBoundHierarchySets
  Unique Items Required: true
• compatibleBoundNodeSets: array compatibleBoundNodeSets
  Unique Items Required: true
• converters: array converters
• createdByUser: object User
• defaultQualifier: string
• description: string
• dimension: object Dimension
  Dimension model that would be returned as response
• id: string(uuid)
• isBound: boolean
  Read Only: true
• links: array links
• modifiedByUser: object User
• name: string
• objectStatus: string
  Allowed Values: [ "DRAFT", "ACTIVE", "SUNSET", "ARCHIVED", "DELETED" ]
• permittedActions: array permittedActions
  Unique Items Required: true
• propertyDefinitions: array propertyDefinitions
• qualifierPosition: string
  Allowed Values: [ "PREFIX", "SUFFIX" ]
• related: object Related
• scope: string
  Allowed Values: [ "MASTER", "APPLICATION" ]
• timeCreated: integer(int64)
• timeModified: 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",
                    "CLOSE",
                    "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", "CLOSE", "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",
            "CLOSE",
            "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: integer(int32)
• description: string
• hasChildren: boolean
• id: string(uuid)
• links: array links
• location: string
  This property is now deprecated and will be removed in 10/2020. Use path instead.
• locationsByParentId: object locationsByParentId
  Additional Properties Allowed: additionalProperties

  This property is now deprecated and will be removed in 10/2020. Use path instead.
• name: string
• nodeType: object IdNameLink
• parentName: string
• parentNodeId: string(uuid)
• parentNodeTypeId: string(uuid)
• path: array path
• relationshipId: string(uuid)
• requestItem: object RequestItem
  A Request Item is a collection of actions to apply to a particular node as part of aRequest
• targetForNodeProperty: boolean

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "nodeType":{
            "$ref":"#/definitions/IdNameLink"
        },
        "requestItem":{
            "readOnly":true,
            "$ref":"#/definitions/RequestItem"
        },
        "hasChildren":{
            "type":"boolean"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "location":{
            "type":"string",
            "description":"This property is now deprecated 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: integer(int32)
• actions: array actions
• actionSummary: string
• applicationName: string
• createdBy: string
• description: string
• id: string(uuid)
• links: array links
• modifiedBy: string
• name: string
• nodeTypeId: string(uuid)
• nodeTypeName: string
• policies: array policies
• timeCreated: integer(int64)
• timeModified: integer(int64)
• validations: array validations

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64"
        },
        "timeModified":{
            "type":"integer",
            "format":"int64"
        },
        "createdBy":{
            "type":"string"
        },
        "modifiedBy":{
            "type":"string"
        },
        "actions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Action"
            }
        },
        "actionCount":{
            "type":"integer",
            "format":"int32"
        },
        "validations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ValidationResult"
            }
        },
        "nodeTypeName":{
            "type":"string"
        },
        "nodeTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "applicationName":{
            "type":"string"
        },
        "actionSummary":{
            "type":"string"
        },
        "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: object JsonNode
• id: string(uuid)
  Read Only: true
• layoutOptions: object layoutOptions
  Additional Properties Allowed: additionalProperties
• links: array links
• nodeTypeName: string
• parentName: string
• parentNodeId: string(uuid)
  id of the parent node this action was performed under, if any
• propertyLevel: string
• summary: string
• type: string
  Read Only: true

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

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

Nested Schema : 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: string(uuid)
• policyType: 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: string
• links: array links
• message: string
• responsibleUserId: string(uuid)
• severity: string
  Allowed Values: [ "ERROR", "WARNING", "IGNORE" ]

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

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64"
        },
        "type":{
            "type":"string",
            "enum":[
                "ERROR"
            ]
        },
        "responsibleUserId":{
            "type":"string",
            "format":"uuid"
        },
        "userCanResolve":{
            "type":"boolean"
        },
        "severity":{
            "type":"string",
            "description":"The severity of the validation issue (ERROR or WARNING) for the stage at which the validation failed.",
            "enum":[
                "ERROR",
                "WARNING",
                "IGNORE"
            ]
        },
        "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 update an extract's connection by submitting a GET request on the REST resource using cURL.

cURL Command

curl --user epm_cloud_user -X GET -H 'Content-Type: application/json' -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/epm/rest/v1/extracts/?q=view::71ad7f6b-d313-4a82-956c-ecdbbc7b0ce0

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "items": [
        {
            "id": "791de1e6-4a1a-4ead-93b5-c5492f608fde",
            "name": "AHC Account - non cash",
            "description": "AHC_ACCOUNT_NON_CASH Map natural account by line type and loan type",
            "extractConnection": {
                "connectionSummary": {
                    "id": "b3ee4f46-9b49-4422-b8b5-7113038e7015",
                    "name": "Fusion",
                    "description": "Fusion",
                    "connectionType": "UCM",
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015"
                        },
                        {
                            "rel": "delete",
                            "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015",
                            "method": "DELETE"
                        }
                    ]
                },
                "connectionOptions": {
                    "defaultDocumentAccount": "fin/fusionAccountingHub/import"
                }
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/791de1e6-4a1a-4ead-93b5-c5492f608fde"
                },
                {
                    "rel": "runExtract",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/791de1e6-4a1a-4ead-93b5-c5492f608fde/run",
                    "method": "POST"
                },
                {
                    "rel": "extractHistory",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/791de1e6-4a1a-4ead-93b5-c5492f608fde/extractHistory?q=limit%3A%3A5",
                    "templated": true
                },
                {
                    "rel": "edit",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/791de1e6-4a1a-4ead-93b5-c5492f608fde",
                    "method": "PUT"
                },
                {
                    "rel": "delete",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/791de1e6-4a1a-4ead-93b5-c5492f608fde",
                    "method": "DELETE"
                },
                {
                    "rel": "copy",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/791de1e6-4a1a-4ead-93b5-c5492f608fde/copy",
                    "method": "POST"
                }
            ],
            "viewpoint": {
                "id": "a7556e2e-2c76-47b4-a18a-db576de1e92c",
                "name": "AHC Loans Non Cash",
                "description": "AHC Loans: Non Cash Mapping Sets",
                "hasHierarchy": true,
                "sortOrder": 3,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/71ad7f6b-d313-4a82-956c-ecdbbc7b0ce0/viewpoints/a7556e2e-2c76-47b4-a18a-db576de1e92c"
                    }
                ],
                "usesCustomSortOrder": false,
                "isBound": false
            },
            "view": {
                "id": "71ad7f6b-d313-4a82-956c-ecdbbc7b0ce0",
                "name": "Mapping Sets",
                "description": "Mapping Sets",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/71ad7f6b-d313-4a82-956c-ecdbbc7b0ce0"
                    }
                ]
            },
            "application": {
                "id": "a3d7a580-17f1-4b0f-9549-cc9c16232f9e",
                "name": "Financials Cloud",
                "description": "Financials Cloud GL",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/a3d7a580-17f1-4b0f-9549-cc9c16232f9e"
                    }
                ]
            },
            "dimension": {
                "id": "14b18bb1-945d-41d2-85c2-30bf3209ccbe",
                "name": "Mapping Sets",
                "description": "Mapping Sets",
                "dimensionType": "Unbound",
                "connected": false,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe"
                    }
                ],
                "isBound": false,
                "canAddBinding": false,
                "supportsMapping": false,
                "supportsMappingExport": false,
                "supportsTemplateExport": true,
                "supportsExtracts": true
            },
            "extractType": "DEFAULT",
            "fileName": "AHC-MapImport.csv",
            "createdByUser": {
                "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a",
                "userName": "Casey.Brown",
                "fullName": "Casey.Brown",
                "firstName": "",
                "lastName": "",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a"
                    }
                ],
                "nameInitials": "",
                "dataManagerOnAny": false
            },
            "timeCreated": "2021-06-16T08:58:59.079Z",
            "modifiedByUser": {
                "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a",
                "userName": "Casey.Brown",
                "fullName": "Casey.Brown",
                "firstName": "",
                "lastName": "",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a"
                    }
                ],
                "nameInitials": "",
                "dataManagerOnAny": false
            },
            "timeModified": "2021-10-26T23:39:45.293Z",
            "lastExtractInfo": {
                "ranBy": "Kerry.Lane",
                "startTime": "2021-07-17T01:52:48.772Z",
                "endTime": "2021-07-17T01:52:49.494Z",
                "success": true,
                "status": "PENDING",
                "connectionName": "Fusion",
                "messages": [
                    "0 records extracted."
                ],
                "extractType": "DEFAULT",
                "publicApiFlag": false
            },
            "profileOwner": {
                "id": "83ed6845-5299-4dce-ad3f-81a92bcc0853",
                "userName": "@@sysadmin",
                "fullName": "System User",
                "firstName": "",
                "lastName": "",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/83ed6845-5299-4dce-ad3f-81a92bcc0853"
                    }
                ],
                "nameInitials": "",
                "dataManagerOnAny": false
            },
            "public": true
        },
        {
            "id": "9beb7ffb-3779-4bb4-b8b9-6fe5b3f347a6",
            "name": "Cost Management Expense",
            "description": "CST_EXPENSE Mapping set created for account rule: Expense",
            "extractConnection": {
                "connectionSummary": {
                    "id": "b3ee4f46-9b49-4422-b8b5-7113038e7015",
                    "name": "Fusion",
                    "description": "Fusion",
                    "connectionType": "UCM",
                    "links": [
                        {
                            "rel": "self",
                            "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015"
                        },
                        {
                            "rel": "delete",
                            "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/globalConnections/b3ee4f46-9b49-4422-b8b5-7113038e7015",
                            "method": "DELETE"
                        }
                    ]
                },
                "connectionOptions": {
                    "defaultDocumentAccount": "fin/fusionAccountingHub/import"
                }
            },
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/9beb7ffb-3779-4bb4-b8b9-6fe5b3f347a6"
                },
                {
                    "rel": "runExtract",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/9beb7ffb-3779-4bb4-b8b9-6fe5b3f347a6/run",
                    "method": "POST"
                },
                {
                    "rel": "extractHistory",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/9beb7ffb-3779-4bb4-b8b9-6fe5b3f347a6/extractHistory?q=limit%3A%3A5",
                    "templated": true
                },
                {
                    "rel": "edit",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/9beb7ffb-3779-4bb4-b8b9-6fe5b3f347a6",
                    "method": "PUT"
                },
                {
                    "rel": "delete",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/9beb7ffb-3779-4bb4-b8b9-6fe5b3f347a6",
                    "method": "DELETE"
                },
                {
                    "rel": "copy",
                    "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe/extracts/9beb7ffb-3779-4bb4-b8b9-6fe5b3f347a6/copy",
                    "method": "POST"
                }
            ],
            "viewpoint": {
                "id": "58ef4757-c3c0-452e-873e-38d926a4b8c8",
                "name": "Cost Mgmt Expenses",
                "description": "Cost Management: Expenses Mapping Set",
                "hasHierarchy": true,
                "sortOrder": 5,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/71ad7f6b-d313-4a82-956c-ecdbbc7b0ce0/viewpoints/58ef4757-c3c0-452e-873e-38d926a4b8c8"
                    }
                ],
                "usesCustomSortOrder": false,
                "isBound": false
            },
            "view": {
                "id": "71ad7f6b-d313-4a82-956c-ecdbbc7b0ce0",
                "name": "Mapping Sets",
                "description": "Mapping Sets",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/71ad7f6b-d313-4a82-956c-ecdbbc7b0ce0"
                    }
                ]
            },
            "application": {
                "id": "a3d7a580-17f1-4b0f-9549-cc9c16232f9e",
                "name": "Financials Cloud",
                "description": "Financials Cloud GL",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/applications/a3d7a580-17f1-4b0f-9549-cc9c16232f9e"
                    }
                ]
            },
            "dimension": {
                "id": "14b18bb1-945d-41d2-85c2-30bf3209ccbe",
                "name": "Mapping Sets",
                "description": "Mapping Sets",
                "dimensionType": "Unbound",
                "connected": false,
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/dimensions/14b18bb1-945d-41d2-85c2-30bf3209ccbe"
                    }
                ],
                "isBound": false,
                "canAddBinding": false,
                "supportsMapping": false,
                "supportsMappingExport": false,
                "supportsTemplateExport": true,
                "supportsExtracts": true
            },
            "extractType": "DEFAULT",
            "fileName": "CMExp-MapImport.csv",
            "createdByUser": {
                "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a",
                "userName": "Casey.Brown",
                "fullName": "Casey.Brown",
                "firstName": "",
                "lastName": "",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a"
                    }
                ],
                "nameInitials": "",
                "dataManagerOnAny": false
            },
            "timeCreated": "2021-06-16T09:57:25.631Z",
            "modifiedByUser": {
                "id": "d93d33f8-f24e-4eaa-8c14-df45501d949a",
                "userName": "Casey.Brown",
                "fullName": "Casey.Brown",
                "firstName": "",
                "lastName": "",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/d93d33f8-f24e-4eaa-8c14-df45501d949a"
                    }
                ],
                "nameInitials": "",
                "dataManagerOnAny": false
            },
            "timeModified": "2021-10-27T02:10:54.930Z",
            "lastExtractInfo": {
                "ranBy": "Casey.Brown",
                "startTime": "2021-06-16T21:28:34.831Z",
                "endTime": "2021-06-16T21:28:35.124Z",
                "success": true,
                "status": "PENDING",
                "messages": [
                    "55 records extracted."
                ],
                "extractType": "DEFAULT",
                "publicApiFlag": false
            },
            "profileOwner": {
                "id": "83ed6845-5299-4dce-ad3f-81a92bcc0853",
                "userName": "@@sysadmin",
                "fullName": "System User",
                "firstName": "",
                "lastName": "",
                "emailAddresses": [],
                "links": [
                    {
                        "rel": "self",
                        "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/users/83ed6845-5299-4dce-ad3f-81a92bcc0853"
                    }
                ],
                "nameInitials": "",
                "dataManagerOnAny": false
            },
            "public": true
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/extracts"
        }
    ],
    "hasMore": false,
    "totalResults": 2,
    "limit": 0,
    "count": 2
}

Back to Top