Jump to

• Request
• Response

Get Flow

get

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

Gets a Flow by identifier.

Request

Path Parameters

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

Query Parameters

• isFlowDetailsNeeded: boolean
  A filter to return details of the Flow.
• projectId(required): string
  Project identifier

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Retrieves the Flow with the given id

Headers

• etag:
  For optimistic concurrency control. See `if-match`.
• 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 : Flow

Type: object

Details of Flow.

Show Source

• areScreenshotsAllowed: boolean
  Whether the screenshots needs to be allowed for the selected tracing levels
• connectionIdentifiers: array connectionIdentifiers
  List connection Identifiers.
• createdBy: string
  Created By
• description: string
  Minimum Length: 0

  Maximum Length: 1024

  Description of the Flow.
• designTimeData: string
  Indicates the design time data
• displayName(required): string
  Flow name
• endpointPath: string
  The endpoint to instantiate the Flow.
• environmentGroupIdentifier: string
  Default Environment Group ID where the flow will be executed
• environmentGroupProjectId: string
  Default Environment Group Project ID where the flow will be executed
• errors: array errors
  List of errors associated with the flow definition.
• flowProperties: object flowProperties
  Additional Properties Allowed: additionalProperties

  Map for the Flow Properties
• hasErrors: boolean
  Whether the flow definition has errors or not.
• hasInputSchemaError: boolean
  Whether the Input Schema of the flow has errors or not.
• hasOutputSchemaError: boolean
  Whether the Output Schema of the flow has errors or not.
• hasSelfHealRecommendations: boolean
  Indicates whether the flow has self heal recommendations
• identifier(required): string
  Flow identifier
• inputJsonSchema: string
  The raw schema of the input parameter of this flow.
• isActivatedWithSelfHeal: boolean
  Indicates whether the flow activated with self-healing
• isCreatedWithSelfHealRecommendations: boolean
  Indicates whether the flow was created by applying self heal recommendations
• keywords: string
  Minimum Length: 0

  Maximum Length: 1024

  Keywords.
• lifecycleState(required): string
  Allowed Values: [ "ACTIVE", "LOCKED", "DRAFT", "CONFIGURED", "ACTIVATING", "DEACTIVATING" ]

  The current state of the Flow.
• maxAiAssistedCalls: integer
  Maximum number of AI Assisted calls set for an instance when activated with self heal option enabled
• outputJsonSchema: string
  The raw schema of the output parameter of this flow.
• timeCreated: string (date-time)
  The time the Flow was created. An RFC3339 formatted datetime string.
• timeUpdated: string (date-time)
  The time the Package was last updated. An RFC3339 formatted datetime string
• tracingLevel: string
  Allowed Values: [ "PROD", "AUDIT", "DEBUG" ]

  tracingLevel of this flow
• updatedBy: string
  Updated By.
• version(required): string
  Minimum Length: 1

  Maximum Length: 255

  This refers to the Semantic Versioning.

{
    "description":"Details of Flow.",
    "type":"object",
    "x-obmcs-splat":{
        "resourceKind":"flow",
        "adLocality":"regional",
        "getOperationId":"GetFlow",
        "listResourcesOperationId":"ListFlows",
        "activeLifecycleStates":[
            "locked",
            "draft",
            "configured",
            "activating",
            "active",
            "deactivating"
        ],
        "ocidEntityType":"flow"
    },
    "required":[
        "displayName",
        "identifier",
        "version",
        "lifecycleState"
    ],
    "properties":{
        "displayName":{
            "description":"Flow name",
            "type":"string"
        },
        "identifier":{
            "description":"Flow identifier",
            "type":"string"
        },
        "version":{
            "description":"This refers to the Semantic Versioning.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "description":{
            "description":"Description of the Flow.",
            "type":"string",
            "minLength":0,
            "maxLength":1024
        },
        "keywords":{
            "description":"Keywords.",
            "type":"string",
            "minLength":0,
            "maxLength":1024
        },
        "updatedBy":{
            "description":"Updated By.",
            "type":"string"
        },
        "createdBy":{
            "description":"Created By",
            "type":"string"
        },
        "timeCreated":{
            "description":"The time the Flow was created. An RFC3339 formatted datetime string.",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The time the Package was last updated. An RFC3339 formatted datetime string",
            "type":"string",
            "format":"date-time"
        },
        "lifecycleState":{
            "description":"The current state of the Flow.",
            "type":"string",
            "enum":[
                "ACTIVE",
                "LOCKED",
                "DRAFT",
                "CONFIGURED",
                "ACTIVATING",
                "DEACTIVATING"
            ]
        },
        "hasErrors":{
            "description":"Whether the flow definition has errors or not.",
            "type":"boolean"
        },
        "inputJsonSchema":{
            "description":"The raw schema of the input parameter of this flow.",
            "type":"string"
        },
        "hasInputSchemaError":{
            "description":"Whether the Input Schema of the flow has errors or not.",
            "type":"boolean"
        },
        "outputJsonSchema":{
            "description":"The raw schema of the output parameter of this flow.",
            "type":"string"
        },
        "hasOutputSchemaError":{
            "description":"Whether the Output Schema of the flow has errors or not.",
            "type":"boolean"
        },
        "errors":{
            "description":"List of errors associated with the flow definition.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FlowDefinitionError"
            }
        },
        "designTimeData":{
            "description":"Indicates the design time data",
            "type":"string"
        },
        "environmentGroupProjectId":{
            "type":"string",
            "description":"Default Environment Group Project ID where the flow will be executed"
        },
        "environmentGroupIdentifier":{
            "type":"string",
            "description":"Default Environment Group ID where the flow will be executed"
        },
        "endpointPath":{
            "type":"string",
            "description":"The endpoint to instantiate the Flow."
        },
        "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"
        },
        "flowProperties":{
            "description":"Map<propName,value> for the Flow Properties",
            "type":"object",
            "additionalProperties":{
                "type":"string",
                "minLength":0,
                "maxLength":1024
            },
            "example":{
                "adminEmail":"[e-mail]",
                "primaryLanguage":"sp"
            }
        },
        "connectionIdentifiers":{
            "description":"List connection Identifiers.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "isActivatedWithSelfHeal":{
            "description":"Indicates whether the flow activated with self-healing",
            "type":"boolean"
        },
        "maxAiAssistedCalls":{
            "description":"Maximum number of AI Assisted calls set for an instance when activated with self heal option enabled",
            "type":"integer"
        },
        "hasSelfHealRecommendations":{
            "description":"Indicates whether the flow has self heal recommendations",
            "type":"boolean"
        },
        "isCreatedWithSelfHealRecommendations":{
            "description":"Indicates whether the flow was created by applying self heal recommendations",
            "type":"boolean"
        }
    }
}

Nested Schema : connectionIdentifiers

Type: array

List connection Identifiers.

Show Source

• Array of: string

{
    "description":"List connection Identifiers.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : errors

Type: array

List of errors associated with the flow definition.

Show Source

• Array of: object FlowDefinitionError
  Represent an error associated with the flow definition.

{
    "description":"List of errors associated with the flow definition.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FlowDefinitionError"
    }
}

Nested Schema : flowProperties

Type: object

Additional Properties Allowed

Show Source

• string
  Minimum Length: 0

  Maximum Length: 1024

{
    "description":"Map<propName,value> for the Flow Properties",
    "type":"object",
    "additionalProperties":{
        "type":"string",
        "minLength":0,
        "maxLength":1024
    },
    "example":{
        "adminEmail":"[e-mail]",
        "primaryLanguage":"sp"
    }
}

Map for the Flow Properties

Example:

{
    "adminEmail":"[e-mail]",
    "primaryLanguage":"sp"
}

Nested Schema : FlowDefinitionError

Type: object

Represent an error associated with the flow definition.

Show Source

• locator(required): object Locator
  Represents the locator for a node which threw the error
• message(required): string
  A human-readable message string.

{
    "type":"object",
    "description":"Represent an error associated with the flow definition.",
    "required":[
        "locator",
        "message"
    ],
    "properties":{
        "locator":{
            "$ref":"#/components/schemas/Locator"
        },
        "message":{
            "type":"string",
            "description":"A human-readable message string."
        }
    }
}

Nested Schema : Locator

Type: object

Represents the locator for a node which threw the error

Show Source

• argumentIndex: integer
  Use the index if no argumentName is present
• argumentName: string
  Name of the argument if present
• artifactType(required): string
  Identifies type of the artifact
• functionId: string
  Id of the function(flow) needed for variable and action artifacts
• id: string
  Id of the artifact if present
• index: integer
  Use the index if no ID or name is present
• name: string
  Name of the artifact if present

{
    "type":"object",
    "description":"Represents the locator for a node which threw the error",
    "required":[
        "artifactType"
    ],
    "properties":{
        "artifactType":{
            "type":"string",
            "description":"Identifies type of the artifact"
        },
        "id":{
            "type":"string",
            "description":"Id of the artifact if present"
        },
        "name":{
            "type":"string",
            "description":"Name of the artifact if present"
        },
        "functionId":{
            "type":"string",
            "description":"Id of the function(flow) needed for variable and action artifacts"
        },
        "index":{
            "type":"integer",
            "description":"Use the index if no ID or name is present"
        },
        "argumentName":{
            "type":"string",
            "description":"Name of the argument if present"
        },
        "argumentIndex":{
            "type":"integer",
            "description":"Use the index if no argumentName is present"
        }
    }
}

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

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