機械翻訳について

移動先

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

B2Bドキュメントの取得

get

/ic/api/b2b/v1/b2bdocuments/{documentId}

指定されたIDのB2Bドキュメントに関する詳細情報を取得します。

リクエスト

パス・パラメータ

• documentId(required): string

  b2bドキュメントを取得します。

  例:

  /b2b/v1/b2bdocuments/DOC123

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : DocumentUI

型: object

ソースを表示

• active: array active
  読取り専用: true
• activeAgr: array activeAgr
  読取り専用: true
• businessIdentifiers: object BusinessIdentifierUI
• count: integer(int32)
• createdBy: string
• createdDate: string
• desc: string
• id: string
• inActive: array inActive
  読取り専用: true
• inActiveAgr: array inActiveAgr
  読取り専用: true
• links: array links
• name: string
• partnerCnt: integer(int32)
• schema: string
• schemaName: string
• state: string
• std: string
• txId: string
• txName: string
• updatedBy: string
• updatedDate: string
• version: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "std":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "txId":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "txName":{
            "type":"string"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "schema":{
            "type":"string"
        },
        "schemaName":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "active":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/IntegrationResourceUI"
            }
        },
        "inActive":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/IntegrationResourceUI"
            }
        },
        "activeAgr":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/AgreementUI"
            }
        },
        "inActiveAgr":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/AgreementUI"
            }
        },
        "partnerCnt":{
            "type":"integer",
            "format":"int32"
        },
        "businessIdentifiers":{
            "$ref":"#/definitions/BusinessIdentifierUI"
        }
    }
}

ネストされたスキーマ : アクティブ

型: array

読取り専用: true

ソースを表示

• Array of: object IntegrationResourceUI

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/IntegrationResourceUI"
    }
}

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

型: array

読取り専用: true

ソースを表示

• Array of: object AgreementUI

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/AgreementUI"
    }
}

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

型: object

ソースを表示

• bizIdName1: string
• bizIdName2: string
• bizIdName3: string
• bizIdXpath1: string
• bizIdXpath2: string
• bizIdXpath3: string

{
    "type":"object",
    "properties":{
        "bizIdName1":{
            "type":"string"
        },
        "bizIdXpath1":{
            "type":"string"
        },
        "bizIdName2":{
            "type":"string"
        },
        "bizIdXpath2":{
            "type":"string"
        },
        "bizIdName3":{
            "type":"string"
        },
        "bizIdXpath3":{
            "type":"string"
        }
    }
}

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

型: array

読取り専用: true

ソースを表示

• Array of: object IntegrationResourceUI

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/IntegrationResourceUI"
    }
}

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

型: array

読取り専用: true

ソースを表示

• Array of: object AgreementUI

{
    "type":"array",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/AgreementUI"
    }
}

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

型: array

ソースを表示

• Array of: object SuiteLink

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

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

型: object

ソースを表示

• count: integer(int32)
• createdBy: string
• createdDate: string
• desc: string
• id: string
• links: array links
• name: string
• status: string
• std: string
• txId: string
• txName: string
• updatedBy: string
• updatedDate: string
• version: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "std":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "txId":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "txName":{
            "type":"string"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "status":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: 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"
        }
    }
}

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

型: object

ソースを表示

• agrID: string
• agrName: string
• count: integer(int32)
• createdBy: string
• createdDate: string
• deployStatus: string
• desc: string
• direction: string
• docId: string
• id: string
• links: array links
• name: string
• std: string
• tpId: string
• txId: string
• txName: string
• updatedBy: string
• updatedDate: string
• version: string

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "std":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "txId":{
            "type":"string"
        },
        "desc":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "updatedDate":{
            "type":"string"
        },
        "updatedBy":{
            "type":"string"
        },
        "txName":{
            "type":"string"
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "agrID":{
            "type":"string"
        },
        "agrName":{
            "type":"string"
        },
        "tpId":{
            "type":"string"
        },
        "docId":{
            "type":"string"
        },
        "direction":{
            "type":"string"
        },
        "deployStatus":{
            "type":"string"
        }
    }
}

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

型: array

ソースを表示

• Array of: object SuiteLink

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

400レスポンス

不正リクエスト

500レスポンス

サーバー・エラー

先頭に戻る