/icws/{sessionId}/data-dictionary

GET

/icws/{sessionId}/data-dictionary

Retrieve data dictionary information for tables, views and sprocs.
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
        dataSetNames
        By adding datasetnames as a query, this will filter and return only the tables, views and stored-procedures for the given dataset names.

          Query
          tableIds

          Given an array of table IDs, this will retrieve the different tables information regarding the IDs.

            Query
            viewIds

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

              Query
              storedProcedureIds

              Given an array of stored-procedure IDs, this will retrieve the different stored-procedures information regarding the IDs.

                Response

                200 - OK
                The description for the specified data is included in the entity body.
                Property
                Value
                Comments
                name
                String

                Required

                The name of the table.

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

                dateTimeFilterColumn
                String

                The column used to filter the table using a datetime.

                siteIdFilterColumn
                String

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

                schema
                String

                Required

                The schema of the table.

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

                shortDescription
                String

                Required

                The short description of the table.

                longDescription
                String

                Required

                The complete description of the table.

                cicProductCode
                String

                Required

                The product code of the table.

                loggingType
                String

                The logging type.

                lastChangeVersion
                String

                Required

                The change version of the table.

                lastChangeReason
                String

                Required

                The change reason of the table.

                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.

                name
                String

                Required

                The name of the table's primary Key.

                primaryKeyType
                String

                Describes the primary key clustering method.

                name
                String

                Required

                The name of column.

                sortOrder
                String

                The sorting order.

                name
                String

                Required

                The name of the foreign Key.

                column
                String

                Required

                The name of the column for this foreign key.

                referenceTable
                String

                Required

                The name of the table referenced by the foreign key.

                referenceColumn
                String

                Required

                The name of the column referenced by the foreign key.

                name
                String

                Required

                The name of the product feature associated with the database object.

                name
                String

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

                name
                String

                Required

                The name of the index.

                indexType
                String

                Required

                The type of index: clustered, non clustered, or unique non-clustered.

                name
                String

                Required

                The name of the column.

                sortOrder
                String

                The sorting order.

                name
                String

                The name of the included column.

                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.

                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 stored procedure.

                dateTimeFilterColumn
                String

                The element used to filter the column using a date time.

                siteIdFilterColumn
                String

                The element used to filter the column using a site Id.

                schema
                String

                Required

                The schema of the stored-procedure.

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

                lastChangeVersion
                String

                Required

                The change version of the stored-procedure.

                lastChangeReason
                String

                Required

                The change reason of the stored-procedure.

                shortDescription
                String

                Required

                The short description of the stored-procedure.

                longDescription
                String

                The complete description of the stored-procedure.

                cicProductCode
                String

                Required

                The product code of the stored-procedure.

                containsPII
                String

                Required

                If the stored-procedure contains PII or not.

                name
                String

                Required

                The name of the procedure parameter.

                parameterType
                String

                Required

                If the parameter is an output parameter.

                seqNo
                Int

                The sequence number.

                dataType
                String

                Required

                The paramter data type.

                maxLength
                Int

                The max length of the procedure parameter.

                encoding
                String

                Required

                The encoding of the procedure parameter.

                shortDescription
                String

                Required

                The short description of the procedure parameter.

                longDescription
                String

                The complete description of the procedure parameter.

                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.
                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.
                  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.
                  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.
                  Property
                  Value
                  Comments
                  errorId
                  String
                  The error identifier that describes the current error.
                  message
                  String

                  Required

                  A message that describes the current error.