Jump to

• Request
• Response
• Examples

Get Cycle execution status by CycleGUID

get

/CycleService/rest/services/tasks/{CycleGuid}

Retrieves execution/status details for a previously submitted Cycle task using the provided CycleGUID.

Request

Path Parameters

• CycleGuid(required): string
  Cycle GUID identifying the submitted Cycle task.

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

Invalid CycleGUID format or Cycle execution task not found.

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 describes how to retrieve the execution status of a cycle run using the CycleGUID.

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/B7F41E58-9C02-4F18-8FA1-55F9D09B7E25"

Success Response Example

The following shows an example of the response body in JSON format:

{
  "cycleGuid": "B7F41E58-9C02-4F18-8FA1-55F9D09B7E25",
  "level": "POLICY",
  "status": {
    "EXECUTING": "10",
    "SUCCESS": "248",
    "BUSINESS ERROR": "2"
  },
  "processedEntities": "260",
  "processedActivities": "512",
  "processedEntitiesPerMinute": "86.67",
  "processedActivitiesPerMinute": "170.67"
}

Error Response Example

The following shows an example of the error response body in JSON format:

{
  "ErrorMessage": "Invalid GUID format for CycleGUID"
}

Implementation Notes

• The endpoint validates CycleGuid before querying execution status.
• The service queries cycle execution statistics using the supplied cycle GUID.
• If no execution task is found for the GUID, the service returns 400 Bad Request with an ErrorMessage.
• The response status object is built from status-code counts and converted to readable names.

Operational Guidance

• Use GET /tasks/{CycleGuid} when the client has the cycleId returned by task submission.
• Store the submitted cycleId in client-side job tracking so status polling can use the deterministic GUID-specific endpoint.

Back to Top