Jump to

• Request
• Response

Get view details

get

/20260430/aiDataPlatforms/{aiDataPlatformId}/views/{viewKey}

Returns information about a view.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• viewKey(required): string
  The fully qualified name of the view in the format ...

Header Parameters

• opc-request-id: string
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash.
• should-update-recent: boolean
  A flag to identify if the recent list should be updated.

  Default Value: false

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. View details are retrieved.

Headers

• etag: string
  For optimistic concurrency control. See `if-match`.
• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : View

Type: object

Information about the view in the schema.

Show Source

• catalogKey: string
  The name of the catalog to which this view belongs.
• createdBy: string
  Minimum Length: 1

  Maximum Length: 255

  The ID of the user/principal who created the view.
• description: string
  The description of the view.
• displayName(required): string
  A user-friendly name. Has to be unique within the scope of the schema and is changeable.
• key: string
  The fully qualified name of the view in the format ..
• lifecycleState: string
  Allowed Values: [ "ACTIVE" ]

  The state of the view.
• lifecycleStateDetails: string
  A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.
• schemaKey: string
  The name of the Schema to which this view belongs.
• timeCreated: string(date-time)
  The date and time the View was created, in the format defined by RFC 3339. Example: `2016-08-25T21:10:29.600Z`
• timeUpdated: string(date-time)
  The date and time the View was updated, in the format defined by RFC 3339. Example: `2016-08-25T21:10:29.600Z`
• updatedBy: string
  Minimum Length: 1

  Maximum Length: 255

  The ID of the user who last updated the view.
• viewFields: array viewFields
  Maximum Number of Items: 1000

  Columns for view.
• viewProperties: array viewProperties
  Maximum Number of Items: 10

  View Properties.
• viewText: string
  The Query used to create the view.

{
    "description":"Information about the view in the schema.",
    "type":"object",
    "required":[
        "displayName"
    ],
    "properties":{
        "key":{
            "description":"The fully qualified name of the view in the format <catalog_name>.<schema_name>.<view_name>",
            "type":"string"
        },
        "displayName":{
            "description":"A user-friendly name. Has to be unique within the scope of the schema and is changeable.",
            "type":"string"
        },
        "catalogKey":{
            "description":"The name of the catalog to which this view belongs.",
            "type":"string"
        },
        "schemaKey":{
            "description":"The name of the Schema to which this view belongs.",
            "type":"string"
        },
        "viewText":{
            "description":"The Query used to create the view.",
            "type":"string"
        },
        "description":{
            "description":"The description of the view.",
            "type":"string"
        },
        "viewFields":{
            "description":"Columns for view.",
            "type":"array",
            "maxItems":1000,
            "items":{
                "$ref":"#/definitions/ViewFieldDetails"
            }
        },
        "timeCreated":{
            "description":"The date and time the View was created, in the format defined by <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\" rel=\"noopener noreferrer\">RFC 3339</a>.\nExample: `2016-08-25T21:10:29.600Z`\n",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The date and time the View was updated, in the format defined by <a href=\"https://tools.ietf.org/html/rfc3339\" target=\"_blank\" rel=\"noopener noreferrer\">RFC 3339</a>.\nExample: `2016-08-25T21:10:29.600Z`\n",
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "description":"The ID of the user/principal who created the view.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "updatedBy":{
            "description":"The ID of the user who last updated the view.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "viewProperties":{
            "description":"View Properties.",
            "type":"array",
            "maxItems":10,
            "items":{
                "$ref":"#/definitions/ViewProperty"
            }
        },
        "lifecycleState":{
            "description":"The state of the view.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/ViewLifecycleState",
            "enum":[
                "ACTIVE"
            ]
        },
        "lifecycleStateDetails":{
            "description":"A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state.",
            "type":"string"
        }
    }
}

Nested Schema : viewFields

Type: array

Maximum Number of Items: 1000

Columns for view.

Show Source

• Array of: object ViewFieldDetails
  Columns for view.

{
    "description":"Columns for view.",
    "type":"array",
    "maxItems":1000,
    "items":{
        "$ref":"#/definitions/ViewFieldDetails"
    }
}

Nested Schema : viewProperties

Type: array

Maximum Number of Items: 10

View Properties.

Show Source

• Array of: object ViewProperty
  The property of the view.

{
    "description":"View Properties.",
    "type":"array",
    "maxItems":10,
    "items":{
        "$ref":"#/definitions/ViewProperty"
    }
}

Nested Schema : ViewFieldDetails

Type: object

Columns for view.

Show Source

• fieldDescription: string
  Description of the column.
• fieldName(required): string
  Minimum Length: 1

  Maximum Length: 767

  Name of the column.
• fieldPrecision: string
  Precision of the column.
• fieldScale: string
  Scale of the column.
• fieldType: string
  Minimum Length: 1

  Maximum Length: 9999

  Type of the column.

{
    "description":"Columns for view.",
    "type":"object",
    "required":[
        "fieldName"
    ],
    "properties":{
        "fieldName":{
            "description":"Name of the column.",
            "type":"string",
            "minLength":1,
            "maxLength":767
        },
        "fieldType":{
            "description":"Type of the column.",
            "type":"string",
            "minLength":1,
            "maxLength":9999
        },
        "fieldPrecision":{
            "description":"Precision of the column.",
            "type":"string"
        },
        "fieldScale":{
            "description":"Scale of the column.",
            "type":"string"
        },
        "fieldDescription":{
            "description":"Description of the column.",
            "type":"string"
        }
    }
}

Nested Schema : ViewProperty

Type: object

The property of the view.

Show Source

• propertyName(required): string
  Minimum Length: 1

  Maximum Length: 255

  Property name.
• propertyValue: string
  Minimum Length: 1

  Maximum Length: 255

  Property value.

{
    "description":"The property of the view.",
    "type":"object",
    "required":[
        "propertyName"
    ],
    "properties":{
        "propertyName":{
            "description":"Property name.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "propertyValue":{
            "description":"Property value.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        }
    }
}

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error message.",
            "type":"string"
        }
    }
}

Back to Top