Jump to

• Request
• Response

Activate Flow

post

/rpa/v1/flows/{identifier}/{version}/actions/activate

Activates the flow for it to accept execution requests.

Request

Path Parameters

• identifier(required): string
  Identifier.
• version(required): string
  Version identifier.

Header Parameters

• if-match: string
  For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Parameters required to activate a Flow.

Show Source

• areScreenshotsAllowed: boolean
  Whether the screenshots needs to be allowed for the selected tracing levels
• isAiFeaturesOptedOut: boolean
  Boolean flag indicating whether the service instance has opted out of AI features
• isSelfHealAllowed: boolean
  Indicates whether the flow execution is permitted to attempt self-healing when fails
• maxAiAssistedCalls: integer
  Maximum number of AI Assisted calls allowed for an instance when activated with self heal option enabled
• projectId(required): string
  Project
• tracingLevel: string
  Allowed Values: [ "PROD", "AUDIT", "DEBUG" ]

  tracingLevel of this flow

{
    "description":"Parameters required to activate a Flow.",
    "type":"object",
    "required":[
        "projectId"
    ],
    "properties":{
        "projectId":{
            "description":"Project",
            "type":"string"
        },
        "tracingLevel":{
            "description":"tracingLevel of this flow",
            "type":"string",
            "enum":[
                "PROD",
                "AUDIT",
                "DEBUG"
            ]
        },
        "areScreenshotsAllowed":{
            "description":"Whether the screenshots needs to be allowed for the selected tracing levels",
            "type":"boolean"
        },
        "isSelfHealAllowed":{
            "description":"Indicates whether the flow execution is permitted to attempt self-healing when fails",
            "type":"boolean"
        },
        "maxAiAssistedCalls":{
            "description":"Maximum number of AI Assisted calls allowed for an instance when activated with self heal option enabled",
            "type":"integer"
        },
        "isAiFeaturesOptedOut":{
            "description":"Boolean flag indicating whether the service instance has opted out of AI features",
            "type":"boolean"
        }
    }
}

Back to Top

Response

202 Response

Accepted the request. The Flow will be activated.

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
• opc-work-request-id:
  Unique Oracle-assigned identifier for the asynchronous work. You can use this to query its status.

400 Response

Bad Request

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

409 Response

Conflict

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

412 Response

Precondition failed

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

429 Response

Too Many Requests

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

Default Response

Unknown Error

Headers

• opc-request-id:
  Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Show Source

• category: string
• code: string
• location: string
• summary: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "category":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        },
        "location":{
            "type":"string"
        }
    }
}

Back to Top