Process health API reference

Before you begin

Event Triggers

The following process health events will trigger data updates to the Reporting API. You can use the Refresh option in the OData client application to view the latest data updates from your Nintex Process Manager site. The Reporting API data is not updated in real-time and it may take up to 24 hours for changes made in your site to be reflected in the data available.

Note: All dates are in the UTC timezone.

Event Type

Description
Process state change

Occurs when a process is saved or published and changes state. Process publish states can be:

  • In Progress

  • Published

  • Awaiting Approval

  • Awaiting Publishing

  • Awaiting Archive Approval

  • Awaiting Archival

  • Archived

  • Deleted
Process review created Occurs when a new process review is created, when a process is published, or when a process is reviewed.
Process Reviewed Occurs when a process is reviewed.

Note: Process group data is not updated in real time. It could take up to 24 hours for changes made on your site to be reflected in the data available through the Reporting API.

Processes

The Processes endpoint provides a summary of data on the latest status of all processes.

Response

Property Type Description
UniqueId Guid Process Unique Id
Name String

The Process Name (with variations appended)
ReferenceNo String Process Reference Number
PublishState String

Publish state the process is in:

  • Published

  • Unpublished

  • In Progress

  • Archived
CreatedDate Datetime Date the process was created
StateChangeDate Datetime Date the process was changed
DeletedDate Datetime Date the process was deleted
MajorVersion Integer Major version of the process
MinorVersion Integer Minor version of the process
Version String Calculated field of the Major and Minor version
ProcessGroupName String The Process Group Name
ProcessGroupUniqueId Guid Process Group Unique Id
ProcessGroupPath String The path from the process group to its Top Level group, delimited by '/'
OwnerFirstName String Owner first name
OwnerLastName String Owner last name
OwnerName String Owner full name
OwnerEmail String Owner email
OwnerPermission String Permission level of the user
ExpertFirstName String Expert first name
ExpertLastName String Expert last name
ExpertName String Expert full name
ExpertEmail String Expert email
ExpertPermission String Permission level of the expert
StandardProcessName String Standard process name
VariationGroupName String Variation Group name
VariationName String Variation name

Example

<Reporting API URL>/Processes 


{
    "@odata.context": "<Reporting API URL>/odata/$metadata#Processes",
    "value": [
        {
		 "UniqueId": "a9e97590-b552-45c0-b209-023b728c507b",
		 "Name": "Conduct a Construction Monitoring Inspection",
		 "ReferenceNo": null,
		 "PublishState": "Published",
		 "CreatedDate": "2016-06-15T23:36:03.237Z",
		 "StateChangeDate": "2019-04-16T20:25:50.537Z",
		 "DeletedDate": null,
		 "MajorVersion": 2,
		 "MinorVersion": 0,
		 "Version": "2.0",
	 	 "ProcessGroupName": "Design Construction Representatives",
	 	 "ProcessGroupUniqueId": "5d5832fc-f922-44e0-a5df-3e4f13093e59",
		 "ProcessGroupPath": "Example Processes/Project Delivery Example/Inspections/Design Construction Representatives",
		 "OwnerFirstName": "Xxxx",
		 "OwnerLastName": "Xxxx",
		 "OwnerName": "Xxxx Xxxx",
	 	 "OwnerEmail": "xxxx.xxxx@promapp.com",
		 "OwnerPermission": "Promaster",
		 "ExpertFirstName": "xxxxxx",
		 "ExpertLastName": "xxxxxxxxxx",
		 "ExpertName": "xxxxxx xxxxxxxxxx",
		 "ExpertEmail": "promapp-noreply@promapp.com.au",
		 "ExpertPermission": "Promaster",
		 "StandardProcessName": null,
		 "VariationGroupName": null,
		 "VariationName": null
        },
	{
		"UniqueId": "571cce4b-c8ac-4b6d-8fd1-05243b6dba68",
		"Name": "Respond to Managed Services IT Request :: Data Protection",
		"ReferenceNo": null,
		"PublishState": "Published",
		"CreatedDate": "2016-11-21T03:06:40.887Z",
		"StateChangeDate": "2019-04-16T20:27:47.303Z",
		"DeletedDate": null,
		"MajorVersion": 2,
		"MinorVersion": 0,
		"Version": "2.0",
		"ProcessGroupName": "Process Variation Examples",
		"ProcessGroupUniqueId": "18815508-9d87-499a-b72d-b2a0ae725357",
		"ProcessGroupPath": "Process Variation Examples",
		"OwnerFirstName": "Xxxxx",
		"OwnerLastName": "Xxxxx",
		"OwnerName": "Xxxxx Xxxxx",
		"OwnerEmail": "xxxxxx-noreply@promapp.com.au",
		"OwnerPermission": "User",
		"ExpertFirstName": "Xxxxx",
		"ExpertLastName": "Xxxxxx",
		"ExpertName": "Xxxxx Xxxxxx",
		"ExpertEmail": "promapp-noreply@promapp.com.au",
		"ExpertPermission": "User",
		"StandardProcessName": "Respond to Managed Services IT Request",
		"VariationGroupName": "Support Level",
		"VariationName": "Data Protection"
	},
       {
		"UniqueId": "a830409a-f662-44a6-86a3-08e2e6cf0cd2",
		"Name": "Request reimbursement for travel costs :: Australia",
		"ReferenceNo": null,
		"PublishState": "Unpublished",
		"CreatedDate": "2016-07-28T21:10:58.807Z",
		"StateChangeDate": "2019-04-16T20:27:35.853Z",
		"DeletedDate": null,
		"MajorVersion": 3,
		"MinorVersion": 0,
		"Version": "3.0",
		"ProcessGroupName": "Process Variation Examples",
		"ProcessGroupUniqueId": "18815508-9d87-499a-b72d-b2a0ae725357",
		"ProcessGroupPath": "Process Variation Examples",
		"OwnerFirstName": "Xxxx",
		"OwnerLastName": "Xxxxxx",
		"OwnerName": "Xxxx Xxxxx",
		"OwnerEmail": "promapp-noreply@promapp.com.au",
		"OwnerPermission": "Promaster",
		"ExpertFirstName": "Xxxx",
		"ExpertLastName": "Xxxxxx",
		"ExpertName": "Xxxx Xxxxxx",
		"ExpertEmail": "promapp-noreply@promapp.com.au",
		"ExpertPermission": "Promaster",
		"StandardProcessName": "Request reimbursement for travel costs",
		"VariationGroupName": "Country",
		"VariationName": "Australia"
	}	
    ]
}

ProcessGroups

The ProcessGroups endpoint provides a summary of data on the latest status of all process groups.

Response

Property Type Description
UniqueId Guid Process group unique Id
ParentGroupName String Name of the parent process group
Name String The process group name
ProcessGroupPath String The path from the process group to its top level group, delimited by '/'
CreatedDate Datetime Date the process group was created
DeletedDate Datetime Date the process group was deleted
MajorVersion Integer Major version of the process group
PublishedProcesses Integer Count of published processes in the group
UnpublishedProcesses Integer Count of unpublished processes in the group
OutOfDateProcesses Integer Count of out of date processes A process which has not been reviewed by the scheduled date or updated within the set cycle if review dates are not specified. in the group
UpToDateProcesses Integer Count of up to date processes in the group
TotalProcesses Integer Total count of processes in the group

Example

<Reporting API URL>/ProcessGroups 


{           
    "@odata.context": "<Reporting API URL>/odata/$metadata#ProcessGroups",
    "value": [
	{
		"UniqueId": "f75c6a11-5145-48da-a242-004f0ec8dbba",
	      	"ParentGroupName": "Other Example Processes",
	      	"Name": "Project Delivery Example",
	      	"ProcessGroupPath": "Other Example Processes/Project Delivery Example",
	      	"CreatedDate": "2016-06-15T23:37:05.81Z",
	      	"DeletedDate": null,
	      	"MajorVersion": 1,
	      	"PublishedProcesses": 0,
	      	"UnpublishedProcesses": 0,
	      	"OutOfDateProcesses": 0,
	      	"UpToDateProcesses": 0,
	      	"TotalProcesses": 0
	},
	{
		"UniqueId": "e0acab6f-ffe7-4f05-a13d-13d64fc587fe",
		"ParentGroupName": "Insurance Company Overview",
		"Name": "Receive Quote Request",
		"ProcessGroupPath": "Other Examples/Insurance Company Overview/Receive Quote Request",
		"CreatedDate": "2021-11-23T23:46:48.060551Z",
		"DeletedDate": null,
		"MajorVersion": 1,
		"PublishedProcesses": 1,
		"UnpublishedProcesses": 0,
		"OutOfDateProcesses": 0,
		"UpToDateProcesses": 0,
		"TotalProcesses": 1
	},
	{
		"UniqueId": "847134fe-5fcd-49ce-951e-1487feb609de",
		"ParentGroupName": "Service Operation",
		"Name": "Manage Problems",
		"ProcessGroupPath": "Information Technology (ITIL)/Service Operation/Manage Problems",
		"CreatedDate": "2021-11-23T23:46:48.060551Z",
		"DeletedDate": null,
		"MajorVersion": 0,
		"PublishedProcesses": 0,
		"UnpublishedProcesses": 0,
		"OutOfDateProcesses": 0,
		"UpToDateProcesses": 0,
		"TotalProcesses": 0
	}
    ]
}

ProcessGroupsHistorical

The ProcessGroupsHistorical endpoint provides a summary of historical data for all process groups.

Response

Property Type Description
UniqueId Guid Process group unique Id
ParentGroupName String Name of the Parent Process Group
Name String The process group name
ProcessGroupPath String The path from the process group to its top level group, delimited by '/' characters"
CreatedDate Datetime Date the process group was created
DeletedDate Datetime Date the process group was deleted
MajorVersion Integer Major version of the process group
PublishedProcesses Integer Count of published processes in the group
UnpublishedProcesses Integer Count of unpublished processes in the group
OutOfDateProcesses Integer Count of out of date processes A process which has not been reviewed by the scheduled date or updated within the set cycle if review dates are not specified. in the group
UpToDateProcesses Integer Count of up to date processes in the group
TotalProcesses Integer

Total count of processes in the group
StateChangeDate Datetime Date the process state was changed

Note: The aggregate totals (for published processes, unpublished processes, out of date processes, up to date processes, and total processes) are for the past 7 days.

Example

<Reporting API URL>/ProcessGroupsHistorical 


{
	"@odata.context": "<Reporting API URL>/odata/$metadata#ProcessGroupsHistorical",
	"value": [
	   {
	 	"UniqueId": "f75c6a11-5145-48da-a242-004f0ec8dbba",
		"ParentGroupName": "Other Example Processes",
		"Name": "Project Delivery Example",
		"ProcessGroupPath": "Other Example Processes/Project Delivery Example",
		"CreatedDate": "2016-06-15T23:37:05.81Z",
		"DeletedDate": null,
	        "MajorVersion": 1,
		"PublishedProcesses": 0,
		"UnpublishedProcesses": 0,
		"OutOfDateProcesses": 0,
		"UpToDateProcesses": 0,
		"TotalProcesses": 0,
		"StateChangeDate": "2021-11-11T00:00:00Z"
	   },
	   {
		"UniqueId": "34d2ea12-aa6d-4c98-8e04-40d416d06108",
		"ParentGroupName": "Service Operation",
		"Name": "Manage Events",
		"ProcessGroupPath": "Information Technology (ITIL)/Service Operation/Manage Events",
		"CreatedDate": "2021-11-23T23:46:48.060551Z",
		"DeletedDate": null,
		"MajorVersion": 0,
		"PublishedProcesses": 0,
		"UnpublishedProcesses": 0,
		"OutOfDateProcesses": 0,
		"UpToDateProcesses": 0,
		"TotalProcesses": 0,
		"StateChangeDate": "2021-11-24T00:00:00Z"
	   },
	   {
		"UniqueId": "2fcb19f3-5f9e-43e5-b182-4230506d548c",
		"ParentGroupName": "Human Resources",
		"Name": "Manage Performance and Discipline",
		"ProcessGroupPath": "Human Resources/Manage Performance and Discipline",
		"CreatedDate": "2021-11-23T23:46:48.060551Z",
		"DeletedDate": null,
		"MajorVersion": 1,
		"PublishedProcesses": 10,
		"UnpublishedProcesses": 0,
		"OutOfDateProcesses": 0,
		"UpToDateProcesses": 0,
		"TotalProcesses": 10,
		"StateChangeDate": "2021-11-24T00:00:00Z"
	   },

     ]
}

ProcessHistorical

The ProcessHistorical endpoint provides a summary of historical data for all processes.

Response

Property Type Description
UniqueId Guid Process Unique Id
Name String The Process Name (with variations appended)
ReferenceNo String Process Reference Number
PublishState String

Publish state the process is in:

  • Published

  • Unpublished

  • In Progress

  • Archived
CreatedDate Datetime Date the process was created
StateChangeDate Datetime Date the process was changed
DeletedDate Datetime Date the process was deleted
MajorVersion Integer Major version of the process
MinorVersion Integer Minor version of the process
Version String Calculated field of the Major and Minor version
ProcessGroupName String The Process Group Name
ProcessGroupUniqueId Guid Process Group Unique Id
ProcessGroupPath String The path from the process group to its Top Level group, delimited by '/' characters"
OwnerFirstName String Owner first name
OwnerLastName String Owner last name
OwnerName String Owner full name
OwnerEmail String Owner email
OwnerPermission String Permission level of the user
ExpertFirstName String Expert first name
ExpertLastName String Expert last name
ExpertName String Expert full name
ExpertEmail String Expert email
ExpertPermission String Permission level of the expert
StandardProcessName String Standard process name
VariationGroupName String Variation Group name
VariationName String Variation name

Example

<Reporting API URL>/ProcessesHistorical 


{
 	"@odata.context": "<Reporting API URL>/odata/$metadata#ProcessesHistorical",
	"value": [
	   {
		"UniqueId": "a9e97590-b552-45c0-b209-023b728c507b",
		"Name": "Conduct a Construction Monitoring Inspection",
		"ReferenceNo": null,
		"PublishState": "Published",
		"CreatedDate": "2016-06-15T23:36:03.237Z",
		"StateChangeDate": "2019-04-16T20:25:50.537Z",
		"DeletedDate": null,
		"MajorVersion": 2,
		"MinorVersion": 0,
		"Version": "2.0",
		"ProcessGroupName": "Design Construction Representatives",
		"ProcessGroupUniqueId": "5d5832fc-f922-44e0-a5df-3e4f13093e59",
		"ProcessGroupPath": "Other Example Processes/Project Delivery Example/Inspections / Testing Documents/Design Construction Representatives",
		"OwnerFirstName": "Xxxx",
		"OwnerLastName": "Xxxxxx",
		"OwnerName": "Xxxx Xxxxxx",
		"OwnerEmail": "xxxx.xxxx@promapp.com",
		"OwnerPermission": "Promaster",
		"ExpertFirstName": "Xxxx",
		"ExpertLastName": "Xxxxxx",
		"ExpertName": "Xxxx Xxxxxx",
		"ExpertEmail": "promapp-noreply@promapp.com.au",
		"ExpertPermission": "Promaster",
		"StandardProcessName": null,
		"VariationGroupName": null,
		"VariationName": null
	  },
	  {
		"UniqueId": "571cce4b-c8ac-4b6d-8fd1-05243b6dba68",
		"Name": "Respond to Managed Services IT Request :: Data Protection",
		"ReferenceNo": null,
		"PublishState": "Published",
		"CreatedDate": "2016-11-21T03:06:40.887Z",
		"StateChangeDate": "2016-11-21T03:06:45.827Z",
		"DeletedDate": null,
		"MajorVersion": 1,
		"MinorVersion": 0,
		"Version": "1.0",
		"ProcessGroupName": "Process Variation Examples",
		"ProcessGroupUniqueId": "18815508-9d87-499a-b72d-b2a0ae725357",
		"ProcessGroupPath": "Process Variation Examples",
		"OwnerFirstName": "Xxxx",
		"OwnerLastName": "Xxxxxx",
		"OwnerName": "Xxxx Xxxxxx",
		"OwnerEmail": "xxxxxx-noreply@promapp.com.au",
		"OwnerPermission": "User",
		"ExpertFirstName": "Xxxx",
		"ExpertLastName": "Xxxxxx",
		"ExpertName": "Xxxx Xxxxxx",
		"ExpertEmail": "promapp-noreply@promapp.com.au",
		"ExpertPermission": "User",
		"StandardProcessName": "Respond to Managed Services IT Request",
		"VariationGroupName": "Support Level",
		"VariationName": "Data Protection"
	},
	{
		"UniqueId": "a29d7dd9-aeaf-4beb-99e1-081db63eab9b",
		"Name": "Apply for Annual, or Long Service Leave :: Annual / LS Leave",
		"ReferenceNo": null,
		"PublishState": "Published",
		"CreatedDate": "2016-07-19T07:12:25.507Z",
		"StateChangeDate": "2019-04-16T20:27:41.873Z",
		"DeletedDate": null,
		"MajorVersion": 3,
		"MinorVersion": 0,
		"Version": "3.0",
		"ProcessGroupName": "Process Variation Examples",
		"ProcessGroupUniqueId": "18815508-9d87-499a-b72d-b2a0ae725357",
		"ProcessGroupPath": "Process Variation Examples",
		"OwnerFirstName": "Xxxx",
		"OwnerLastName": "Xxxxxx",
		"OwnerName": "Xxxx Xxxxxx",
		"OwnerEmail": "xxxxxx-noreply@promapp.com.au",
		"OwnerPermission": "Promaster",
		"ExpertFirstName": "Xxxx",
		"ExpertLastName": "Xxxxxx",
		"ExpertName": "Xxxx Xxxxxx",
		"ExpertEmail": "promapp-noreply@promapp.com.au",
		"ExpertPermission": "Promaster",
		"StandardProcessName": "Apply for Leave",
		"VariationGroupName": "Leave Type",
		"VariationName": "Annual / LS Leave"
	}
    ]
}

ProcessReviews

The ProcessReviews endpoint provides a summary of data on the latest status of process reviews.

Note: Data for the ProcessReviews and ProcessReviewsHistorical endpoints include data for archived processes.

Response

Property Type Description
UniqueId Guid Process Unique Id
Name String The Process Name (with variations appended)
ReferenceNo String Process Reference Number
ProcessGroupName String The Process Group Name
ProcessGroupUniqueId Guid Process Group Unique Id
ProcessGroupPath String The path from the process group to its Top Level group, delimited by '/' characters"
OwnerFirstName String Owner first name
OwnerLastName String Owner last name
OwnerName String Owner full name
OwnerEmail String Owner email
OwnerPermission String Permission level of the user
ExpertFirstName String Expert first name
ExpertLastName String Expert last name
ExpertName String Expert full name
ExpertEmail String Expert email
ExpertPermission String Permission level of the expert
LastReviewedDate Datetime Date of the last review
ScheduledReviewDate Datetime Due date of the next review
StandardProcessName String Standard process name
VariationGroupName String Variation Group name
VariationName String Variation name
ChangeDate Datetime Date the process review was created

Example

<Reporting API URL>/ProcessReviews 


{
	"@odata.context": "<Reporting API URL>/odata/$metadata#ProcessReviews",
	"value": [
	   {
		"UniqueId": "a9e97590-b552-45c0-b209-023b728c507b",
		"Name": "Conduct a Construction Monitoring Inspection",
		"ReferenceNo": null,
		"ProcessGroupName": "Design Construction Representatives",
		"ProcessGroupUniqueId": "5d5832fc-f922-44e0-a5df-3e4f13093e59",
		"ProcessGroupPath": "Other Examples/Project Delivery Example/Inspections / Testing Documents/Design Construction Representatives",
		"OwnerFirstName": "Xxxx",
		"OwnerLastName": "Xxxxxx",
		"OwnerName": "Xxxx Xxxxxx",
		"OwnerEmail": "xxxx.xxxxxx@promapp.com",
		"OwnerPermission": "Promaster",
		"ExpertFirstName": "Xxxx",
		"ExpertLastName": "Xxxxxx",
		"ExpertName": "Xxxx Xxxxxx",
		"ExpertEmail": "promapp-noreply@promapp.com.au",
		"ExpertPermission": "Promaster",
		"LastReviewedDate": null,
		"ScheduledReviewDate": "2017-07-29T00:58:56.613Z",
		"StandardProcessName": null,
		"VariationGroupName": null,
		"VariationName": null,
		"ChangeDate": "2021-11-23T01:52:28.074061Z"
	  },
	 {
		"UniqueId": "136d1705-04e9-41f1-93b5-03ba2fe711d5",
		"Name": "Assess DA's - Bushfire Prone Land",
		"ReferenceNo": null,
		"ProcessGroupName": "Other Examples",
		"ProcessGroupUniqueId": "216cafe2-d0b8-42cb-a983-e2bbb19d4319",
		"ProcessGroupPath": "Other Examples",
		"OwnerFirstName": "Xxxx",
		"OwnerLastName": "Xxxxxx",
		"OwnerName": "Xxxx Xxxxxx",
		"OwnerEmail": "xxxxxx-noreply@nintex.com",
		"OwnerPermission": "Promaster",
		"ExpertFirstName": "Xxxx",
		"ExpertLastName": "Xxxxxx",
		"ExpertName": "Xxxx Xxxxxx",
		"ExpertEmail": "promapp-noreply@nintex.com",
		"ExpertPermission": "Promaster",
		"LastReviewedDate": null,
		"ScheduledReviewDate": "2017-07-27T23:29:12.443Z",
		"StandardProcessName": null,
		"VariationGroupName": null,
		"VariationName": null,
		"ChangeDate": "2021-11-23T01:52:28.074061Z"
	  },
	 {
		"UniqueId": "571cce4b-c8ac-4b6d-8fd1-05243b6dba68",
		"Name": "Respond to Managed Services IT Request",
		"ReferenceNo": null,
		"ProcessGroupName": "Process Variation Examples",
		"ProcessGroupUniqueId": "18815508-9d87-499a-b72d-b2a0ae725357",
		"ProcessGroupPath": "Process Variation Examples",
		"OwnerFirstName": "Xxxx",
		"OwnerLastName": "Xxxxxx",
		"OwnerName": "Xxxx Xxxxxx",
		"OwnerEmail": "v-noreply@promapp.com.au",
		"OwnerPermission": "User",
		"ExpertFirstName": "Xxxx",
		"ExpertLastName": "Xxxxxx",
		"ExpertName": "Xxxx Xxxxxx",
		"ExpertEmail": "promapp-noreply@promapp.com.au",
		"ExpertPermission": "User",
		"LastReviewedDate": null,
		"ScheduledReviewDate": "2017-11-21T03:06:45.67Z",
		"StandardProcessName": null,
		"VariationGroupName": "Support Level",
		"VariationName": "Data Protection",
		"ChangeDate": "2021-11-23T01:52:28.074061Z"
	}	
    ]
}

ProcessReviewsHistorical

The ProcessReviewsHistorical endpoint provides a summary of historical data for process reviews.

Response

Property Type Description
Name String The Process Name (with variations appended)
ReferenceNo String Process Reference Number
UniqueId Guid Process Unique Id
ProcessGroupName String The Process Group Name
ProcessGroupUniqueId Guid Process Group Unique Id
ProcessGroupPath String The path from the process group to its Top Level group, delimited by '/' characters"
OwnerFirstName String Owner first name
OwnerLastName String Owner last name
OwnerName String Owner full name
OwnerEmail String Owner email
OwnerPermission String Permission level of the user
ExpertFirstName String Expert first name
ExpertLastName String Expert last name
ExpertName String Expert full name
ExpertEmail String Expert email
ExpertPermission String Permission level of the expert
LastReviewedDate Datetime Date of the last review
ScheduledReviewDate Datetime Due date of the next review
StandardProcessName String Standard process name
VariationGroupName String Variation Group name
VariationName String Variation name
ChangeDate Datetime Date the process review was created

Note: Data for the ProcessReviews and ProcessReviewsHistorical endpoints include data for archived processes.

Example

<Reporting API URL>/ProcessReviewsHistorical 


{
	"@odata.context": "<Reporting API URL>/odata/$metadata#ProcessReviewsHistorical",
	"value": [
          {
		"UniqueId": "a9e97590-b552-45c0-b209-023b728c507b",
		"Name": "Conduct a Construction Monitoring Inspection",
		"ReferenceNo": null,
		"ProcessGroupName": "Design Construction Representatives",
		"ProcessGroupUniqueId": "5d5832fc-f922-44e0-a5df-3e4f13093e59",
		"ProcessGroupPath": "Other Examples/Project Delivery Example/Inspections / Testing Documents/Design Construction Representatives",
		"OwnerFirstName": "Xxxx",
		"OwnerLastName": "Xxxxxx",
		"OwnerName": "Xxxx Xxxxxx",
		"OwnerEmail": "xxxx.xxxxxx@promapp.com",
		"OwnerPermission": "Promaster",
		"ExpertFirstName": "Xxxx",
		"ExpertLastName": "Xxxxxx",
		"ExpertName": "Xxxx Xxxxxx",
		"ExpertEmail": "promapp-noreply@promapp.com.au",
		"ExpertPermission": "Promaster",
		"LastReviewedDate": null,
		"ScheduledReviewDate": "2017-07-29T00:58:56.613Z",
		"StandardProcessName": null,
		"VariationGroupName": null,
		"VariationName": null,
		"ChangeDate": "2021-11-23T01:52:28.074061Z"
	    },
	    {
		"UniqueId": "136d1705-04e9-41f1-93b5-03ba2fe711d5",
		"Name": "Assess DA's - Bushfire Prone Land",
		"ReferenceNo": null,
		"ProcessGroupName": "Other Examples",
		"ProcessGroupUniqueId": "216cafe2-d0b8-42cb-a983-e2bbb19d4319",
		"ProcessGroupPath": "Other Examples",
		"OwnerFirstName": "Xxxx",
		"OwnerLastName": "Xxxxxx",
		"OwnerName": "Xxxx Xxxxxx",
		"OwnerEmail": "xxxxxx-noreply@nintex.com",
		"OwnerPermission": "Promaster",
		"ExpertFirstName": "Xxxx",
		"ExpertLastName": "Xxxxxx",
		"ExpertName": "Xxxx Xxxxxx",
		"ExpertEmail": "promapp-noreply@nintex.com",
		"ExpertPermission": "Promaster",
		"LastReviewedDate": null,
		"ScheduledReviewDate": "2017-07-27T23:29:12.443Z",
		"StandardProcessName": null,
		"VariationGroupName": null,
		"VariationName": null,
		"ChangeDate": "2021-11-23T01:52:28.074061Z"
	   },
	   {
		"UniqueId": "571cce4b-c8ac-4b6d-8fd1-05243b6dba68",
		"Name": "Respond to Managed Services IT Request",
		"ReferenceNo": null,
		"ProcessGroupName": "Process Variation Examples",
		"ProcessGroupUniqueId": "18815508-9d87-499a-b72d-b2a0ae725357",
		"ProcessGroupPath": "Process Variation Examples",
		"OwnerFirstName": "Xxxx",
		"OwnerLastName": "Xxxxxx",
		"OwnerName": "Xxxx Xxxxxx",
		"OwnerEmail": "xxxxxx-noreply@promapp.com.au",
		"OwnerPermission": "User",
		"ExpertFirstName": "Xxxx",
		"ExpertLastName": "Xxxxxx",
		"ExpertName": "Xxxx Xxxxxx",
		"ExpertEmail": "promapp-noreply@promapp.com.au",
		"ExpertPermission": "User",
		"LastReviewedDate": null,
		"ScheduledReviewDate": "2017-11-21T03:06:45.67Z",
		"StandardProcessName": null,
		"VariationGroupName": "Support Level",
		"VariationName": "Data Protection",
		"ChangeDate": "2021-11-23T01:52:28.074061Z"
         }
     ]
}

ProcessViews

The ProcessViews endpoint provides a summary of process views.

The following actions cause an entry in the Process Views log:

  • Opening the process (by a minimode link, by clicking View on the dashboard, or by the editing process).

  • Clicking the Seen It button on the dashboard. This causes SeenItView = True for the entry.

  • System changes to the process followed by the system opening the process. This causes SystemView = True for the entry.

Response

Property Type Description
Name String The Process Name (with variations appended)
ReferenceNo String Process Reference Number
ProcessUniqueId Guid Process Unique Id
ProcessGroupName String The Process Group Name
ProcessGroupUniqueId Guid Process Group Unique Id
ProcessGroupPath String The path from the process group to its top level group, delimited by '/'
OwnerName String Owner full name
ExpertName String Expert full name
ViewerName String Viewer full name
ViewDate String Date the process was viewed
SeenItView Boolean This is only set to True when 'Seen It' is clicked on the user's dashboard. Editing a process sets both SeenItView and SystemView to False.
SystemView Boolean

After the system has internally modified the process, such as when changing a role, the system views the process and sets the value of the SystemView to True.

Note: If False, then the view was part of a user view in the Nintex Process Manager application (for example, when editing a process), from a minimode link, or a view from the Nintex Process Manager mobile app.
FrontEnd String

The medium through which this event was viewed:

  • Web

  • Mobile

Note: The processviews endpoint displays data available from the time the API has been connected to your Nintex Process Manager tenant.

Example

<Reporting API URL>/ProcessViews 


{
	"@odata.context": "<Reporting API URL>/odata/$metadata#ProcessViews",
	"value": [
	  {
		"ProcessUniqueId": "e48a99c8-7413-4ca6-81cd-6ee97e05bcc9",
		"Name": "Respond to Misconduct ",
		"ReferenceNo": null,
		"ProcessGroupName": null,
		"ProcessGroupUniqueId": null,
		"ProcessGroupPath": null,
		"OwnerName": null,
		"ExpertName": null,
		"ViewerName": null,
		"ViewDate": "2021-12-07T01:45:05.012867Z",
		"SeenItView": false,
		"SystemView": false,
		"FrontEnd": "Web"
	  },
	  {
		"ProcessUniqueId": "6d7e148e-3d4f-41e5-867a-ade8e9b7459d",
		"Name": "Respond to Misconduct ",
		"ReferenceNo": null,
		"ProcessGroupName": null,
		"ProcessGroupUniqueId": null,
		"ProcessGroupPath": null,
		"OwnerName": null,
		"ExpertName": null,
		"ViewerName": null,
		"ViewDate": "2021-12-07T01:44:29.956974Z",
		"SeenItView": false,
		"SystemView": false,
		"FrontEnd": "Web"
	 },
	 {
		"ProcessUniqueId": "82dcad41-db66-4747-b552-e3cf9ad04e99",
		"Name": "Respond to Misconduct ",
		"ReferenceNo": null,
		"ProcessGroupName": null,
		"ProcessGroupUniqueId": null,
		"ProcessGroupPath": null,
		"OwnerName": null,
		"ExpertName": null,
		"ViewerName": null,
		"ViewDate": "2021-12-07T01:44:46.210586Z",
		"SeenItView": false,
		"SystemView": false,
		"FrontEnd": "Web"
	 },
	 {
		"ProcessUniqueId": "3e3a422a-4ece-4e04-b54b-feceb993f4c5",
		"Name": "Create new personnel record",
		"ReferenceNo": null,
		"ProcessGroupName": "Induct New Employees",
		"ProcessGroupUniqueId": "90d744d1-24ef-4bed-a3b8-a2f16ced6278",
		"ProcessGroupPath": "Human Resources/Induct New Employees",
		"OwnerName": "Xxxx Xxxx",
		"ExpertName": "Xxxx Xxxx",
		"ViewerName": "Promapp Promaster",
		"ViewDate": "2021-12-17T03:35:28.132137Z",
		"SeenItView": false,
		"SystemView": false,
		"FrontEnd": "Web"
	 }
   ]
}