ファイル、画像フィールドのアップロード

POST /v1/fileField/attachments

このインターフェースは、ファイルフィールドの添付ファイルをアップロードするために使用され、一度に複数のファイルのアップロードをサポートします。リクエストボディは multipart/form-data タイプを使用します。現在サポートされている形式は、pdf、doc(docx)、xls(xlsx)、ppt(pptx)、png、jpg、jpeg、gif です。

リクエストパラメータ
パラメータ タイプ 必須 説明
dataId 整数 はい レコード ID.
objectApiName 文字列 はい レコードオブジェクトのAPI名称.
fieldApiName 文字列 はい フィールドのApiName名称.
レスポンスデータ
属性名 タイプ 説明
code 整数 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 表示可否, true / false .
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/fileField/attachments?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&dataId=1234&objectApiName=customApi&fieldApiName=description' -i -H 'Content-Type: multipart/form-data' -H 'Accept: application/json' -F 'file=helloWorld.pdf'
レスポンス例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}

ファイル、画像フィールドにアップロードされた添付ファイルリストの照会

GET /v1/fileField/attachments

このインターフェースは、ファイル、画像フィールドにアップロード済みの添付ファイルリストを照会します。

リクエストパラメータ
パラメータ タイプ 必須 説明
dataId 整数 はい レコード ID.
objectApiName 文字列 はい レコードオブジェクトのAPI名称.
fieldApiName 文字列 はい フィールドのApiName名称.
レスポンスデータ
属性名 タイプ 説明
code 整数 レスポンスコード.
message 文字列 レスポンスメッセージ.
visible ブール型 表示可否, true / false .
data 配列 ビジネスオブジェクト.
data[].docId 文字列 添付ファイルID識別子.
data[].name 文字列 添付ファイル名.
data[].size 文字列 添付ファイルサイズ.
data[].downloadAddress 文字列 ダウンロードアドレス.
リクエスト例
$ curl 'https://servicego.udesk.cn/api/v1/fileField/attachments?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&dataId=1234&objectApiName=customApi&fieldApiName=description' -i -H 'Content-Type: application/json' -H 'Accept: application/json'
レスポンス例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false
  "data" : [ {
    "docId" : "4f6adc8e1866f7dba9cd722c03b78d72",
    "name" : "helloWorld.pdf",
    "size" : 11
    "downloadAddress" : "http://www.udesk.cn"
  } ]
}

ファイル・画像フィールドの添付ファイル削除

PUT /v1/fileField/attachments/remove

このインターフェースは、ファイルまたは画像フィールドのレコード添付ファイルを削除するために使用されます。一度にそのフィールド下の複数のファイルを削除することができます。

リクエストパラメータ
パラメータ タイプ 必須 説明
dataId 整数型 はい レコード ID.
objectApiName 文字列型 はい レコードオブジェクトのAPI名称.
fieldApiName 文字列型 はい フィールドのApiName名称.
isClear 整数型 はい クリアするかどうか。0: いいえ, 1: はい.
docIds 文字列配列 いいえ 削除する docId の配列。isClear が 0 の場合、配列内に要素が必要です.
レスポンスデータ
属性名 タイプ 説明
code 整数型 レスポンスコード.
message 文字列型 レスポンスメッセージ.
visible ブール型 可視性。true / false .
リクエスト例
$ curl 'https://s-case3.udesk.cn/api/v1/fileField/attachments/remove?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&dataId=201516&objectApiName=jiandanshangpin&fieldApiName=tupian&isClear=0&docIds=269eeeb278b68dcf873fc2ac540e9e3c&docIds=5d8cd5de781265c628383955d4f38f7c' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json'
レスポンス例
{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}