Jump to

• Request
• Response

Associate a Global Credential With the Connector

patch

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

Associates a global credential with a connectorId.

Request

Path Parameters

• applicationName(required): string
  Application name
• connectorId(required): string(uuid)
  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

• file: string (binary)
  Choose application expx file to import
• json(required): object UpdateCredentialRequest
  Request body for connector credential update

{
    "required":[
        "json"
    ],
    "type":"object",
    "properties":{
        "json":{
            "$ref":"#/components/schemas/UpdateCredentialRequest"
        },
        "file":{
            "type":"string",
            "format":"binary",
            "description":"Choose application expx file to import"
        }
    }
}

Nested Schema : UpdateCredentialRequest

Type: object

Request body for connector credential update

Show Source

• keyName(required): string
  key name for the credential
• mapName(required): string
  map name of the credential
• type(required): string
  credential type

{
    "type":"object",
    "description":"Request body for connector credential update",
    "required":[
        "mapName",
        "keyName",
        "type"
    ],
    "properties":{
        "mapName":{
            "type":"string",
            "description":"map name of the credential"
        },
        "keyName":{
            "type":"string",
            "description":"key name for the credential"
        },
        "type":{
            "type":"string",
            "description":"credential type"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Associated credential successfully updated

Body ()

Root Schema : Snapshots

Type: object

Show Source

• count: number
• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Snapshot"
            }
        },
        "count":{
            "type":"number"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Snapshot

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Snapshot"
    }
}

Nested Schema : Snapshot

Type: object

Show Source

• audit: object Audit
• description: string
• id: string (uuid)
• name: string
• status: string
  Allowed Values: [ "IN_PROGRESS", "SUCCESSFUL", "FAILED" ]
• validation: string
  Allowed Values: [ "IN_PROGRESS", "SUCCESSFUL", "SUCCESSFUL_WITH_WARNINGS", "FAILED" ]

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "audit":{
            "$ref":"#/components/schemas/Audit"
        },
        "status":{
            "type":"string",
            "enum":[
                "IN_PROGRESS",
                "SUCCESSFUL",
                "FAILED"
            ]
        },
        "validation":{
            "type":"string",
            "enum":[
                "IN_PROGRESS",
                "SUCCESSFUL",
                "SUCCESSFUL_WITH_WARNINGS",
                "FAILED"
            ]
        }
    }
}

Nested Schema : Audit

Type: object

Show Source

• createdBy: string
• createdOn: string (date-time)

{
    "type":"object",
    "properties":{
        "createdBy":{
            "type":"string"
        },
        "createdOn":{
            "type":"string",
            "format":"date-time"
        }
    }
}

401 Response

Unauthorized

404 Response

Application not found.

409 Response

Connector is already locked by another user.

500 Response

An internal error occurred.

Back to Top