Jump to

• Request
• Response
• Examples

Update the Base URL for a Connector

patch

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

Updates the base URL of a connector for a given application name, version, and connector Id.

Request

Path Parameters

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

Supported Media Types

• multipart/form-data

Request Body - multipart/form-data ()

Root Schema : schema

Type: object

Show Source

• body(required): object Configuration
  Request body for connector base url update

{
    "required":[
        "body"
    ],
    "type":"object",
    "properties":{
        "body":{
            "$ref":"#/components/schemas/Configuration"
        }
    }
}

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

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

409 Response

Connector is already locked by another user.

500 Response

An internal error occurred.

Back to Top

Examples

Example: Get the available global credentials for a connector

curl --location --request GET 'http://10.1.1.4/process/api/v1/design/applications/AWT/versions/1.0/connectors/12345/credentials/global' 
--header 'Content-Type: application/json' 
--header 'Authorization: Basic clMQ==' 
--data-raw

Example: Get the associated global credentials with a connector

curl --location --request GET 'http://10.1.1.4/process/api/v1/design/applications/BXT>/versions/2.0/connectors/12345/credentials/global' 
--header 'Content-Type: application/json' 
--header 'Authorization: Basic clMQ==' 
--data-raw

Example: Update credentials for a connector

url --location --request PATCH 'http://10.1.1.4/process/api/v1/design/applications/AZL/versions/3.0/connectors/324223/credentials/global/associate' 
--header 'Content-Type: application/json' 
--header 'Authorization: Basic clMQ==' 
--data-raw '{
   "mapName": "MAP1.0",
   "keyName": "KeyName",
   "type": "CUSTOM_KEY"
}'

Back to Top