モジュール名: connection

機能名 説明
list 指定するコネクション情報の一覧を取得します
show 指定するコネクション情報を取得します
create コネクション情報を作成します
copy コネクション情報を複製します
update コネクション情報を変更します
delete コネクション情報を削除します

機能名: list

説明

指定するコネクション情報の一覧を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/connection/list
リクエストパラメーター
パラメーター 必須 説明
type いいえ コネクションタイプを指定します。
  • rdb - RDB
  • http - HTTP
  • ftp - FTP
  • smtp - SMTP
  • pop3 - POP3
  • imap4 - IMAP4
  • aws - AWS
  • kintone - kintone
  • queue - Queue
  • jndi - JNDI
  • generic - 汎用
指定しなかった場合は全てのタイプを取得します。
userName いいえ 取得するユーザーコネクションのユーザー名を指定します。
ただし、ログインユーザー以外のユーザーコネクション情報を取得するためには、「administrator」あるいは「operator」の権限が必須です。
「userName」が指定された場合、「showAllUsers」は無視されて、指定されたユーザーのユーザーコネクション情報のみを取得します。
「userName」と「showAllUsers」の両方を指定しなかった場合、ログインユーザーのユーザーコネクション情報を取得します。
showAllUsers いいえ ログインユーザーが取得可能なすべてのユーザーコネクション情報を取得するには「true」を設定します。「false」あるいは未設定の場合は取得しません。
ただし、すべてのユーザーコネクション情報を取得するためには「administrator」あるいは「operator」の権限が必須です。
「userName」が指定された場合、「showAllUsers」は無視されて、指定されたユーザーのユーザーコネクション情報のみを取得します。
「userName」と「showAllUsers」の両方を指定しなかった場合、ログインユーザーのユーザーコネクション情報を取得します。
リクエスト例
指定するユーザーの情報を取得する場合
GET /mcapi/connection/list?type=rdb&userName=/guest HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
取得可能なすべてのユーザーの情報を取得する場合
GET /mcapi/connection/list?type=rdb&showAllUsers=true HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果(共通)

実行に成功するとシステムコネクション情報と指定したユーザーコネクション情報の一覧が返ります。
各種コネクション情報の共通の情報として、次の情報が取得できます。

以下に各種コネクション情報の内容と実行結果の例を記します。

実行結果(RDBの場合)

RDBの個別の情報としては次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "rdb": [
                    {
                        "name": "test_rdb",
                        "dbType": "Oracle(Thin)",
                        "url": "jdbc:oracle:thin:@oracle.test.com:53140:ORCL",
                        "userName": ""
                    },
                    {
                        "name": "test_rdb2",
                        "dbType": "DB2(app)",
                        "url": "jdbc:db2:db2_test",
                        "userName": "sa"
                    }
                ]
            },
            "user": {
            	"/guest": {
                    "rdb": [
                        {
                            "name": "test_conn",
                            "dbType": "DB2(app)",
                            "url": "jdbc:db2:user_test",
                            "userName": ""
                        }
                    ]
            	}
            }
        }
    }
}
取得可能なすべてのユーザーの情報を取得する場合
{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "rdb": [
                    {
                        "name": "test_rdb",
                        "dbType": "Oracle(Thin)",
                        "url": "jdbc:oracle:thin:@oracle.test.com:53140:ORCL",
                        "userName": ""
                    },
                    {
                        "name": "test_rdb2",
                        "dbType": "DB2(app)",
                        "url": "jdbc:db2:db2_test",
                        "userName": "sa"
                    }
                ]
            },
            "user": {
            	"/user1": {
                    "rdb": [
                        {
                            "name": "test_conn",
                            "dbType": "DB2(app)",
                            "url": "jdbc:db2:user_test",
                            "userName": ""
                        }
                    ]
            	},
            	"/domain1/user1": {
                    "rdb": [
                        {
                            "name": "test_conn",
                            "dbType": "DB2(app)",
                            "url": "jdbc:db2:user_test",
                            "userName": ""
                        }
                    ]
            	}
            }
        }
    }
}
実行結果(Httpの場合)

Httpの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "http": [
                    {
                        "name": "test_http",
                        "url": "http://www.httptest.com",
                        "userName": "test"
                    }
                ]
            }
        }
    }
}
実行結果(Ftpの場合)

Ftpの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "ftp": [
                    {
                        "name": "test_ftp",
                        "hostName": "test.ftp.com",
                        "protocol": "ftp",
                        "port": 21,
                        "userName": "test"
                    }
                ]
            }
        }
    }
}
実行結果(SMTPの場合)

SMTPの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "smtp": [
                    {
                        "name": "test_smtp_smtp",
                        "hostName": "test.smtp.com",
                        "port": 25,
                        "authenticationType": "SMTP"
                    },
                    {
                        "name": "test_smtp_pop3",
                        "hostName": "test.smtp.com",
                        "port": 25,
                        "authenticationType": "POP before SMTP"
                    },
                    {
                        "name": "test_smtp_none",
                        "hostName": "test.smtp.com",
                        "port": 25,
                        "authenticationType": "none"
                    }
                ]
            }
        }
    }
}
実行結果(POP3の場合)

POP3の個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "pop3": [
                    {
                        "name": "test_pop3",
                        "hostName": "test.pop3.com",
                        "port": 110,
                        "userName": "test"
                    }
                ]
            }
        }
    }
}
実行結果(IMAP4の場合)

IMAP4の個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "imap4": [
                    {
                        "name": "test_imap4",
                        "hostName": "test.imap4.com",
                        "port": 143,
                        "userName": "test",
                        "mailbox": "INBOX"
                    }
                ]
            }
        }
    }
}
実行結果(AWSの場合)

AWSの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "aws": [
                    {
                        "name": "test",
                        "accessKey": "accessKey",
                        "region": "region"
                    }
                ]
            }
        }
    }
}
実行結果(kintoneの場合)

kintoneの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "kintone": [
                    {
                        "name": "test",
                        "url": "https://test.cybozu.com/k/v1/",
                        "auth": "PASSWORD"
                    }
                ]
            }
        }
    }
}
実行結果(Queueの場合)

Queueの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "queue": [
                    {
                        "name": "test_queue",
                        "jndi": "test_jndi",
                        "userName": "test"
                    }
                ]
            }
        }
    }
}
実行結果(JNDIの場合)

JNDIの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "jndi": [
                    {
                        "name": "test_jndi",
                        "url": "test.jndi.com"
                    }
                ]
            }
        }
    }
}
実行結果(汎用の場合)
{
    "result": {
        "status": "success",
        "data": {
            "system": {
                "generic": [
                    {
                        "name": "test_generic"
                    }
                ]
            }
        }
    }
}
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

<
HTTPステータスコード エラーコード 説明
400 Bad Request 2001 パラメーター type の値が正しくなかった場合
403 Forbidden 3001 ログインしていなかった場合
3101 権限が不足していた場合
404 Not Found 4002 パラメーター userName で指定したユーザーが存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: show

説明

指定したコネクション情報を取得します。

権限

administrator、developer、operator

リクエスト
HTTPメソッド リクエストURL
GET http://{Hostname}:{Port}/mcapi/connection/show
リクエストパラメーター
パラメーター 必須 説明
type はい コネクションタイプを指定します。
  • rdb - RDB
  • http - HTTP
  • ftp - FTP
  • smtp - SMTP
  • pop3 - POP3
  • imap4 - IMAP4
  • aws - AWS
  • kintone - kintone
  • queue - Queue
  • jndi - JNDI
  • generic - 汎用
name はい コネクション名を指定します。
ownerType はい コネクション情報の種別を指定します。
「システムコネクション」の場合は「system」、「ユーザーコネクション」の場合は「user」を指定します。
userName いいえ 取得するユーザーコネクションのユーザー名を指定します。
指定しなかった場合はログインユーザーとなります。
リクエスト例
GET /mcapi/connection/show?type=rdb&name=test_conn HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果(共通)

実行に成功すると指定したコネクション情報が返ります。 各種コネクション情報の共通の情報として、次の情報が取得できます。

以下に各種コネクション情報の内容と実行結果の例を記します。

実行結果(RDBの場合)

RDBの個別の情報としては次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "rdb": {
                "name": "test_rdb",
                "dbType": "Oracle(Thin)",
                "url": "jdbc:oracle:thin:@oracle.test.com:53140:ORCL",
                "userName": "",
                "driver": "oracle.jdbc.OracleDriver",
                "schema": "",
                "pool": false,
                "xa": false,
                "dynamic": true
            }
        }
    }
}
実行結果(Httpの場合)

Httpの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "http": {
                "name": "test_http",
                "url": "http://www.httptest.com",
                "userName": "test",
                "encoding": "utf-8",
                "timeOut": 30,
                "useUserClientCert": true,
                "clientCertAlias": "alias",
                "proxyServer": false,
                "dynamic": false
            }
        }
    }
}
実行結果(Ftpの場合)

Ftpの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "ftp": {
                "name": "test_ftp",
                "hostName": "test.ftp.com",
                "protocol": "ftp",
                "port": 21,
                "userName": "anonymous",
                "encoding": "utf-8",
                "timeOut": 60,
                "keyFile": "file.key",
                "passiveMode": true,
                "dynamic": false
            }
        }
    }
}
実行結果(SMTP 「POP before SMTP認証」の場合)

SMTPの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "smtp": {
                "name": "test_smtp_pop3",
                "hostName": "test.smtp.com",
                "port": 25,
                "authenticationType": "POP before SMTP",
                "useSmtpOverSsl": false,
                "useStartTls": false,
                "pop3HostName": "test.smtp.com/pop3",
                "usePopOverSsl": false,
                "useStartTlsForPop": false,
                "pop3Port": 443,
                "userName": "test",
                "useApop": false,
                "pop3Interval": 5,
                "timeOut": 60,
                "dynamic": false
            }
        }
    }
}
実行結果(SMTP 「SMTP認証」の場合)

SMTPの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "smtp": {
                "name": "test_smtp_smtp",
                "hostName": "test.smtp.com",
                "port": 25,
                "authenticationType": "SMTP",
                "useSmtpOverSsl": true,
                "useStartTls": false,
                "userName": "",
                "smtpAuthenticationType": "plain",
                "timeOut": 60,
                "dynamic": true
            }
        }
    }
}
実行結果(SMTP 認証を行わない場合)

SMTPの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "smtp": {
                "name": "test_smtp_none",
                "hostName": "test.smtp.com",
                "port": 25,
                "authenticationType": "none",
                "useSmtpOverSsl": true,
                "useStartTls": true,
                "timeOut": 60,
                "dynamic": false
            }
        }
    }
}
実行結果(POP3の場合)

POP3の個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "pop3": {
                "name": "test_pop3",
                "hostName": "test.pop3.com",
                "port": 110,
                "userName": "test",
                "usePopOverSsl": true,
                "useStartTls": true,
                "authenticationType": "none",
                "timeOut": 60,
                "dynamic": false
            }
        }
    }
}
実行結果(IMAP4の場合)

IMAP4の個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "imap4": {
                "name": "test_imap4",
                "hostName": "test.imap4.com",
                "port": 143,
                "userName": "test",
                "mailbox": "INBOX",
                "useImap4OverSsl": false,
                "useStartTls": false,
                "timeOut": 60,
                "authenticationType": "none",
                "dynamic": false
            }
        }
    }
}
実行結果(AWSの場合)

AWSの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "aws": {
                "name": "test",
                "accessKey": "accessKey",
                "region": "region",
                "protocol": "HTTPS",
                "timeOut": 30,
                "useProxy": true,
                "pool": true,
                "dynamic": false
            }
        }
    }
}
実行結果(kintoneの場合)

kintoneの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "aws": {
                "name": "test",
                "url": "https://test.cybozu.com/k/v1/",
                "auth": "PASSWORD",
                "loginName": "testUser",
                "useBasicAuth": true,
                "basicAuthLoginName": "basicUser",
                "timeOut": 45,
                "useProxy": true,
                "dynamic": false
            }
        }
    }
}
実行結果(Queueの場合)

Queueの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "queue": {
                "name": "test_queue",
                "jndi": "test_jndi",
                "userName": "test",
                "queueConnectionFactory": "test_factory",
                "dynamic": false
            }
        }
    }
}
実行結果(JNDIの場合)

JNDIの個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "jndi": {
                "name": "test_jndi",
                "url": "test.jndi.com",
                "initialFactory": "jndi_factory",
                "parameters": {
                    "param1": "abc",
                    "param2": "123"
                },
                "connectionPool": true,
                "dynamic": false
            }
        }
    }
}
実行結果(汎用の場合)

汎用の個別の情報として次の情報が取得できます。

{
    "result": {
        "status": "success",
        "data": {
            "generic": {
                "name": "test_generic",
                "parameters": {
                    "param1": "abc"
                },
                "maskedParameters": [
                    "param2"
                ],
                "connectionPool": true,
                "dynamic": false
            }
        }
    }
}
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

HTTPステータスコード エラーコード 説明
400 Bad Request 2001 パラメーター type, ownerType の値が正しくなかった場合
2002 パラメーター type, ownerType, name の値が設定されていなかった場合
403 Forbidden 3001 ログインしていなかった場合
3101 権限が不足していた場合
3103 システムコネクションへのアクセスが拒否された場合
404 Not Found 4002 パラメーター userName で指定されたユーザーが存在しなかった場合
4005 パラメーター type, name で指定されたコネクション情報が存在しなかった場合
500 Internal Server Error 5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: create

説明

コネクション情報を作成します。

権限

administrator、developer

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/connection/create
リクエストパラメーター
パラメーター 必須 説明
ownerType はい コネクション情報の種別を指定します。
「システムコネクション」の場合は「system」、「ユーザーコネクション」の場合は「user」を指定します。
userName いいえ ユーザーコネクションのユーザー名を指定します。
ownerTypeが「user」のときのみ有効です。
指定しなかった場合はログインユーザーとなります。

リクエスト例
設定する情報は、showで取得できる形式の情報と同じ形式でリクエストのボディに設定します。
ただし、必要に応じてshowで表示されない「password」の情報と非表示パラメーターの値を設定します。
「password」情報
RDB
RDB
Http
Ftp
SMTP
POP3
IMAP4
AWS
kintone
Queue
必須項目
RDB
Http
Ftp
SMTP
POP3
IMAP4
AWS
kintone
Queue
JNDI
Generic
POST /mcapi/connection/create?ownerType=user&userName=/guest HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 217

{
    "rdb": {
        "name": "test",
        "dbType": "Oracle(Thin)",
        "url": "jdbc:oracle:thin:@oracle.test.com:53140:ORCL",
        "userName": "sa",
        "password": "",
        "driver": "oracle.jdbc.OracleDriver",
        "schema": "",
        "pool": true,
        "xa": false,
        "dynamic": false
    }
}
POST /mcapi/connection/create?ownerType=user&userName=/guest HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 139

{
    "generic": {
        "name": "test_generic",
        "parameters": {
            "param1": "abc"
        },
        "maskedParameters": {
            "param2": "123"
        },
        "connectionPool": true,
        "dynamic": false
    }
}
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功するとコネクション情報を作成します。

{
    "result": {
        "status": "success",
        "data": {}
    }
}
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

HTTPステータスコード エラーコード 説明
400 Bad Request 2001 パラメーター type, ownerType の値が正しくなかった場合
2002 パラメーター ownerType の値は設定されていなかった場合
2101 Jsonデータの値が正しくなかった場合
2102 Jsonデータの必須項目が入力されなかった場合
2103 Jsonデータの値のタイプが正しくなかった場合
2901 指定したコネクションの初期化でエラーが発生した場合
403 Forbidden 3001 ログインしていなかった場合
3101 権限が不足していた場合
3103 システムコネクションへのアクセスが拒否された場合
404 Not Found 4002 パラメーター userName で指定されたユーザーが存在しなかった場合
500 Internal Server Error 9002 設定ファイルの書き込みに失敗した場合
5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: copy

説明

コネクション情報を複製します。

権限

administrator、developer

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/connection/copy
リクエストパラメーター
パラメーター 必須 説明
type はい コネクションタイプを指定します。
  • rdb - RDB
  • http - HTTP
  • ftp - FTP
  • smtp - SMTP
  • pop3 - POP3
  • imap4 - IMAP4
  • aws - AWS
  • kintone - kintone
  • queue - Queue
  • jndi - JNDI
  • generic - 汎用
srcName はい 複製元のコネクション名を指定します。
destName はい 新しく作られる複製先のコネクション名を指定します。
ownerType はい コネクション情報の種別を指定します。
「システムコネクション」の場合は「system」、「ユーザーコネクション」の場合は「user」を指定します。
userName いいえ ユーザーコネクションのユーザー名を指定します。
ownerTypeが「user」のときのみ有効です。
指定しなかった場合はログインユーザーとなります。

リクエスト例
POST /mcapi/connection/copy?type=rdb&srcName=test_conn&destName=copy_test_conn&ownerType=user HTTP/1.1
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功するとコネクション情報を複製します。

{
    "result": {
        "status": "success",
        "data": {}
    }
}
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

HTTPステータスコード エラーコード 説明
400 Bad Request 2001 パラメーター type, ownerType の値が正しくなかった場合
2002 パラメーター ownerType の値が設定されていなかった場合
2901 指定したコネクションの初期化でエラーが発生した場合
2903 パラメーター destName で指定したコネクション情報がすでに存在していた場合
403 Forbidden 3001 ログインしていなかった場合
3101 権限が不足していた場合
3103 システムコネクションへのアクセスが拒否された場合
404 Not Found 4002 パラメーター userName で指定されたユーザーが存在しなかった場合
4005 パラメーター type, srcName で指定されたコネクション情報が存在しなかった場合
500 Internal Server Error 9002 設定ファイルの書き込みに失敗した場合
5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: update

説明

コネクション情報を変更します。

権限

administrator、developer

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/connection/update
リクエストパラメーター
パラメーター 必須 説明
type はい コネクションタイプを指定します。
  • rdb - RDB
  • http - HTTP
  • ftp - FTP
  • smtp - SMTP
  • pop3 - POP3
  • imap4 - IMAP4
  • aws - AWS
  • kintone - kintone
  • queue - Queue
  • jndi - JNDI
  • generic - 汎用
name はい コネクション名を指定します。
ownerType はい コネクション情報の種別を指定します。
「システムコネクション」の場合は「system」、「ユーザーコネクション」の場合は「user」を指定します。
userName いいえ 取得するユーザーコネクションのユーザー名を指定します。
ownerTypeが「user」のときのみ有効です。
指定しなかった場合はログインユーザーとなります。

リクエスト例
設定する情報は、createの設定情報と同じ形式でリクエストのボディに設定します。
更新する情報だけを設定します。
コネクション名を変更する場合は、パラメーター name に今のコネクション名を指定し、リクエストボディに新しいコネクション名を指定します。
POST /mcapi/connection/update?type=rdb&name=test&ownerType=user&userName=/guest HTTP/1.1
Content-Type: application/json; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 72

{
    "rdb": {
        "name": "test2",
        "password": "abc",
        "schema": "test",
        "dynamic": true
    }
}
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功するとコネクション情報を変更します。

{
    "result": {
        "status": "success",
        "data": {}
    }
}
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

HTTPステータスコード エラーコード 説明
400 Bad Request 2001 パラメーター type, ownerType の値が正しくなかった場合
2002 パラメーター type, ownerType, name の値は設定されていなかった場合
2101 Jsonデータの値が正しくなかった場合
2102 Jsonデータの必須項目が入力されなかった場合
2103 Jsonデータの値のタイプが正しくなかった場合
2108 Jsonデータのキーが正しくなかった場合
2901 指定したコネクションの初期化でエラーが発生した場合
403 Forbidden 3001 ログインしていなかった場合
3101 権限が不足していた場合
3103 システムコネクションへのアクセスが拒否された場合
404 Not Found 4002 パラメーター userName で指定されたユーザーが存在しなかった場合
4005 パラメーター type, name で指定されたコネクション情報が存在しなかった場合
500 Internal Server Error 9002 設定ファイルの書き込みに失敗した場合
5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ

機能名: delete

説明

コネクション情報を削除します。

権限

administrator、developer

リクエスト
HTTPメソッド リクエストURL
POST http://{Hostname}:{Port}/mcapi/connection/delete
リクエストパラメーター
パラメーター 必須 説明
type はい コネクションタイプを指定します。
  • rdb - RDB
  • http - HTTP
  • ftp - FTP
  • smtp - SMTP
  • pop3 - POP3
  • imap4 - IMAP4
  • aws - AWS
  • kintone - kintone
  • queue - Queue
  • jndi - JNDI
  • generic - 汎用
name はい コネクション名を指定します。
ownerType はい コネクション情報の種別を指定します。
「システムコネクション」の場合は「system」、「ユーザーコネクション」の場合は「user」を指定します。
userName いいえ 取得するユーザーコネクションのユーザー名を指定します。
ownerTypeが「user」のときのみ有効です。
指定しなかった場合はログインユーザーとなります。

リクエスト例
POST /mcapi/connection/delete HTTP/1.1
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
X-As-SessionId: 76B7EDBB1F14443FA538E62E05C5EEA4
Content-Length: 49

type=rdb&name=test&ownerType=user&userName=/guest
レスポンス
HTTPステータスコード

APIの実行が成功した場合、HTTPステータスコードは200が返ります。

実行結果

実行に成功するとコネクション情報を削除します。

{
    "result": {
        "status": "success",
        "data": {}
    }
}
エラーケース

下記以外のエラーについては、共通エラーコードを参照してください。

HTTPステータスコード エラーコード 説明
400 Bad Request 2001 パラメーター type, ownerType の値が正しくなかった場合
2002 パラメーター type, ownerType, name の値は設定されていなかった場合
403 Forbidden 3001 ログインしていなかった場合
3101 権限が不足していた場合
3103 システムコネクションへのアクセスが拒否された場合
404 Not Found 4002 パラメーター userName で指定されたユーザーが存在しなかった場合
4005 パラメーター type, name で指定されたコネクション情報が存在しなかった場合
500 Internal Server Error 9002 設定ファイルの書き込みに失敗した場合
5101 内部の通信に失敗した場合
5102 サーバー内部にエラーが発生した場合

▲ このページのトップへ