REST API for Oracle Cloud Infrastructure Process Automation

List Timer Start Events

get

/process/api/v1/instances/startTimer

Get the list of timer start events.

Request

Query Parameters

keyword: string

Keyword search against process name and applicationName.

Header Parameters

Accept-Language:

Accept-Language header in IETF BCP 47
oci-original-url:

Actual endpoint which customer requested

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : PauseResumeRequestList

Type: object

Show Source

activites: array activites

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        }
    ],
    "properties":{
        "activites":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PauseResumeObject"
            }
        }
    }
}

Match All

Show Source

object CommonModel

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        }
    ],
    "properties":{
        "activites":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PauseResumeObject"
            }
        }
    }
}

Nested Schema : activites

Type: array

Show Source

Array of: object PauseResumeObject

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/PauseResumeObject"
    }
}

Nested Schema : CommonModel

Type: object

Show Source

links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        }
    }
}

Nested Schema : PauseResumeObject

Type: object

Show Source

applicationName: string
lastExecutedTime: string
processDefinitionId: string
processName: string
state: string

{
    "type":"object",
    "properties":{
        "processName":{
            "type":"string"
        },
        "applicationName":{
            "type":"string"
        },
        "lastExecutedTime":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "processDefinitionId":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

Array of: object Link

Defines Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Defines Link

Show Source

code: integer

Minimum Value: 100

Maximum Value: 600
href(required): string
hreflang: string
length: integer (int32)
mediaType: string
message: string
rel(required): string
title: string
type: string

{
    "type":"object",
    "description":"Defines Link",
    "additionalProperties":false,
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "hreflang":{
            "type":"string"
        },
        "length":{
            "type":"integer",
            "format":"int32"
        },
        "rel":{
            "type":"string"
        },
        "title":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        },
        "message":{
            "type":"string"
        },
        "code":{
            "type":"integer",
            "minimum":"100",
            "maximum":"600"
        }
    }
}

401 Response

Unauthorized

404 Response

Task not found for given ID

429 Response

Too Many Requests

500 Response

Internal Server Error

503 Response

Too Many Exceptions or Too Slow Requests

Examples

Example: Get the list of timer start events

The following example shows how to get the list of timer start events involved in a process instance by submitting a GET request on the REST resource using cURL. For more information about cURL, see cURL Access. For more information about endpoint URL structure, see Send Requests.

Retrieve the list of timer start events from a list of applications that contain the word sales.

curl --location 'http://<OIC URL>/process/api/v1/instances/startTimer' \
--header 'x-tenant-id: abcd' \
--header 'Authorization: Basic c3sdkfF5DGuy1hjGHJ2sfnHJndjfhb21lMQ=='

Example: Format of 200 Operation Successful response

{
  "links": [
    {
      "href": "string",
      "hreflang": "string",
      "length": 0,
      "rel": "string",
      "title": "string",
      "type": "string",
      "mediaType": "string",
      "message": "string",
      "code": 600
    }
  ],
  "activites": [
    {
      "processName": "string",
      "applicationName": "string",
      "lastExecutedTime": "string",
      "state": "string",
      "processDefinitionId": "string"
    }
  ]
}