Revoke Case Access

<< Click to Display Table of Contents >>

Navigation:  Bizagi Studio > Bizagi from external applications > Bizagi API > SOAP web services > Available SOAP web services > WorkflowEngineSOA Web methods >

Revoke Case Access

Overview

This Web method is used to revoke access to cases in Bizagi for a given set of users (from an external application).

 

This method receives a single input having mainly: any number of UserNames of the users to be revoked as privileged users and the respective case number.

Through this method, a user is removed from the privileged list of users who have access to a Process instance (case). The values passed must be known in advance and must be sent from an external system

For further information about revoke case access, please refer to Case security.

 

For the revokeCaseAccess method, the request and response XML's are of the native .NET XmlDocument type.

For the revokeCaseAccessAsString method the same XML structure is handled, but this parameter is sent as a string type using CDATA.

 

Input

 

Input Schema

The following shows a sample XML structure of information to send to Bizagi:

 

<?xml version="1.0" encoding="utf-8"?>

<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">

 

</xs:schema>

 

Input Parameters

BizAgiWSParam: Root node.

CaseAccessXML: Include here the information (XML-structured) of the cases where you want to remove users from the privileged list of users who have access to them.

For further information about the expected structured for the business information contained in this Entities element, refer to Bizagi's data model XML schemas.

 

 

Input Example

With the following sample XML, the users dtaylor and efeller will be removed to case 354. To revoke case access, the case must not be closed and must exist.

 

Method grantCaseAccess

 

<![CDATA[<BizAgiWSParam>

 <CaseAccess idCase='354'>

         <UserName>domain\dtaylor</UserName>

         <UserName>domain\efeller</UserName>

 </CaseAccess>

</BizAgiWSParam>]]>

 

Method grantCaseAccessAsString

 

<caseAccessXML>

 <![CDATA[<BizAgiWSParam>

         <CaseAccess idCase='354'>

                 <UserName>domain\dtaylor</UserName>

                 <UserName>domain\efeller</UserName>        

         </CaseAccess>

 </BizAgiWSParam>]]>

</caseAccessXML>

 

Output

 

Output Schema

The following shows a sample XML structure of information returned by Bizagi:

 

<?xml version="1.0" encoding="utf-8"?>

<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" xmlns:xs="http://www.w3.org/2001/XMLSchema">

 

</xs:schema>

 

Output Parameters

ErrorMessage: Message explaining why the error occurred. Visible when the error is caused by wrong data.

CaseAccess: Cases processed during the invocation.

 

 

Output Example

In the following example, we illustrate a returned XML-structured response from Bizagi SOA layer, in which we can see:

The set of users has been removed from the case 354.

 

RevokeCaseAccess_01

 

The user could not be removed. Within the response, error detail is found at ErrorMessage, in which the service informs that the case 3294 does not exist or is closed.

 

RevokeCaseAccess_03

 

Related Web methods

If you wish to grant the access to a case, use the grantCaseAccessAsString or grantCaseAccess Web method.

For further information refer to the Grant Case Access article.