REST interface for BPD-related resources - Undercover Agent Resource - GET Method [deprecated]

This function is deprecated. Use this method to retrieve the detailed information related to an undercover agent.

Sample method invocation

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

Parameters

Note: To identify the correct snapshot to be used, you must specify 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 undercover agent. You must set one of the snapshotId or branchId parameters.
branchId string
The identifier of the branch associated with the undercover agent. You must set one of the snapshotId or branchId parameters.

Request content

None

Response content

The detailed information related to the undercover agent (UCAType complexType).

The default content type is application/json.

MIME type: application/json


Schema
{
    "status":"200",
    "data":{
        "ucaId":{"type": "string", "description": "The ID of the undercover agent."},
        "name":{"type": "string", "description": "The name of the undercover agent."},
        "desc":{"type": "string", "description": "The description of the undercover agent."},
        "schedType":{"type": "string", "description": "The schedule type.", 
        	enum":
        	   [
        		"TimeElapsed",
        		"OnEvent"
        	   ]
        },
        "queue":{"type": "string", "description": "The name of the queue."},
        "enabled":{"type": "boolean"},
        "serviceId":{"type": "string", "description": "The ID of the attached service."},
        "serviceName":{"type": "string", "description": "The name of the attached service."},
	"serviceSnapshotId":{"type": "string", "description": "The ID of the snapshot associated with the attached service.
		Either 'snapshotId' or 'branchId' must be specified."},
	"serviceBranchId":{"type": "string", "description": "The ID of the branch associated with the attached service.
		Either 'snapshotId' or 'branchId' must be specified."}               
        "eventMessage":{"type": "string", "description": "The event message, which only applies when schedType is 'OnEvent'."},
        "timeSchedule":
	{
	   "type": "object", "description": "The details of the time schedule, which only applies when schedType is 'TimeElapsed'."},              
	        {
	            "month":[{"type": "integer"}],
	            "freqType":{"type": "string", "description": "The frequency type.", 
        	        "enum":
	       		   [
		   		"Every",
		   		"First",
		   		"Last"
	       		   ]
                    },
	            "weekDay":
	            [
	            	{"type": "string",  
        		     "enum":
			        [
					"MONDAY",
				        "TUESDAY",
				        "WEDNESDAY",
				        "THURSDAY",
				        "FRIDAY",
				        "SATURDAY",
				        "SUNDAY"
				]
                        },
	            ],
	            "hours":[{"type": "integer"}],
	            "minutes":[{"type": "integer"}]
	        }
	}
    }
}
Example content
{
    "status":"200",
    "data":{
        "ucaId":"4.1c1e0762-aac8-4759-ab36-2fa06de6aa11",
        "name":"UCA1",
        "desc":"UCA1 description",
        "schedType":"TimeElapsed",
        "queue":"Async Queue",
        "enabled":true,
        "serviceId":"1.254a0925-652c-4e75-a377-3b6528c69fb2",
        "serviceName":"Default System Service",
        "serviceSnapshotId":"2064.74f9ea10-a351-4c42-ada5-b3dce7145330",
        "serviceBranchId":null,
        "eventMessage":null,
        "timeSchedule":{
            "month":[1
            ],
            "freqType":"First",
            "weekDay":["TUESDAY"
            ],
            "hours":[3
            ],
            "minutes":[5
            ]
        }
    }
}

MIME type: application/xml


Schema
<?xml version="1.0" encoding="UTF-8"?>
<schema targetNamespace="http://rest.bpm.ibm.com/v1/data/uca"
	elementFormDefault="unqualified" xmlns="http://www.w3.org/2001/XMLSchema"
	xmlns:tns="http://rest.bpm.ibm.com/v1/data/uca" 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" />
	
	<simpleType name="ScheduleType">
		<restriction base="string">
			<enumeration value="OnEvent" />
			<enumeration value="TimeElapsed" />
		</restriction>
	</simpleType>	

	<simpleType name="EventType">
		<restriction base="string">
			<enumeration value="Message" />
			<enumeration value="Content" />
			<enumeration value="Timer" />
		</restriction>
	</simpleType>

	<simpleType name="TimeScheduleFreqType">
		<restriction base="string">
			<enumeration value="Every" />
			<enumeration value="First" />
			<enumeration value="Last" />
		</restriction>
	</simpleType>	

	<complexType name="TimeSchedule">
		<sequence>
			<element name="month" type="int" maxOccurs="unbounded"/>
			<element name="freqType" type="tns:TimeScheduleFreqType" />
			<element name="weekDay" type="string" maxOccurs="unbounded"/>
			<element name="hours" type="int" maxOccurs="unbounded"/>
			<element name="minutes" type="int" maxOccurs="unbounded"/>
		</sequence>
	</complexType>


	<complexType name="UCAType">
		<complexContent>
			<extension base="pref:Data">
				<sequence>
					<element name="ucaId" type="string" />
					<element name="name" type="string" />
					<element name="desc" type="string" />
					<element name="richDesc" type="string" />
					<element name="schedType" type="tns:ScheduleType" />
					<element name="eventType" type="tns:EventType" />
					<element name="queue" type="string" />
					<element name="enabled" type="boolean" />
					<element name="serviceId" type="string"/>
					<element name="serviceName" type="string"/>
					<choice>
						<element name="serviceSnapshotId" type="string"/>
						<element name="serviceBranchId" type="string"/>
					</choice>					
					<choice>
						<element name="eventMessage" type="string"/>
						<element name="timeSchedule" type="tns:TimeSchedule" />
					</choice>
				</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: Undercover Agent Resource



Feedback