Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

ProcessMiningIntegrationAPI- Scoped

The ProcessMiningIntegrationAPI script include provides methods to manage process mining projects and retrieve findings and breakdowns.

This script include requires the Process Mining plugin (sn_po). For more information, see Process Mining.

The calling user must have the sn_process_mining_analyst or sn_process_mining_power_user role.

The following system properties can be used to manage API functionality.

  • promin.limit.api.project_creation

    Limits the number of projects that can be created daily using APIs.

    Default: 25.

  • promin.limit.api.max_daily_minings

    Limits the number of minings that can be scheduled daily using APIs.

    Default: 25.

  • promin.limit.api.max_daily_minings_per_project

    Limits the number of minings that can be scheduled daily per project using APIs.

    Default: 1.

  • promin.api.allow_no_role_mining

    Allows projects to be mined by users without the sn_process_mining_analyst role.

    Default: False.

  • promin.api.auto_share_project_with_creator

    Automatically shares the project with the creator of the project.

    Default: False.

Parent Topic:Server API reference

ProcessMiningIntegrationAPI - createProject(String table, Array activities, Array breakdowns, String encodedQuery, String templateType, Object permissions, Boolean autoRetire)

Creates a process mining project.

A project acts as a blueprint for Process Mining operations. It selects the process that the mining is done on and which attributes of the process are considered while mining.

NameTypeDescription
tableStringName of the table containing the data to analyze.
activitiesArray

Activity definitions for the project. An activity definition is an attribute of the process to consider while mining, such as state or assignment group. It must be a column from the table specified in the table parameter. At least one activity definition is required to mine a project. For more information about activity definitions, see Set activity definitions.

Note: Activity definitions are also included in the project template specified in the templateType parameter. Use the activities parameter to specify any additional activities not included in the template.

["<column_name>"]
breakdownsArray

Breakdown definitions for the project.A breakdown definition allows you to filter records and analyze a process map by categories, such as priority or business category. It must be a column from the table specified in the table parameter. Breakdown definitions aren't required to mine a project. For more information about breakdown definitions, see Set breakdown definitions.

Note: Breakdown definitions are also included in the project template specified in the templateType parameter. Use the breakdowns parameter to specify any additional breakdowns not included in the template.

["<column_name>"]
encodedQueryStringEncoded query to select the data to analyze. This allows you to limit the data that is analyzed, such as by selecting data only from a specified time period.To include all data in the table, you can pass an empty string.
templateTypeStringType of template to use for the project.Valid values: - Default - Digital Portfolio Management - Vendor Management - WFO For a project that is not part of Workforce Optimization \(WFO\), Vendor Management, or Digital Portfolio Management, choose Default. For example, to create a Performance Analytics project, select Default.
permissionsObjectMap of groups, roles, and users to share the project with, where the key is a sys\_id and the value specifies the type \(group, role, or user\).All users who the project is shared with can view the analyzed model and view project configurations. Only users with the sn\_process\_optimization\_analyst or sn\_process\_optimization\_power\_user can mine the project.
{
   "<user_sys_id>":"user",
   "<role_sys_id>":"role",
   "<group_sys_id>":"group"
}
autoRetireBooleanOptional. Flag that indicates whether to automatically retire the project. Valid values: - true: The project is automatically retired seven days after creation. - false: The project isn't automatically retired. Default: False
TypeDescription
ObjectObject containing information about the project.
{
   "entity": {Object},
   "findingDefinitionKPIMap": {Object},
   "id": "String",
   "lastMined": String",
   "miningState": "String",
   "name": "String",
   "permissions": [Array],
   "retiredDate": "String"
}
<Object>.entityObject containing information about the data analyzed in the project.Data type: Object
{
   "activityDefinitions": [Array],
   "breakdownDefinitions": [Array],
   "condition": "String,"
   "table": "String"
}
<Object>.entity.activityDefinitionsActivity definitions for the project.Data type: Array
[
   {
      "activityOfInterest":Boolean,
      "field":"String",
      "type":"String"      
   }
]
<Object>.entity.activityDefinitions.activityOfInterestFlag that indicates whether field changes appear in the analyst workbench. Valid values: - true: Field changes appear in the analyst workbench. - false: Field changes don’t appear in the analyst workbench, but can still be used in contextual conditions in transitions or findings.
<Object>.entity.activityDefinitions.fieldField containing the data to analyze. The field must be from the table specified in the table parameter.
<Object>.entity.activityDefinitions.typeThe type of values to mine.Valid values: - Field Values \(Default\): This is the default selection. This option is available whenever you create an activity definition. - Date Time: Uses date time value from the actual record rather than the audit history and is displayed as a grouped node on the process map. - Compound: One node or process graph representing change in the multiple field value from the actual record rather than the audit history. - Child Attached: This option is available when you have selected two tables for table configuration and have set a child-parent relationship. This option is available only for the parent table configuration. In the visualization, you will see when the child was attached in the process. - Parent Attached: This option creates a node on the child process representing when a parent record was attached to a child.
<Object>.entity.breakdownDefinitionsBreakdown definitions for the project.Data type: Array
[
 {
   "field":"String",
   "fieldLabel":"String"
 }
]
<Object>.entity.breakdownDefinitions.fieldName of the field used in the breakdown.Data type: String
<Object>.entity.breakdownDefinitions.fieldLabelLabel of the field used in the breakdown.Data type: String
<Object>.entity.conditionEncoded query to select the data to analyze.Data type: String
<Object>.entity.tableName of the table containing the data to analyze.Data type: String
<Object>.findingDefinitionKPIMapMap of improvement opportunities and key performance indicators \(KPIs\), where the map key is an improvement opportunity sys\_id and the value is an array of sys\_ids of the KPIs impacted by the improvement opportunity.Improvement opportunities are located in the Finding Definition \[promin\_finding\_def\] and Automated Finding Definition \[promin\_automated\_finding\] tables. KPIs are located in the Indicator \[pa\_indicators\] table. For more information about improvement opportunities and KPIs, see Setting improvement opportunities and Viewing business insights. Data type: Object
{
   "<finding_def_sys_id":[
      "<kpi_sys_id>"
   ]
}
<Object>.idSys\_id of the project.Table: Project Definition \[promin\_project\] Data type: String
<Object>.lastMinedDate the project was last mined.Data type: String
<Object>.miningStateMining state for the project.For descriptions of mining states, see Mining states. Data type: String
<Object>.nameName of the project.Data type: String
<Object>.permissionsGroup, role, and user permissions for the project.Data type: Object
[
   {
      "type":"String",
      "value":"String"      
   }
]
<Object>.permissions.typeType of permission.Valid values: - group - role - user Data type: String
<Object>.permissions.valueSys\_id of the group, role, or user to grant permissions.Data type: String
<Object>.retiredDateDate the project will be retired.Data type: String

This example creates a project using data from incidents created last month.

SNC.ProcessMiningIntegrationAPI
.createProject(
"incident", // table name
["state"], // activity definitions
["priority"], // breakdown definitions
"sys_created_onONLast month@javascript:gs.beginningOfLastMonth()@javascript:gs.endOfLastMonth()", // incident created on last month
"DEFAULT", // template type
{"02acf036b3120010ed7fc9c316a8dc0c":"user"}, // map of permissions "sys_id":"type"
true // auto retire project
);

Output:

{
   "entity":{
      "table":"incident",
      "condition":"sys_created_onONLast month@javascript:gs.beginningOfLastMonth()@javascript:gs.endOfLastMonth()",
      "activityDefinitions":[
         {
            "field":"assignment_group",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"business_service",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"category",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"priority",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"state",
            "type":"DEFAULT",
            "activityOfInterest":false
         }
      ],
      "breakdownDefinitions":[
         {
            "field":"contact_type",
            "fieldLabel":"Channel"
         },
         {
            "field":"assignment_group",
            "fieldLabel":"Assignment group"
         },
         {
            "field":"location",
            "fieldLabel":"Location"
         },
         {
            "field":"priority",
            "fieldLabel":"Priority"
         },
         {
            "field":"category",
            "fieldLabel":"Category"
         }
      ]
   },
   "name":"Incident Process",
   "permissions":[
      {
         "value":"62826bf03710200044e0bfc8bcbe5df1",
         "type":"user"
      },
      {
         "value":"02acf036b3120010ed7fc9c316a8dc0c",
         "type":"user"
      }
   ],
   "id":"a4286c4f4f831210c98b8a4a91ce0bf5",
   "miningState":"NEW",
   "findingDefinitionKPIMap":{
      "f23c20c34fc31210c98b8a4a91ce0bac":[
         "002d65c3d7131100b96d45a3ce6103e2"
      ]
   },
   "retiredDate":null,
   "lastMined":null
}

ProcessMiningIntegrationAPI - deleteProject(String projectId)

Deletes a process mining project.

NameTypeDescription
projectIdStringSys\_id of the project.Table: Project Definition \[promin\_project\]
TypeDescription
None 

This example deletes a process mining project.

SNC.ProcessMiningIntegrationAPI.deleteProject("a4286c4f4f831210c98b8a4a91ce0bf5");

ProcessMiningIntegrationAPI - getBreakDownStats(String projectId)

Gets breakdown statistics for a process mining project.

Breakdowns allow you to filter records and analyze a process by categories, such as priority or business category.

NameTypeDescription
projectIdStringSys\_id of the project.Table: Project Definition \[promin\_project\]
TypeDescription
ArrayArray of breakdown objects. Each object contains statistics for the breakdown.
[
   {
      "caseCount": Number,
      "field": "String",
      "fieldValue": "String",
      "performanceStats": {Object},
      "tableName": "String",
      "variantCount": Number     
   }
]
<Array>.caseCountNumber of cases from the Case Record \[promin\_case\_record\] table that are part of this breakdown.Data type: Number
<Array>.fieldField used for the breakdown.Data type: String
<Array>.fieldValueField value used for the breakdown.Data type: String
<Array>.performanceStatsPerformance statistics for the breakdown.
{
   "max": Number,
   "mean": Number,
   "median": Number, 
   "min": Number,  
   "n": Number, 
   "q1": Number, 
   "q3": Number, 
   "q4": Number, 
   "stdDeviation": Number, 
   "sum": Number, 
   "total": Number, 
   "trimmedAverage": Number, 
   "trimmedPercentage": Number
}
Data type: Object
<Array>.performanceStats.maxLongest time a record took to complete a route.Data type: Number Unit: Milliseconds
<Array>.performanceStats.meanAverage time that records took to complete a route, from the time records were opened to closed.Data type: Number Unit: Milliseconds
<Array>.performanceStats.medianDuration middle value, or average of two middle values.Data type: Number Unit: Milliseconds
<Array>.performanceStats.minShortest time a record took to complete a route.Data type: Number Unit: Milliseconds
<Array>.performanceStats.nNumber of records that are part of this breakdown.Data type: Number Unit: Milliseconds
<Array>.performanceStats.q1Duration first quartile value.Data type: Number Unit: Milliseconds
<Array>.performanceStats.q3Duration third quartile value.Data type: Number Unit: Milliseconds
<Array>.performanceStats.q4Duration fourth quartile value \(maximum\).Data type: Number Unit: Milliseconds
<Array>.performanceStats.stdDeviationVariation from the route duration average value.Data type: Number Unit: Milliseconds
<Array>.performanceStats.sumSum total of all duration times, from the first to the last event, for all records that follow a route.Data type: Number Unit: Milliseconds
<Array>.performanceStats.totalSum total of all duration times, from the first to the last event, for all records that follow a route.Data type: Number Unit: Milliseconds
<Array>.performanceStats.trimmedAverageAverage time that records took to complete a route, calculated after removing a percentage of smallest and largest values.Data type: Number Unit: Milliseconds
<Array>.performanceStats.trimmedPercentagePercentage used to calculate the trimmedAverage value.Data type: Number
<Array>.tableNameTable used for the breakdown.Data type: String
<Array>.variantCountCount of variants \(a unique sequence of activities performed in a process\) corresponding to this breakdown. Data type: Number

This example gets breakdown statistics for a project.

SNC.ProcessMiningIntegrationAPI.getBreakDownStats("a4286c4f4f831210c98b8a4a91ce0bf5");

Output:

[
   {
      "fieldValue":"1",
      "field":"priority",
      "tableName":"incident",
      "variantCount":21,
      "caseCount":33,
      "performanceStats":{
         "sum":6.4945381E7,
         "min":0.0,
         "max":5.2334704E7,
         "n":33,
         "median":0.0,
         "mean":0.0,
         "total":64945381,
         "stdDeviation":9144841.0,
         "trimmedAverage":165594.0,
         "trimmedPercentage":-1.0,
         "q1":0.0,
         "q3":313333.0,
         "q4":5.2334704E7
      }
   }
]

ProcessMiningIntegrationAPI - getFindings(String projectId)

Gets findings for a process mining project.

NameTypeDescription
projectIdStringSys\_id of the project.Table: Project Definition \[promin\_project\]
TypeDescription
ArrayArray of findings objects.
[
   {
      "caseIds":[Array],  
      "category": "String",
      "categoryDescription": "String",
      "categoryLabel": "String",
      "createdOn": Number, 
      "findingDefId": "String", 
      "id": "String",
      "impactedKpis": [Array],
      "matchingRecords": Number,
      "message": "String",
      "performanceStats": {Object},
      "shortMessage": "String",
      "tableName": "String",
      "totalRecords": Number,
      "type": "String",
      "typeLabel": "String",    
      "versionId": "String"  
   }
]
<Array>.caseIdsList of IDs of cases that match the finding pattern. Located in the Case ID column of the Case Record \[promin\_case\_record\] table.Data type: Array
<Array>.categoryCategory of the finding.Possible values: - AUTOMATION - COMPLIANCE - CONFORMANCE - COST - PERFORMANCE - QUALITY - SPEED Data type: String
<Array>.categoryDescriptionDescription of the finding category.Data type: String
<Array>.categoryLabelLabel for the finding category.Data type: String
<Array>.createdOnCreation date of the finding.Data type: Number
<Array>.findingDefIdSys\_id of the improvement opportunity.Improvement opportunities are located in the Finding Definition \[promin\_finding\_def\] and Automated Finding Definition \[promin\_automated\_finding\] tables. Data type: String
<Array>.idSys\_id of the finding. Located in the Finding \[promin\_finding\] table.Data type: String
<Array>.impactedKpisList of sys\_ids of KPIs impacted by the finding. Located in the Indicator \[pa\_indicators\] table.Data type: Array
<Array>.matchingRecordsNumber of Case IDs from the Case Record \[promin\_case\_record\] table that match the finding pattern.Data type: Number
<Array>.messageMessage from the improvement opportunity.Data type: String
<Array>.performanceStatsPerformance statistics for the finding.
{
   "max": Number,
   "mean": Number,
   "median": Number, 
   "min": Number,  
   "n": Number, 
   "q1": Number, 
   "q3": Number, 
   "q4": Number, 
   "stdDeviation": Number, 
   "sum": Number, 
   "total": Number, 
   "trimmedAverage": Number, 
   "trimmedPercentage": Number
}
Data type: Object
<Array>.performanceStats.maxLongest time a record took to complete a route.Data type: Number Unit: Milliseconds
<Array>.performanceStats.meanAverage time that records took to complete a route, from the time records were opened to closed.Data type: Number Unit: Milliseconds
<Array>.performanceStats.medianDuration middle value, or average of two middle values.Data type: Number Unit: Milliseconds
<Array>.performanceStats.minShortest time a record took to complete a route.Data type: Number Unit: Milliseconds
<Array>.performanceStats.nNumber of records that are part of this finding.Data type: Number Unit: Milliseconds
<Array>.performanceStats.q1Duration first quartile value.Data type: Number Unit: Milliseconds
<Array>.performanceStats.q3Duration third quartile value.Data type: Number Unit: Milliseconds
<Array>.performanceStats.q4Duration fourth quartile value \(maximum\).Data type: Number Unit: Milliseconds
<Array>.performanceStats.stdDeviationVariation from the route duration average value.Data type: Number Unit: Milliseconds
<Array>.performanceStats.sumSum total of all duration times, from the first to the last event, for all records that follow a route.Data type: Number Unit: Milliseconds
<Array>.performanceStats.totalSum total of all duration times, from the first to the last event, for all records that follow a route.Data type: Number Unit: Milliseconds
<Array>.performanceStats.trimmedAverageAverage time that records took to complete a route, calculated after removing a percentage of smallest and largest values.Data type: Number Unit: Milliseconds
<Array>.performanceStats.trimmedPercentagePercentage used to calculate the trimmedAverage value.Data type: Number
<Array>.shortMessageShort message from the improvement opportunity.Data type: String
<Array>.tableNameName of the table used in the finding.Data type: String
<Array>.totalRecordsTotal number of records analyzed in the mining.Data type: Number
<Array>.typeType of improvement opportunity.Possible values: - EXTRA\_STEP - EXTREME\_DURATION - EXTREME\_REPETITION - OTHER - PATTERN - PERFORMANCE\_OUTLIER - PINGPONG - REWORK For more information, see Setting Automated improvement opportunities.
<Array>.typeLabelLabel for the improvement opportunity type.Data type: String
<Array>.versionIdSys\_id of the project version. Located in the Project Definition Version \[promin\_model\_def\_version\] table.Data type: String

This example gets findings for a project.

SNC.ProcessMiningIntegrationAPI.getFindings("a4286c4f4f831210c98b8a4a91ce0bf5");

Output:

[
   {
      "message":"Rework on Closed",
      "id":"0ef09b2e1c6cf0d98045e6ba1c3c9edb",
      "type":"REWORK",
      "createdOn":1727036052.000000000,
      "category":"AUTOMATION",
      "tableName":"incident",
      "categoryLabel":"Automation",
      "matchingRecords":111,
      "versionId":"9a2f187177b412102f7a1b56ba5a99e2",
      "totalRecords":19758,
      "findingDefId":"791f587177b412102f7a1b56ba5a99eb",
      "categoryDescription":"Category that groups all opportunities that are subject to automation.",
      "impactedKpis":[

      ],
      "performanceStats":{
         "sum":2.09532828E8,
         "min":1.0,
         "max":6563078.0,
         "n":111,
         "median":1036715.0,
         "mean":1.0,
         "total":209532828,
         "stdDeviation":1855944.0,
         "trimmedAverage":1716904.0,
         "trimmedPercentage":-1.0,
         "q1":776859.0,
         "q3":2246368.0,
         "q4":6563078.0
      },
      "typeLabel":"Automation",
      "shortMessage":"Closed",
      "caseIds":[
         "119e4a569397fd14849bbcd74dba1018",
         "b16b355f47197190498cc044846d43b0",
         "cf9bca7597fe7d90ef889504a253af9e",
      ]
   }
]

ProcessMiningIntegrationAPI - getMiningStatus(String projectId)

Gets the mining status of a process mining project.

NameTypeDescription
projectIdStringSys\_id of the project.Table: Project Definition \[promin\_project\]
TypeDescription
ObjectObject containing the project sys\_id and a tracker.
{
   "projectId":"String",
   "trackerId":"String"  
}
<Object>.projectIdSys\_id of the project.Table: Project Definition \[promin\_project\] Data type: String
<Object>.trackerIdSys\_id of the tracker that monitors the mining progress for the project.Table: Execution Tracker \[sys\_execution\_tracker\] Data type: String

This example gets the mining status for a project.

SNC.ProcessMiningIntegrationAPI.getMiningStatus("c0b91f0cff01121047cae835f2cb14bc");

Output:

{
   "trackerId":"aec9530cff01121047cae835f2cb147e",
   "projectId":"c0b91f0cff01121047cae835f2cb14bc"
}

ProcessMiningIntegrationAPI - getProject(String projectId)

Retrieves a process mining project.

NameTypeDescription
projectIdStringSys\_id of the project.Table: Project Definition \[promin\_project\]
TypeDescription
ObjectObject containing information about the project.
{
   "entity": {Object},
   "findingDefinitionKPIMap": {Object},
   "id": "String",
   "lastMined": String",
   "miningState": "String",
   "name": "String",
   "permissions": [Array],
   "retiredDate": "String"
}
<Object>.entityObject containing information about the data analyzed in the project.Data type: Object
{
   "activityDefinitions": [Array],
   "breakdownDefinitions": [Array],
   "condition": "String,"
   "table": "String"
}
<Object>.entity.activityDefinitionsActivity definitions for the project.Data type: Array
[
   {
      "activityOfInterest":Boolean,
      "field":"String",
      "type":"String"      
   }
]
<Object>.entity.activityDefinitions.activityOfInterestFlag that indicates whether field changes appear in the analyst workbench. Valid values: - true: Field changes appear in the analyst workbench. - false: Field changes don’t appear in the analyst workbench, but can still be used in contextual conditions in transitions or findings.
<Object>.entity.activityDefinitions.fieldField containing the data to analyze. The field must be from the table specified in the table parameter.
<Object>.entity.activityDefinitions.typeThe type of values to mine.Valid values: - Field Values \(Default\): This is the default selection. This option is available whenever you create an activity definition. - Date Time: Uses date time value from the actual record rather than the audit history and is displayed as a grouped node on the process map. - Compound: One node or process graph representing change in the multiple field value from the actual record rather than the audit history. - Child Attached: This option is available when you have selected two tables for table configuration and have set a child-parent relationship. This option is available only for the parent table configuration. In the visualization, you will see when the child was attached in the process. - Parent Attached: This option creates a node on the child process representing when a parent record was attached to a child.
<Object>.entity.breakdownDefinitionsBreakdown definitions for the project.Data type: Array
[
 {
   "field":"String",
   "fieldLabel":"String"
 }
]
<Object>.entity.breakdownDefinitions.fieldName of the field used in the breakdown.Data type: String
<Object>.entity.breakdownDefinitions.fieldLabelLabel of the field used in the breakdown.Data type: String
<Object>.entity.conditionEncoded query to select the data to analyze.Data type: String
<Object>.entity.tableName of the table containing the data to analyze.Data type: String
<Object>.findingDefinitionKPIMapMap of improvement opportunities and key performance indicators \(KPIs\), where the map key is an improvement opportunity sys\_id and the value is an array of sys\_ids of the KPIs impacted by the improvement opportunity.Improvement opportunities are located in the Finding Definition \[promin\_finding\_def\] and Automated Finding Definition \[promin\_automated\_finding\] tables. KPIs are located in the Indicator \[pa\_indicators\] table. For more information about improvement opportunities and KPIs, see Setting improvement opportunities and Viewing business insights. Data type: Object
{
   "<finding_def_sys_id":[
      "<kpi_sys_id>"
   ]
}
<Object>.idSys\_id of the project.Table: Project Definition \[promin\_project\] Data type: String
<Object>.lastMinedDate the project was last mined.Data type: String
<Object>.miningStateMining state for the project.For descriptions of mining states, see Mining states. Data type: String
<Object>.nameName of the project.Data type: String
<Object>.permissionsGroup, role, and user permissions for the project.Data type: Object
[
   {
      "type":"String",
      "value":"String"      
   }
]
<Object>.permissions.typeType of permission.Valid values: - group - role - user Data type: String
<Object>.permissions.valueSys\_id of the group, role, or user to grant permissions.Data type: String
<Object>.retiredDateDate the project will be retired.Data type: String

This example retrieves a process mining project.

SNC.ProcessMiningIntegrationAPI.getProject("fa465748ff01121047cae835f2cb1473");

Output:

{
   "entity":{
      "table":"incident",
      "activityDefinitions":[
         {
            "field":"assignment_group",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"business_service",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"state",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"category",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"priority",
            "type":"DEFAULT",
            "activityOfInterest":false
         }
      ],
      "condition":"",
      "breakdownDefinitions":[
         {
            "field":"contact_type",
            "fieldLabel":"Channel"
         },
         {
            "field":"close_code",
            "fieldLabel":"Resolution code"
         },
         {
            "field":"assignment_group",
            "fieldLabel":"Assignment group"
         },
         {
            "field":"location",
            "fieldLabel":"Location"
         },
         {
            "field":"priority",
            "fieldLabel":"Priority"
         },
         {
            "field":"category",
            "fieldLabel":"Category"
         }
      ]
   },
   "name":"Incident Process",
   "permissions":[
      {
         "value":"some_group_sys_id",
         "type":"group"
      },
      {
         "value":"some_role_sys_id",
         "type":"role"
      },
      {
         "value":"some_user_sys_id",
         "type":"user"
      }
   ],
   "id":"fa465748ff01121047cae835f2cb1473",
   "miningState":"NEW",
   "findingDefinitionKPIMap":{

   },
   "retiredDate":1728292672.622894000,
   "lastMined":null
}

ProcessMiningIntegrationAPI - scheduleMining(String projectId)

Submits a process mining project for mining.

NameTypeDescription
projectIdStringSys\_id of the project.Table: Project Definition \[promin\_project\]
TypeDescription
ObjectObject containing the project sys\_id and a tracker.
{
   "projectId":"String",
   "trackerId":"String"  
}
<Object>.projectIdSys\_id of the project.Table: Project Definition \[promin\_project\] Data type: String
<Object>.trackerIdSys\_id of the tracker that monitors the mining progress for the project.Table: Execution Tracker \[sys\_execution\_tracker\] Data type: String

This example submits a project for mining.

SNC.ProcessMiningIntegrationAPI.scheduleMining("c0b91f0cff01121047cae835f2cb14bc");

Output:

{
   "trackerId":"aec9530cff01121047cae835f2cb147e",
   "projectId":"c0b91f0cff01121047cae835f2cb14bc"
}