REST interface for BPD-related resources - Exposed Process Value Resource - GET Method [deprecated]

This function is deprecated. Use this method to retrieve the detailed information related to an exposed process value.

Sample method invocation

GET /rest/bpm/wle/v1/epv/{epvId}[?snapshotId={string}][&branchId={string}]

Parameters

Note: To identify the correct snapshot to be used, you must set one of the snapshotId or branchId parameters.
The following precedence rules apply:
1) If the snapshotId parameter is specified, that specific snapshot is used, and the branchId parameter is ignored.
2) If the branchId parameter is specified, the tip (current) snapshot of the specified branch (track) is used.
Optional parameters
NameValue TypeDescription
snapshotId string
The identifier of the snapshot associated with the exposed process value. You must set one of the snapshotId or branchId parameters.
branchId string
The identifier of the branch associated with the exposed process value. You must set one of the snapshotId or branchId parameters.

Request content

None

Response content

The detailed information related to the exposed process value (RestEpv complexType). Note: The identifier returned for a participant can be used as a teamId value in team-related calls.

The default content type is application/json.

MIME type: application/json


Schema
{
    "status":"200",
    "data":{
        "name":{"type": "string", "description": "The name of the exposed process variable."},
        "desc":{"type": "string", "description": "The description of the exposed process variable."},
        "participantName":{"type": "string", "description": "The name of the participant group to which the exposed process variable is exposed."},
        "participantId":{"type": "string", "description": "The ID of the participant group to which the exposed process variable is exposed."},
        "participantRefSnapshotId":{"type": "string", "description": "The ID of the snapshot associated with the participant group.
		Either 'snapshotId' or 'branchId' must be specified if participantId is not null."},
        "participantRefBranchIdId":{"type": "string", "description": "The ID of the branch associated with the participant group.
		Either 'snapshotId' or 'branchId' must be specified if participantId is not null."},           
        "vars":
        [
            {
                "name":{"type": "string", "description": "The external name of the variable."},
                "extDesc":{"type": "string", "description": "The external description of the variable."},
                "varname":{"type": "string", "description": "The variable name."},
                "defaultValue":{"type": "string", "description": "The default value."},
                "isChgActiveProc":{"type": "boolean", "description": "Indicates whether In-Progress Tasks use a new value."},
                "typeClass":{"type": "string", "description": "The name of the type class for the variable."},
                "typeClassRef":{"type": "string", "description": "The reference ID of the type class if it is a complex type.
				It is null when typeClass is a primitive type."},
                "typeClassSnapshotId":{"type": "string", "description": "The ID of the snapshot associated with the type class.
        			Either 'snapshotId' or 'branchId' must be specified when typeClassRef is not null."},
                "typeClassBranchId":{"type": "string", "description": "The ID of the branch associated with the type class.
        			Either 'snapshotId' or 'branchId' must be specified when typeClassRef is not null."}
                "isChgActiveProc":false,
            }
        ]
    }
}
Example content
{
    "status":"200",
    "data":{
        "desc":"EPV desc",
        "participantName":"GeneralManagers",
        "participantId":"24.eb30156e-52c8-4ec5-9be6-02290d02f827",
        "participantRefSnapshotId":"2064.8b2561f3-5ea4-437f-bd61-3d8c415b12ac",
        "vars":[{
                "extDesc":"external description for varName2",
                "typeClass":"String",
                "typeClassSnapshotId":null,
                "typeClassBranchId":null,
                "varname":"varName2",
                "defaultValue":"\"USA\"",
                "isChgActiveProc":false,
                "name":"address"
            },
            {
                "extDesc":"external description for varName1",
                "typeClass":"String",
                "typeClassSnapshotId":null,
                "typeClassBranchId":null,
                "varname":"varName1",
                "defaultValue":"\"john\"",
                "isChgActiveProc":true,
                "name":"name"
            },
            {
                "extDesc":"external description for var3",
                "typeClass":"Position",
                "typeClassRef":"12.0ea493a3-08b7-4456-84be-443c8d41bc8b",
                "typeClassSnapshotId":"2064.8b2561f3-5ea4-437f-bd61-3d8c415b12ac",
                "typeClassBranchId":null,
                "varname":"var3",
                "isChgActiveProc":false,
                "name":"position"
            }
        ],
        "name":"EPV1"
    }
}

MIME type: application/xml


Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/epv"
	elementFormDefault="unqualified"
	xmlns="http://www.w3.org/2001/XMLSchema"
	xmlns:tns="http://rest.bpm.ibm.com/v1/data/epv"
	xmlns:pref="http://rest.bpm.ibm.com/v1/data/root"
	xmlns:cmn="http://rest.bpm.ibm.com/v1/data/common">

    <import schemaLocation="Common.xsd" namespace="http://rest.bpm.ibm.com/v1/data/common"/>
    <import schemaLocation="BPMRestData.xsd" namespace="http://rest.bpm.ibm.com/v1/data/root"/>
    
	<complexType name="RestEpvVar">
		<complexContent>
		    <extension base="pref:NamedElement">        
		        <sequence>
					<element name="extDesc" type="string" />
					<element name="plainExtDesc" type="string" />					
					<element name="typeClass" type="string" />
					<element name="typeClassRef" type="string" />
					<choice>
						<element name="typeClassSnapshotId" type="string" />
						<element name="typeClassBranchId" type="string" />
					</choice>
					<element name="varname" type="string" />
					<element name="defaultValue" type="string" />
					<element name="isChgActiveProc" type="boolean" />
				</sequence>
		    </extension>
		</complexContent>		
	</complexType>

	<complexType name="RestEpv">
		<complexContent>
		    <extension base="pref:NamedElement">        
		        <sequence>
					<element name="envId" type="string" />
					<element name="desc" type="string" />
					<element name="richDesc" type="string" />
					<element name="extDesc" type="string" />
					<element name="feedback" type="string" />
					<element name="participantName" type="string" />
					<element name="participantId" type="string" />
					<element name="participantRefSnapshotId" type="string" />
					<element name="participantRefBranchId" type="string" />
					<element name="vars" type="tns:RestEpvVar" maxOccurs="unbounded"/>
				</sequence>
		    </extension>
		</complexContent>		
	</complexType>
            
</schema>

Error Response content

Detailed error information.

The default content type is application/json.

MIME type: application/json


Schema
{  "description": "WLE Error Response", 
   "type": "object",
   "properties":
   {  "status": {"type": "string",
         "description": "The status of the previous API call."
      },
      "exceptionType": {"type": "string",
         "description": "The classname associated with the exception."
      },
      "errorNumber": {"type": "string",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description": "Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"], "optional": true,
         "description":"Message text parameters of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description":"Additional exception details, for example, a stack trace."
      }
   }
} 

Status codes

The method returns one of the following status codes:
CodeDescription
200 OK
Successful completion - detailed report returned.
400 Bad RequestThe parameters are not valid or they are missing.
404 Not FoundThe resource does not exist.
406 Not AcceptableThe requested content type or content encoding is not supported.
500 Internal Server ErrorA severe problem has occurred, programmer's details are provided.

Available since

7.5.1

Parent Topic: Exposed Process Value Resource