Oracle Data Relationship Management (DRM): Data Relationship Governance Web Service interface Copyright © 1994, 2025, Oracle and/or its affiliates.
+Service Definition
<service name="DrmGovernanceService">
<port binding="IDrmGovernanceServiceSoapHttp" name="DrmGovernanceServicePortType">
<address location="REPLACE_WITH_ACTUAL_URL"/>
</port>
</service>
Creates a workflow request object based upon a specified workflow model. This operation will not persist the workflow request.

Input Parameters:

BaseRequestType request: Parameters used to create a request template.

Output Parameters:

WorkflowRequestType request: Request template to be completed and submitted.
+Operation Definition
<operation name="createWorkflowRequest">
<input message="createWorkflowRequestInput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/createWorkflowRequestRequest" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<output message="createWorkflowRequestOutput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/createWorkflowRequestResponse" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<fault message="drgGeneralException" name="drgGeneralException"/>
</operation>
+Binding Operation Definition
<operation name="createWorkflowRequest">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="drgGeneralException">
<fault name="drgGeneralException" use="literal"/>
</fault>
</operation>
Deletes an existing workflow request.

Input Parameters:

int requestId: Delete workflow request input parameter.
+Operation Definition
<operation name="deleteWorkflowRequest">
<input message="deleteWorkflowRequestInput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/deleteWorkflowRequestRequest" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<output message="deleteWorkflowRequestOutput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/deleteWorkflowRequestResponse" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<fault message="drgGeneralException" name="drgGeneralException"/>
</operation>
+Binding Operation Definition
<operation name="deleteWorkflowRequest">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="drgGeneralException">
<fault name="drgGeneralException" use="literal"/>
</fault>
</operation>
Returns a list of available hierarchies for a request.

Input Parameters:

RequestHeaderType header: The workflow request header.
string taskName: Name of the task on the request item to check available hierarchies for.

Output Parameters:

HierListType hierarchies: List of available hierarcheis for a given request.
+Operation Definition
<operation name="getAvailableHiers">
<input message="getAvailableHiersInput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/getAvailableHiersRequest" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<output message="getAvailableHiersOutput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/getAvailableHiersResponse" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<fault message="drgGeneralException" name="drgGeneralException"/>
</operation>
+Binding Operation Definition
<operation name="getAvailableHiers">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="drgGeneralException">
<fault name="drgGeneralException" use="literal"/>
</fault>
</operation>
Returns node information (Property values, access level) for a given request item.

Input Parameters:

RequestHeaderType header: The workflow request header.
RequestItemType requestItem: The request item that contains node information.

Output Parameters:

RequestNodeType requestNode: The node information that is returned for a request item.
+Operation Definition
<operation name="getNodeForRequestItem">
<input message="getNodeForRequestItemInput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/getNodeForRequestItemRequest" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<output message="getNodeForRequestItemOutput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/getNodeForRequestItemResponse" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<fault message="drgGeneralException" name="drgGeneralException"/>
</operation>
+Binding Operation Definition
<operation name="getNodeForRequestItem">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="drgGeneralException">
<fault name="drgGeneralException" use="literal"/>
</fault>
</operation>
Indicates the user's access for the current stage of the request for the parent node indicated on the request item.
Notable rules for the return values in the RequestNodeType are
  • withinFilter is set to true if the node is not excluded by the workflow model and the user has appropriate workflow access for the parent node indicated on the item.
  • If the node does not exist for the parentName input parameter, then null will be returned.
  • A return value will be returned only if the task indicated on the request item has a Workflow Action equal to ADD_LIMB, ADD_LEAF, INSERT or MOVE.

Input Parameters:

RequestHeaderType header: The workflow request header.
RequestItemType requestItem: The request item that contains node information.

Output Parameters:

RequestNodeBaseType requestNode: The node information that is returned for a request item.
+Operation Definition
<operation name="getParentForRequestItem">
<input message="getParentForRequestItemInput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/getParentForRequestItemRequest" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<output message="getParentForRequestItemOutput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/getParentForRequestItemResponse" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<fault message="drgGeneralException" name="drgGeneralException"/>
</operation>
+Binding Operation Definition
<operation name="getParentForRequestItem">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="drgGeneralException">
<fault name="drgGeneralException" use="literal"/>
</fault>
</operation>
Retrieves a list of workflow models to which a user can submit a governance request for.

Output Parameters:

WorkflowModelInfoListType modelList: Get workflow model infos output type.
+Operation Definition
<operation name="getWorkflowModelInfos">
<input message="getWorkflowModelInfosInput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/getWorkflowModelInfosRequest" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<output message="getWorkflowModelInfosOutput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/getWorkflowModelInfosResponse" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<fault message="drgGeneralException" name="drgGeneralException"/>
</operation>
+Binding Operation Definition
<operation name="getWorkflowModelInfos">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="drgGeneralException">
<fault name="drgGeneralException" use="literal"/>
</fault>
</operation>
Returns a workflow request given an input key.

Input Parameters:

int requestId: Request Id of the workflow request.

Output Parameters:

WorkflowRequestType request: The workflow request and items.
+Operation Definition
<operation name="getWorkflowRequest">
<input message="getWorkflowRequestInput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/getWorkflowRequestRequest" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<output message="getWorkflowRequestOutput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/getWorkflowRequestResponse" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<fault message="drgGeneralException" name="drgGeneralException"/>
</operation>
+Binding Operation Definition
<operation name="getWorkflowRequest">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="drgGeneralException">
<fault name="drgGeneralException" use="literal"/>
</fault>
</operation>
Saves a workflow request to the DRM repository. This operation can be used for persisting a new or existing workflow request. If Request Id is empty or null, a new Workflow Request will be persisted else it will be updated.

Input Parameters:

WorkflowRequestType request: The input parameter type for the save workflow request method. This object should include the header as well as the items of the request.

Output Parameters:

WorkflowRequestType request: The output type for the save workflow request method.
+Operation Definition
<operation name="saveWorkflowRequest">
<input message="saveWorkflowRequestInput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/saveWorkflowRequestRequest" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<output message="saveWorkflowRequestOutput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/saveWorkflowRequestResponse" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<fault message="drgGeneralException" name="drgGeneralException"/>
</operation>
+Binding Operation Definition
<operation name="saveWorkflowRequest">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="drgGeneralException">
<fault name="drgGeneralException" use="literal"/>
</fault>
</operation>
Saves, validates and if successful, assigns the request to the next stage in the workflow path. If the Request Id is empty or null, a new Workflow Request will be persisted prior to the validation and submit. If WorkflowStatusEnum in the response type is Pending, use the getWorkflowRequest operation to poll for the status of the request until it is no longer in a Pending state.

Input Parameters:

WorkflowRequestType request: Workflow request object to be submitted.

Output Parameters:

WorkflowRequestType request: Workflow request object to be submitted. WorkflowStatusEnum indicates the status of the request..
+Operation Definition
<operation name="submitWorkflowRequest">
<input message="submitWorkflowRequestInput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/submitWorkflowRequestRequest" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<output message="submitWorkflowRequestOutput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/submitWorkflowRequestResponse" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<fault message="drgGeneralException" name="drgGeneralException"/>
</operation>
+Binding Operation Definition
<operation name="submitWorkflowRequest">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="drgGeneralException">
<fault name="drgGeneralException" use="literal"/>
</fault>
</operation>
Saves, calculates, and validates a workflow request. If the request Id is empty or null, a new workflow request will be persisted prior to the validation. If WorkflowStatusEnum in the response type is Pending, use the getWorkflowRequest operation to poll for the status of the request until it is no longer in a Pending state.

Input Parameters:

WorkflowRequestType request: Workflow request object to be validated.

Output Parameters:

WorkflowRequestType request: Workflow request object to be validated. WorkflowStatusEnum indicates the status of the request.
+Operation Definition
<operation name="validateWorkflowRequest">
<input message="validateWorkflowRequestInput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/validateWorkflowRequestRequest" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<output message="validateWorkflowRequestOutput" ns1:Action="http://drg.webservices.epm.oracle/IDrmGovernanceService/validateWorkflowRequestResponse" xmlns:ns1="http://www.w3.org/2006/05/addressing/wsdl"/>
<fault message="drgGeneralException" name="drgGeneralException"/>
</operation>
+Binding Operation Definition
<operation name="validateWorkflowRequest">
<operation soapAction=""/>
<input>
<body use="literal"/>
</input>
<output>
<body use="literal"/>
</output>
<fault name="drgGeneralException">
<fault name="drgGeneralException" use="literal"/>
</fault>
</operation>
+Message Definition
<message name="createWorkflowRequestInput">
<part element="createWorkflowRequest" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="createWorkflowRequestOutput">
<part element="createWorkflowRequestResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteWorkflowRequestInput">
<part element="deleteWorkflowRequest" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="deleteWorkflowRequestOutput">
<part element="deleteWorkflowRequestResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getAvailableHiersInput">
<part element="getAvailableHiers" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getAvailableHiersOutput">
<part element="getAvailableHiersResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeForRequestItemInput">
<part element="getNodeForRequestItem" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getNodeForRequestItemOutput">
<part element="getNodeForRequestItemResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getParentForRequestItemInput">
<part element="getParentForRequestItem" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getParentForRequestItemOutput">
<part element="getParentForRequestItemResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getWorkflowModelInfosInput">
<part element="getWorkflowModelInfos" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getWorkflowModelInfosOutput">
<part element="getWorkflowModelInfosResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getWorkflowRequestInput">
<part element="getWorkflowRequest" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="getWorkflowRequestOutput">
<part element="getWorkflowRequestResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="saveWorkflowRequestInput">
<part element="saveWorkflowRequest" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="saveWorkflowRequestOutput">
<part element="saveWorkflowRequestResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="submitWorkflowRequestInput">
<part element="submitWorkflowRequest" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="submitWorkflowRequestOutput">
<part element="submitWorkflowRequestResponse" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="validateWorkflowRequestInput">
<part element="validateWorkflowRequest" name="parameters"/>
</message>
Referenced By:
+Message Definition
<message name="validateWorkflowRequestOutput">
<part element="validateWorkflowRequestResponse" name="parameters"/>
</message>
Referenced By:
Exception element for web service methods.

Fields:

string Message: Exception message.
int Code: Exception code.
+Element Definition
<element name="drgGeneralException" type="DrgServiceException"/>
Referenced By:
This type is to be passed in the soap header.

Fields:

string serverUrl: : API adapter URL of the DRM application. Example: http://localhost:5240/Oracle/Drm/APIAdapter?wsdl
string sessionParams: Session parameters for the DRM application. Refer to the API Guide for a complete list of parameters. Example: ProductVersion=11.1.2;CultureName=en-US;TimeZoneOffset=-360
+Element Definition
<element name="AppParameters" type="AppParameters"/>
List element for validation failures.

Fields:

ValidationFailureType validationFailure: List container type for validation failures for a request item.
+Element Definition
<element name="ValidationFailureListType" type="ValidationFailureListType"/>
List element for workflow tasks.

Fields:

WorkflowRequestTaskType tasks: List element for workflow tasks.
+Element Definition
<element name="WorkflowTaskListType" type="WorkflowTaskListType"/>
Create workflow request input parameter.

Fields:

BaseRequestType request: Parameters used to create a request template.
+Element Definition
<element name="createWorkflowRequest" type="CreateWorkflowRequestType"/>
Referenced By:
Create workflow request output parameter.

Fields:

WorkflowRequestType request: Request template to be completed and submitted.
+Element Definition
<element name="createWorkflowRequestResponse" type="CreateWorkflowRequestResponseType"/>
Referenced By:
Deletes an existing request.

Fields:

int requestId: Delete workflow request input parameter.
+Element Definition
<element name="deleteWorkflowRequest">
<complexType>
<sequence>
<element name="requestId" type="int"/>
</sequence>
</complexType>
</element>
Referenced By:
Delete workflow request output parameter.
+Element Definition
<element name="deleteWorkflowRequestResponse" type="DeleteWorkflowRequestResponse"/>
Referenced By:
Get available hierarchies input parameter.

Fields:

RequestHeaderType header: The workflow request header.
string taskName: Name of the task on the request item to check available hierarchies for.
+Element Definition
<element name="getAvailableHiers" type="AvailableHiersType"/>
Referenced By:
Get available hierarchies output parameter.

Fields:

HierListType hierarchies: List of available hierarcheis for a given request.
+Element Definition
<element name="getAvailableHiersResponse" type="AvailableHiersResponseType"/>
Referenced By:
Get node for request item input parameter.

Fields:

RequestHeaderType header: The workflow request header.
RequestItemType requestItem: The request item that contains node information.
+Element Definition
<element name="getNodeForRequestItem" type="GetNodeForRequestItemType"/>
Referenced By:
Get node for request item output parameter.

Fields:

RequestNodeType requestNode: The node information that is returned for a request item.
+Element Definition
<element name="getNodeForRequestItemResponse" type="GetNodeForRequestItemResponseType"/>
Referenced By:
The input parameter for the getParentForRequestItem method.

Fields:

RequestHeaderType header: The workflow request header.
RequestItemType requestItem: The request item that contains node information.
+Element Definition
<element name="getParentForRequestItem" type="GetNodeForRequestItemType"/>
Referenced By:
The output parameter for the getParentForRequestItem method.

Fields:

RequestNodeBaseType requestNode: The node information that is returned for a request item.
+Element Definition
<element name="getParentForRequestItemResponse" type="GetParentForRequestItemResponseType"/>
Referenced By:
Get workflow models output parameter.

Fields:

WorkflowModelInfoListType modelList: Get workflow model infos output type.
+Element Definition
<element name="getWorkflowModelInfosResponse" type="GetWorkflowModelInfosResponseType"/>
Referenced By:
Get workflow request input parameter.

Fields:

int requestId: Request Id of the workflow request.
+Element Definition
<element name="getWorkflowRequest">
<complexType>
<sequence>
<element name="requestId" type="int"/>
</sequence>
</complexType>
</element>
Referenced By:
Existing request object matching the specified request Id.

Fields:

WorkflowRequestType request: The workflow request and items.
+Element Definition
<element name="getWorkflowRequestResponse" type="GetWorkflowRequestResponseType"/>
Referenced By:
Save workflow request input parameter.

Fields:

WorkflowRequestType request: The input parameter type for the save workflow request method. This object should include the header as well as the items of the request.
+Element Definition
<element name="saveWorkflowRequest" type="SaveWorkflowRequestType"/>
Referenced By:
Request Id of the workflow request in the DRM repository.

Fields:

WorkflowRequestType request: The output type for the save workflow request method.
+Element Definition
<element name="saveWorkflowRequestResponse" type="SaveWorkflowRequestResponseType"/>
Referenced By:
Submit workflow request input parameter.

Fields:

WorkflowRequestType request: Workflow request object to be submitted.
+Element Definition
<element name="submitWorkflowRequest">
<complexType>
<sequence>
<element name="request" type="WorkflowRequestType"/>
</sequence>
</complexType>
</element>
Referenced By:
Workflow request object to be submitted. WorkflowStatusEnum indicates the status of the request.

Fields:

WorkflowRequestType request: Workflow request object to be submitted. WorkflowStatusEnum indicates the status of the request..
+Element Definition
<element name="submitWorkflowRequestResponse" type="SubmitWorkflowRequestResponseType"/>
Referenced By:
Validate workflow request input parameter.

Fields:

WorkflowRequestType request: Workflow request object to be validated.
+Element Definition
<element name="validateWorkflowRequest" type="ValidateWorkflowRequestType"/>
Referenced By:
Validate workflow request output parameter.

Fields:

WorkflowRequestType request: Workflow request object to be validated. WorkflowStatusEnum indicates the status of the request.
+Element Definition
<element name="validateWorkflowRequestResponse" type="ValidateWorkflowRequestResponseType"/>
Referenced By:

Fields:

string Message: Exception message.
int Code: Exception code.
+Type Definition
<complexType name="DrgServiceException">
<sequence>
<element form="qualified" name="Message" type="string"/>
<element form="qualified" name="Code" type="int"/>
</sequence>
</complexType>
Referenced By:

Fields:

string serverUrl: : API adapter URL of the DRM application. Example: http://localhost:5240/Oracle/Drm/APIAdapter?wsdl
string sessionParams: Session parameters for the DRM application. Refer to the API Guide for a complete list of parameters. Example: ProductVersion=11.1.2;CultureName=en-US;TimeZoneOffset=-360
+Type Definition
<complexType name="AppParameters">
<sequence>
<element name="serverUrl" type="string"/>
<element name="sessionParams" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

HierListType hierarchies: List of available hierarcheis for a given request.
+Type Definition
<complexType name="AvailableHiersResponseType">
<sequence>
<element name="hierarchies" type="HierListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

RequestHeaderType header: The workflow request header.
string taskName: Name of the task on the request item to check available hierarchies for.
+Type Definition
<complexType name="AvailableHiersType">
<sequence>
<element minOccurs="0" name="header" type="RequestHeaderType"/>
<element minOccurs="0" name="taskName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

int modelId: The Id of the workflow model.
string name: The name of the workflow model.
string label: The label of the workflow model.
string description: The description of the workflow model.
+Type Definition
<complexType name="BaseModelType">
<sequence>
<element minOccurs="0" name="modelId" type="int"/>
<element name="name" type="string"/>
<element name="label" type="string"/>
<element minOccurs="0" name="description" type="string"/>
</sequence>
</complexType>
Type Hierarchy:

Fields:

string modelName: The name of the workflow model for the workflow request.
string versionName: The name of the target version for the workflow request.
+Type Definition
<complexType name="BaseRequestType">
<sequence>
<element minOccurs="0" name="modelName" type="string"/>
<element minOccurs="0" name="versionName" type="string"/>
</sequence>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

WorkflowRequestType request: Request template to be completed and submitted.
+Type Definition
<complexType name="CreateWorkflowRequestResponseType">
<sequence>
<element name="request" type="WorkflowRequestType"/>
</sequence>
</complexType>
Referenced By:

Fields:

BaseRequestType request: Parameters used to create a request template.
+Type Definition
<complexType name="CreateWorkflowRequestType">
<sequence>
<element name="request" type="BaseRequestType"/>
</sequence>
</complexType>
Referenced By:
+Type Definition
<complexType name="DeleteWorkflowRequestResponse">
<sequence/>
</complexType>
Referenced By:

Fields:

RequestNodeType requestNode: The node information that is returned for a request item.
+Type Definition
<complexType name="GetNodeForRequestItemResponseType">
<sequence>
<element name="requestNode" type="RequestNodeType"/>
</sequence>
</complexType>
Referenced By:

Fields:

RequestHeaderType header: The workflow request header.
RequestItemType requestItem: The request item that contains node information.
+Type Definition
<complexType name="GetNodeForRequestItemType">
<sequence>
<element minOccurs="0" name="header" type="RequestHeaderType"/>
<element minOccurs="0" name="requestItem" type="RequestItemType"/>
</sequence>
</complexType>
Referenced By:

Fields:

RequestNodeBaseType requestNode: The node information that is returned for a request item.
+Type Definition
<complexType name="GetParentForRequestItemResponseType">
<sequence>
<element name="requestNode" type="RequestNodeBaseType"/>
</sequence>
</complexType>
Referenced By:
+Type Definition
<complexType name="GetWorkflowModelInfos">
<sequence/>
</complexType>
Referenced By:

Fields:

WorkflowModelInfoListType modelList: Get workflow model infos output type.
+Type Definition
<complexType name="GetWorkflowModelInfosResponseType">
<sequence>
<element minOccurs="0" name="modelList" type="WorkflowModelInfoListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

WorkflowRequestType request: The workflow request and items.
+Type Definition
<complexType name="GetWorkflowRequestResponseType">
<sequence>
<element name="request" type="WorkflowRequestType"/>
</sequence>
</complexType>
Referenced By:

Fields:

HierType workflowHiers: A list of hierarchies.
+Type Definition
<complexType name="HierListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="workflowHiers" nillable="true" type="HierType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string name: The name of the hierarchy.
string description: The description of the hierarchy.
string versionName: The name of the version for this hierarchy.
+Type Definition
<complexType name="HierType">
<sequence>
<element name="name" type="string"/>
<element minOccurs="0" name="description" type="string"/>
<element name="versionName" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

PropertyValueType values: List of property value objects.
+Type Definition
<complexType name="PropertyValueListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="values" nillable="true" type="PropertyValueType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string value: The value of the property.
string property: The name of the property.
+Type Definition
<complexType name="PropertyValueType">
<sequence>
<element minOccurs="0" name="value" type="string"/>
<element minOccurs="0" name="property" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

string modelName: The name of the workflow model for the workflow request.
string versionName: The name of the target version for the workflow request.
string title: The title of the request.
int requestId: The Id of the workflow request.
string createdBy: The username of the user that created the workflow request.
WorkflowStageType stage: The active workflow stage for the request.
WorkflowStatusEnum status: Enumeration value indicating the workflow status of the request.
string submittedBy: The username that submitted the request. This can be null in some cases if a request has not been submitted.
string claimedBy: The username that claims the request. This can be null in some cases if a request has not been claimed.
boolean canAddItems: Boolean that indicates if items can be added.
WorkflowTaskListType allowedTasks: List of tasks for the model. This is read only information and is intended as an aid for creating a workflow request.
WorkflowRequestAllowedActionListType allowedActions: A list of workflow actions that can be performed on the request given the current status.
+Type Definition
<complexType name="RequestHeaderType">
<complexContent>
<extension base="BaseRequestType">
<sequence>
<element minOccurs="0" name="title" type="string"/>
<element minOccurs="0" name="requestId" type="int"/>
<element minOccurs="0" name="createdBy" type="string"/>
<element minOccurs="0" name="stage" type="WorkflowStageType"/>
<element minOccurs="0" name="status" type="WorkflowStatusEnum"/>
<element minOccurs="0" name="submittedBy" type="string"/>
<element minOccurs="0" name="claimedBy" type="string"/>
<element minOccurs="0" name="canAddItems" type="boolean"/>
<element minOccurs="0" name="allowedTasks" type="WorkflowTaskListType"/>
<element minOccurs="0" name="allowedActions" type="WorkflowRequestAllowedActionListType"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

RequestItemType items: A list of request items.
+Type Definition
<complexType name="RequestItemListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="items" nillable="true" type="RequestItemType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string taskName: The name of the workflow task associated with the request item.
int taskId: The Id of the workflow task.
string nodeName: The name of the node.
string description: The node description.
string parentName: The parent node name.
string hierarchyName: The name of the hierarchy.
boolean readOnly: Boolean that indicates that the item is read only.
WorkflowRequestItemDetailListType workflowRequestItemDetails: List of property details for the request item.
ValidationFailureListType validationFailures: List of validation failures for the request item.
+Type Definition
<complexType name="RequestItemType">
<sequence>
<element minOccurs="0" name="taskName" type="string"/>
<element minOccurs="0" name="taskId" type="int"/>
<element minOccurs="0" name="nodeName" type="string"/>
<element minOccurs="0" name="description" type="string"/>
<element minOccurs="0" name="parentName" type="string"/>
<element minOccurs="0" name="hierarchyName" type="string"/>
<element minOccurs="0" name="readOnly" type="boolean"/>
<element minOccurs="0" name="workflowRequestItemDetails" type="WorkflowRequestItemDetailListType"/>
<element minOccurs="0" name="validationFailures" type="ValidationFailureListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string hierarchyName: The name of the hierarchy.
string nodeName: The name of the node.
string description: The description of the node.
string parentName: The name of the parent for the node.
boolean withinFilter: Is set to true if the node is not excluded by the workflow model and the user has appropriate workflow access for the nodeName indicated on the item.
WorkflowAccessLevelEnum accessLevel: The users access level for the node indicated on the item.
+Type Definition
<complexType name="RequestNodeBaseType">
<sequence>
<element minOccurs="0" name="hierarchyName" type="string"/>
<element minOccurs="0" name="nodeName" type="string"/>
<element minOccurs="0" name="description" type="string"/>
<element minOccurs="0" name="parentName" type="string"/>
<element minOccurs="0" name="withinFilter" type="boolean"/>
<element minOccurs="0" name="accessLevel" type="WorkflowAccessLevelEnum"/>
</sequence>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

string hierarchyName: The name of the hierarchy.
string nodeName: The name of the node.
string description: The description of the node.
string parentName: The name of the parent for the node.
boolean withinFilter: Is set to true if the node is not excluded by the workflow model and the user has appropriate workflow access for the nodeName indicated on the item.
WorkflowAccessLevelEnum accessLevel: The users access level for the node indicated on the item.
PropertyValueListType propertyValues: List of property values for the request node.
+Type Definition
<complexType name="RequestNodeType">
<complexContent>
<extension base="RequestNodeBaseType">
<sequence>
<element name="propertyValues" type="PropertyValueListType"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:

Fields:

WorkflowRequestType request: The output type for the save workflow request method.
+Type Definition
<complexType name="SaveWorkflowRequestResponseType">
<sequence>
<element name="request" type="WorkflowRequestType"/>
</sequence>
</complexType>
Referenced By:

Fields:

WorkflowRequestType request: The input parameter type for the save workflow request method. This object should include the header as well as the items of the request.
+Type Definition
<complexType name="SaveWorkflowRequestType">
<sequence>
<element name="request" type="WorkflowRequestType"/>
</sequence>
</complexType>
Referenced By:

Fields:

WorkflowRequestType request: Workflow request object to be submitted. WorkflowStatusEnum indicates the status of the request..
+Type Definition
<complexType name="SubmitWorkflowRequestResponseType">
<sequence>
<element name="request" type="WorkflowRequestType"/>
</sequence>
</complexType>
Referenced By:

Fields:

TaskPropertyType properties: A list of task properties.
+Type Definition
<complexType name="TaskPropertyListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="properties" nillable="true" type="TaskPropertyType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string name: The name of the property.
string label: The label of the property.
boolean editable: Boolean indicating if the property is editable for the task.
boolean required: Boolean indicating if the property is required for the task.
string allowedValues: If the property is a list type property then this is the list of allowed values for the property.
+Type Definition
<complexType name="TaskPropertyType">
<sequence>
<element minOccurs="0" name="name" type="string"/>
<element minOccurs="0" name="label" type="string"/>
<element minOccurs="0" name="editable" type="boolean"/>
<element minOccurs="0" name="required" type="boolean"/>
<element maxOccurs="unbounded" minOccurs="0" name="allowedValues" nillable="true" type="string"/>
</sequence>
</complexType>
Referenced By:

Fields:

WorkflowRequestType request: Workflow request object to be validated. WorkflowStatusEnum indicates the status of the request.
+Type Definition
<complexType name="ValidateWorkflowRequestResponseType">
<sequence>
<element name="request" type="WorkflowRequestType"/>
</sequence>
</complexType>
Referenced By:

Fields:

WorkflowRequestType request: Workflow request object to be validated.
+Type Definition
<complexType name="ValidateWorkflowRequestType">
<sequence>
<element name="request" type="WorkflowRequestType"/>
</sequence>
</complexType>
Referenced By:

Fields:

ValidationFailureType validationFailure: List container type for validation failures for a request item.
+Type Definition
<complexType name="ValidationFailureListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="validationFailure" nillable="true" type="ValidationFailureType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string failureReason: Validation failure message.
boolean isPropertyFailure: Indicates if the failure is associated with a specific property.
string property: Name of the property associated with the validation.
+Type Definition
<complexType name="ValidationFailureType">
<sequence>
<element minOccurs="0" name="failureReason" type="string"/>
<element minOccurs="0" name="isPropertyFailure" type="boolean"/>
<element minOccurs="0" name="property" type="string"/>
</sequence>
</complexType>
Referenced By:
+Type Definition
<simpleType name="WorkflowAccessLevelEnum">
<restriction base="string">
<enumeration value="None"/>
<enumeration value="Notify"/>
<enumeration value="Submit"/>
<enumeration value="Approve"/>
<enumeration value="Enrich"/>
<enumeration value="Commit"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
+Type Definition
<simpleType name="WorkflowActionEnum">
<restriction base="string">
<enumeration value="AddLeaf"/>
<enumeration value="AddLimb"/>
<enumeration value="Update"/>
<enumeration value="Inactivate"/>
<enumeration value="Insert"/>
<enumeration value="Move"/>
<enumeration value="Remove"/>
<enumeration value="Delete"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

WorkflowModelInfoType models: List of workflow model info types.
+Type Definition
<complexType name="WorkflowModelInfoListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="models" nillable="true" type="WorkflowModelInfoType"/>
</sequence>
</complexType>
Referenced By:

Fields:

int modelId: The Id of the workflow model.
string name: The name of the workflow model.
string label: The label of the workflow model.
string description: The description of the workflow model.
string availableVersions: List of versions for the model.
+Type Definition
<complexType name="WorkflowModelInfoType">
<complexContent>
<extension base="BaseModelType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="availableVersions" nillable="true" type="string"/>
</sequence>
</extension>
</complexContent>
</complexType>
Type Hierarchy:
Referenced By:
+Type Definition
<simpleType name="WorkflowRequestActionsEnum">
<restriction base="string">
<enumeration value="Save"/>
<enumeration value="Calculate"/>
<enumeration value="Submit"/>
<enumeration value="Validate"/>
<enumeration value="Claim"/>
<enumeration value="Unclaim"/>
<enumeration value="Descalate"/>
<enumeration value="Pushback"/>
<enumeration value="Escalate"/>
<enumeration value="Approve"/>
<enumeration value="Reject"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

WorkflowRequestActionsEnum actionTypes: List of allowed action type objects.
+Type Definition
<complexType name="WorkflowRequestAllowedActionListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="actionTypes" nillable="true" type="WorkflowRequestActionsEnum"/>
</sequence>
</complexType>
Referenced By:

Fields:

WorkflowRequestItemDetailType detailList: List of workflow item details object.
+Type Definition
<complexType name="WorkflowRequestItemDetailListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="detailList" nillable="true" type="WorkflowRequestItemDetailType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string property: Name of request item property in a workflow request.
boolean modified: Indicates whether the request item property value has been user modified.
string requestValue: The value for the property.
boolean calculated: Indicates whether the request item property value is calculated.
+Type Definition
<complexType name="WorkflowRequestItemDetailType">
<sequence>
<element minOccurs="0" name="property" type="string"/>
<element minOccurs="0" name="modified" type="boolean"/>
<element minOccurs="0" name="requestValue" type="string"/>
<element minOccurs="0" name="calculated" type="boolean"/>
</sequence>
</complexType>
Referenced By:

Fields:

string name: The name of the task.
string instructions: Instructions text for the task.
WorkflowActionEnum action: Enumeration of the action type for task.
TaskPropertyListType taskProperties: List of properties available for the task.
+Type Definition
<complexType name="WorkflowRequestTaskType">
<sequence>
<element minOccurs="0" name="name" type="string"/>
<element minOccurs="0" name="instructions" type="string"/>
<element minOccurs="0" name="action" type="WorkflowActionEnum"/>
<element minOccurs="0" name="taskProperties" type="TaskPropertyListType"/>
</sequence>
</complexType>
Referenced By:

Fields:

string label: The label value for the stage.
int id: The Id of the stage.
string assignedGroups: The list of groups that are assigned to the stage.
WorkflowStageTypeEnum stageType: The type of stage.
+Type Definition
<complexType name="WorkflowStageType">
<sequence>
<element minOccurs="0" name="label" type="string"/>
<element minOccurs="0" name="id" type="int"/>
<element maxOccurs="unbounded" minOccurs="0" name="assignedGroups" nillable="true" type="string"/>
<element minOccurs="0" name="stageType" type="WorkflowStageTypeEnum"/>
</sequence>
</complexType>
Referenced By:
+Type Definition
<simpleType name="WorkflowStageTypeEnum">
<restriction base="string">
<enumeration value="Submit"/>
<enumeration value="Enrich"/>
<enumeration value="Approve"/>
<enumeration value="Commit"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:
+Type Definition
<simpleType name="WorkflowStatusEnum">
<restriction base="string">
<enumeration value="None"/>
<enumeration value="Draft"/>
<enumeration value="Submitted"/>
<enumeration value="Calculated"/>
<enumeration value="Validated"/>
<enumeration value="PushedBack"/>
<enumeration value="Pending"/>
<enumeration value="Assigned"/>
<enumeration value="Claimed"/>
<enumeration value="Escalated"/>
<enumeration value="DeEscalated"/>
<enumeration value="Rejected"/>
<enumeration value="Committed"/>
</restriction>
</simpleType>
Type Hierarchy:
Referenced By:

Fields:

WorkflowRequestTaskType tasks: List element for workflow tasks.
+Type Definition
<complexType name="WorkflowTaskListType">
<sequence>
<element maxOccurs="unbounded" minOccurs="0" name="tasks" nillable="true" type="WorkflowRequestTaskType"/>
</sequence>
</complexType>
Referenced By: