Catalyst RESTful services let you access Catalyst Process Automation Services. To discover the Catalyst RESTful interface resources, start at the base URL from any browser and use HTTP GET requests to traverse the hyperlinks.
The base URL of the Catalyst RESTful interface is:
http://<hostname>:7000/node/rest/
The base URL displays the URLs of the Catalyst container modules. The Catalyst container hosts modules for the Catalyst broker and Catalyst Process Automation Services.
The status of the modules can be displayed at:
http://<hostname>:7000/node/rest/broker/Entity
The module for Catalyst Process Automation Services is "CA:00074_CA:00074:01":
http://<hostname>:7000/node/rest/CA:00074_CA:00074:01/
The connector descriptors are accessed through the REST API metadata interface, which is:
http://<hostname>:7000/node/rest/CA:00074_CA:00074:01;metadata=descriptor
For example:
<?xml version="1.0" encoding="UTF-8"?>
<conndesc:descriptor xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:conndesc="http://www.ca.com/connex/conndesc"
xsi:schemaLocation="http://www.ca.com/connex/conndesc conn_desc.xsd"
xmlns:usm="http://www.ca.com/usm"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:usm-core="http://ns.ca.com/2009/07/usm-core"
xmlns:pam-ops="http://ns.ca.com/2011/09/pam-ops"
xmlns:pam="http://www.ca.com/pam">
<ID>com.ca.c2o.mdr.UCFPAMConnector</ID>
<version>4.0</version>
<category>CA Process Automation</category>
<configurationDesc xsi:type="usm:KeywordValuePairs">
</configurationDesc>
<connectorProperties>
<property name = "BaseURI" value="http://pam-uri"/>
</connectorProperties>
<!-- ******************************* -->
<!-- Process operations... -->
<!-- ******************************* -->
<!-- Start a Process -->
<customOp ID="Start" name="Start" synchronous="true">
<inputType xsi:type="pam-ops:StartRequest"/>
<resultType xsi:type="pam-ops:StartResponse"/>
</customOp>
…
The schema for the connector operations is accessed through the REST API metadata interface at:
http://<hostname>:7000/node/rest/CA:00074_CA:00074:01;metadata=schema
Any third-party XML schema utility can use the schema to construct the input parameters of the operations.
For example:
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
targetNamespace="http://ns.ca.com/2011/09/pam-ops"
xmlns:pam-ops="http://ns.ca.com/2011/09/pam-ops"
xmlns:usm-meta="http://ns.ca.com/2009/07/usm-metadata"
xmlns:usm-meta2="http://ns.ca.com/2011/02/usm-metadata2"
xmlns:usm-core="http://ns.ca.com/2009/07/usm-core" >
<xs:import namespace="http://ns.ca.com/2009/07/usm-metadata" schemaLocation="usm-metadata-200907.xsd"/>
<xs:import namespace="http://ns.ca.com/2011/02/usm-metadata2" schemaLocation="usm-metadata2-201102.xsd"/>
<xs:import namespace="http://ns.ca.com/2009/07/usm-core" schemaLocation="usm-core-200907.xsd"/>
<xs:complexType name="StartRequest">
<xs:annotation>
<xs:documentation>Request to start an entity, identified by its EntityID</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="EntityID" type="usm-core:EntityID">
<xs:annotation>
<xs:documentation>Identification of the entity which should be started (defined by the elements, MdrProduct-MdrProdInstance-MdrElementID).</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="Arguments" type="pam-ops:ArgumentList" minOccurs="0" maxOccurs="1" />
</xs:sequence>
</xs:complexType>
<xs:element name="StartRequest" type="pam-ops:StartRequest">
<xs:annotation>
<xs:documentation>Request to start an entity, identified by its EntityID</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="StartResponse">
<xs:annotation>
<xs:documentation>If successfully started, a response containing the EntityID is returned</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="EntityID" type="usm-core:EntityID">
<xs:annotation>
<xs:documentation>Identification of the entity which was requested to be started (defined by the elements, MdrProduct-MdrProdInstance-MdrElementID).</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="StartResponse" type="pam-ops:StartResponse">
<xs:annotation>
<xs:documentation>If successfully started, a response containing theEntityID is returned</xs:documentation>
</xs:annotation>
</xs:element>
…
Starting with the URL of the Catalyst REST interface, you can display the Catalyst Process Automation Services URL. The Catalyst Process Automation Services URL contains the URLs of the supported types and operations. For example:
<?xml version="1.0" encoding="UTF-8"?>
<module xmlns="http://ns.ca.com/2010/11/coreapi">
<id>CA:00074_CA:00074:01</id>
<mdrProduct>CA:00074</mdrProduct>
<mdrProdInstance> CA:00074:01</mdrProdInstance>
<type>
<id>ITActivity</id>
<name>ITActivity</name>
<namespace>http://ns.ca.com/2009/07/usm-core</namespace>
<prefix/>
<link href="http://mulwi01-w500:7000/node/rest/CA:00074_CA:00074:01/ITActivity" rel="list"/>
<link href="http://mulwi01-w500:7000/node/rest/CA:00074_CA:00074:01/ITActivity;metadata" rel="metadata"/>
</type>
<type>
<id>ITActivityTemplate</id>
<name>ITActivityTemplate</name>
<namespace>http://ns.ca.com/2009/07/usm-core</namespace>
<prefix/>
<link href="http://mulwi01-w500:7000/node/rest/CA:00074_CA:00074:01/ITActivityTemplate" rel="list"/>
<link href="http://mulwi01-w500:7000/node/rest/CA:00074_CA:00074:01/ITActivityTemplate;metadata" rel="metadata"/>
</type>
<operation>
<id>Release</id>
<name>Release</name>
<synchronous>true</synchronous>
<link href="http://mulwi01-w500:7000/node/rest/CA:00074_CA:00074:01/_ops/Release" rel="self"/>
</operation>
|
Copyright © 2014 CA.
All rights reserved.
|
|