移管文書の作成 v2
- 印刷する
- PDF
移管文書の作成 v2
- 印刷する
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
説明
顧客会社の文書を移行して作成します。
リクエスト URL
POST https://workplace.apigw.ntruss.com/workflow/apigw/v2/company/{companyId}/import/doc
リクエストヘッダ
| Header | Description |
|---|---|
| x-ncp-apigw-timestamp | - 1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもの - API Gatewayサーバとの時間差が5分以上の場合は、無効なリクエストとみなす |
| x-ncp-iam-access-key | - NAVERクラウドプラットフォームポータル{target=『_blank』}または Sub Accountから発行された Access Key ID |
| x-ncp-apigw-signature-v2 | - 上記例の Bodyを Access Key IDとマッピングされる Secret Keyで暗号化した署名 - HMAC暗号化アルゴリズムは HmacSHA256を使用 |
リクエスト Pathパラメータ
| パラメータ | タイプ | 容量 | 要否 | 説明 |
|---|---|---|---|---|
| companyId | String | 36 | Y | 連携キー(CompanyId) Developers > Default settings > Integration key |
リクエスト Bodyパラメータ
| パラメータ | タイプ | 容量 | 要否 | 説明 |
|---|---|---|---|---|
| docNo | String | 100 | Y | 文書番号 |
| dfmNm | String | 100 | Y | テンプレート名 |
| docTitle | String | 1000 | Y | タイトル |
| trgtUserNm | String | 1000 | Y | 申請人 |
| drftYmd | String | 8 | Y | 申請日(YYYYMMDD) |
| pdfFileId | String | 36 | N | 本文の PDF添付ファイル ID |
| registExternalKey | String | 36 | Y | 登録者 ID - 外部キー - workplaceの社員 IDまたは外部キー、ログイン IDの中から一つは必須 |
| registUserId | String | 36 | Y | 登録者の workplace ID - workplaceの社員 IDまたは外部キー、ログイン IDの中から一つは必須 |
| registLoginId | String | 36 | Y | 登録者のログイン ID - workplaceの社員 IDまたは外部キー、ログイン IDの中から一つは必須 |
| fileIdList | List | N | 添付ファイル ID | |
| aprvLineList | List | N | 承認フローの情報 - 承認フローの詳細リンク | |
| shreTargetTpCd | String | 20 | N | 共有対象(共有者情報を入力しないと共有されません) - user: 一部の対象者と共有 - comp: 対象者全員と共有 |
| shreTargetList | List | N | 共有者情報 - 共有者の詳細リンク |
承認フローの詳細
| パラメータ | タイプ | 容量 | 要否 | 説明 |
|---|---|---|---|---|
| aprvOrd | int | Y | 決裁の順序(1から順次記入) | |
| aprvUserNm | String | 1000 | Y | 決裁者名 |
| aprvDt | String | 20 | Y | 決裁日時(YYYY-MM-DD HH:MM:SS) |
共有者の詳細
| パラメータ | タイプ | 容量 | 要否 | 説明 |
|---|---|---|---|---|
| shreUserCompanyId | String | 36 | Y | 共有対象(user): 共有者の会社 ID |
| shreExternalKey | String | 36 | Y | 共有対象(user): 共有者の外部キー - workplaceの社員 IDまたは外部キー、ログイン IDの中から一つは必須 |
| shreUserId | String | 36 | Y | 共有対象(user): 共有者の workplace ID - workplaceの社員 IDまたは外部キー、ログイン IDの中から一つは必須 |
| shreLoginId | String | 36 | Y | 共有対象(user): 共有者のログイン ID - workplaceの社員 IDまたは外部キー、ログイン IDの中から一つは必須 |
| shreCompanyId | String | 36 | Y | 共有対象(comp): 共有会社 ID(有効な会社 ID) |
リクエスト例
POST /workflow/apigw/v2/company/e721e2da-29ee-4782-9672-3d2b150ac1a6/import/doc
HOST: workplace.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
{
"docNo": "2022-EX001",
"dfmNm": "一般起案紙",
"docTitle": "起案稟議書",
"trgtUserNm": "山田太郎",
"drftYmd": "20220820",
"pdfFileId": "dbee1643-4c3e-47de-9b42-4166a42705ed",
"registExternalKey": "",
"registUserId": "96b02530-82de-41c8-8223-3055c74e705e",
"registLoginId": "",
"fileIdList": [
"007d4fbc-dcaf-423c-9c15-fb3716be21e3",
"0218bd02-402c-4fee-ba16-385665e00b67"
],
"aprvLineList": [
{
"aprvOrd": 1,
"aprvUserNm": "山田太郎",
"aprvDt": "2022-08-21 15:00:00"
}
],
"shreTargetTpCd": "user",
"shreTargetList": [
{
"shreUserCompanyId" : "e721e2da-29ee-4782-9672-3d2b150ac1a6",
"shreExternalKey": "",
"shreUserId": "",
"shreLoginId": "admin@test.co.kr",
"shreCompanyId": ""
}
]
}
レスポンス
HTTPステータスコードでリターンされ、 Body情報として転送します。
| HTTPステータスコード | レスポンスメッセージ | 説明 |
|---|---|---|
| 200 | OK | 一般的なリクエスト成功 |
| 201 | Created | リソース作成成功に対するレスポンスコード |
| 400 | Bad Request | 一般的なリクエスト失敗に使用 |
| 500 | Internal Server Error | - 一般的なサーバエラーに対するレスポンスコード - 4XX番台のエラーコードは、クライアント側のエラーを表すために使用される - 5XX番台のエラーコードは、サーバ側のエラーを表すために使用される |
レスポンス例
HTTP/1.1 200 OK
Server: nginx
date: Sun21 Aug 2022 05:37:34 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34
{
"companyId": "e721e2da-29ee-4782-9672-3d2b150ac1a6",
"docId": "22541"
}
この記事は役に立ちましたか?