Skip to content

/AWS1/IF_BDZ=>CHECKINGESTEDDOCUMENTACL()

About CheckIngestedDocumentAcl

Checks whether a user has access to a specific document by verifying against the ingested access control list (ACL) in a knowledge base. Use this operation to validate that document-level access control is working as expected after ingestion. To use this operation, you must have the bedrock:CheckIngestedDocumentAcl permission.

Method Signature

METHODS /AWS1/IF_BDZ~CHECKINGESTEDDOCUMENTACL
  IMPORTING
    !IV_KNOWLEDGEBASEID TYPE /AWS1/BDZKNOWLEDGEBASEID00 OPTIONAL
    !IV_DATASOURCEID TYPE /AWS1/BDZDATASOURCEID OPTIONAL
    !IV_DOCUMENTID TYPE /AWS1/BDZDOCUMENTID OPTIONAL
    !IO_USERCONTEXT TYPE REF TO /AWS1/CL_BDZUSERCONTEXT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_bdzcheckigstdocaclrsp
  RAISING
    /AWS1/CX_BDZACCESSDENIEDEX
    /AWS1/CX_BDZINTERNALSERVEREX
    /AWS1/CX_BDZRESOURCENOTFOUNDEX
    /AWS1/CX_BDZTHROTTLINGEX
    /AWS1/CX_BDZVALIDATIONEX
    /AWS1/CX_BDZCLIENTEXC
    /AWS1/CX_BDZSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_knowledgebaseid TYPE /AWS1/BDZKNOWLEDGEBASEID00 /AWS1/BDZKNOWLEDGEBASEID00

The unique identifier of the knowledge base that contains the document.

iv_datasourceid TYPE /AWS1/BDZDATASOURCEID /AWS1/BDZDATASOURCEID

The unique identifier of the data source that contains the document.

iv_documentid TYPE /AWS1/BDZDOCUMENTID /AWS1/BDZDOCUMENTID

The unique identifier of the document to check access for.

io_usercontext TYPE REF TO /AWS1/CL_BDZUSERCONTEXT /AWS1/CL_BDZUSERCONTEXT

The context object containing identity information for access control filtering, including user ID and optional group memberships used to evaluate the document access control list (ACL).

RETURNING

oo_output TYPE REF TO /aws1/cl_bdzcheckigstdocaclrsp /AWS1/CL_BDZCHECKIGSTDOCACLRSP

Examples

Syntax Example

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->checkingesteddocumentacl(
  io_usercontext = new /aws1/cl_bdzusercontext( |string| )
  iv_datasourceid = |string|
  iv_documentid = |string|
  iv_knowledgebaseid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_boolean = lo_result->get_hasaccess( ).
ENDIF.