This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.

CRUD operation support for Configurable Governance Artifacts

The CRUD API for Configurable Governance Artifacts is one of many APIs supported by the WSO2 Governance Registry. Read more on Supported APIs & Standards for a complete list of APIs supported by WSO2 Governance Registry.

Any Configurable Governance Artifact deployed on the registry is exposed as a web service. By retrieving the corresponding WSDL of the  Configurable Governance Artifact service it is possible write external clients to do Create, Retrieve, Update, Delete operations on the implemented artifact. 

  1. The WSDL of a Configurable Governance Artifact Service can be exposed by giving the value false to the following configuration given in the $GREG_HOME/repository/conf/carbon.xml.

    <HideAdminServiceWSDLs>false</HideAdminServiceWSDLs>


  2.  Now after starting the server the service WSDL can be accessed. For an example lets say that we have implemented a Configurable Governance Artifact called Department. The corresponding service can be accessed as given in the following URL. 

    https://localhost:9443/services/Department?wsdl

  3. When going through the WSDL it is evident that it contains operations with operation names containing the singularLabel of the artifact. For an instance if the singular label of the artifact is Department then the operations would be as below. 

  • addDepartment  - create an artifact in the type Department.
  • getDepartment - retrieve an artifact in the type Department.
  • updateDepartment - update an artifact in the type Department.
  • deleteDepartment - delete an artifact in the type Department. 
  • getDepartmentArtifactIDs - get all the artifact ID s of artifacts in the type Department.

     4.  Users can write their own clients to use artifact service operations as given above in order to do CRUD operations and corresponding parameters for those operations can be passed as below. for an instance the getDepartment method can be  accesssed as 

          https://localhost:9443/services/Department/getDepartment?artifactId={id}. 

Note

For a complete RXT sample which creates an RXT configuration model, deploys and tests it, refer to RXT Service Client Sample.

 

 

Â