Expand All Collapse All

/icws/{sessionId}/data-dictionary/views

GET

/icws/{sessionId}/data-dictionary/views

Retrieves views.
Feature Version
data-dictionary 2

Request

Parameters
Type
Name
Comments
Header
ININ-ICWS-CSRF-Token

Required

The ININ session token necessary for all calls that require a security or user context.

    Header
    Cookie

    Required

    The session cookie. With the exception of the connection request, all requests must provide a session cookie.

      Template
      sessionId

      Required

      The ININ session ID necessary for all calls that require a security or user context.

        Query
        ids

        Given an array of view IDs, this will retrieve the different views information based on the IDs.

          Query
          dataSetNames

          By adding datasetnames as a query, this will filter and return only the views for the given dataset names.

            Response

            200 - OK
            The description for the specified views are included in the entity body.
            views
            Expand AllCollapse All
            Property
            Value
            Comments
            name
            String

            Required

            The name of the view.

            dateTimeFilterColumn
            String

            The column used to filter the view using a datetime.

            siteIdFilterColumn
            String

            The column used to filter the view using one or more site IDs.

            schema
            String

            Required

            The schema of the view.

            The value represented by this property should be treated as case-insensitive.

            shortDescription
            String

            Required

            The short description of the view.

            longDescription
            String

            Required

            The complete description of the view.

            cicProductCode
            String

            Required

            The product code of the view.

            name
            String

            The dataset the database object is associated with. This is currently used for internal server purposes.

            lastChangeVersion
            String

            The last change version of the view.

            lastChangeReason
            String

            The ;ast change reason of the view.

            name
            String

            Required

            The name of the column.

            dataType
            String

            Required

            The data type of the column.

            maxLength
            Int

            Required

            The max length of the column.

            encoding
            String

            Encoding type of the column.

            precision
            Int

            Precision of the column.

            scale
            Int

            Scale of the column.

            allowsNulls
            String

            The value will be "True" if the column allows nulls, otherwise "False".

            lastChangeVersion
            String

            Required

            The change version of the column.

            lastChangeReason
            String

            Required

            The change reason of the column.

            containsPII
            String

            Required

            Describes the column's level of Personally Identifiable Information.

            seqNo
            Int

            The sequence number for the column.

            shortDescription
            String

            Required

            The short description of the column.

            longDescription
            String

            The complete description of the column.

            400 - Bad Request
            The request was invalid. This can occur when the message body is malformed or missing required items. This will also occur if a required header or query string parameter is missing or invalid.
            error
            Provides additional detail for an error.
            Expand AllCollapse All
            Property
            Value
            Comments
            errorId
            String
            The error identifier that describes the current error.
            message
            String

            Required

            A message that describes the current error.
            401 - Unauthorized
            The specified session token is missing, invalid, or has expired.
            Parameters
            Type
            Name
            Comments
            Header
            WWW-Authenticate

            Required

            Indicates that the client needs to authenticate using a custom ICWS scheme, which supports a realm of type ICWS and a location which is the URL at which the client can authenticate. A typical example would be the following.

            WWW-Authenticate: ICWS realm="ICWS" location="/ICWS/connection"

              error
              Provides additional detail for an error.
              Expand AllCollapse All
              Property
              Value
              Comments
              errorId
              String
              The error identifier that describes the current error.
              message
              String

              Required

              A message that describes the current error.
              410 - Gone
              This resource has been deprecated and removed from the API.
              error
              Provides additional detail for an error.
              Expand AllCollapse All
              Property
              Value
              Comments
              errorId
              String
              The error identifier that describes the current error.
              message
              String

              Required

              A message that describes the current error.
              500 - Internal Server Error
              An unexpected error occurred while processing the request.
              error
              Provides additional detail for an error.
              Expand AllCollapse All
              Property
              Value
              Comments
              errorId
              String
              The error identifier that describes the current error.
              message
              String

              Required

              A message that describes the current error.