Expand All Collapse All

/icws/{sessionId}/data-dictionary/stored-procedures

GET

/icws/{sessionId}/data-dictionary/stored-procedures

Retrieves stored procedures used by reports.
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 stored-procedure IDs, this will retrieve the different stored procedures 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.
            storedProcedures
            Expand AllCollapse All
            Property
            Value
            Comments
            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.

            name
            String

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

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