Communities
A collaborative platform to connect and grow with like-minded Informaticans across the globe
Product Communities
Connect and collaborate with Informatica experts and champions
Discussions
Have a question? Start a Discussion and get immediate answers you are looking for
User Groups
Customer-organized groups that meet online and in-person. Join today to network, share ideas, and get tips on how to get the most out of Informatica
Get Started
Community Guidelines
Knowledge Center
Troubleshooting documents, product guides, how to videos, best practices, and more
Knowledge Base
One-stop self-service portal for solutions, FAQs, Whitepapers, How Tos, Videos, and more
Support TV
Video channel for step-by-step instructions to use our products, best practices, troubleshooting tips, and much more
Documentation
Information library of the latest product documents
Velocity (Best Practices)
Best practices and use cases from the Implementation team
Learn
Rich resources to help you leverage full capabilities of our products
Trainings
Role-based training programs for the best ROI
Certifications
Get certified on Informatica products. Free, Foundation, or Professional
Product Learning Paths
Free and unlimited modules based on your expertise level and journey
Resources
Library of content to help you leverage the best of Informatica products
Tech Tuesdays Webinars
Most popular webinars on product architecture, best practices, and more
Product Availability Matrix
Product Availability Matrix statements of Informatica products
SupportFlash
Monthly support newsletter
Support Documents
Informatica Support Guide and Statements, Quick Start Guides, and Cloud Product Description Schedule
Product Lifecycle
End of Life statements of Informatica products
Ideas
Events
Change Request Tracking
Marketplace
English
  • Application Integration
  • All Products

Table of Contents

Search

  1. Preface
  2. The Application Integration Console
  3. Process Server Configuration
  4. Deployed Assets
  5. Process Schedules
  6. Processes
  7. Process Server Health
  8. Process Metrics
  9. APIs
  10. Connections
  11. Guides
  12. Logs

Monitor

Monitor

Back Next

REST APIs for viewing processes

REST APIs for viewing processes

You can use REST APIs to get a list all the processes that run on the Cloud Server or a Secure Agent.
If the REST API call is successful, the API returns the status code 200 in the response body.

REST APIs for viewing all processes

You can use REST APIs to view all the processes that run on the Cloud Server or a Secure Agent. The maximum number of processes that is returned by default is 20. The following table describes the REST APIs:
API
Description
Authorization Header
Status Code
GET <Informatica Cloud Application Integration URL>/active-bpel/restadmin/processes/
Lists all the processes that run on the Cloud Server.
IDS-SESSION-ID
200
GET http://<agentName>:<httpPortNumber>/process-engine/restadmin/processes/
Lists all the processes that run on a specific Secure Agent.
IDS-SESSION-ID
200
The following example shows a sample response when you view the list of processes on the Cloud Server: 
{
	"totalRowCount": 1,
"completeRowCount": true,
"process": [ {
"processId": "624948257633603584",
"processState": "COMPLETED",
"processStateReason": null,
"processName": {
"value": "Process2",
"namespace": "urn:screenflow:process:Process2"
},
"title": "Process2",
"planId": "624948219649986560",
"cid": "624948218609799168",
"version": 5.0,
"persistenceType": "FINAL",
"processGroup": "RT.User",
"processInitiator": null,
"processInitiatorTenantContext": null,
"tenantContext": "fDe0qZ1yc48bB2mRUmUYIN",
"started": "2021-09-21T12:41:15.598+00:00",
"modified": "2021-09-21T12:41:16.000+00:00",
"completed": "2021-09-21T12:41:15.849+00:00"
}
]
}

Get method to view a process status using run ID

You can use REST APIs to view a process execution status using the run ID of the process that was run on the Cloud Server or a Secure Agent. The following table describes the REST APIs:
API
Description
Authorization Header
Status Code
GET <Informatica Cloud Application Integration URL>/active-bpel/restadmin/processes/?processId=<RunID>/
?
View the process execution status using the run ID of the process that was run on the Cloud Server.
IDS-SESSION-ID
200
GET http://<agentName>:<httpPortNumber>/process-engine/restadmin/processes/?processId=<RunID>/
View the process execution status using the run ID of the process that was run on a Secure Agent.
IDS-SESSION-ID
200
The following example shows a sample response when you view the process execution status based on the run ID that run on the Cloud Server: 
{
"totalRowCount": 1,
"completeRowCount": true,
"process": [
{
"processId": "623402767129513984",
"processState": "COMPLETED",
"processStateReason": null,
"processName": {
"value": "Process1",
"namespace": "urn:screenflow:process:Process1"
},
"title": "Process1",
"planId": "623402719180230656",
"cid": "623402717951299584",
"version": 2.0,
"persistenceType": "BRIEF",
"processGroup": "RT.User",
"processInitiator": null,
"processInitiatorTenantContext": null,
"tenantContext": "fDe0qZ1yc48bB2mRUmUYIN",
"started": "2021-09-17T06:20:01.948+00:00",
"modified": "2021-09-17T06:20:02.000+00:00",
"completed": "2021-09-17T06:20:02.281+00:00"
}
]
}

Get method to fetch the details of a process using filters and advanced query

You can use REST APIs to fetch the details of a process using a filter value. The following table describes the REST APIs:
API
Description
Authorization Header
Status Code
GET http://<agentName>:<httpPortNumber>/process-engine/restadmin/processes?<Filters>
Fetch the details of a process using filters. You must append parameters to the URL to filter the process by using the
&
 symbol.
IDS-SESSION-ID
200
GET <Informatica Cloud Application Integration URL>/active-bpel/restadmin/processes?<Filters>
Use the filters to fetch the details of a process that run on Cloud Server. You must append parameters to the URL to filter the process by using the
&
 symbol.
IDS-SESSION-ID
200
GET http://<agentName>:<httpPortNumber>/process-engine/restadmin/processes?<AdvancedQuery>
Fetch the details of a process based on the advanced process filter condition. You can combine the advanced query filters and append the parameters to the URL using the AND condition.
IDS-SESSION-ID
200
GET <Informatica Cloud Application Integration URL>/active-bpel/restadmin/processes?<Filters>
Use the advanced process filter condition to fetch the details of a process that run on Cloud Server. You can combine the advanced query filters and append the parameters to the URL using the AND condition.
For example:
{{ <Informatica Intelligent Cloud Services URL>}}/active-bpel/restadmin/processes?advancedQuery=getProcessProperty("Version")=3.0 and getProcessProperty("Title") = "Process_fault_multiple_version"
IDS-SESSION-ID
200
The following table describes the query parameters to the request URL using filters:
Parameter
Type
Description
processState
String
The state of the process. Refer to the following states: SUSPENDED, COMPLETED, RUNNING, COMPENSATABLE, FAULTED.
processName
String
The API name of the process.
processNameNamespace
String
The value that isolates a process from other processes.
processGroup
String
The name of the process group. For example, $system, or RT.User.
hideSystem
Boolean
The value is TRUE when the system parameters are hidden and the value is FALSE when the system parameters are not hidden.
hidePublicTenant
Boolean
The value is TRUE when the tenant details are hidden and the value is FALSE when the tenant details are not hidden.
listStart
Encoded Integer
The starting point of the list.
maxReturn
Encoded Integer
The max number of results to return.
processId
String
The ID of the process.
The following example shows a sample response when you fetch the details of a process using a filter value: 
{
"totalRowCount": 9,
"completeRowCount": true,
"process": [
{
"processId": "624901185991610368",
"processState": "COMPLETED",
"processStateReason": null,
"processName": {
"value": "ProcessSchedule",
"namespace": "urn:screenflow:process:ProcessSchedule"
},
"title": "ProcessSchedule",
"planId": "624900778041020416",
"cid": "624900775176310784",
"version": 3.0,
"persistenceType": "FINAL",
"processGroup": "RT.User",
"processInitiator": null,
"processInitiatorTenantContext": null,
"tenantContext": "8zhtLUJEe1sgbBURHFcGS3",
"started": "2021-09-21T09:34:12.844+00:00",
"modified": "2021-09-21T09:34:13.000+00:00",
"completed": "2021-09-21T09:34:12.880+00:00"
},
{
"processId": "624901183047208960",
"processState": "COMPLETED",
"processStateReason": null,
"processName": {
"value": "ProcessSchedule",
"namespace": "urn:screenflow:process:ProcessSchedule"
},
"title": "ProcessSchedule",
"planId": "624900778041020416",
"cid": "624900775176310784",
"version": 3.0,
"persistenceType": "FINAL",
"processGroup": "RT.User",
"processInitiator": null,
"processInitiatorTenantContext": null,
"tenantContext": "8zhtLUJEe1sgbBURHFcGS3",
"started": "2021-09-21T09:34:12.145+00:00",
"modified": "2021-09-21T09:34:13.000+00:00",
"completed": "2021-09-21T09:34:12.589+00:00"
},
{
"processId": "624857077264683008",
"processState": "COMPLETED",
"processStateReason": null,
"processName": {
"value": "ProcessSchedule",
"namespace": "urn:screenflow:process:ProcessSchedule"
},
"title": "ProcessSchedule",
"planId": "624856556772528128",
"cid": "624856555866558464",
"version": 2.0,
"persistenceType": "FINAL",
"processGroup": "RT.User",
"processInitiator": null,
"processInitiatorTenantContext": null,
"tenantContext": "8zhtLUJEe1sgbBURHFcGS3",
"started": "2021-09-21T06:38:56.508+00:00",
"modified": "2021-09-21T06:38:57.000+00:00",
"completed": "2021-09-21T06:38:56.521+00:00"
},
{
"processId": "624856814512508928",
"processState": "COMPLETED",
"processStateReason": null,
"processName": {
"value": "ProcessSchedule",
"namespace": "urn:screenflow:process:ProcessSchedule"
},
"title": "ProcessSchedule",
"planId": "624856556772528128",
"cid": "624856555866558464",
"version": 2.0,
"persistenceType": "FINAL",
"processGroup": "RT.User",
"processInitiator": null,
"processInitiatorTenantContext": null,
"tenantContext": "8zhtLUJEe1sgbBURHFcGS3",
"started": "2021-09-21T06:37:53.860+00:00",
"modified": "2021-09-21T06:37:54.000+00:00",
"completed": "2021-09-21T06:37:54.383+00:00"
},
{
"processId": "624834222103728128",
"processState": "COMPLETED",
"processStateReason": null,
"processName": {
"value": "ProcessSchedule",
"namespace": "urn:screenflow:process:ProcessSchedule"
},
"title": "ProcessSchedule",
"planId": "624833502256304128",
"cid": "624833501849456640",
"version": 1.0,
"persistenceType": "FINAL",
"processGroup": "RT.User",
"processInitiator": null,
"processInitiatorTenantContext": null,
"tenantContext": "8zhtLUJEe1sgbBURHFcGS3",
"started": "2021-09-21T05:08:07.411+00:00",
"modified": "2021-09-21T05:08:07.000+00:00",
"completed": "2021-09-21T05:08:07.418+00:00"
},
{
"processId": "624834051236171776",
"processState": "COMPLETED",
"processStateReason": null,
"processName": {
"value": "ProcessSchedule",
"namespace": "urn:screenflow:process:ProcessSchedule"
},
"title": "ProcessSchedule",
"planId": "624833502256304128",
"cid": "624833501849456640",
"version": 1.0,
"persistenceType": "FINAL",
"processGroup": "RT.User",
"processInitiator": null,
"processInitiatorTenantContext": null,
"tenantContext": "8zhtLUJEe1sgbBURHFcGS3",
"started": "2021-09-21T05:07:26.670+00:00",
"modified": "2021-09-21T05:07:27.000+00:00",
"completed": "2021-09-21T05:07:26.678+00:00"
},
{
"processId": "624833925381885952",
"processState": "COMPLETED",
"processStateReason": null,
"processName": {
"value": "ProcessSchedule",
"namespace": "urn:screenflow:process:ProcessSchedule"
},
"title": "ProcessSchedule",
"planId": "624833502256304128",
"cid": "624833501849456640",
"version": 1.0,
"persistenceType": "FINAL",
"processGroup": "RT.User",
"processInitiator": null,
"processInitiatorTenantContext": null,
"tenantContext": "8zhtLUJEe1sgbBURHFcGS3",
"started": "2021-09-21T05:06:56.665+00:00",
"modified": "2021-09-21T05:06:57.000+00:00",
"completed": "2021-09-21T05:06:56.675+00:00"
},
{
"processId": "624833799540183040",
"processState": "COMPLETED",
"processStateReason": null,
"processName": {
"value": "ProcessSchedule",
"namespace": "urn:screenflow:process:ProcessSchedule"
},
"title": "ProcessSchedule",
"planId": "624833502256304128",
"cid": "624833501849456640",
"version": 1.0,
"persistenceType": "FINAL",
"processGroup": "RT.User",
"processInitiator": null,
"processInitiatorTenantContext": null,
"tenantContext": "8zhtLUJEe1sgbBURHFcGS3",
"started": "2021-09-21T05:06:26.662+00:00",
"modified": "2021-09-21T05:06:27.000+00:00",
"completed": "2021-09-21T05:06:26.676+00:00"
},
{
"processId": "624833673618788352",
"processState": "COMPLETED",
"processStateReason": null,
"processName": {
"value": "ProcessSchedule",
"namespace": "urn:screenflow:process:ProcessSchedule"
},
"title": "ProcessSchedule",
"planId": "624833502256304128",
"cid": "624833501849456640",
"version": 1.0,
"persistenceType": "FINAL",
"processGroup": "RT.User",
"processInitiator": null,
"processInitiatorTenantContext": null,
"tenantContext": "8zhtLUJEe1sgbBURHFcGS3",
"started": "2021-09-21T05:05:56.639+00:00",
"modified": "2021-09-21T05:05:57.000+00:00",
"completed": "2021-09-21T05:05:56.776+00:00"
}
]
}
The following table describes the query parameters to the request URL using advanced query:
Parameter
Type
Description
State
String
The state of the process. The following list describes the state reason values and the associated state reason codes:
  • 3. COMPLETED
  • 4. FAULTED
  • 1. RUNNING
  • 2. SUSPENDED
  • 5.COMPENSATABLE
Version
String
The version number of the published asset.
EndDate
String
The date the process expired.
Start Date
String
The date the process was run.
Initiator
String
The name of the user who initiated the process.
StateReason
String
The reason why a process is in a specific state. The following list describes the state reason values and the associated state reason codes:
  • Suspended (Manual). 0. Applies to processes that were suspended manually.
  • Suspended (Faulting). 1. Applies to processes that were suspended due to a fault that was not caught.
  • Suspended (Activity). 2. Applies to processes that were suspended at a BPEL suspend activity.
  • Suspended (Migration Error). 7. Applies to processes that were suspended due to a migration error for a process that has been migrated to a new process version.
  • Suspended (Migration Warning). 8. Applies to processes that were suspended due to a migration warning for a process that has been migrated to a new process version. Warnings indicate differences found in the new version that might need review and updates before you resume the process.
  • Pre Migration Copy. 20. Applies to an old process instance that has been saved temporarily until the new process instance has been resumed or terminated.
The following example shows a sample response when you fetch details of a single process using the advanced query output: 
{
    "totalRowCount": 1,
    "completeRowCount": true,
    "process": [
        {
            "processId": "1020936957125353472",
            "processState": "COMPLETED",
            "processStateReason": null,
            "processName": {
                "value": "ab",
                "namespace": "urn:screenflow:process:ab"
            },
            "title": "ab",
            "planId": "958340605065715712",
            "cid": "958340602968563712",
            "version": 1.0,
            "persistenceType": "BRIEF",
            "processGroup": "RT.User",
            "processInitiator": null,
            "processInitiatorTenantContext": null,
            "tenantContext": "6CsVq4DWVeJf96ngDYdLSa",
            "started": "2024-09-18T05:58:58.670+00:00",
            "modified": "2024-09-18T05:58:59.000+00:00",
            "completed": "2024-09-18T05:58:58.746+00:00"
        }
    ]
}
0 COMMENTS
We’d like to hear from you!