ParseEdifacts : /API/v2/Reports/ParseEdifacts

Venndor name

0000000000000_CyberPort(港湾物流分野)

System name

CyberPort

EDIFACT解析

Infomation
Category
Field
Governments
Data / Business logic
Paid / Free Free
Fees
Created by
Maintainer
Date created
Last updated
Update frequency
Necessity of contract Unnecessary
About contract
Version
Terms and Conditions

API List

APIDescription
DELETE /API/v2/Reports/ParseEdifacts/Delete/{parseEdifactId}

EDIFACT解析を削除します。 EDIFACT解析ID(***parseEdifactId***)を指定して、EDIFACT解析を削除します。 このAPIが削除するのは、EDFIACT解析を行った組織に所属している利用者、つまり、EDFIACT設定変換ID(***parseEdifactSettingId***)が示す組織に所属している利用者が行った解析についてとなります。 EDIFACT解析に関する詳細については、[EDIFACT解析について]()を参照ください。

GET /API/v2/Reports/ParseEdifacts/Get/{parseEdifactId}

EDIFACT解析を取得します。 EDIFACT解析ID(***parseEdifactId***)を指定して、EDIFACT解析を全て取得します。 このAPIは返却するのは、EDFIACT解析を行った組織に所属している利用者、つまり、EDFIACT設定変換ID(***parseEdifactSettingId***)が示す組織に所属している利用者が行った解析についてとなります。 EDIFACT解析に関する詳細については、[EDIFACT解析について]()を参照ください。

GET /API/v2/Reports/ParseEdifacts/GetEdifactMessage/{parseEdifactId}

EDIFACT解析を行うメッセージを取得します。 EDIFACT解析ID(***parseEdifactId***)を指定して、EDIFACT解析を行うメッセージを取得します。 このAPIは返却するのは、EDFIACT解析を行った組織に所属している利用者、つまり、EDFIACT設定変換ID(***parseEdifactSettingId***)が示す組織に所属している利用者が行った解析についてとなります。 EDIFACT解析に関する詳細については、[EDIFACT解析について]()を参照ください。

GET /API/v2/Reports/ParseEdifacts/GetList?organizationId=!{organizationId}&parseEdifactSettingId=!{parseEdifactSettingId}&fileName=!{fileName}&parseEdifactStatus=!{parseEdifactStatus}&requestedBy=!{requestedBy}&updatedAtFrom=!{updatedAtFrom}&updatedAtTo=!{updatedAtTo}

EDIFACT解析を全て取得します。 検索条件に該当するEDIFACT解析を全て取得します。 このAPIは返却するのは、EDFIACT解析を行った組織に所属している利用者、つまり、EDFIACT設定変換ID(***parseEdifactSettingId***)が示す組織に所属している利用者が行った解析についてとなります。 EDIFACT解析に関する詳細については、[EDIFACT解析について]()を参照ください。

GET /API/v2/Reports/ParseEdifacts/GetParsedMessage/{parseEdifactId}

解析されたEDIFACTメッセージを取得します。 EDIFACT解析ID(***parseEdifactId***)を指定して、解析されたEDIFACTメッセージを取得します。 このAPIは返却するのは、EDFIACT解析を行った組織に所属している利用者、つまり、EDFIACT設定変換ID(***parseEdifactSettingId***)が示す組織に所属している利用者が行った解析についてとなります。 EDIFACT解析に関する詳細については、[EDIFACT解析について]()を参照ください。

POST /API/v2/Reports/ParseEdifacts/Request

EDIFACTの解析を要求(登録)します。 指定されたEDFIACT設定変換ID(***parseEdifactSettingId***)を基に、EDIFACTメッセージを解析し、サイバーポートの帳票項目に変換します。 このAPIを呼び出せるのは、EDFIACT設定変換ID(***parseEdifactSettingId***)が示す組織に所属している利用者だけとなります。 EDIFACT解析に関する詳細については、[EDIFACT解析について]()を参照ください。

GET /API/v2/Reports/ParseEdifacts/Search?name=!{name}&value=!{value}

検索ポリシー設定に従い、EDIFACT解析結果を検索します。 検索ポリシー設定(***/API/v2/Organizations/ParseEdifactSettings/SearchPolicies***)のキーワード条件(name / value)を用いて、EDIFACT変換後の帳票データを検索します。 検索にあたっては、呼び出し元の利用者が所属する組織に対して設定された検索ポリシーを適用し、 検索を許可されたキーワードのみを条件として使用します。 また、検索結果は、検索ポリシーに定義された固定条件(value が * 以外の条件)のいずれかに一致するデータに限定されます。 EDIFACT解析に関する詳細については、[EDIFACT解析について]()を参照ください。