Jump to

• Request
• Response

Get Connection

get

/rpa/v1/connections/{identifier}

Gets a Connection 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 with the given identifier

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

Type: object

Details of Connection.

Show Source

• connectionShapeIdentifier(required): string
  Connection Shape Identifier
• createdBy: string
  Created By
• description: string
  Minimum Length: 0

  Maximum Length: 1024

  Description of the Connection.
• displayName(required): string
  Connection name
• identifier(required): string
  Connection identifier
• keywords: string
  Minimum Length: 0

  Maximum Length: 1024

  Keywords.
• lifecycleState(required): string
  Allowed Values: [ "DRAFT", "CONFIGURED", "CREATING", "UPDATING" ]

  The current state of the Connection.
• timeCreated: string (date-time)
  The time the Connection was created. An RFC3339 formatted datetime string.
• timeUpdated: string (date-time)
  The time the Connection was last updated. An RFC3339 formatted datetime string
• updatedBy: string
  Updated By.

{
    "description":"Details of Connection.",
    "type":"object",
    "x-obmcs-splat":{
        "resourceKind":"connection",
        "adLocality":"regional",
        "getOperationId":"GetConnection",
        "listResourcesOperationId":"ListConnections",
        "activeLifecycleStates":[
            "draft",
            "configured"
        ],
        "ocidEntityType":"connection"
    },
    "required":[
        "displayName",
        "identifier",
        "connectionShapeIdentifier",
        "lifecycleState"
    ],
    "properties":{
        "displayName":{
            "description":"Connection name",
            "type":"string"
        },
        "identifier":{
            "description":"Connection identifier",
            "type":"string"
        },
        "keywords":{
            "description":"Keywords.",
            "type":"string",
            "minLength":0,
            "maxLength":1024
        },
        "description":{
            "description":"Description of the Connection.",
            "type":"string",
            "minLength":0,
            "maxLength":1024
        },
        "connectionShapeIdentifier":{
            "description":"Connection Shape Identifier",
            "type":"string"
        },
        "timeCreated":{
            "description":"The time the Connection was created. An RFC3339 formatted datetime string.",
            "type":"string",
            "format":"date-time"
        },
        "timeUpdated":{
            "description":"The time the Connection 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 Connection.",
            "type":"string",
            "enum":[
                "DRAFT",
                "CONFIGURED",
                "CREATING",
                "UPDATING"
            ]
        }
    }
}

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