Process tags and search keywords API reference

Before you begin

Event Triggers

The following tags and search keywords 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.

Event Type

Description
Tag created

Occurs when a tag has been created.
Tag updated Occurs when a tag has been edited and saved.
Tag deleted Occurs when a tag has been deleted.

Tags

The Tags endpoint provides a summary of data for all tags.

Response

Property

Type

Description
Id Integer Tag unique Id
Name String Name of the tag
AlternateNames String Coma separated list of alternate names
Description String Description of the tag
Type String

The tag type:

  • Document

  • Incident

  • System

  • Timeframe

  • Lean

  • Training

  • Location

  • Team
LastModifiedDate DateTime Date the tag was last modified

Example

<Reporting API URL>/Tags 


{
	"@odata.context": "<Reporting API URL>/odata/$metadata#Tags",
	"value": [
		{
			"Id": 2219,
			"Name": "Timeframe_Tag_20240213",
			"AlternateNames": "Timeframe_Tag_20240213",
			"Description": "Timeframe_Tag_20240213 Description",
			"Type": "Timeframe",
			"LastModifiedDate": "2024-02-14T06:03:46.147+02:00"
		},
		{
			"Id": 2220,
			"Name": "Training_Tag_20240213",
			"AlternateNames": "Training_Tag_20240213",
			"Description": "Training_Tag_20240213 Description",
			"Type": "Training",
			"LastModifiedDate": "2024-02-14T06:03:53.128+02:00"
		},
		{
			"Id": 2230,
			"Name": "Training_Tag_20240214",
			"AlternateNames": "Training_Tag_20240214",
			"Description": "Training_Tag_20240214",
			"Type": "Training", 
			"LastModifiedDate": "2024-02-14T06:04:50.127+02:00"
		}
	]
}

ProcessTags

The ProcessTags endpoint provides a summary of data for all process tags, showing every tag for every process, one tag per process, per row.

Response

Property

Type

Description
UniqueId String Process unique Id
Name String Name of the process
MajorVersion String The process major version
MinorVersion String The process minor version
PublishedState String

The process state:

  • Unpublished

  • InProgress

  • Published

  • AwaitingApproval

  • AwaitingPublishing

  • AwaitingArchiveApproval

  • AwaitingArchival

  • Archived

  • Deleted
TagId Integer Tag unique ID
TagName String Name of the tag
TagType String

The tag type:

  • Document

  • Incident

  • System

  • Timeframe

  • Lean

  • Training

  • Location

  • Team

Example

<Reporting API URL>/ProcessTags 


    
{
	"@odata.context": "https://tst-wus-rep.promapponline.com/odata/$metadata#ProcessTags",
	"value": [
		{
			"UniqueId": "5d6ac234-f2fe-44aa-a91d-adfa0fdb0a1e",
			"Name": "Happiness Index",
			"MajorVersion": 1,
			"MinorVersion": 0,
			"PublishState": "Published",
			"TagId": 370,
			"TagName": "Happiness-Index-1-tag",
			"TagType": "Lean"
		},
		{
			"UniqueId": "7b9932e0-8aa2-480e-9a21-6263e816cd63",
			"Name": "Reporting Api process tag",
			"MajorVersion": 0,
			"MinorVersion": 3,
			"PublishState": "Unpublished",
			"TagId": 369,
			"TagName": "ReportingApi,
			"TagType": "Lean"
		}					
	]
}

ProcessTaskTags

The ProcessTaskTags endpoint provides a summary of data for all Task tags for processes available.

Response

Property

Type

Description
UniqueId String Process unique Id
Name String Name of the process
MajorVersion String The process major version
MinorVersion String The process minor version
PublishedState String

The process state:

  • Unpublished

  • InProgress

  • Published

  • AwaitingApproval

  • AwaitingPublishing

  • AwaitingArchiveApproval

  • AwaitingArchival

  • Archived

  • Deleted
ActivityID   The ID of the activity
ActivityText   The activity text
TaskId Integer The ID of the task
TaskText String The tasks text
TagId Integer Tag unique ID
TagName String Name of the tag
Type String

The tag type:

  • Document

  • Incident

  • System

  • Timeframe

  • Lean

  • Training

  • Location

  • Team

Example

<Reporting API URL>/ProcessTaskTags 


{
	"@odata.context": "<Reporting API URL>/$metadata#ProcessTaskTags",
	"value": [
		{
			"UniqueId": a37e7517-4eea-c6e9-bae8-6a7b45edfaab,
			"Name": "HRProcess",
			"MajorVersion": 1,
			"MinorVersion": 0,
			"PublishState": "Published",
			"ActivityId": 1,
			"ActivityText": "HRProcessActivity1",
			"TaskId": 1,
			"TaskText": "HRProcessTask1",
			"TagId": 1,
			"TagName": "HRLeanTag",
			"TagType": "Lean"
		},
		{
			"UniqueId": 6a7b45ed-c6e9-4eea-bae8-a37e7517faab,
			"Name": "OnboardingProcess",
			"MajorVersion": 1,
			"MinorVersion": 0,
			"PublishState": "Published",
			"ActivityId": 1,
			"ActivityText": "OnboardingProcessActivity1",
			"TaskId": 1,
			"TaskText": "OnboardingProcessTask1",
			"TagId": 2,
			"TagName": "HRLeanTagTwo",
			"TagType": "Lean"
		},
		{
			"UniqueId": c6e96a7b-45ed-4eea-7517-a37efabae8ab,
			"Name": "HRTimeProcess",
			"MajorVersion": 1,
			"MinorVersion": 0,
			"PublishState": "Published",
			"ActivityId": 1,
			"ActivityText": "HRTimeProcessActivity1",
			"TaskId": 2,
			"TaskText": "HRTimeProcessTask2",
			"TagId": 3,
			"TagName": "HRTimeframeTag",
			"TagType": "Timeframe"
		}
	]
}

ProcessNoteTags

The ProcessNoteTags endpoint provides a summary of data for all Process Activity tags available.

Response

Property

Type

Description
UniqueId String Process unique Id
Name String Name of the process
MajorVersion String The process major version
MinorVersion String The process minor version
PublishedState String

The process state:

  • Unpublished

  • InProgress

  • Published

  • AwaitingApproval

  • AwaitingPublishing

  • AwaitingArchiveApproval

  • AwaitingArchival

  • Archived

  • Deleted
TagId Integer Tag unique ID
TagType String

The tag type:

  • System

  • Lean
TagName String Name of the tag
ActivityId Integer Activity unique ID
ActivityText String Activity display text
NoteID String Note unique ID
NoteText String Text of the Note

Example

<Reporting API URL>/ProcessNoteTags 


{
	"@odata.context": "https://tst-wus-rep.promapponline.com/odata/$metadata#ProcessNoteTags",
	"value": [
		{
			"UniqueId": "5d1dfee5-1089-41d6-a3a0-5822e8bce22c",
			"Name": "Happiness Index - Test",
			"MajorVersion": 1,
			"MinorVersion": 0,
			"PublishState": "Published",
			"ActivityId": 258866,
			"ActivityText": "Update document",
			"NoteId": 258881,
			"NoteText": "Log into SAP",
			"TagId": 370,
			"TagName": "Happiness-Index-test-tag",
			"TagType": "Lean"
		},
		{
			"UniqueId": "4dd6a484-7651-45b2-a74d-51c4d32ce2da",
			"Name": "ReportingAPI Tag Test",
			"MajorVersion": 0,
			"MinorVersion": 3,
			"PublishState": "Unpublished",
			"ActivityId": 258866,
			"ActivityText": "Update document",
			"NoteId": 258882,
			"NoteText": "Log into SAP",
			"TagId": 369,
			"TagName": "LeanTag2",
			"TagType": "Lean"
		}
	}

ProcessActivityTags

The ProcessActivityTags endpoint provides a summary of data for all Process Activity tags available.

Response

Property

Type

Description
UniqueId String Process unique Id
Name String Name of the process
MajorVersion String The process major version
MinorVersion String The process minor version
PublishedState String

The process state:

  • Unpublished

  • InProgress

  • Published

  • AwaitingApproval

  • AwaitingPublishing

  • AwaitingArchiveApproval

  • AwaitingArchival

  • Archived

  • Deleted
ActivityId Integer Activity unique ID
ActivityText String Activity display text
TagId Integer Tag unique ID
TagName String Name of the tag
Type String

The tag type:

  • Document

  • Incident

  • System

  • Timeframe

  • Lean

  • Training

  • Location

  • Team

Example

<Reporting API URL>/ProcessActivityTags 


{
	"@odata.context": "<Reporting API URL>/$metadata#ProcessActivityTags",
	"value": [
		{
			"UniqueId": 6a7b45ed-c6e9-4eea-bae8-a37e7517faab,
			"Name": "HRProcess",
			"MajorVersion": 1,
			"MinorVersion": 0,
			"PublishState": "Published",
			"ActivityId": 1,
			"ActivityText": "HRProcessActivity1",
			"TagId": 1,
			"TagName": "HRLeanTag",
			"TagType": "Lean"
		},
		{
			"UniqueId": a37e7517-4eea-c6e9-bae8-6a7b45edfaab,
			"Name": "HRTimeProcess",
			"MajorVersion": 1,
			"MinorVersion": 0,
			"PublishState": "Published",
			"ActivityId": 2,
			"ActivityText": "HRTimeProcessActivity2",
			"TagId": 3,
			"TagName": "HRTimeframeTag",
			"Type": "Timeframe"
		},
		{
			"UniqueId": 4eea7517-bae8-a37e-faab-6a7b45edc6e9,
			"Name": "HRProcess2",
			"MajorVersion": 5,
			"MinorVersion": 4,
			"PublishState": "Unpublished",
			"ActivityId": 1,
			"ActivityText": "Activity1",
			"TagId": 1,
			"TagName": "Outlook",
			"Type": "System"
		}
	]
}

ProcessSearchKeywords

The ProcessSearchKeywords endpoint provides a summary of data for all process search keywords.

Response

Property Type Description
UniqueId String Process unique Id
Name String Name of the process
MajorVersion Integer The process major version
MinorVersion Integer The process minor version
PublishedState String

The process state:

  • Unpublished

  • InProgress

  • Published

  • AwaitingApproval

  • AwaitingPublishing

  • AwaitingArchiveApproval

  • AwaitingArchival

  • Archived

  • Deleted
Searchkeyword String The search keyword

Example

<Reporting API URL>/ProcessSearchKeywords 


{
	"@odata.context": "<Reporting API URL>/odata/$metadata#ProcessSearchKeywords",
	"value": [
		{
			"UniqueId": 4eea7517-bae8-a37e-faab-6a7b45edc6e9,
			"MajorVersion": 1,
			"MinorVersion": 0,
			"PublishState": "Published",
			"Name": "HRProcess",
			"SearchKeyword": Employee"
		},
		{
			"UniqueId": 6a7b45ed-c6e9-4eea-bae8-a37e7517faab,
			"MajorVersion": 1,
			"MinorVersion": 0,
			"PublishState": "Published",
			"Name": "HRProcess",
			"SearchKeyword": "Employer"
		}     
	]
}