Jump to

• Request
• Response
• Examples

Get latest Cycle execution status

get

/CycleService/rest/services/tasks

Retrieves execution/status details for the most recently submitted Cycle task.

Request

Header Parameters

• ClientNumber(required): string
  For basic Authentication, the ClientNumber Username is sent in the HTTPS header request.
• PersonalId(required): string
  For basic Authentication, the PersonalId Password is sent in the HTTPS header request.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Cycle execution details retrieved successfully.

Body ()

Root Schema : CycleTaskDetail

Type: object

Show Source

• cycleGuid: string
• level: string
  Example: POLICY
• processedActivities: string
• processedActivitiesPerMinute: string
• processedEntities: string
• processedEntitiesPerMinute: string
• status: object status
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "cycleGuid":{
            "type":"string"
        },
        "level":{
            "type":"string",
            "example":"POLICY"
        },
        "status":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "example":{
                "SUCCESS":"10",
                "BUSINESS ERROR":"2",
                "SYSTEM ERROR":"1"
            }
        },
        "processedEntities":{
            "type":"string"
        },
        "processedActivities":{
            "type":"string"
        },
        "processedEntitiesPerMinute":{
            "type":"string"
        },
        "processedActivitiesPerMinute":{
            "type":"string"
        }
    }
}

Nested Schema : status

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "example":{
        "SUCCESS":"10",
        "BUSINESS ERROR":"2",
        "SYSTEM ERROR":"1"
    }
}

Example:

{
    "SUCCESS":"10",
    "BUSINESS ERROR":"2",
    "SYSTEM ERROR":"1"
}

400 Response

Cycle execution task not found or details could not be retrieved.

401 Response

Authentication refused for provided credentials or the token is invalid.

403 Response

Authentication refused for provided credentials or the token is invalid.

Back to Top

Examples

This example demonstrates how to retrieve execution and status information for the most recently submitted Cycle task.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl \
   -X GET \
   -H "Accept: application/json" \
   -H "ClientNumber: wsUser" \
   -H "PersonalId: wsUserPassword" \
   -L "https://oipa.example.com/PASJava/CycleService/rest/services/tasks"

Implementation Notes

• The endpoint first identifies the most recent cycle GUID from cycle execution data.
• After the recent GUID is resolved, it follows the same execution-status lookup used by GET /tasks/{CycleGuid}.
• If no previous cycle execution task exists, the service returns 400 Bad Request with an ErrorMessage.

Operational Guidance

• Use GET /tasks for monitoring dashboards or administrative checks that need the latest cycle run.
• Treat counts and processing rates as point-in-time values. Repeated calls may return different values while a cycle run is still executing.

Back to Top