ドキュメント API (1.0)

Download OpenAPI specification:Download

概要

本APIでは、docomo business RINK セキュアドWANのドキュメントリソース情報の参照・操作が可能です。

Documents

書類ダウンロードAPI

現地調査時の作業者候補リスト、宅内工事の作業候補者リスト、構内区間の現地調査結果報告書、工事結果報告書をダウンロードするAPI
ベストエフォートIPoEアクセスで利用

query Parameters

documentId

required

string ^[a-f0-9]{32}$

Example: documentId=1e115026499c42d783b53c04b4808f1e

書類ID。ダウンロードする対象の書類IDを指定する。

header Parameters

X-Auth-Token

required

string

クライアントが Keystone を利用して取得した認証 Token

Responses

200

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

get/v1/download-document

http://api.ntt.com/sdpf-ztgict/v1/download-document

Response samples

Content type

Copy

Expand all Collapse all


{"documentId": "1e115026499c42d783b53c04b4808f1e",
"decoding": "base64",
"content": "string",
"format": "pdf",
"md5": "string"
}

書類アップロードAPI

本人確認書類ファイル等をアップロードするAPI

header Parameters

X-Auth-Token

required

string ^[0-9a-f]{32}$

Example: dc03494823a841338430052e9ee95e07

クライアントが Keystone を利用して取得した認証 Token

Request Body schema: application/json

request body

encoding required	string Value: "base64"
content required	string <= 13000000 characters base64エンコーディングをしたファイルコンテンツ現調レスファイルのサイズ上限ファイルサイズ上限：3MB 文字列上限：3.999MB
format required	string Enum: "jpg" "png" "pdf" "xls" "xlsx" "zip" ファイルフォーマット。確認書類: jpg, png, pdf 現調レス図面: pdf, xls, xlsx, zip 地図情報ファイル: jpg, png, pdf
documentType required	string Enum: "identificationDocument" "fieldSurveyLessFile" "mapDocument" ドキュメントの種別。 service: mobileの場合に指定可能 identificationDocument: 確認書類 service: guaranteeの場合に指定可能 fieldSurveyLessFile: 現調レス図面 mapDocument: 地図情報ファイル
service required	string Enum: "guarantee" "mobile" サービス分類。 guarantee: ギャランティ mobile: モバイル

Responses

201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

post/v1/upload-document

http://api.ntt.com/sdpf-ztgict/v1/upload-document

Request samples

Payload

Content type

application/json

Copy

Expand all Collapse all


{"encoding": "base64",
"content": "string",
"format": "jpg",
"documentType": "identificationDocument",
"service": "mobile"
}

Response samples

Content type

application/json

Copy

Expand all Collapse all


{"documentId": "1e115026499c42d783b53c04b4808f1e",
"ref": "/v1/upload-document/1e115026499c42d783b53c04b4808f1e",
"creationTime": "2019-05-21T10:05:48+09:00",
"expireTime": "2019-05-21T10:05:48+09:00",
"encoding": "base64",
"size": 1024,
"content": "string",
"md5": "string",
"documentType": "identificationDocument"
}