Jump to

• Request
• Response

Get Rich History Configuration

get

/api/v1/configuration/richHistoryConfig/{id}

Get a rich history database configuration. BPM administrators receive the full configuration. Instance administrators receive only `id`, `configName`, and `databaseType`.

Request

Path Parameters

• id(required): string
  unique Rich History config identifier

Header Parameters

• Authorization(required): string
  Bearer access token. Supply as: Bearer .

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : RichHistoryConfig

Type: object

Rich History database configuration. Returned passwords are masked. Oracle and MySQL use different conditional fields.

Show Source

• advanced: object RichHistoryAdvancedConfig
  Advanced rich history retention configuration.
• caCertFileBytes: string(byte)
  Request-only base64 MySQL CA certificate accepted by JSON create or update.
• caCertFileName: string
  MySQL CA certificate filename.
• configName: string
• connectionString: string
  Required for Oracle.
• databaseType: string
  Default Value: oracle

  Allowed Values: [ "oracle", "mysql" ]
• dbName: string
  MySQL database name. For Oracle, use connectionString.
• endpoint: string
  Required for MySQL.
• id: string
• password: string(password)
  Required for MySQL create; optional for update. Returned masked.
• retentionMode: string
  Allowed Values: [ "advanced" ]

  Required and must be advanced when useBlockchainTable is true.
• useBlockchainTable: boolean
• username: string
• walletArchiveBytes: string(byte)
  Request-only base64 Oracle wallet archive accepted by JSON create or update.
• walletArchiveName: string

{
    "description":"Rich History database configuration. Returned passwords are masked. Oracle and MySQL use different conditional fields.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "configName":{
            "type":"string"
        },
        "dbName":{
            "type":"string",
            "description":"MySQL database name. For Oracle, use <code>connectionString</code>."
        },
        "databaseType":{
            "type":"string",
            "enum":[
                "oracle",
                "mysql"
            ],
            "default":"oracle"
        },
        "username":{
            "type":"string"
        },
        "password":{
            "type":"string",
            "format":"password",
            "description":"Required for MySQL create; optional for update. Returned masked."
        },
        "connectionString":{
            "type":"string",
            "description":"Required for Oracle."
        },
        "endpoint":{
            "type":"string",
            "description":"Required for MySQL."
        },
        "useBlockchainTable":{
            "type":"boolean"
        },
        "retentionMode":{
            "type":"string",
            "enum":[
                "advanced"
            ],
            "description":"Required and must be advanced when <code>useBlockchainTable</code> is true."
        },
        "advanced":{
            "$ref":"#/definitions/RichHistoryAdvancedConfig"
        },
        "walletArchiveName":{
            "type":"string"
        },
        "walletArchiveBytes":{
            "type":"string",
            "format":"byte",
            "description":"Request-only base64 Oracle wallet archive accepted by JSON create or update."
        },
        "caCertFileName":{
            "type":"string",
            "description":"MySQL CA certificate filename."
        },
        "caCertFileBytes":{
            "type":"string",
            "format":"byte",
            "description":"Request-only base64 MySQL CA certificate accepted by JSON create or update."
        }
    }
}

Nested Schema : RichHistoryAdvancedConfig

Type: object

Advanced rich history retention configuration.

Show Source

• query: string

{
    "description":"Advanced rich history retention configuration.",
    "type":"object",
    "properties":{
        "query":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : AuthError

Type: object

Authentication or authorization error returned by request filters.

Show Source

• code(required): string
  Allowed Values: [ "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND" ]
• message(required): string

{
    "description":"Authentication or authorization error returned by request filters.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "enum":[
                "UNAUTHENTICATED",
                "FORBIDDEN",
                "NOT_FOUND"
            ]
        },
        "message":{
            "type":"string"
        }
    }
}

403 Response

Forbidden. The authenticated caller lacks a required global role, instance-access-group membership, or a valid CSRF token.

Body ()

Root Schema : AuthError

Type: object

Authentication or authorization error returned by request filters.

Show Source

• code(required): string
  Allowed Values: [ "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND" ]
• message(required): string

{
    "description":"Authentication or authorization error returned by request filters.",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "enum":[
                "UNAUTHENTICATED",
                "FORBIDDEN",
                "NOT_FOUND"
            ]
        },
        "message":{
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors: array errors
  list of errors
• message(required): string
  A human-readable error string.
• status(required): string
  A short error status that defines the error, meant for programmatic parsing.
• warnings: array warnings
  list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : Error

Type: object

Error Information.

Show Source

• errors: array errors
  list of errors
• message(required): string
  A human-readable error string.
• status(required): string
  A short error status that defines the error, meant for programmatic parsing.
• warnings: array warnings
  list of warnings

{
    "description":"Error Information.",
    "required":[
        "status",
        "message"
    ],
    "properties":{
        "status":{
            "description":"A short error status that defines the error, meant for programmatic parsing.",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string.",
            "type":"string"
        },
        "errors":{
            "type":"array",
            "description":"list of errors",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "description":"list of warnings",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : errors

Type: array

list of errors

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of errors",
    "items":{
        "type":"string"
    }
}

Nested Schema : warnings

Type: array

list of warnings

Show Source

• Array of: string

{
    "type":"array",
    "description":"list of warnings",
    "items":{
        "type":"string"
    }
}

Back to Top