REST interface for BPD-related resources - Business Object Resource - GET Method

Use this method to retrieve the details of a business object. Note that the calling user must have read permission for the process application that contains the business object.

Sample method invocation

GET /rest/bpm/wle/v1/businessobject/{boId}[?snapshotId={string}][&branchId={string}][&processAppId={string}]

Parameters

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

Request content

None

Response content

The details of the business object (BusinessObject complexType).

The default content type is application/json.

MIME type: application/json


+ View schema
{
    "status":"200",
    "data":{
        "isComplex":{"type": "boolean", "description": "Indicates whether the business object is a complex type."},
        "type":{"type": "string", "description": "The type of the business object. It is the same as the name for the complex type."},
        "name":{"type": "string", "description": "The name of the business object."},        
        "properties":[
            {
                "typeClass":{"type": "string", "description": "The name of the type class for the property."},
                "typeClassRef":{"type": "string", "description": "The reference ID of the type class if it is a complex type.
				It is null when the 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."},
                "isArray":{"type": "boolean", "description": "Indicates whether this property is a list."},
                "name":{"type": "string", "description": "The name of the property."}
            }
        ]
    }
}
+ View example content
{
    "status":"200",
    "data":{
        "isComplex":true,
        "type":"Person",
        "properties":[{
                "typeClass":"String",
                "typeClassSnapshotId":null,
                "typeClassBranchId":null,
                "isArray":false,
                "name":"firstName"
            },
            {
                "typeClass":"String",
                "typeClassSnapshotId":null,
                "typeClassBranchId":null,
                "isArray":false,
                "name":"lastName"
            },
            {
                "typeClass":"String",
                "typeClassSnapshotId":null,
                "typeClassBranchId":null,
                "isArray":false,
                "name":"notes"
            },
            {
                "typeClass":"String",
                "typeClassSnapshotId":null,
                "typeClassBranchId":null,
                "isArray":false,
                "name":"payLevel"
            },
            {
                "typeClass":"String",
                "typeClassSnapshotId":null,
                "typeClassBranchId":null,
                "isArray":false,
                "name":"payType"
            },
            {
                "typeClass":"Date",
                "typeClassSnapshotId":null,
                "typeClassBranchId":null,
                "isArray":false,
                "name":"startDate"
            },
            {
                "typeClass":"String",
                "typeClassSnapshotId":null,
                "typeClassBranchId":null,
                "isArray":false,
                "name":"supervisor"
            },
            {
                "typeClass":"BO1",
                "typeClassRef":"12.7249b869-04b8-4588-97bd-aad4489583f0",
                "typeClassSnapshotId":"2064.63c0e2f8-7060-4d5a-8122-0fdb0f3cb8f7",
                "typeClassBranchId":null,
                "isArray":true,
                "name":"test"
            }
        ],
        "name":"Person"
    }
}

MIME type: application/xml


+ View schema
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/businessobject"
	elementFormDefault="unqualified"
	xmlns="http://www.w3.org/2001/XMLSchema"
	xmlns:tns="http://rest.bpm.ibm.com/v1/data/businessobject"
	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="BOProperty">
		<complexContent>
		    <extension base="pref:NamedElement">        
		        <sequence>
					<element name="description" type="string" />
					<element name="richDescription" 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="isArray" type="boolean" />
				</sequence>
		    </extension>
		</complexContent>		
	</complexType>
    
	<complexType name="DocumentProperty">
		<complexContent>
		    <extension base="tns:BOProperty">        
		        <sequence>
					<element name="isHidden" type="boolean" default="false"/>
					<element name="isRequired" type="boolean" default="false"/>
				</sequence>
		    </extension>
		</complexContent>		
	</complexType>
	
	<complexType name="BusinessObject">
		<complexContent>
		    <extension base="pref:NamedElement">        
		        <sequence>
					<element name="isComplex" type="boolean" />
					<element name="type" type="string" />
					<element name="description" type="string" />
					<element name="richDescription" type="string" />
					<element name="isShared" type="boolean" />
					<element name="properties" type="tns:BOProperty" maxOccurs="unbounded"/>
					<element name="iconType" type="int" default="0" />
				</sequence>
		    </extension>
		</complexContent>		
	</complexType>
            
</schema>

Error Response content

Detailed error information.

The default content type is application/json.

MIME type: application/json


+ View 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 OKSuccess completion.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
404 Not Found
The business object 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: Business Object Resource