Jump to

• Request
• Response

Get a Connector

get

/process/api/v1/design/applications/{applicationName}/versions/{version}/connectors/{connectorId}

Get the details of the connector available for a given application name, version, and connector Id.

Example:

 curl --location --request GET 'http:///process/api/v1/design/applications//versions//connectors/' --header 'Authorization: Basic c3NlMQ==' 

Request

Path Parameters

• applicationName(required): string
  Application name
• connectorId(required): string
  Connector Id
• version(required): string
  Application version

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : Connector

Type: object

Show Source

• configuration: object Configuration
  Request body for connector base url update
• description: object Description
• identifier: object Identifier
• lock: object Lock
• name: string

{
    "type":"object",
    "properties":{
        "identifier":{
            "$ref":"#/components/schemas/Identifier"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "$ref":"#/components/schemas/Description"
        },
        "configuration":{
            "$ref":"#/components/schemas/Configuration"
        },
        "lock":{
            "$ref":"#/components/schemas/Lock"
        }
    }
}

Nested Schema : Configuration

Type: object

Request body for connector base url update

Show Source

• baseUrl: string
  Value of base url which needs to be set

{
    "type":"object",
    "description":"Request body for connector base url update",
    "required":[
        "-baseUrl"
    ],
    "properties":{
        "baseUrl":{
            "type":"string",
            "description":"Value of base url which needs to be set"
        }
    }
}

Nested Schema : Description

Type: object

Show Source

• summary: string
• title: string

{
    "type":"object",
    "properties":{
        "title":{
            "type":"string"
        },
        "summary":{
            "type":"string"
        }
    }
}

Nested Schema : Identifier

Type: object

Show Source

• id: string (uuid)
• isnapshotIdd: string (uuid)
• projectId: string (uuid)

{
    "type":"object",
    "properties":{
        "projectId":{
            "type":"string",
            "format":"uuid"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "isnapshotIdd":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Nested Schema : Lock

Type: object

Show Source

• ownerId: string
• timestamp: string (date-time)

{
    "type":"object",
    "properties":{
        "ownerId":{
            "type":"string"
        },
        "timestamp":{
            "type":"string",
            "format":"date-time"
        }
    }
}

401 Response

Unauthorized

403 Response

Forbidden error

404 Response

Not found

500 Response

An internal error occurred.

Back to Top