機械翻訳について

移動先

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

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

post

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

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

リクエスト

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

• application/json

パス・パラメータ

• tpId(required): string
  取引先ID

本文()

取引先アウトバウンド契約リクエストを作成します。

例:

{ "name": "outagr", "desc": "out agr",	"docId":"DOC1",  "transportId":"TRANS123456",  "params":{      "validate":true,         "fa":true    }, "hostIdentifiersRef": [ {"id": 3730642141264966 }],        "tpIdentifiersRef": [{"id": 3710624275162543 }, {"id": 3710624275252203}]}

ルート・スキーマ : OutboundAgrRs

型: object

ソースを表示

• createdDate: string
• desc: string
• docDef: string
• docId: string
• docStd: string
• docTxId: string
• docVersion: string
• hostIdentifiersRef: array hostIdentifiersRef
• id: string
• lastDeployed: string
• links: array links
• name: string
• params: object Params
• status: string
• tpIdentifiersRef: array tpIdentifiersRef
• 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"
        },
        "updatedDate":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "lastDeployed":{
            "type":"string"
        },
        "tpIdentifiersRef":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IdentifierRs"
            }
        },
        "hostIdentifiersRef":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/HostIdentifierRs"
            }
        },
        "transportId":{
            "type":"string"
        },
        "transportName":{
            "type":"string"
        },
        "params":{
            "$ref":"#/definitions/Params"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: object HostIdentifierRs

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

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

型: array

ソースを表示

• Array of: object SuiteLink

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

ネストされたスキーマ : パラメータ

型: object

ソースを表示

• fa: boolean
• validate: boolean

{
    "type":"object",
    "properties":{
        "validate":{
            "type":"boolean",
            "xml":{
                "attribute":true
            }
        },
        "fa":{
            "type":"boolean",
            "xml":{
                "attribute":true
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: object IdentifierRs

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

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

型: object

ソースを表示

• id: string
• identifierType: string
• identifierValue: string
• links: array links

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "identifierType":{
            "type":"string"
        },
        "identifierValue":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: object SuiteLink

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

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

型: object

ソースを表示

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

• id: string
• identifierType: string
• identifierValue: string
• links: array links

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "identifierType":{
            "type":"string"
        },
        "identifierValue":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: object SuiteLink

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

成功した操作

本文()

ルート・スキーマ : OutboundAgrRs

型: object

ソースを表示

• createdDate: string
• desc: string
• docDef: string
• docId: string
• docStd: string
• docTxId: string
• docVersion: string
• hostIdentifiersRef: array hostIdentifiersRef
• id: string
• lastDeployed: string
• links: array links
• name: string
• params: object Params
• status: string
• tpIdentifiersRef: array tpIdentifiersRef
• 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"
        },
        "updatedDate":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "lastDeployed":{
            "type":"string"
        },
        "tpIdentifiersRef":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IdentifierRs"
            }
        },
        "hostIdentifiersRef":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/HostIdentifierRs"
            }
        },
        "transportId":{
            "type":"string"
        },
        "transportName":{
            "type":"string"
        },
        "params":{
            "$ref":"#/definitions/Params"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: object HostIdentifierRs

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

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

型: array

ソースを表示

• Array of: object SuiteLink

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

ネストされたスキーマ : パラメータ

型: object

ソースを表示

• fa: boolean
• validate: boolean

{
    "type":"object",
    "properties":{
        "validate":{
            "type":"boolean",
            "xml":{
                "attribute":true
            }
        },
        "fa":{
            "type":"boolean",
            "xml":{
                "attribute":true
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: object IdentifierRs

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

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

型: object

ソースを表示

• id: string
• identifierType: string
• identifierValue: string
• links: array links

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "identifierType":{
            "type":"string"
        },
        "identifierValue":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: object SuiteLink

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

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

型: object

ソースを表示

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

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

型: object

ソースを表示

• id: string
• identifierType: string
• identifierValue: string
• links: array links

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "identifierType":{
            "type":"string"
        },
        "identifierValue":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    }
}

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

型: array

ソースを表示

• Array of: object SuiteLink

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

201レスポンス

操作の成功

409レスポンス

重複データ・エラー

412レスポンス

事前条件失敗

500レスポンス

サーバー・エラー

先頭に戻る