Jump to

• Request
• Response

Validate Flow

post

/rpa/v1/flows/actions/validate

Validates the DesignTime data without saving it into the flow.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

The information to be validated for errors.

Show Source

• designTimeData: string
  Indicates the design time data
• projectId: string
  Project

{
    "description":"The information to be validated for errors.",
    "type":"object",
    "properties":{
        "projectId":{
            "description":"Project",
            "type":"string"
        },
        "designTimeData":{
            "description":"Indicates the design time data",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A page of Flow Summary objects.

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 : ValidateFlowResult

Type: object

Flow payload related errors if any.

Show Source

• errors(required): array errors
  List of errors associated with the flow definition.

{
    "description":"Flow payload related errors if any.",
    "type":"object",
    "x-obmcs-splat":{
        "resourceKind":"flow",
        "adLocality":"regional",
        "getOperationId":"GetFlow",
        "listResourcesOperationId":"ListFlows",
        "activeLifecycleStates":[
            "locked",
            "draft",
            "configured",
            "activating",
            "active",
            "deactivating"
        ],
        "ocidEntityType":"flow"
    },
    "required":[
        "errors"
    ],
    "properties":{
        "errors":{
            "description":"List of errors associated with the flow definition.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FlowDefinitionError"
            }
        }
    }
}

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 : 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