REST API for Oracle Enterprise Data Management Cloud Service

Gets the views

get

/epm/rest/v1/views

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

Request

Query Parameters

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

filters views by statuses and/or a dimension
- Allowed Values: [ "objectStatus::{list of object statuses separated by comma(DRAFT", "ACTIVE", "ARCHIVED)}", "dimension::dimensionId" ]

Response

Supported Media Types

application/json

200 Response

successful operation

Root Schema : ItemsView

Type: object

Show Source

count(optional): integer(int32)
hasMore(optional): boolean
items(optional): array items

Read Only: true
limit(optional): integer(int32)
links(optional): array links

Read Only: true
offset(optional): integer(int32)
totalResults(optional): integer(int32)

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

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

Nested Schema : links

Type: array

Read Only: true

Show Source

Array of: object Link

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

Nested Schema : View

Type: object

Show Source

createdBy(optional): string

This property is now deprecated and will be removed in 10/2020. Use createdByUser instead.
createdByUser(optional): object User
description(optional): string
id(optional): string(uuid)
links(optional): array links
master(optional): boolean
modifiedBy(optional): string

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

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

Unique Items Required: true
requestDescription(optional): string

Allowed Values: [ "DEFAULT", "REQUIRED" ]
requestPlaceholder(optional): string
timeCreated(optional): integer(int64)
timeModified(optional): integer(int64)
usersBrowseFilter(optional): 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",
                    "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 : User

Type: object

Show Source

artifactAssignments(optional): array artifactAssignments
associatedRoles(optional): array associatedRoles
dataManagerOnAny(optional): boolean
emailAddresses(optional): array emailAddresses
epmIdleSessionTimeout(optional): integer(int32)
firstName(optional): string
fullName(optional): string
grantPermission(optional): string

Allowed Values: [ "OWNER", "DATAMANAGER", "PARTICIPANT", "APPROVER", "NOTIFIED", "COMMITTER", "NONE", "METADATAMANAGER" ]
homePageLayoutName(optional): string
id(optional): string(uuid)
lastName(optional): string
links(optional): array links
nameInitials(optional): string
preferences(optional): object Preferences
ssoToken(optional): string
userName(optional): string

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

Nested Schema : links

Type: array

Show Source

Array of: object Link

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

Nested Schema : permittedActions

Type: array

Unique Items Required: true

Show Source

Array of: string

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

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

Nested Schema : UsersBrowseFilter

Type: object

Show Source

filterType(optional): string

Allowed Values: [ "INCLUDE", "EXCLUDE", "NONE" ]
userGroups(optional): array userGroups

Unique Items Required: true
users(optional): 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 : artifactAssignments

Type: array

Show Source

Array of: object ArtifactAssignment

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

Nested Schema : associatedRoles

Type: array

Show Source

Array of: object Role

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

Nested Schema : emailAddresses

Type: array

Show Source

Array of: string

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

Nested Schema : links

Type: array

Show Source

Array of: object Link

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

Nested Schema : Preferences

Type: object

Show Source

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

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

Nested Schema : ArtifactAssignment

Type: object

Show Source

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

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

Nested Schema : Artifact

Type: object

Show Source

id(optional): string(uuid)
name(optional): string
type(optional): string

Allowed Values: [ "CLUSTER", "CARD" ]

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

Nested Schema : Role

Type: object

Show Source

id(optional): string
name(optional): string

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

Nested Schema : Link

Type: object

Show Source

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

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

Nested Schema : links

Type: array

Show Source

Array of: object Link

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

Nested Schema : TimeZone

Type: object

Show Source

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

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

Nested Schema : 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"
    }
}

Examples

The following example shows how to retrieve all the views by submitting a GET request on the REST resource using cURL.

curl --user edmcs_cloud_user -X GET https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views

Example of the Response Body

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

{
  "items": [
    {
      "id": "91fab006-5185-478f-9d3c-c1b4548a0b10",
      "name": "Corporate Planning (EPBCS)",
      "description": "Corporate Planning dimensions",
      "timeCreated": "2017-11-08T22:13:01.060Z",
      "timeModified": "2017-11-10T03:46:23.515Z",
      "createdBy": "demoadmin",
      "modifiedBy": "demoadmin",
      "master": false, 
      "objectStatus": "ACTIVE",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10"
        },
        {
          "rel": "viewpoints",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints"
        },
        {
          "rel": "create",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/viewpoints",
          "method": "POST"
        },
        {
          "rel": "requests",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests?q=views%3A%3A91fab006-5185-478f-9d3c-c1b4548a0b10",
          "templated": true
        },
        {
          "rel": "createRequest",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests",
          "method": "POST"
        },
        {
          "rel": "delete",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10",
          "method": "DELETE"
        },
        {
          "rel": "edit",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10",
          "method": "PUT"
        },
        {
          "rel": "grants",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/91fab006-5185-478f-9d3c-c1b4548a0b10/grants"
        }
      ],
      "permittedActions": [
        "CREATE_REQUEST",
        "ARCHIVE",
        "EDIT_METADATA",
        "CREATE_VIEWPOINT",
        "MANAGE_GRANTS",
        "DELETE"
      ]
    },
    {
      "id": "9f9d7689-44ce-4e0a-8f37-33ed54e703c4",
      "name": "Acquired GL (Legacy)",
      "description": "Acquired GL Chart of Accounts",
      "timeCreated": "2017-11-10T04:43:30.049Z",
      "timeModified": "2017-11-10T04:58:33.958Z",
      "createdBy": "Casey.Brown",
      "modifiedBy": "Casey.Brown",
      "master": false,
      "objectStatus": "ACTIVE",
      "links": [
        {
          "rel": "self",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/9f9d7689-44ce-4e0a-8f37-33ed54e703c4"
        },
        {
          "rel": "viewpoints",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/9f9d7689-44ce-4e0a-8f37-33ed54e703c4/viewpoints"
        },
        {
          "rel": "create",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/9f9d7689-44ce-4e0a-8f37-33ed54e703c4/viewpoints",
          "method": "POST"
        },
        {
          "rel": "requests",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests?q=views%3A%3A9f9d7689-44ce-4e0a-8f37-33ed54e703c4",
          "templated": true
        },
        {
          "rel": "createRequest",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/requests",
          "method": "POST"
        },
        {
          "rel": "delete",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/9f9d7689-44ce-4e0a-8f37-33ed54e703c4",
          "method": "DELETE"
        },
        {
          "rel": "edit",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/9f9d7689-44ce-4e0a-8f37-33ed54e703c4",
          "method": "PUT"
        },
        {
          "rel": "grants",
          "href": "https://servername.fa.us2.oraclecloud.com/epm/rest/v1/views/9f9d7689-44ce-4e0a-8f37-33ed54e703c4/grants"
        }
      ],
      "permittedActions": [
        "CREATE_REQUEST",
        "ARCHIVE",
        "EDIT_METADATA",
        "CREATE_VIEWPOINT",
        "MANAGE_GRANTS",
        "DELETE"
      ]
    }
  ]
}