機械翻訳について

移動先

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

B2Bスキーマの作成

post

/ic/api/b2b/v1/schemas

指定されたID、名前、説明、標準、txIdおよびバージョンのB2Bスキーマを作成します。 標準値の例は、X12、EDIFACTです。 EDIFACTのバージョンの例は、D00A、D00Bなどで、X12は4010、4011などです。EDIFACTのtxId(またはトランザクション・タイプ)の例は、APERAK、AUTHORなどで、X12は100、850などです。

リクエスト

本文()

B2Bスキーマ・リクエストの詳細を作成します。

例:

{"id": "SCH123",	"name": "Sch123", "std": "X12", "version": "4010", "txId": "850", "desc": "Schema Document" }

ルート・スキーマ : SchemaUI

型: object

ソースを表示

• active: array active
  読取り専用: true
• activeAgr: array activeAgr
  読取り専用: true
• count: integer(int32)
• createdBy: string
• createdDate: string
• desc: string
• docNode: array docNode
• id: string
• inActive: array inActive
  読取り専用: true
• inActiveAgr: array inActiveAgr
  読取り専用: true
• links: array links
• maxSize: object MaxSize
• name: 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"
        },
        "docNode":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DocumentNode"
            }
        },
        "state":{
            "type":"string"
        },
        "active":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/DocumentUI"
            }
        },
        "inActive":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/DocumentUI"
            }
        },
        "maxSize":{
            "$ref":"#/definitions/MaxSize"
        },
        "activeAgr":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/AgreementUI"
            }
        },
        "inActiveAgr":{
            "type":"array",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/AgreementUI"
            }
        }
    }
}

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

型: array

読取り専用: true

ソースを表示

• Array of: object DocumentUI

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

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

型: array

読取り専用: true

ソースを表示

• Array of: object AgreementUI

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

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

型: array

ソースを表示

• Array of: object DocumentNode

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

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

型: array

読取り専用: true

ソースを表示

• Array of: object DocumentUI

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

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

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

型: object

ソースを表示

• cmnts: integer(int32)
• desc: integer(int32)
• notes: integer(int32)
• pos: boolean
• purpose: integer(int32)
• steps: integer(int32)
• txt: integer(int32)
• ver: number(float)

{
    "type":"object",
    "properties":{
        "purpose":{
            "type":"integer",
            "format":"int32"
        },
        "notes":{
            "type":"integer",
            "format":"int32"
        },
        "cmnts":{
            "type":"integer",
            "format":"int32"
        },
        "desc":{
            "type":"integer",
            "format":"int32"
        },
        "steps":{
            "type":"integer",
            "format":"int32"
        },
        "txt":{
            "type":"integer",
            "format":"int32"
        },
        "ver":{
            "type":"number",
            "format":"float"
        },
        "pos":{
            "type":"boolean"
        }
    }
}

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

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

型: object

ソースを表示

• attr: object DocumentModelUI
  識別子: objType
• children: array children

{
    "type":"object",
    "properties":{
        "attr":{
            "$ref":"#/definitions/DocumentModelUI"
        },
        "children":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DocumentNode"
            }
        }
    }
}

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

型: object

識別子: objType

ソースを表示

• cmnts: string
• getcRef: integer(int32)
• getnRef: integer(int32)
• getpRef: integer(int32)
• msk: boolean
• name: string
• notes: string
• objId: string
• objType: string
• posNo: string
• purpose: string
• r: boolean
• req: string
• rptCnt: string
• usage: string
• var: integer(int32)

{
    "type":"object",
    "discriminator":"objType",
    "properties":{
        "objId":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "objType":{
            "type":"string"
        },
        "rptCnt":{
            "type":"string"
        },
        "req":{
            "type":"string"
        },
        "usage":{
            "type":"string"
        },
        "purpose":{
            "type":"string"
        },
        "notes":{
            "type":"string"
        },
        "cmnts":{
            "type":"string"
        },
        "posNo":{
            "type":"string"
        },
        "msk":{
            "type":"boolean"
        },
        "var":{
            "type":"integer",
            "format":"int32"
        },
        "r":{
            "type":"boolean"
        },
        "getpRef":{
            "type":"integer",
            "format":"int32"
        },
        "getnRef":{
            "type":"integer",
            "format":"int32"
        },
        "getcRef":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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

型: array

ソースを表示

• Array of: object DocumentNode

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

成功した操作

本文()

ルート・スキーマ: schema

型: array

ソースを表示

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

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

型: object

201レスポンス

操作の成功

400レスポンス

不正なリクエスト、不正なパラメータ、または必須データがありません

409レスポンス

重複データ・エラー

412レスポンス

事前条件に失敗しました。名前の長さは50文字以下で、識別子の長さが32文字以下であること、復号化の長さが1024文字以下であること、識別子の長さが32文字以下であること、名前および識別子を標準またはデフォルトとして指定しないでください。また、std、versionおよびtxIdの有効な組合せが必要です

500レスポンス

サーバー・エラー

先頭に戻る