機械翻訳について

移動先

• リクエスト
• レスポンス

アウトバウンド契約の作成

post

/ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs

指定された取引先IDを持つアウトバウンド契約を作成します。 リクエスト本文には、少なくとも名前およびdocIdフィールドが含まれている必要があります。

リクエスト

パス・パラメータ

• tpId(required): string
  取引先ID

サポートされているメディア・タイプ

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

ソースを表示

• outboundAgrUI: OutboundAgrRs

{
    "type":"object",
    "properties":{
        "outboundAgrUI":{
            "$ref":"#/components/schemas/OutboundAgrRs"
        }
    }
}

ネストされたスキーマ : OutboundAgrRs

すべてに一致

ソースを表示

• allOf IdRs
• object GenericRestRs
• object OutboundAgrRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                },
                "name":{
                    "type":"string"
                },
                "desc":{
                    "type":"string"
                },
                "docStd":{
                    "type":"string"
                },
                "docVersion":{
                    "type":"string"
                },
                "docTxId":{
                    "type":"string"
                },
                "docDef":{
                    "type":"string"
                },
                "docId":{
                    "type":"string"
                },
                "status":{
                    "type":"string"
                },
                "createdDate":{
                    "type":"string"
                },
                "lastDeployed":{
                    "type":"string"
                },
                "updatedDate":{
                    "type":"string"
                },
                "tpIdentifiersRef":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/IdentifierRs"
                    }
                },
                "hostIdentifiersRef":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/HostIdentifierRs"
                    }
                },
                "transportName":{
                    "type":"string"
                },
                "params":{
                    "$ref":"#/components/schemas/OutboundAgr.Params"
                },
                "transportId":{
                    "type":"string"
                },
                "tpmVerson":{
                    "type":"string"
                },
                "batchEnabled":{
                    "type":"string"
                },
                "scheduleOperation":{
                    "type":"string"
                },
                "schedule":{
                    "$ref":"#/components/schemas/OutboundAgr.Schedule"
                }
            }
        }
    ]
}

ネストされたスキーマ : IdRs

すべてに一致

ソースを表示

• object GenericRestRs
• object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : GenericRestRs

型: object

ソースを表示

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

ネストされたスキーマ : IdRs-allOf[1]

型: object

ソースを表示

• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : OutboundAgrRs-allOf[2]

型: object

ソースを表示

• batchEnabled: string
• createdDate: string
• desc: string
• docDef: string
• docId: string
• docStd: string
• docTxId: string
• docVersion: string
• hostIdentifiersRef: array hostIdentifiersRef
• id: string
• lastDeployed: string
• name: string
• params: object OutboundAgr.Params
• schedule: object OutboundAgr.Schedule
• scheduleOperation: string
• status: string
• tpIdentifiersRef: array tpIdentifiersRef
• tpmVerson: string
• transportId: string
• transportName: string
• updatedDate: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "docStd":{
            "type":"string"
        },
        "docVersion":{
            "type":"string"
        },
        "docTxId":{
            "type":"string"
        },
        "docDef":{
            "type":"string"
        },
        "docId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "lastDeployed":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "tpIdentifiersRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IdentifierRs"
            }
        },
        "hostIdentifiersRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/HostIdentifierRs"
            }
        },
        "transportName":{
            "type":"string"
        },
        "params":{
            "$ref":"#/components/schemas/OutboundAgr.Params"
        },
        "transportId":{
            "type":"string"
        },
        "tpmVerson":{
            "type":"string"
        },
        "batchEnabled":{
            "type":"string"
        },
        "scheduleOperation":{
            "type":"string"
        },
        "schedule":{
            "$ref":"#/components/schemas/OutboundAgr.Schedule"
        }
    }
}

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object SuiteLink

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

ネストされたスキーマ : SuiteLink

型: object

ソースを表示

• href: string
• media-type: string
• method: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : hostIdentifiersRef

型: array

ソースを表示

• Array of: HostIdentifierRs

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

ネストされたスキーマ : OutboundAgr.Params

型: object

ソースを表示

• acceptGroup: string
• acceptGroupName: string
• fa: boolean
  faプロパティの値を取得します。考えられるオブジェクトはブールです
• rejectGroup: string
• rejectGroupName: string
• validate: boolean
  検証プロパティの値を取得します。使用可能なオブジェクトはブールです

{
    "type":"object",
    "properties":{
        "validate":{
            "type":"boolean",
            "description":"Gets the value of the validate property.\n \n     possible object is\n     Boolean"
        },
        "fa":{
            "type":"boolean",
            "description":"Gets the value of the fa property.\n \n     possible object is\n     Boolean"
        },
        "acceptGroup":{
            "type":"string"
        },
        "rejectGroup":{
            "type":"string"
        },
        "acceptGroupName":{
            "type":"string"
        },
        "rejectGroupName":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : OutboundAgr.Schedule

型: object

ソースを表示

• endDate: string
• frequency: object OutboundAgr.Schedule.Frequency
• name: string
• scheduleTZ: string
• scheduleTZDisplayName: string
• startDate: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "startDate":{
            "type":"string"
        },
        "endDate":{
            "type":"string"
        },
        "scheduleTZDisplayName":{
            "type":"string"
        },
        "scheduleTZ":{
            "type":"string"
        },
        "frequency":{
            "$ref":"#/components/schemas/OutboundAgr.Schedule.Frequency"
        }
    }
}

ネストされたスキーマ : tpIdentifiersRef

型: array

ソースを表示

• Array of: IdentifierRs

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

ネストされたスキーマ : HostIdentifierRs

すべてに一致

ソースを表示

• allOf IdRs
• object GenericRestRs
• object HostIdentifierRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                },
                "identifierType":{
                    "type":"string"
                },
                "identifierValue":{
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : HostIdentifierRs-allOf[2]

型: object

ソースを表示

• id: string
• identifierType: string
• identifierValue: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "identifierType":{
            "type":"string"
        },
        "identifierValue":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : OutboundAgr.Schedule.Frequency

型: object

ソースを表示

• frequencyType: string
• interval: string

{
    "type":"object",
    "properties":{
        "frequencyType":{
            "type":"string"
        },
        "interval":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : IdentifierRs

すべてに一致

ソースを表示

• allOf IdRs
• object GenericRestRs
• object IdentifierRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                },
                "identifierType":{
                    "type":"string"
                },
                "identifierValue":{
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : IdentifierRs-allOf[2]

型: object

ソースを表示

• id: string
• identifierType: string
• identifierValue: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "identifierType":{
            "type":"string"
        },
        "identifierValue":{
            "type":"string"
        }
    }
}

トップに戻る

レスポンス

サポートされているメディア・タイプ

• application/json

201レスポンス

操作の成功

本文()

ルート・スキーマ : OutboundAgrRs

すべてに一致

ソースを表示

• allOf IdRs
• object GenericRestRs
• object OutboundAgrRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                },
                "name":{
                    "type":"string"
                },
                "desc":{
                    "type":"string"
                },
                "docStd":{
                    "type":"string"
                },
                "docVersion":{
                    "type":"string"
                },
                "docTxId":{
                    "type":"string"
                },
                "docDef":{
                    "type":"string"
                },
                "docId":{
                    "type":"string"
                },
                "status":{
                    "type":"string"
                },
                "createdDate":{
                    "type":"string"
                },
                "lastDeployed":{
                    "type":"string"
                },
                "updatedDate":{
                    "type":"string"
                },
                "tpIdentifiersRef":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/IdentifierRs"
                    }
                },
                "hostIdentifiersRef":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/HostIdentifierRs"
                    }
                },
                "transportName":{
                    "type":"string"
                },
                "params":{
                    "$ref":"#/components/schemas/OutboundAgr.Params"
                },
                "transportId":{
                    "type":"string"
                },
                "tpmVerson":{
                    "type":"string"
                },
                "batchEnabled":{
                    "type":"string"
                },
                "scheduleOperation":{
                    "type":"string"
                },
                "schedule":{
                    "$ref":"#/components/schemas/OutboundAgr.Schedule"
                }
            }
        }
    ]
}

ネストされたスキーマ : IdRs

すべてに一致

ソースを表示

• object GenericRestRs
• object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : GenericRestRs

型: object

ソースを表示

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

ネストされたスキーマ : IdRs-allOf[1]

型: object

ソースを表示

• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : OutboundAgrRs-allOf[2]

型: object

ソースを表示

• batchEnabled: string
• createdDate: string
• desc: string
• docDef: string
• docId: string
• docStd: string
• docTxId: string
• docVersion: string
• hostIdentifiersRef: array hostIdentifiersRef
• id: string
• lastDeployed: string
• name: string
• params: object OutboundAgr.Params
• schedule: object OutboundAgr.Schedule
• scheduleOperation: string
• status: string
• tpIdentifiersRef: array tpIdentifiersRef
• tpmVerson: string
• transportId: string
• transportName: string
• updatedDate: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "docStd":{
            "type":"string"
        },
        "docVersion":{
            "type":"string"
        },
        "docTxId":{
            "type":"string"
        },
        "docDef":{
            "type":"string"
        },
        "docId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "lastDeployed":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "tpIdentifiersRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IdentifierRs"
            }
        },
        "hostIdentifiersRef":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/HostIdentifierRs"
            }
        },
        "transportName":{
            "type":"string"
        },
        "params":{
            "$ref":"#/components/schemas/OutboundAgr.Params"
        },
        "transportId":{
            "type":"string"
        },
        "tpmVerson":{
            "type":"string"
        },
        "batchEnabled":{
            "type":"string"
        },
        "scheduleOperation":{
            "type":"string"
        },
        "schedule":{
            "$ref":"#/components/schemas/OutboundAgr.Schedule"
        }
    }
}

ネストされたスキーマ: links

型: array

ソースを表示

• Array of: object SuiteLink

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

ネストされたスキーマ : SuiteLink

型: object

ソースを表示

• href: string
• media-type: string
• method: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : hostIdentifiersRef

型: array

ソースを表示

• Array of: HostIdentifierRs

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

ネストされたスキーマ : OutboundAgr.Params

型: object

ソースを表示

• acceptGroup: string
• acceptGroupName: string
• fa: boolean
  faプロパティの値を取得します。考えられるオブジェクトはブールです
• rejectGroup: string
• rejectGroupName: string
• validate: boolean
  検証プロパティの値を取得します。使用可能なオブジェクトはブールです

{
    "type":"object",
    "properties":{
        "validate":{
            "type":"boolean",
            "description":"Gets the value of the validate property.\n \n     possible object is\n     Boolean"
        },
        "fa":{
            "type":"boolean",
            "description":"Gets the value of the fa property.\n \n     possible object is\n     Boolean"
        },
        "acceptGroup":{
            "type":"string"
        },
        "rejectGroup":{
            "type":"string"
        },
        "acceptGroupName":{
            "type":"string"
        },
        "rejectGroupName":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : OutboundAgr.Schedule

型: object

ソースを表示

• endDate: string
• frequency: object OutboundAgr.Schedule.Frequency
• name: string
• scheduleTZ: string
• scheduleTZDisplayName: string
• startDate: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "startDate":{
            "type":"string"
        },
        "endDate":{
            "type":"string"
        },
        "scheduleTZDisplayName":{
            "type":"string"
        },
        "scheduleTZ":{
            "type":"string"
        },
        "frequency":{
            "$ref":"#/components/schemas/OutboundAgr.Schedule.Frequency"
        }
    }
}

ネストされたスキーマ : tpIdentifiersRef

型: array

ソースを表示

• Array of: IdentifierRs

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

ネストされたスキーマ : HostIdentifierRs

すべてに一致

ソースを表示

• allOf IdRs
• object GenericRestRs
• object HostIdentifierRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                },
                "identifierType":{
                    "type":"string"
                },
                "identifierValue":{
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : HostIdentifierRs-allOf[2]

型: object

ソースを表示

• id: string
• identifierType: string
• identifierValue: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "identifierType":{
            "type":"string"
        },
        "identifierValue":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : OutboundAgr.Schedule.Frequency

型: object

ソースを表示

• frequencyType: string
• interval: string

{
    "type":"object",
    "properties":{
        "frequencyType":{
            "type":"string"
        },
        "interval":{
            "type":"string"
        }
    }
}

ネストされたスキーマ : IdentifierRs

すべてに一致

ソースを表示

• allOf IdRs
• object GenericRestRs
• object IdentifierRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                },
                "identifierType":{
                    "type":"string"
                },
                "identifierValue":{
                    "type":"string"
                }
            }
        }
    ]
}

ネストされたスキーマ : IdentifierRs-allOf[2]

型: object

ソースを表示

• id: string
• identifierType: string
• identifierValue: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "identifierType":{
            "type":"string"
        },
        "identifierValue":{
            "type":"string"
        }
    }
}

409レスポンス

重複データ・エラー

412レスポンス

前提条件の失敗

500レスポンス

サーバー・エラー

先頭に戻る