REST API for Oracle Cloud Infrastructure Process Automation

Pause Timer Start Event

post

/process/api/v1/instances/startTimer/pause

Pause the timer start event.

Request

There are no request parameters for this operation.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

value: string

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        }
    ],
    "properties":{
        "value":{
            "type":"string"
        }
    }
}

Match All

Show Source

object CommonModel

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        }
    ],
    "properties":{
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : CommonModel

Type: object

Show Source

links: array links

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

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"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Successful operation

Root Schema : DataObject

Type: object

Show Source

value: string

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        }
    ],
    "properties":{
        "value":{
            "type":"string"
        }
    }
}

Match All

Show Source

object CommonModel

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/CommonModel"
        }
    ],
    "properties":{
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : CommonModel

Type: object

Show Source

links: array links

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

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: Pause a timer start event

The following example shows how to pause timer start event by submitting a POST 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.

curl --location 'http://<OIC URL>/process/api/v1/instances/startTimer/pause' \
--header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:126.0) Gecko/20100101 Firefox/126.0' \
--header 'Accept: application/json, text/javascript, */*; q=0.01' \
--header 'Accept-Language: en-US,en;q=0.5' \
--header 'Accept-Encoding: gzip, deflate' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic c4BhdfghjjRfggFnuyhJHlF56fhji1lMQ==' \
--header 'x-tenant-id: abcd' \
--header 'opc-request-id: aty76886lmln' \
--header 'X-Requested-With: XMLHttpRequest' \
--header 'Connection: keep-alive' \
--header 'Referer: http://<OIC URL>/process/workspace/?root=instances' \
--data '{
    "value": "EveryElevenMins--1.0--Every11Mins"
}'

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
    }
  ],
  "value": "string"
}