Improvements Add-on API reference

Before you begin

Event Triggers

The following events in the Improvements add-on The Improvements Add-on enables you to report and manage incidents. 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
Incident Reported

Occurs when an incident is first created.
Incident Deleted Occurs when the incident record is deleted.
Incident Field Deleted Occurs when a Select list (Multiple choice) field value for an incident record is deleted.
Incident Updated

Occurs when the data reported for the incident is updated.
Incident Investigation Updated Occurs when the findings for an incident investigation are updated or submitted.

Incident Action Plan Updated

Occurs when the incident action plan is updated or submitted.

Incident Action Created

Occurs when an incident action is added.

Incident Action Updated

Occurs when the incident action details are updated.

Incident Action Completed

Occurs when an action owner marks an assigned action as closed.

Incident Action Deleted

Occurs when an incident action is deleted.

Incident

The Incident endpoint provides an incident summary for the latest status recorded in Nintex Process Manager.

Response

Property Type Nullable Description
UniqueId Guid false The Id and Primary Key of the incident.
Reporter String   Name of the person who reported the incident.
DateofIncident DateTimeOffset   Date and time (UTC) this incident occurred.
Owner String   Name of the person who currently owns the incident.
PortfolioManager String   Name of the manager for the portfolio that the incident belongs to.
IsDeleted Boolean    
Status String  

The current incident status. Values are:

  • New
  • Under Investigation
  • Under Action
  • Ready to Close
  • Closed
  • Reopened
    • New
    • Under Investigation
    • Under Action
    • Ready to Close
Description String   Full description of the incident.
ReportedDate DateTimeOffset   Date and time (UTC) that this incident was reported.
Priority String  

The priority level of the incident. Values are:

  • Low
  • Med
  • High
Reference String   Reference number that identifies the incident.
ReporterEmail String   Email of the person who reported the incident.
Title String   The title or summary description for the incident.
PortfolioManagerEmail String   Email address for the portfolio manager.
PortfolioId Int32   The unique identifier of the portfolio.
DueDate DateTimeOffset   Target completion date for the incident.
PortfolioName String   Label of the portfolio that contains this incident.
OwnerEmail String   Email of the person who currently owns the incident.
Category String   The category associated with this incident.
SubCategory String   The sub category associated with this incident.
Location String   Location where the incident occurred.
SubLocation String   The sub location associated with this incident.

IncidentFields

IncidentField Collection

 

Collection of IncidentFields.

IncidentActionPlans

IncidentActionPlan Collection

 

Collection of IncidentActionPlans.

IncidentActions

IncidentAction Collection

 

Collection of IncidentActions.

IncidentInvestigations

IncidentInvestigation Collection

 

Collection of IncidentInvestigations.

Example

<Reporting API URL>/Incident 


{   
    "@odata.context": "<Reporting API URL>/odata/$metadata#Incident",
    "value": [
        {
            "UniqueId": "ad7aaabb-5544-e911-a9de-e432dec70fcd",
            "Reporter": "user 20",
            "DateOfIncident": "2019-03-11T11:00:00Z",
            "Owner": "Promapp Promaster",
            "PortfolioManager": "Xxxx Xxxx",
            "IsDeleted": false,
            "Status": "New",
            "Description": "test",
            "ReportedDate": "2019-03-11T23:31:03.267Z",
            "Priority": null,
            "Reference": "I00100",
            "ReporterEmail": "promapp-noreply@promapp.com.au",
            "Title": "test",
            "PortfolioManagerEmail": "promapp-noreply@promapp.com.au",
            "PortfolioId": "3",
            "DueDate": "2019-03-12T23:31:03.267Z",
            "PortfolioName": "Test incident",
            "OwnerEmail": "promapp-noreply@promapp.com.au",
            "Category": null,
            "SubCategory": null,
            "Location": "Auckland",
            "SubLocation": "Factory Floor"
        }
    ]
}

IncidentHistorical

The IncidentHistorical endpoint provides a historical incident summary for all statuses recorded in Nintex Process Manager.

Response

Property

Type

Nullable

Description
UniqueId Guid false The unique identifier for the incident updates.
IncidentId Guid   The Id and Primary Key of the incident.
Reporter String   Name of the person who reported the incident.
DateofIncident DateTimeOffset   Date and time (UTC) this incident occurred.
Owner String   Name of the person who currently owns the incident.
PortfolioManager String   Name of the manager for the portfolio that the incident belongs to.
Status String  

The current incident status. Values are:

  • New
  • Under Investigation
  • Under Action
  • Ready to Close
  • Closed
  • Reopened
    • New
    • Under Investigation
    • Under Action
    • Ready to Close
Description String   Full description of the incident.
ReportedDate DateTimeOffset   Date and time (UTC) that this incident was reported.
Priority String  

The priority level of the incident. Values are:

  • Low
  • Med
  • High
Reference String   Reference number that identifies the incident.
ReporterEmail String   Email of the person who reported the incident.
Title String   The title or summary description for the incident.
PortfolioManagerEmail String   Email address for the portfolio manager.
PortfolioId Int32   The unique identifier of the portfolio.
DueDate DateTimeOffset   Target completion date for the incident.
PortfolioName String   Label of the portfolio that contains this incident.
OwnerEmail String   Email of the person who currently owns the incident.
Category String   The category associated with this incident.
SubCategory String   The sub category associated with this incident.
Location String   Location where the incident occurred.
SubLocation String   The sub location associated with this incident.
EventType String   The type of event. For more information, see Event Triggers.
EventDateTime DateTimeOffset false

Date and time (UTC) when the event occurred. For example: When a user,

  • reports an incident
  • submits an investigation
  • creates an action
  • submits actions for approval etc

IncidentFields

IncidentField Collection

 

Collection of IncidentFields.

IncidentActionPlans

IncidentActionPlan Collection

 

Collection of IncidentActionPlans.

IncidentActions

IncidentAction Collection

 

Collection of IncidentActions.

IncidentInvestigations

IncidentInvestigation Collection

 

Collection of IncidentInvestigations.

Example

<Reporting API URL>/IncidentHistorical 


{
    "@odata.context": "<Reporting API URL>/odata/$metadata#IncidentHistorical",
    "value": [
        
        {
            "UniqueId": "d34f0ef6-76da-412f-8660-02af225a480f",
            "IncidentId": "64424bb3-b07d-e911-a9e0-d7c64556bb9c",
            "Reporter": "Promapp Promaster",
            "DateOfIncident": "2019-05-23T12:00:00Z",
            "Owner": "User 1",
            "PortfolioManager": "User 1",
            "Status": "New",
            "Description": "test",
            "ReportedDate": "2019-05-23T23:15:49.703Z",
            "Priority": null,
            "Reference": "I00173",
            "ReporterEmail": "promapp-noreply@promapp.com.au",
            "Title": "test",
            "PortfolioManagerEmail": "promapp-noreply@promapp.com.au",
            "PortfolioId": 8,
            "DueDate": "2019-05-24T23:15:49.703Z",
            "PortfolioName": "Test",
            "OwnerEmail": "promapp-noreply@promapp.com.au",
            "Category": null,
            "SubCategory": null,
            "Location": null,
            "SubLocation": null,
            "EventType": "incidentsnapshot",
            "EventDateTime": "2019-08-20T02:37:03.148333Z"
        },
        {
            "UniqueId": "dcbaf173-a387-45a9-a333-03caa126851f",
            "IncidentId": "73ea5fc6-456d-e911-a9e0-d7c64556bb9c",
            "Reporter": "Promapp Promaster",
            "DateOfIncident": "2019-05-02T12:00:00Z",
            "Owner": "Promapp Promaster",
            "PortfolioManager": "User 1",
            "Status": "Under Investigation",
            "Description": "Test...",
            "ReportedDate": "2019-05-03T01:50:06.953Z",
            "Priority": "Med",
            "Reference": "I00164",
            "ReporterEmail": "promapp-noreply@promapp.com.au",
            "Title": "Test Incident Investigation updated",
            "PortfolioManagerEmail": "promapp-noreply@promapp.com.au",
            "PortfolioId": 8,
            "DueDate": "2019-05-07T12:00:00Z",
            "PortfolioName": "Test",
            "OwnerEmail": "promapp-noreply@promapp.com.au",
            "Category": null,
            "SubCategory": null,
            "Location": null,
            "SubLocation": null,
            "EventType": "incidentsnapshot",
            "EventDateTime": "2019-08-20T03:02:26.985657Z"
        },
        {
            "UniqueId": "2fea3090-5a2f-40a7-8c82-183ccef51b6c",
            "IncidentId": "e02c6808-f902-e911-a9da-ffd8e2e0194e",
            "Reporter": "Promapp Promaster",
            "DateOfIncident": "2018-12-18T11:00:00Z",
            "Owner": "Promapp Promaster",
            "PortfolioManager": "Promapp Promaster",
            "Status": "Under Action",
            "Description": "Test18",
            "ReportedDate": "2018-12-18T19:13:43.247Z",
            "Priority": "Low",
            "Reference": "I00068",
            "ReporterEmail": "promapp-noreply@promapp.com.au",
            "Title": "Test18",
            "PortfolioManagerEmail": "promapp-noreply@promapp.com.au",
            "PortfolioId": 5,
            "DueDate": "2018-12-23T11:00:00Z",
            "PortfolioName": "Supplier issue",
            "OwnerEmail": "promapp-noreply@promapp.com.au",
            "Category": null,
            "SubCategory": null,
            "Location": null,
            "SubLocation": null,
            "EventType": "incidentsnapshot",
            "EventDateTime": "2019-08-20T02:37:03.148333Z"
        },
        {
            "UniqueId": "9ebd3d75-695b-489c-abbd-1d5e11d6e306",
            "IncidentId": "fd03cdec-2a71-e911-a9e0-d7c64556bb9c",
            "Reporter": "Promapp Promaster",
            "DateOfIncident": "2019-05-07T12:00:00Z",
            "Owner": "Promapp Promaster",
            "PortfolioManager": "User 1",
            "Status": "Ready to Close",
            "Description": "test",
            "ReportedDate": "2019-05-08T00:47:59.663Z",
            "Priority": "Med",
            "Reference": "I00169",
            "ReporterEmail": "promapp-noreply@promapp.com.au",
            "Title": "Test action created",
            "PortfolioManagerEmail": "promapp-noreply@promapp.com.au",
            "PortfolioId": 8,
            "DueDate": "2019-08-20T03:34:42.275Z",
            "PortfolioName": "Test",
            "OwnerEmail": "promapp-noreply@promapp.com.au",
            "Category": null,
            "SubCategory": null,
            "Location": null,
            "SubLocation": null,
            "EventType": "incidentsnapshot",
            "EventDateTime": "2019-08-20T02:59:56.488573Z"
        },
        {
            "UniqueId": "8af70197-b9e2-48b6-b9be-188c4df67351",
            "IncidentId": "97094d8d-fa02-e911-a9da-ffd8e2e0194e",
            "Reporter": "Promapp Promaster",
            "DateOfIncident": "2018-12-18T11:00:00Z",
            "Owner": "Promapp Promaster",
            "PortfolioManager": "Promapp Promaster",
            "Status": "Closed",
            "Description": "Test42",
            "ReportedDate": "2018-12-18T19:24:35.007Z",
            "Priority": "Med",
            "Reference": "I00080",
            "ReporterEmail": "promapp-noreply@promapp.com.au",
            "Title": "Test42",
            "PortfolioManagerEmail": "promapp-noreply@promapp.com.au",
            "PortfolioId": 7,
            "DueDate": "2019-03-22T01:33:24.095Z",
            "PortfolioName": "Internal Non-Conformances",
            "OwnerEmail": "promapp-noreply@promapp.com.au",
            "Category": null,
            "SubCategory": null,
            "Location": null,
            "SubLocation": null,
            "EventType": "incidentsnapshot",
            "EventDateTime": "2019-08-20T02:41:22.52002Z"
        },
        {
            "UniqueId": "3130516b-ad24-42d5-ad81-5699abbbd379",
            "IncidentId": "934097de-276d-e911-a9e0-d7c64556bb9c",
            "Reporter": "Promapp Promaster",
            "DateOfIncident": "2019-05-02T12:00:00Z",
            "Owner": "User 1",
            "PortfolioManager": "User 1",
            "Status": "Reopened: Under Investigation",
            "Description": "test",
            "ReportedDate": "2019-05-02T22:16:02.623Z",
            "Priority": "Med",
            "Reference": "I00163",
            "ReporterEmail": "promapp-noreply@promapp.com.au",
            "Title": "Test Investigation Updated",
            "PortfolioManagerEmail": "promapp-noreply@promapp.com.au",
            "PortfolioId": 8,
            "DueDate": "2019-05-07T12:00:00Z",
            "PortfolioName": "Test",
            "OwnerEmail": "promapp-noreply@promapp.com.au",
            "Category": null,
            "SubCategory": null,
            "Location": null,
            "SubLocation": null,
            "EventType": "incidentsnapshot",
            "EventDateTime": "2019-08-20T03:02:26.985657Z"
        },
        {
            "UniqueId": "0e9b4f2d-763c-489a-9ee3-6591eb79949a",
            "IncidentId": "fd03cdec-2a71-e911-a9e0-d7c64556bb9c",
            "Reporter": "Promapp Promaster",
            "DateOfIncident": "2019-05-07T12:00:00Z",
            "Owner": "Promapp Promaster",
            "PortfolioManager": "User 1",
            "Status": "Ready to Close",
            "Description": "test",
            "ReportedDate": "2019-05-08T00:47:59.663Z",
            "Priority": "Med",
            "Reference": "I00169",
            "ReporterEmail": "promapp-noreply@promapp.com.au",
            "Title": "Test action created",
            "PortfolioManagerEmail": "promapp-noreply@promapp.com.au",
            "PortfolioId": 8,
            "DueDate": "2019-08-20T04:58:42.699Z",
            "PortfolioName": "Test",
            "OwnerEmail": "promapp-noreply@promapp.com.au",
            "Category": null,
            "SubCategory": null,
            "Location": null,
            "SubLocation": null,
            "EventType": "incidentsnapshot",
            "EventDateTime": "2019-08-20T03:02:26.985657Z"
        },
        
    ]
}

IncidentField

The IncidentField endpoint provides a summary of the Incident fields for the latest update.

Response

Property

Type

Nullable

Description

UniqueId

Guid

false

Unique identifier of the custom field (The id of the field definition not the specific value record for an incident).
IncidentId String   The Id and Primary Key of the incident.

FieldLabel

String

 

Label of the field.

FieldValue

String

 

 Value of the field for the incident.
IsDeleted Boolean   True if the Select list (Multiple choice) field value for an incident record is deleted.

Example

<Reporting API URL/odata/IncidentField?$filter=FieldValue eq 'Leg' 


{
  "@odata.context": "<Reporting API URL>/odata/$metadata#IncidentField",
  "value": [
    {
      "UniqueId": "303",
      "IncidentId": null,
      "FieldLabel": "Part of body affected",
      "FieldValue": "Leg",
      "ParentValue": "Lower Body",
      "IsDeleted": "False"
    },
    {
      "UniqueId": "339",
      "IncidentId": null,
      "FieldLabel": "Part of body affected",
      "FieldValue": "Leg",
      "ParentValue": "Lower Body",
      "IsDeleted": "False"
    },
    {
      "UniqueId": "365",
      "IncidentId": null,
      "FieldLabel": "Part of body affected",
      "FieldValue": "Leg",
      "ParentValue": "Lower Body",
      "IsDeleted": "False"
    }
  ]
}

IncidentFieldHistorical

The IncidentFieldHistorical endpoint provides a historical summary of the Incident fields for all updates.

Response

Property

Type

Nullable

Description

UniqueId

Guid

false

Unique identifier of the custom field (The id of the field definition not the specific value record for an incident).
IncidentId String   The Id and Primary Key of the incident.

FieldLabel

String

 

Label of the field.

FieldValue

String

 

 Value of the field for the incident.

ParentValue

DateTimeOffset

 

 The parent value of the field if it is a parent - child relationship.

EventType

String

 

The type of event. For more information, see Event Triggers.

EventDateTime

DateTimeOffset

false

Date and time (UTC) when the event occurred.
IsDeleted Boolean  

True (multiple choice value) if an incident record is deleted.

Note: For the latest incident field records, clear the True value to ignore records that have been deleted and select the False value to view records that have not been deleted.

Example

<Reporting API URL>/odata/IncidentFieldHistorical?$filter=FieldValue eq 'Leg' 

{
  "@odata.context": "<Reporting API URL>/odata/$metadata#IncidentFieldHistorical",
  "value": [
    {
      "UniqueId": "597c2d6d-6e9d-44f1-9ce2-0017265b090f",
      "IncidentId": null,
      "FieldLabel": "Part of body affected",
      "FieldValue": "Leg",
      "ParentValue": "Lower Body",
      "EventType": "incidentsnapshot",
      "EventDateTime": "2019-08-20T02:41:22.52002Z",
      "IsDeleted": "False"
    },
    {
      "UniqueId": "60592a03-caf4-49ab-9dc2-02937b9602a8",
      "IncidentId": null,
      "FieldLabel": "Part of body affected",
      "FieldValue": "Leg",
      "ParentValue": "Lower Body",
      "EventType": "incidentsnapshot",
      "EventDateTime": "2019-08-20T02:41:22.52002Z",
      "IsDeleted": "False"
    },
    {
      "UniqueId": "c674a73c-2cdf-40d4-9987-177ab43af754",
      "IncidentId": null,
      "FieldLabel": "Part of body affected",
      "FieldValue": "Leg",
      "ParentValue": "Lower Body",
      "EventType": "incidentsnapshot",
      "EventDateTime": "2019-08-20T02:37:03.148333Z",
      "IsDeleted": "False"
    },
    {
      "UniqueId": "ae3bbb44-aa64-4e82-99eb-1dadd2f741db",
      "IncidentId": null,
      "FieldLabel": "Part of body affected",
      "FieldValue": "Leg",
      "ParentValue": "Lower Body",
      "EventType": "incidentsnapshot",
      "EventDateTime": "2019-08-20T03:02:26.985657Z",
      "IsDeleted": "False"
    },
    {
      "UniqueId": "0f6561ea-a33d-4267-82b6-2aab6188515c",
      "IncidentId": null,
      "FieldLabel": "Part of body affected",
      "FieldValue": "Leg",
      "ParentValue": "Lower Body",
      "EventType": "incidentsnapshot",
      "EventDateTime": "2019-08-20T02:38:49.682748Z",
      "IsDeleted": "False"
    },
    {
      "UniqueId": "add1ebd0-c2bb-4162-832e-2ca98c67374d",
      "IncidentId": null,
      "FieldLabel": "Part of body affected",
      "FieldValue": "Leg",
      "ParentValue": "Lower Body",
      "EventType": "incidentsnapshot",
      "EventDateTime": "2019-08-20T02:57:48.756671Z",
      "IsDeleted": "False"
    },
    {
      "UniqueId": "a0bf192c-2302-4655-b37a-3d00cd7ec587",
      "IncidentId": null,
      "FieldLabel": "Part of body affected",
      "FieldValue": "Leg",
      "ParentValue": "Lower Body",
      "EventType": "incidentsnapshot",
      "EventDateTime": "2019-08-20T03:02:26.985657Z",
      "IsDeleted": "False"
    },
    {
      "UniqueId": "cfd8ec7f-0d33-4690-9dde-3e184848f5b9",
      "IncidentId": null,
      "FieldLabel": "Part of body affected",
      "FieldValue": "Leg",
      "ParentValue": "Lower Body",
      "EventType": "incidentsnapshot",
      "EventDateTime": "2019-08-20T02:38:49.682748Z",
      "IsDeleted": "False"
    },
    {
      "UniqueId": "6c8b0f5e-fbe7-4d4f-94e2-412616186ab6",
      "IncidentId": null,
      "FieldLabel": "Part of body affected",
      "FieldValue": "Leg",
      "ParentValue": "Lower Body",
      "EventType": "incidentsnapshot",
      "EventDateTime": "2019-08-20T02:59:56.488573Z",
      "IsDeleted": "False"
    },
    {
      "UniqueId": "7b0899fa-9dfc-4e8b-bc6d-4559cc4f01ca",
      "IncidentId": null,
      "FieldLabel": "Part of body affected",
      "FieldValue": "Leg",
      "ParentValue": "Lower Body",
      "EventType": "incidentsnapshot",
      "EventDateTime": "2019-08-20T03:02:26.985657Z",
      "IsDeleted": "False"
    }
  ]
}

IncidentInvestigation

The IncidentInvestigation endpoint provides an incident summary of the latest findings recorded in Nintex Process Manager.

Response

Property

Type

Nullable

Description

UniqueId

Guid

false

Unique identifier for the investigation findings.
IncidentId String   The Id and Primary Key of the incident.

Findings

String

 

Details of the investigation findings.

Example

<Reporting API URL>/IncidentInvestigation/39 


{
    "@odata.context": "<Reporting API URL>/odata/$metadata#IncidentInvestigation",
    "value": [
        {
            "UniqueId": "39",
            "IncidentId": "4f9c9c90-29b3-44b3-8f41-780de2a652f6",
            "Findings": "The advertisement was not approved by the manager before being sent to the agency."
        }
    ]
}

IncidentInvestigationHistorical

The IncidentInvestigationHistorical endpoint provides a historical incident summary for all findings recorded in Nintex Process Manager.

Response

Property

Type

Nullable

Description

UniqueId

Guid

false

Unique identifier for the investigation findings updates.
IncidentId String   The Id and Primary Key of the incident.

Findings

String

 

Details of the investigation findings.

EventType

String

 

The event type. For more information, see Event Triggers.

EventDateTime

DateTimeOffset

false

Date and time (UTC) when the event occurred.

Example

<Reporting API URL>/odata/IncidentInvestigationHistorical/a5424350-fe0a-4af0-ad1c-03243129cbd5 


{
    "@odata.context": "<Reporting API URL>/odata/$metadata#IncidentInvestigationHistorical",
    "value": [
        {
            "UniqueId": "a5424350-fe0a-4af0-ad1c-03243129cbd5",
            "IncidentId": "4f9c9c90-29b3-44b3-8f41-780de2a652f6",
            "Findings": "The advertisement was not approved by the general manager before being sent to the agency.",
            "EventType": "incidentsnapshot",
            "EventDateTime": "2019-07-17T02:53:28.160527Z"
        },
	 {
            "UniqueId": "a5424350-fe0a-4af0-ad1c-03243129cbd5",
            "IncidentId": "4f9c9c90-29b3-44b3-8f41-780de2a652f6",
            "Findings": "The advertisement was not approved by the department manager.",
            "EventType": "incidentsnapshot",
            "EventDateTime": "2019-07-17T02:53:28.160527Z"
        },			
    ]
}

IncidentAction

The IncidentAction endpoint provides an incident summary for the latest action types recorded in Nintex Process Manager.

Response

Property

Type

Nullable

Description

UniqueId

Guid

false

Unique identifier for the action.
IncidentId String   Incident id in your Nintex Process Manager account.

Owner

String

 

Name of the person who owns the action.

CreatedBy

String

 

Name of the person who created the action.

CompletedBy

String

 

Name of the person who completed the action.

DeletedBy

String

 

Name of the person who deleted the action.

ActionType

String

 

The type of action. Values are:

  • Remedial Action

  • Monitor Risk
  • Change Process

  • Provide Training

  • Other Action

Title

String

 

Title/short description of the action.
Description String   Full description of the action.

DueDate

DateTimeOffset

 

Target completion date for the action.

CreatedByEmail

String

 

Email of the person who created the action.

CreatedDate

DateTimeOffset

 

Date the action was created.

CompletedDate

DateTimeOffset

 

Date the action was completed.

CompletedByEmail

String

 

Email of the person who completed the action.

DeletedDate

DateTimeOffset

 

Date the action was deleted.

DeletedByEmail

String

 

Email of the person who deleted the action.

OwnerEmail

String

 

Email of the person who owns the action.

Example

<Reporting API URL>/IncidentAction?$filter=ActionType eq 'Change Process' and Owner eq 'User 1' 


{
    "@odata.context": "<Reporting API URL>/odata/$metadata#IncidentAction",
    "value": [
        {
            "UniqueId": "1131",
            "IncidentId": "445333b0-0750-e911-a9df-d96ad83fcabc",
            "Owner": "User 1",
            "CreatedBy": "Xxxx Xxxx",
            "CompletedBy": "User 1",
            "DeletedBy": null,
            "ActionType": "Change Process",
            "Title": "Action title",
	     "Description": "Action description",
            "DueDate": "2019-03-31T11:00:00Z",
            "CreatedByEmail": "promapp-noreply@promapp.com.au",
            "CreatedDate": "2019-03-26T21:04:50.157Z",
            "CompletedDate": "2019-03-26T21:30:04.833Z",
            "CompletedByEmail": "promapp-noreply@promapp.com.au",
            "DeletedDate": null,
            "DeletedByEmail": null,
            "OwnerEmail": "promapp-noreply@promapp.com.au"
        }
    ]
}

IncidentActionHistorical

The lncidentActionHistorical endpoint provides a historical incident summary for all action types recorded in Nintex Process Manager.

Response

Property

Type

Nullable

Description

UniqueId

Guid

false

Unique identifier for the action updates.
IncidentId String   The Id and Primary Key of the incident.

Owner

String

 

Name of the person who owns the action.

CreatedBy

String

 

Name of the person who created the action.

CompletedBy

String

 

Name of the person who completed the action.

DeletedBy

String

 

Name of the person who deleted the action.

ActionType

String

 

The type of action. Values are:

  • Remedial Action

  • Monitor Risk
  • Change Process

  • Provide Training

  • Other Action

Title

String

 

Title/short description of the action.
Description String   Full description of the action.

DueDate

DateTimeOffset

 

Target completion date for the action.

OwnerEmail

String

 

Email of the person who owns the action.

CreatedDate

DateTimeOffset

 

Date the action was created.

CreatedByEmail

String

 

Email of the person who created the action.

CompletedDate

DateTimeOffset

 

Date the action was completed.

CompletedByEmail

String

 

Email of the person who completed the action.

DeletedDate

DateTimeOffset

 

Date the action was deleted.

DeletedByEmail

String

 

Email of the person who deleted the action.

EventType

String

 

The type of event. For more information, see Event Triggers.

EventDateTime

DateTimeOffset

false

Date and time (UTC) when the event occurred.

Example

<Reporting API URL>/IncidentActionHistorical?$filter=ActionType eq 'Change Process' and Owner eq 'User 1'

 


{
    "@odata.context": "<Reporting API URL>/odata/$metadata#IncidentActionHistorical",
    "value": [
        {
            "UniqueId": "14eb8324-85ac-4e48-99c8-37cc83949369",
            "IncidentId": "445333b0-0750-e911-a9df-d96ad83fcabc",
            "Owner": "User 1",
            "CreatedBy": "Xxxx Xxxx",
            "CompletedBy": "User 1",
            "DeletedBy": null,
            "ActionType": "Change Process",
            "Title": "Action title",
	     "Description": "Action description",
            "DueDate": "2019-03-31T11:00:00Z",
            "OwnerEmail": "promapp-noreply@promapp.com.au",
            "CreatedDate": "2019-03-26T21:04:50.157Z",
            "CreatedByEmail": "promapp-noreply@promapp.com.au",
            "CompletedDate": "2019-03-26T21:30:04.833Z",
            "CompletedByEmail": "promapp-noreply@promapp.com.au",
            "DeletedDate": null,
            "DeletedByEmail": null,
            "EventType": "incidentsnapshot",
            "EventDateTime": "2019-08-20T02:59:56.488573Z"
        },
        {
            "UniqueId": "51d4d88e-d061-4fbc-af4e-7d02198f2175",
            "IncidentId": "445333b0-0750-e911-a9df-d96ad83fcabc",
            "Owner": "User 1",
            "CreatedBy": "Xxxx Xxxx",
            "CompletedBy": "User 1",
            "DeletedBy": null,
            "ActionType": "Change Process",
            "Title": "Action title",
	     "Description": "Action description",
            "DueDate": "2019-03-31T11:00:00Z",
            "OwnerEmail": "promapp-noreply@promapp.com.au",
            "CreatedDate": "2019-03-26T21:04:50.157Z",
            "CreatedByEmail": "promapp-noreply@promapp.com.au",
            "CompletedDate": "2019-03-26T21:30:04.833Z",
            "CompletedByEmail": "promapp-noreply@promapp.com.au",
            "DeletedDate": null,
            "DeletedByEmail": null,
            "EventType": "incidentsnapshot",
            "EventDateTime": "2019-08-20T02:41:22.52002Z"
        },
        {
            "UniqueId": "e1a9d3c9-64be-4051-ac7c-905149fde0bf",
            "IncidentId": "445333b0-0750-e911-a9df-d96ad83fcabc",
            "Owner": "User 1",
            "CreatedBy": "Xxxx Xxxx",
            "CompletedBy": "User 1",
            "DeletedBy": null,
            "ActionType": "Change Process",
            "Title": "Action title",
	     "Description": "Action description",
            "DueDate": "2019-03-31T11:00:00Z",
            "OwnerEmail": "promapp-noreply@promapp.com.au",
            "CreatedDate": "2019-03-26T21:04:50.157Z",
            "CreatedByEmail": "promapp-noreply@promapp.com.au",
            "CompletedDate": "2019-03-26T21:30:04.833Z",
            "CompletedByEmail": "promapp-noreply@promapp.com.au",
            "DeletedDate": null,
            "DeletedByEmail": null,
            "EventType": "incidentsnapshot",
            "EventDateTime": "2019-08-20T03:02:26.985657Z"
        },
        {
            "UniqueId": "d298f8e0-d6c3-4f00-b2ca-ac15e58331e0",
            "IncidentId": "445333b0-0750-e911-a9df-d96ad83fcabc",
            "Owner": "User 1",
            "CreatedBy": "Xxxx Xxxx",
            "CompletedBy": "User 1",
            "DeletedBy": null,
            "ActionType": "Change Process",
            "Title": "Action title",
	     "Description": "Action description",
            "DueDate": "2019-03-31T11:00:00Z",
            "OwnerEmail": "promapp-noreply@promapp.com.au",
            "CreatedDate": "2019-03-26T21:04:50.157Z",
            "CreatedByEmail": "promapp-noreply@promapp.com.au",
            "CompletedDate": "2019-03-26T21:30:04.833Z",
            "CompletedByEmail": "promapp-noreply@promapp.com.au",
            "DeletedDate": null,
            "DeletedByEmail": null,
            "EventType": "incidentsnapshot",
            "EventDateTime": "2019-08-20T02:57:48.756671Z"
        },
        {
            "UniqueId": "0b38fb30-c159-44c2-a786-c58b2da18110",
            "IncidentId": "445333b0-0750-e911-a9df-d96ad83fcabc",
            "Owner": "User 1",
            "CreatedBy": "Xxxx Xxxx",
            "CompletedBy": "User 1",
            "DeletedBy": null,
            "ActionType": "Change Process",
            "Title": "Action title",
	     "Description": "Action description",
            "DueDate": "2019-03-31T11:00:00Z",
            "OwnerEmail": "promapp-noreply@promapp.com.au",
            "CreatedDate": "2019-03-26T21:04:50.157Z",
            "CreatedByEmail": "promapp-noreply@promapp.com.au",
            "CompletedDate": "2019-03-26T21:30:04.833Z",
            "CompletedByEmail": "promapp-noreply@promapp.com.au",
            "DeletedDate": null,
            "DeletedByEmail": null,
            "EventType": "incidentsnapshot",
            "EventDateTime": "2019-08-20T02:37:03.148333Z"
        },
        {
            "UniqueId": "eadcb697-ff63-4373-be78-de362b177b96",
            "IncidentId": "445333b0-0750-e911-a9df-d96ad83fcabc",
            "Owner": "User 1",
            "CreatedBy": "Xxxx Xxxx",
            "CompletedBy": "User 1",
            "DeletedBy": null,
            "ActionType": "Change Process",
            "Title": "Action title",
	     "Description": "Action description",
            "DueDate": "2019-03-31T11:00:00Z",
            "OwnerEmail": "promapp-noreply@promapp.com.au",
            "CreatedDate": "2019-03-26T21:04:50.157Z",
            "CreatedByEmail": "promapp-noreply@promapp.com.au",
            "CompletedDate": "2019-03-26T21:30:04.833Z",
            "CompletedByEmail": "promapp-noreply@promapp.com.au",
            "DeletedDate": null,
            "DeletedByEmail": null,
            "EventType": "incidentsnapshot",
            "EventDateTime": "2019-07-17T02:53:28.160527Z"
        },
        {
            "UniqueId": "2c2cab0f-a629-48ee-ad70-e2dd3db5e2ea",
            "IncidentId": "445333b0-0750-e911-a9df-d96ad83fcabc",
            "Owner": "User 1",
            "CreatedBy": "Xxxx Xxxx",
            "CompletedBy": "User 1",
            "DeletedBy": null,
            "ActionType": "Change Process",
            "Title": "Action title",
	     "Description": "Action description",
            "DueDate": "2019-03-31T11:00:00Z",
            "OwnerEmail": "promapp-noreply@promapp.com.au",
            "CreatedDate": "2019-03-26T21:04:50.157Z",
            "CreatedByEmail": "promapp-noreply@promapp.com.au",
            "CompletedDate": "2019-03-26T21:30:04.833Z",
            "CompletedByEmail": "promapp-noreply@promapp.com.au",
            "DeletedDate": null,
            "DeletedByEmail": null,
            "EventType": "incidentsnapshot",
            "EventDateTime": "2019-08-20T02:38:49.682748Z"
        }
    ]
}

IncidentActionPlan

The IncidentActionPlan endpoint provides an incident summary for the latest action plans recorded in Nintex Process Manager.

Response

Property

Type

Nullable

Description

UniqueId

Guid

false

Unique identifier for the action plan.
IncidentId String   The Id and Primary Key of the incident.

State

String

 

One of the following values based on the action plan::

  • Approved
  • Submitted
  • Rejected

UpdatedBy

String

 

Name of the person who updated the action plan.

UpdatedDate

DateTimeOffset

 

Date when the action plan was updated.

UpdatedByEmail

String

 

Email of the person who updated the action plan.

Example

<Reporting API URL>/IncidentActionPlan?$filter=State eq 'Submitted' 


{
    "@odata.context": "<Reporting API URL>/odata/$metadata#IncidentActionPlan",
    "value": [
        {
            "UniqueId": "114",
            "IncidentId": "a85aa5e1-fe45-e911-a9de-e432dec70fcd",
            "State": "Submitted",
            "UpdatedBy": "Xxxx Xxxx",
            "UpdatedDate": "2019-04-04T23:29:44.19Z",
            "UpdatedByEmail": "promapp-noreply@promapp.com.au"
        },
        {
            "UniqueId": "137",
            "IncidentId": "90b2ca3f-e154-e911-a9df-d96ad83fcabc",
            "State": "Submitted",
            "UpdatedBy": "Promapp Promaster",
            "UpdatedDate": "2019-04-02T00:54:41.42Z",
            "UpdatedByEmail": "promapp-noreply@promapp.com.au"
        },
        {
            "UniqueId": "174",
            "IncidentId": "a046fa11-be7d-e911-a9e0-d7c64556bb9c",
            "State": "Submitted",
            "UpdatedBy": "Xxxx Xxxx",
            "UpdatedDate": "2019-05-24T00:56:44.753Z",
            "UpdatedByEmail": "promapp-noreply@promapp.com.au"
        },
        {
            "Id": "227",
            "IncidentId": "2ee66377-36b3-e911-aa29-b5a895d4ba97",
            "State": "Submitted",
            "UpdatedBy": "Promapp Promaster",
            "UpdatedDate": "2019-07-31T01:57:59.03Z",
            "UpdatedByEmail": "promapp-noreply@promapp.com.au"
        },
        {
            "UniqueId": "36",
            "IncidentId": "0bf13ac5-4ddc-40a2-a2c0-6da223da7bf9",
            "State": "Submitted",
            "UpdatedBy": "Promaster - Lindsey Bradfield",
            "UpdatedDate": "2016-03-11T00:44:03.533Z",
            "UpdatedByEmail": "promapp-noreply@promapp.com.au"
        },
        {
            "UniqueId": "52",
            "IncidentId": "30eadc85-7802-e911-a9da-ffd8e2e0194e",
            "State": "Submitted",
            "UpdatedBy": "Promapp Promaster",
            "UpdatedDate": "2018-12-18T21:07:57.897Z",
            "UpdatedByEmail": "promapp-noreply@promapp.com.au"
        }
    ]
}

IncidentActionPlanHistorical

The IncidentActionPlanHistorical endpoint provides a historical incident summary for all action plans recorded in Nintex Process Manager.

Response

Property

Type

Nullable

Description

UniqueId

Guid

false

Unique identifier for the action plan updates.
IncidentId String   The Id and Primary Key of the incident.

State

String

 

One of the following values based on the action plan:

  • Approved
  • Submitted
  • Rejected

UpdatedBy

String

 

Name of the person who updated the action plan.

UpdatedDate

DateTimeOffset

 

Date when the action plan was updated.

UpdatedByEmail

String

 

Email of the person who updated the action plan.

EventType

String

 

The type of event. For more information, see Event Triggers.

EventDateTime

DateTimeOffset

false

Date and time (UTC) when the event occurred.

Example

<Reporting API URL>/IncidentActionPlanHistorical?$filter=State eq 'Submitted' and EventType eq 'incidentactionplanupdated' 


{
    "@odata.context": "<Reporting API URL>/odata/$metadata#IncidentActionPlanHistorical",
    "value": [
        {
            "UniqueId": "fe702a90-873a-48cc-95e8-139be64931d5",
            "IncidentId": "4c0fe6ce-f7ac-e911-aa28-abb77f6cbd36",
            "State": "Submitted",
            "UpdatedBy": "Promapp Promaster",
            "UpdatedDate": "2019-07-23T03:41:45.657Z",
            "UpdatedByEmail": "promapp-noreply@promapp.com.au",
            "EventType": "incidentactionplanupdated",
            "EventDateTime": "2019-07-23T03:41:45.686966Z"
        },
        {
            "UniqueId": "71648e6c-4e38-4b68-b677-2aafae057d59",
            "IncidentId": "4c0fe6ce-f7ac-e911-aa28-abb77f6cbd36",
            "State": "Submitted",
            "UpdatedBy": "Promapp Promaster",
            "UpdatedDate": "2019-07-23T03:42:25.297Z",
            "UpdatedByEmail": "promapp-noreply@promapp.com.au",
            "EventType": "incidentactionplanupdated",
            "EventDateTime": "2019-07-23T03:42:25.326614Z"
        },
        {
            "UniqueId": "1c5cdb1d-c20f-45d3-9ae1-90a17d8de4fc",
            "IncidentId": "113f52ba-2fc5-e911-aa2a-ee0046dfd6fe",
            "State": "Submitted",
            "UpdatedBy": "Xxxx Xxxx",
            "UpdatedDate": "2019-08-22T23:22:58.69Z",
            "UpdatedByEmail": "promapp-noreply@promapp.com.au",
            "EventType": "incidentactionplanupdated",
            "EventDateTime": "2019-08-22T23:22:58.72228Z"
        },
        {
            "UniqueId": "fd2e9a2e-ceff-4cda-855d-a27691630c94",
            "IncidentId": "54cdcc2c-37b3-e911-aa29-b5a895d4ba97",
            "State": "Submitted",
            "UpdatedBy": "Promapp Promaster",
            "UpdatedDate": "2019-08-28T05:00:18.593Z",
            "UpdatedByEmail": "promapp-noreply@promapp.com.au",
            "EventType": "incidentactionplanupdated",
            "EventDateTime": "2019-08-28T05:00:18.62441Z"
        },
        {
            "UniqueId": "f41524a4-4cb1-4534-b4be-c9cec08cd2fd",
            "IncidentId": "2ee66377-36b3-e911-aa29-b5a895d4ba97",
            "State": "Submitted",
            "UpdatedBy": "Promapp Promaster",
            "UpdatedDate": "2019-07-31T01:57:59.03Z",
            "UpdatedByEmail": "promapp-noreply@promapp.com.au",
            "EventType": "incidentactionplanupdated",
            "EventDateTime": "2019-07-31T01:57:59.078213Z"
        },
        {
            "UniqueId": "f8595f6a-3335-43cf-b81b-eec3b266c0a6",
            "IncidentId": "8c76c5a5-f1ac-e911-aa28-abb77f6cbd36",
            "State": "Submitted",
            "UpdatedBy": "Promapp Promaster",
            "UpdatedDate": "2019-08-28T05:03:50.433Z",
            "UpdatedByEmail": "promapp-noreply@promapp.com.au",
            "EventType": "incidentactionplanupdated",
            "EventDateTime": "2019-08-28T05:03:50.463207Z"
        }
    ]
}