Jump to

• Request
• Response

Create Flow

post

/rpa/v1/flows

Creates a new Flow.

Request

Header Parameters

• opc-retry-token: string
  Minimum Length: 1

  Maximum Length: 64

  A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

The information about new Flow.

Show Source

• areScreenshotsAllowed: boolean
  Whether the screenshots needs to be allowed for the selected tracing levels
• description: string
  Minimum Length: 0

  Maximum Length: 1024

  Description of the Flow.
• designTimeData: string
  Indicates the IR design time data
• displayName(required): string
  Flow name
• 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
• flowProperties: object flowProperties
  Additional Properties Allowed: additionalProperties

  Map for the Flow Properties
• identifier(required): string
  Flow identifier
• keywords: string
  Minimum Length: 0

  Maximum Length: 1024

  Keywords.
• projectId(required): string
  Project
• projectType: string
  Project Type
• tracingLevel: string
  Allowed Values: [ "PROD", "AUDIT", "DEBUG" ]

  tracingLevel of this flow
• version(required): string
  Minimum Length: 1

  Maximum Length: 255

  This refers to the Semantic Versioning.

{
    "description":"The information about new Flow.",
    "type":"object",
    "required":[
        "projectId",
        "displayName",
        "identifier",
        "version"
    ],
    "properties":{
        "projectId":{
            "description":"Project",
            "type":"string"
        },
        "projectType":{
            "description":"Project Type",
            "type":"string"
        },
        "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
        },
        "designTimeData":{
            "description":"Indicates the IR 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"
        },
        "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"
            }
        }
    }
}

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

Back to Top

Response

202 Response

Accepted the request. The Flow will be created.

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

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