SAP Function SRM_DOCUMENT_GETLIST - Determine List of Documents

Parameter Reference Type Length Default Optional Text
MAX_HITS BAPISRMDOC-MAX_HITS I 4 X Maximum No. of Hits to be Delivered
RMS_ID BAPISRMDOC-RMSID C 32 Records Management System ID
SPS_ID BAPISRMDOC-SPSID C 32 Element Type

Parameter Reference Type Length Text
RETURN BAPIRET2 u 548 Return Code

Parameter Reference Length Optional Text
PROPERTY_SELECTION BAPIPROPQY 577 X Properties of Document to Be Searched
RESULTING_LIST BAPIDOCTAB 552 List of Documents Found

Exception Text
INTERNAL_ERROR Internal Error
NOT_AUTHORIZED No Authorization
PARAMETER_ERROR Parameter error

Functionality
Gets a list of documents with certain properties.
The documents in the list are specified in the table parameterPROPERTY_SELECTION.

Description
Result of the BAPI call

Description
Maximum number of hits

Description
ID of the Records Management System (RMS) whose records you want todisplay in a list

Description
Element type of the records you want to list

Description
In this table, you can specify attribute values that restrict thesearch.
The table has the following columns:

  • PROPNAME

  • Specify the name of an attribute in this column.
    The attributes of a document are determined by a PHIO class defined inthe content model. You can look these up in the Document ModelingWorkbench (transaction DMWB). Here, you can view the attributes of adocument that can be assigned values in the BAPI for a search, on the"Instance Attributes" tab page. You can double click on every attributeto navigate to the corresponding data element and its related domains.You can use this method to determine the data type of an attribute.
    • SIGN

    • OPTION

    • PROPVA_LO

    • PROPVA_HI

    • Caution: Attribute values must be entered in their internal SAP format.
      The decisive factors are the data type of the domains and any relevantconversion routines (see also the comments for the field PROPNAME).

      Example
      Find all documents created by user MEIER between July 1 and July 31,2001 whose descriptions contain the word "record".
      PROPNAME    SIGN  OPTION  PROPVA_LO       PROPVA_HI
      --------------------------------------------------------
      CREATED_BY  I     EQ      MEIER
      CREATED_AT  I     BT      20010701000000  20010731235959
      DESCRIPTION I     NP      *record*

      Description
      This table contains a list of found records.
      Each record is listed with its internal ID (OBJECTID column), location(DOCCLASS column), a unique name, the record number (DOCUMENT IDcolumn), and a description (DESCR column).