Get workflow list by status or ID
Added by IBM contributorRajmeet S Bal | Edited by IBM contributorElizabeth Bowling on June 26, 2015
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

Get a list of workflows by customer Id, subscriber ID, or workflow status.

The API caller must have the VSR role to run the API.

Example URLs

/resource/workflow?_namedQuery=getWorkflowByStatus&workflowStatus=FAILED&_pageNumber=1&_pageSize=10

/resource/workflow?_namedQuery=getWorkflowByCustomerId&customerId=2000011&_pageSize=10&_pageNumber=1

/resource/workflow?_namedQuery=getWorkflowBySubscribererId&subscriberId=2000012&_pageSize=10&_pageNumber=1

For a list of common HTTP status codes that are returned for API calls, see HTTP status codes.

Input
Method URI Description
GET /resource/workflow?_namedQuery=getWorkflowByStatus Retrieves the workflow based on its status.
GET /resource/workflow?_namedQuery=getWorkflowByCustomerId Retrieves the workflow based on the customer ID field.
GET /resource/workflow?_namedQuery=getWorkflowBySubscriberId Retrieves the workflow based on the subscriber ID field.
Name Type Optional Description
workflowStatus
enumerated No The workflow status for which workflow list is to be retrieved. The request must use one of the following parameters to identify items for the workflow list to be returned:
- workflowStatus
- customerId
- subscriberId
Authorized values:
  • COMPLETED
  • FAILED
  • DEFERRED
  • RUNNING
customerId
string No The ID of customer for which workflow list is to be retrieved. The request must use one of the following parameters to identify items for the workflow list to be returned:
- workflowStatus
- customerId
- subscriberId
subscriberId
string No The ID of subscriber for which workflow list is to be retrieved. The request must use one of the following parameters to identify items for the workflow list to be returned:
- workflowStatus
- customerId
- subscriberId
_pageNumber
int Yes The number of the page that you want to be returned first. If no value is specified, the default value is 1.
_pageSize
int Yes The number of items to be returned in one page (one request). The maximum value allowed is 100; any value higher than 100 causes the API to fail with an error. If no value is specified, the default value is 25.
Examples

Response returned by the server
{
	"List": [{
		"SeatId": 10177,
		"SubscriberEmailAddress": "blah@us.ibm.com",
		"OperationId": "EntitleSubscriber",
		"SubscriberId": 20000306,
		"ReplayCount": 0,
		"IsResumable": true,
		"CreationDate": "03/30/2012 11:50:49",
		"WorklogId": "ID:9.70.221.26-42935-1333114627455-0:5:1:1:1",
		"Status": "FAILED",
		"SavedMsgId": "ID:9.70.221.26-42935-1333114627455-0:5:1:1:1-phase-service0",
		"CustomerEmailAddress": "houseadmin@lotuslive.com",
		"SubscriptionId": 0,
		"Version": 1,
		"CustomerId": 0,
		"ExtraData": {
			"compensate": {
				"restartable": true,
				"succeeded": true
			},
			"event": {
				"Credentials": {
					"iv-groups": ["CSR",
					"CustomerPurchaser",
					"CustomerAdministrator"],
					"iv-user": "bssadmin@us.ibm.com",
					"ldap_customerid": "0",
					"ldap_extid": "bssadmin@us.ibm.com",
					"ldap_orgid": "20000001",
					"ldap_personid": "20000001",
					"ldap_subscriberid": "20000001"
				},
				"Message": {
					"CurrentSubscriberId": "20000001",
					"EmailTemplate": "user_add",
					"OperationId": "EntitleSubscriber",
					"Payload": {
						"CustomerId": "0",
						"InvitedBy": "20000001",
						"Profile": {
							"Subscriber": {
								"Created": "03/30/201211: 50: 44",
								"CustomerId": 0,
								"Deleted": false,
								"Id": 20000306,
								"InvitedBy": 20000001,
								"IsGuest": true,
								"IsSyncPending": false,
								"Modified": "03/30/201211: 50: 48",
								"Oid": 20000306,
								"OptimisticLock": 0,
								"Owner": 20000306,
								"PartyRoleType": "SUBSCRIBER",
								"Person": {
									"AddressSet": [{
										"AddressLine1": "",
										"AddressLine2": "",
										"AddressType": "MAILING",
										"City": "",
										"Country": "",
										"CountryCode": "US",
										"Created": "03/30/201211: 50: 48",
										"Deleted": false,
										"Id": 10240,
										"Modified": "03/30/201211: 50: 48",
										"Oid": 10240,
										"OptimisticLock": 0,
										"Owner": 20000306,
										"PartyId": 20000306,
										"PostalCode": "",
										"State": "",
										"StateCode": "",
										"Version": 3
									}],
									"AltEmailAddress": "",
									"Created": "03/30/201211: 50: 48",
									"DN": "uid=blah@us.ibm.com,cn=Users,
		o=IBM,
		c=US",
									"DPLStatus": "PASSED",
									"Deleted": false,
									"DisplayName": "TerryBlah",
									"EmailAddress": "blah@us.ibm.com",
									"EmployeeNumber": "",
									"FamilyName": "Keen",
									"Fax": "",
									"GivenName": "Terry",
									"HasOptedIn": 0,
									"HomePhone": "",
									"Id": 20000306,
									"IsContact": false,
									"IsRestrictedUse": true,
									"JobTitle": "",
									"LanguagePreference": "EN_US",
									"MobilePhone": "",
									"Modified": "03/30/201211: 50: 48",
									"NamePrefix": "",
									"NameSuffix": "",
									"Oid": 20000306,
									"OptimisticLock": 0,
									"OrgName": "IBMGuestHouseAccount",
									"OrganizationId": 0,
									"Owner": 20000306,
									"PartyRoleSet": [],
									"PartyType": "PERSON",
									"Photo": "",
									"RoleSet": ["User",
									"CustomerAdministrator"],
									"SearchableName": "BLAH",
									"SecurityRealm": "NON_FEDERATED",
									"TimeZone": "America/New_York",
									"Version": 3,
									"WebSiteAddress": "",
									"WorkPhone": ""
								},
								"SeatSet": [{
									"Created": "03/30/201211: 50: 48",
									"Deleted": false,
									"EntitlementQuantityAllocated": 0,
									"HasAcceptedTermsOfUse": false,
									"Id": 10177,
									"Modified": "03/30/201211: 50: 48",
									"Oid": 10177,
									"OptimisticLock": 0,
									"Owner": 0,
									"ProvisioningWorkflowId": 0,
									"SeatServiceProductAttributeSet": [],
									"SeatState": "ENTITLE_PENDING",
									"SubscriberId": 20000306,
									"SubscriptionId": 0,
									"TermsOfUseId": 4,
									"Version": 3,
									"WorkflowIdList": []
								}],
								"SubscriberAttributeSet": [{
									"BooleanValue": false,
									"Created": "03/30/201211: 50: 48",
									"Deleted": false,
									"DisplayPrecedence": 0,
									"Id": 10274,
									"IntegerValue": 1,
									"Modified": "03/30/201211: 50: 48",
									"Name": "bss__billingCode",
									"Oid": 10274,
									"OptimisticLock": 0,
									"Owner": 20000306,
									"StringValue": "FVT",
									"SubscriberId": 20000306,
									"Type": "STRING",
									"Version": 3
								}],
								"SubscriberState": "PENDING",
								"Version": 3
							}
						},
						"SeatId": "10177",
						"ServiceOfferingAttributeValues": {
							"bh_activities": true,
							"bh_activities__allow_overage": true,
							"bh_activities__count": -1,
							"bh_communities": true,
							"bh_contacts": true,
							"bh_dashboard": true,
							"bh_feedback": true,
							"bh_filer": true,
							"bh_filer__allow_overage": false,
							"bh_filer__data_transfer": 5000,
							"bh_filer__size": 25,
							"bh_forms": false,
							"bh_forums": true,
							"bh_whats_new": true,
							"bss_admin": true,
							"bss_invite_guest": true,
							"bssui__dashboard_id": "engage",
							"bssui__dashboard_id_weight": 40,
							"lc_activities": true,
							"lc_news": true
						},
						"SubscriberId": "20000306",
						"SubscriptionId": "0"
					},
					"PersonalizedText": "Anewaccountisreadyforyou.",
					"Phase": "compensate",
					"ReqId": "ID: 9.70.221.26-42935-1333114627455-0: 5: 1: 1: 1",
					"RequestedBy": "bssadmin@us.ibm.com",
					"ServiceId": "bh_forums",
					"Version": "3"
				},
				"ServiceList": [{
					"ServiceComponentAttributeValues": {
						"ProvisioningClass": "com.ibm.wdp.bss.prov.provisioning.ProvisioningPreProcessing",
						"ReadSeatAttributeNames": [],
						"WriteSeatAttributeNames": []
					},
					"ShortName": "bss_core_pre_processing"
				},
				{
					"ServiceComponentAttributeValues": {
						"ProvisioningUrl": "http: //9.70.230.57: 85/forums/wdp/provisioning/forumsendpoint",
						"ReadSeatAttributeNames": [],
						"WriteSeatAttributeNames": []
					},
					"ShortName": "bh_forums"
				},
				{
					"ServiceComponentAttributeValues": {
						"ProvisioningUrl": "http: //9.70.230.57: 85/news/wdp/provisioning/newsendpoint",
						"ReadSeatAttributeNames": [],
						"WriteSeatAttributeNames": []
					},
					"ShortName": "lc_news"
				},
				{
					"ServiceComponentAttributeValues": {
						"ProvisioningUrl": "http: //9.70.230.57: 85/contacts/submgrProvisioningV2/process",
						"ReadSeatAttributeNames": [],
						"WriteSeatAttributeNames": []
					},
					"ShortName": "bh_contacts"
				},
				{
					"ServiceComponentAttributeValues": {
						"ProvisioningUrl": "http: //9.70.230.57: 85/activities/wdp/provisioning/activitiesendpoint",
						"ReadSeatAttributeNames": [],
						"WriteSeatAttributeNames": []
					},
					"ShortName": "lc_activities"
				},
				{
					"ServiceComponentAttributeValues": {
						"ProvisioningUrl": "http: //9.70.230.57: 85/files/wdp/provisioning/filesendpoint",
						"ReadSeatAttributeNames": [],
						"WriteSeatAttributeNames": []
					},
					"ShortName": "bh_filer"
				},
				{
					"ServiceComponentAttributeValues": {
						"ProvisioningUrl": "http: //9.70.230.57: 85/communities/wdp/provisioning/communitiesendpoint",
						"ReadSeatAttributeNames": [],
						"WriteSeatAttributeNames": []
					},
					"ShortName": "bh_communities"
				},
				{
					"ServiceComponentAttributeValues": {
						"ProvisioningUrl": "http: //9.70.230.57: 85/contacts/dashboardProvisioning/process",
						"ReadSeatAttributeNames": [],
						"WriteSeatAttributeNames": []
					},
					"ShortName": "bh_dashboard"
				},
				{
					"ServiceComponentAttributeValues": {
						"ProvisioningUrl": "http: //9.70.230.57: 85/forms/wdp/provisioning/endpoint",
						"ReadSeatAttributeNames": [],
						"WriteSeatAttributeNames": []
					},
					"ShortName": "bh_forms"
				},
				{
					"ServiceComponentAttributeValues": {
						"ProvisioningClass": "com.ibm.wdp.bss.prov.provisioning.ProvisioningPostProcessing",
						"ReadSeatAttributeNames": [],
						"WriteSeatAttributeNames": []
					},
					"ShortName": "bss_core_post_processing"
				}],
				"ThreadName": "20000001-1333126248691"
			},
			"prepare": {
				"failure_message": "bh_forums: WF: ID: 9.70.0.0-42935-1333114627455-0: 5: 1: 1: 1CallfailedwithnonrestartableHTTPStatuscode: 404 can'tcontinue.forbh_forums.EntitleSubscriberphasepreparefromurl: http: //9.70.0.0: 85/forums/wdp/provisioning/forumsendpoint\<H1>SRVE0255E: AWebGroup/VirtualHosttohandle/forums/wdp/provisioning/forumsendpointhasnotbeendefined.</H1><BR><H3>SRVE0255E: AWebGroup/VirtualHosttohandle9.70.0.0: 85hasnotbeendefined.</H3><BR><I>IBMWebSphereApplicationServer</I>",        
"failures": "bh_forums",
"restartable": false,        
"succeeded": false    },    
"restartable": false,    
"succeeded": false},
				
"Id": 707
			}]
		}
	}
}