Jump to

• Request
• Response

Get Connection Shape

get

/rpa/v1/connectionShapes/{identifier}

Gets a Connection Shape by identifier

Request

Path Parameters

• identifier(required): string
  Identifier.

Query Parameters

• 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 Connection Shape 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 : ConnectionShape

Type: object

Details of ConnectionShape.

Show Source

• createdBy: string
  Created By
• description: string
  ConnectionShape description
• displayName(required): string
  ConnectionShape name
• identifier(required): string
  ConnectionShape identifier
• keywords: string
  ConnectionShape keywords
• lifecycleState(required): string
  Allowed Values: [ "CONFIGURED" ]

  The current state of the ConnectionShape.
• schema(required): string
  The Schema refers to the JSON to which the Connection's content will adhere.
• timeCreated: string (date-time)
  The time the ConnectionShape was created. An RFC3339 formatted datetime string.
• timeUpdated: string (date-time)
  The time the ConnectionShape was last updated. An RFC3339 formatted datetime string
• updatedBy: string
  Updated By.

{
    "description":"Details of ConnectionShape.",
    "type":"object",
    "x-obmcs-splat":{
        "resourceKind":"connectionShape",
        "adLocality":"regional",
        "getOperationId":"GetConnectionShape",
        "listResourcesOperationId":"ListConnectionShapes",
        "activeLifecycleStates":[
            "configured"
        ],
        "ocidEntityType":"connection"
    },
    "required":[
        "displayName",
        "identifier",
        "schema",
        "lifecycleState"
    ],
    "properties":{
        "displayName":{
            "description":"ConnectionShape name",
            "type":"string"
        },
        "identifier":{
            "description":"ConnectionShape identifier",
            "type":"string"
        },
        "keywords":{
            "description":"ConnectionShape keywords",
            "type":"string"
        },
        "description":{
            "description":"ConnectionShape description",
            "type":"string"
        },
        "schema":{
            "description":"The Schema refers to the JSON to which the Connection's content will adhere.",
            "type":"string"
        },
        "timeCreated":{
            "description":"The time the ConnectionShape was created. An RFC3339 formatted datetime string.",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The time the ConnectionShape was last updated. An RFC3339 formatted datetime string",
            "type":"string",
            "format":"date-time"
        },
        "updatedBy":{
            "description":"Updated By.",
            "type":"string"
        },
        "createdBy":{
            "description":"Created By",
            "type":"string"
        },
        "lifecycleState":{
            "description":"The current state of the ConnectionShape.",
            "type":"string",
            "enum":[
                "CONFIGURED"
            ]
        }
    }
}

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