メインコンテンツまでスキップ

15) SOMファイルの生成

SOMファイルの生成

API

MethodURL
POST/api/som/createFile

Request Body

NameRequiredTypeDescription
licenseKeyrequiredstringSHIELDRM 管理者ページの連携アプリ管理メニューで発行されたライセンスを入力
srcFilePathrequiredstring元のファイルの絶対パス
- DSセキュリティ文書はsomファイルの生成をサポートしていません
- 該当文書が som ファイルの場合、ファイルをコピーした後に成功を返す
dstFilePathrequiredstring生成される外部転送セキュリティファイルの絶対パス
- ファイル拡張子はexeで表記する必要があります。
somSetRightsrequiredarrayStringSLSomFileLinker.DSSOMSetRights() 関数で設定した権限
propertiesrequiredjsondssom.propertiesで設定したオプション
decisionFactoroptionaljson登録された条件付きポリシーを適用するための追加情報の入力
(以下の decisionFactor データ説明表およびサンプルデータを参照)
somSetRights
indexTypeDescription
0stringパスワード文字列
- パスワードは英数字のみ可能
1int別名で保存する権限
2int印刷権限
3int読み回数
4int印刷回数
5int破棄権限
6int有効期限
7intOLESOM Viewer サポート
8int画像ビューアのサポート
9intText Viewerのサポート
10intUse UI Version(1, 2(Defaule;DS4.0))
11booleanUse Unicode(true(Default), False)
12string同じPCでのみMACアドレスがオープン可能です。
プロパティ (dssom.properties 参照)
NameTypeDescription
DSKEYENCRYPT_KEYstringSOM生成のための固定キー入力(EKDATA2)
...
decisionFactor データ説明表
KeyRequiredTypeDescription
userIdrequiredstring条件付きポリシーの構成員に該当する文書変換をリクエストしたユーザーID
ipAddressrequiredstring条件付きポリシーの位置(IP)に該当する文書変換をリクエストしたユーザーIP
  • サンプルデータ
{
"userId": "user1@socam.info",
"ipAddress": "10.10.10.100"
}

Response

NameTypeDescription
codeint0 : 成功
それ以外の値 : エラー
messagestring失敗時のエラーメッセージ

Examples

Request

  • Body
{
"licenseKey": "EFB4-19136-DB9E-201B9",
"srcFilePath": "D:\\opt\\shieldrm\\data\\test\\test.pptx",
"dstFilePath": "D:\\opt\\shieldrm\\data\\test\\test.exe",
"somSetRights": "[\"1111\",1,1,2,0,1,1,1,0,0,2,true,\"10-FF-E0-7F-06-C6\"]",
"properties": "{\"SiteInfo\":\"\",\"DocUIDWithoutMAC\":0,\"DSKEYENCRYPT_KEY\":\"EhH9NMxViK0XFXho/DEZZg==\",\"useDSvFive\":0,\"useAutoGenDocUID\":1,\"useHashDispersed\":1,\"LimitPwdFail\":0}",
"decisionFactor": "{\"userId\":\"user1@socam.info\",\"ipAddress\":\"10.10.10.100\"}"
}

Response

  • 成功
{
"code": 0,
"message": "OK"
}
  • 失敗
  • Status code : 500 INTERNAL_SERVER_ERROR
[SDF 컨테이너 모듈(SCSL) 에러]
{
"code": -61,
"message": "EXCEPTION error"
}