レコードインターフェース - Udesk

レコード作成

POST /v1/data

リクエストパラメータ

パラメータ	タイプ	必須	説明
objectApiName	文字列	はい	対象オブジェクトのAPI名称.
fieldDataList	配列	はい	フィールドAPI名称とフィールド値のリスト.
fieldDataList[].fieldApiName	文字列	はい	フィールドAPI名称.
fieldDataList[].fieldValue	文字列	いいえ	フィールド値.
fieldDataList[].foreignExternalFieldApiName	文字列	いいえ	関連付けられたオブジェクトの外部一意フィールドAPI名称を指定します. フィールドタイプが参照の場合、必須ではありません。このフィールドが指定されない場合、fieldDataList[].fieldValueにはdataIdを指定する必要があります。

レスポンスデータ

属性名	タイプ	説明
code	整数型	レスポンスコード.
message	文字列	レスポンスメッセージ.
visible	ブール型	可視性. true / false .
data	オブジェクト	ビジネスオブジェクト.
data.id	整数型	新規作成されたレコードのID.

リクエスト例

$ curl 'https://servicego.udesk.cn/api/v1/data?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "objectApiName" : "contact",
  "fieldDataList" : [ {
    "fieldApiName" : "name",
    "fieldValue" : "テスト連絡先1"
  }, {
    "fieldApiName" : "organization",
    "fieldValue" : "顧客",
    "foreignExternalFieldApiName": "sysOrganizationNo"
  } ]
}'

レスポンス例

{
  "code" : 200,
  "visible" : false,
  "data" : {
    "id" : 61528
  }
}

レコード更新

PUT /v1/data

リクエストパラメータ

パラメータ	タイプ	必須	説明
objectApiName	文字列	はい	対象オブジェクトのAPI名称.
id	整数型	いいえ	レコードID. IDが空の場合、uniqueFieldApiNameとuniqueFieldValueは必須です。
uniqueFieldApiName	文字列	いいえ	外部一意フィールドAPI名称を指定します. uniqueFieldApiNameとuniqueFieldValueが空の場合、IDは必須です。
uniqueFieldValue	文字列	いいえ	uniqueFieldApiNameに対応する外部一意フィールドの値. uniqueFieldApiNameとuniqueFieldValueが空の場合、IDは必須です。
fieldDataList	配列	はい	フィールドAPI名称とフィールド値のリスト.
fieldDataList[].fieldApiName	文字列	はい	フィールドAPI名称.
fieldDataList[].fieldValue	文字列	いいえ	フィールド値.
fieldDataList[].foreignExternalFieldApiName	文字列	いいえ	関連付けられたオブジェクトの外部一意フィールドAPI名称を指定します. フィールドタイプが参照の場合、必須です。
##### レスポンスデータ

属性名	型	説明
code	整数型	レスポンスコード.
message	文字列	レスポンスメッセージ.
visible	ブール型	可視性. true / false .

リクエスト例

$ curl 'https://servicego.udesk.cn/api/v1/data?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "objectApiName" : "contact",
  "id" : 61530,
  "fieldDataList" : [ {
    "fieldApiName" : "name",
    "fieldValue" : "テスト連絡先2"
  }, {
       "fieldApiName" : "organization",
       "fieldValue" : "顧客",
       "foreignExternalFieldApiName": "sysOrganizationNo"
  } ]
}'

レスポンス例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}

レコードを検索する

GET /v1/data

リクエストパラメータ

パラメータ	型	必須	説明
objectApiName	文字列	いいえ	オブジェクトAPI_NAME. 一意フィールドで検索する場合は必須
id	整数型	いいえ	レコードID. IDが空の場合、uniqueFieldApiNameとuniqueFieldValueは必須
uniqueFieldApiName	文字列	いいえ	外部一意フィールドAPI名称. uniqueFieldApiNameとuniqueFieldValueが空の場合、IDは必須
uniqueFieldValue	文字列	いいえ	uniqueFieldApiNameに対応する外部一意フィールド値. uniqueFieldApiNameとuniqueFieldValueが空の場合、IDは必須

レスポンスデータ

属性名	型	説明
code	整数型	レスポンスコード.
message	文字列	レスポンスメッセージ.
visible	ブール型	可視性. true / false .
data	オブジェクト	ビジネスオブジェクト.
data.id	整数型	レコードID.
data.fieldDataList	配列	フィールド情報リスト.
data.fieldDataList[].fieldApiName	文字列	フィールドAPI名称.
data.fieldDataList[].fieldTypeApiName	文字列	フィールドAPI名称.
data.fieldDataList[].fieldValue	文字列	フィールド値.
data.fieldDataList[].foreignDataName	文字列	関連オブジェクトレコード名.
data.fieldDataList[].userEmail	文字列	関連スタッフメールアドレス.
data.fieldDataList[].optionNameList	配列	オプション名リスト(選択型フィールド).
data.fieldDataList[].tagValueList	配列	タグフィールド詳細情報(電話またはメール).
data.fieldDataList[].tagValueList[].tagName	文字列	タグ名.
data.fieldDataList[].tagValueList[].tagValue	文字列	タグ値.
data.fieldDataList[].richText	オブジェクト	リッチテキストフィールド詳細情報(内容および添付ファイル).
data.fieldDataList[].richText.content	文字列	リッチテキスト内容.
data.fieldDataList[].richText.attachmentList	配列	添付ファイルリスト.
data.fieldDataList[].richText.attachmentList[].name	文字列	元のファイル名.
data.fieldDataList[].richText.attachmentList[].docAddress	文字列	外部リンク.
data.fieldDataList[].richText.attachmentList[].size	整数型	サイズ.
data.fieldDataList[].ownerResult	オブジェクト	所有者.
data.fieldDataList[].ownerResult.ownerType	整数型	所有者タイプ.
data.fieldDataList[].ownerResult.ownerName	文字列	所有者名.
data.fieldDataList[].signDto	オブジェクト	署名情報.
data.fieldDataList[].signDto.url	文字列	署名画像URL.
data.fieldDataList[].signDto.time	文字列	署名日時.
##### リクエスト例

$ curl 'https://servicego.udesk.cn/api/v1/data?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&objectApiName=contact&id=61527' -i -H 'Content-Type: application/json' -H 'Accept: application/json'

レスポンス例

{
  "code" : 200,
  "visible" : false,
  "data" : {
    "id" : 61527,
    "fieldDataList" : [ {
      "fieldApiName" : "name",
      "fieldTypeApiName" : "field_type_single_line",
      "fieldValue" : "テスト連絡先03"
    }, {
      "fieldApiName" : "calcFormula",
      "fieldTypeApiName" : "field_type_formular",
      "fieldValue" : "15.00"
    }, {
      "fieldApiName" : "coordinate",
      "fieldTypeApiName" : "field_type_geography",
      "fieldValue" : ""
    } ]
  }
}

レコード削除

DELETE /v1/data

リクエストパラメータ

パラメータ	タイプ	必須	説明
objectApiName	文字列	はい	オブジェクトAPI_NAME.
id	整数	いいえ	レコードID. IDが空の場合、uniqueFieldApiNameとuniqueFieldValueは必須です。
uniqueFieldApiName	文字列	いいえ	外部ユニークフィールドAPI名称. uniqueFieldApiNameとuniqueFieldValueが空の場合、IDは必須です。
uniqueFieldValue	文字列	いいえ	uniqueFieldApiNameに対応する外部ユニークフィールド値. uniqueFieldApiNameとuniqueFieldValueが空の場合、IDは必須です。

レスポンスデータ

属性名	タイプ	説明
code	整数	レスポンスコード.
message	文字列	レスポンスメッセージ.
visible	ブール型	表示可否. true / false .

リクエスト例

$ curl 'https://servicego.udesk.cn/api/v1/data?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&objectApiName=contact&id=61529' -i -X DELETE -H 'Content-Type: application/json' -H 'Accept: application/json'

レスポンス例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}

レコードリストの検索

GET /v1/datas

このインターフェースはフィルターに依存してデータセットを検索し、取得したデータ結果セットは実際のフィルターの並び順と一致するように維持できます。少量のデータ検索に適しており、データ量の閾値が10,000以下の場合に有効です。大量のデータ検索が必要な場合は、GET /v1/datas/scroll インターフェースの使用を推奨します。

リクエストパラメータ

パラメータ	タイプ	必須	説明
pageNum	整数型	否	ページ番号 Min: 1 , デフォルト：1.
pageSize	整数型	否	ページサイズ Min: 1 , Max: 100 , デフォルト：20.
filterId	整数型	是	フィルターID.
objectApiName	文字列型	是	オブジェクトAPI_NAME.

レスポンスデータ

標準ページネーションオブジェクトページネーション

属性名	タイプ	説明
code	整数型	レスポンスコード.
message	文字列型	レスポンスメッセージ.
visible	ブール型	表示/非表示, true / false .
paging	オブジェクト	ページネーションオブジェクト.
paging.pageNum	整数型	ページネーションのページ番号.
paging.pageSize	整数型	ページネーションのページサイズ.
paging.total	整数型	ページネーション検索でヒットした総数.
data	配列	ビジネスオブジェクト.
data[].id	整数型	レコードID.
data[].createUser	文字列型	作成者名.
data[].createTime	文字列型	作成日時.
data[].updateUser	文字列型	最終更新者名.
data[].updateTime	文字列型	最終更新日時.
data[].owner	文字列型	所有者名.

リクエスト例

$ curl 'https://servicego.udesk.cn/api/v1/datas?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&objectApiName=contact&filterId=2&pageSize=20&pageNum=1' -i -H 'Content-Type: application/json' -H 'Accept: application/json'

レスポンス例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "paging": {
    "pageNum": 1,
    "pageSize": 20,
    "total": 50
  },
  "data" : [ {
    "id" : 46480,
    "createUser" : "zhangsan",
    "createTime" : "2019-11-12 15:52",
    "updateUser" : "zhangsan",
    "updateTime" : "2019-11-12 15:52",
    "owner" : "zhangsan"
  }, {
    "id" : 46476,
    "createUser" : "zhangsan",
    "createTime" : "2019-11-12 15:04",
    "updateUser" : "zhangsan",
    "updateTime" : "2019-11-12 15:08",
    "owner" : "zhangsan"
  }, {
    "id" : 46477,
    "createUser" : "zhangsan",
    "createTime" : "2019-11-12 15:04",
    "updateUser" : "zhangsan",
    "updateTime" : "2019-11-12 15:09",
    "owner" : "zhangsan"
  } ]
}

レコードリストのスクロールクエリ

GET /v1/datas/scroll

このインターフェースは、データセットのクエリをフィルターに依存させます。フィルターの条件のみを使用し、フィルターのソートは無視されるため、大量のデータをクエリするのに適しています。

リクエストパラメータ

パラメータ	タイプ	必須	説明
scrollId	整数型	否	スクロールレコードID Min: 0 , デフォルト: 0.
pageSize	整数型	否	ページサイズ Min: 1 , Max: 100 , デフォルト: 20.
filterId	整数型	是	フィルターID.
objectApiName	文字列型	是	オブジェクトAPI_NAME.

レスポンスデータ

標準ページネーションオブジェクトページネーション

属性名	タイプ	説明
code	整数型	レスポンスコード.
message	文字列型	レスポンスメッセージ.
visible	ブール型	表示/非表示, true / false .
paging	オブジェクト	ページネーションオブジェクト.
paging.pageNum	整数型	ページ番号.
paging.pageSize	整数型	ページサイズ.
paging.total	整数型	クエリでヒットした総数.
data	配列	ビジネスオブジェクト.
data[].id	整数型	レコードID.
data[].createUser	文字列型	作成者.
data[].createTime	文字列型	作成日時.
data[].updateUser	文字列型	最終更新者.
data[].updateTime	文字列型	最終更新日時.
data[].owner	文字列型	所有者.

リクエスト例

$ curl 'https://servicego.udesk.cn/api/v1/datas/scroll?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&objectApiName=contact&filterId=2&pageSize=20' -i -H 'Content-Type: application/json' -H 'Accept: application/json'

レスポンス例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "paging": {
    "pageNum": 1,
    "pageSize": 20,
    "total": 50
  },
  "data" : [ {
    "id" : 46433,
    "createUser" : "zhangsan",
    "createTime" : "2019-11-11 14:23",
    "updateUser" : "zhangsan",
    "updateTime" : "2019-11-11 14:23",
    "owner" : "zhangsan"
  }, {
    "id" : 46434,
    "createUser" : "zhangsan",
    "createTime" : "2019-11-11 16:52",
    "updateUser" : "zhangsan",
    "updateTime" : "2019-11-11 16:52",
    "owner" : "zhangsan"
  }, {
    "id" : 46436,
    "createUser" : "zhangsan",
    "createTime" : "2019-11-11 17:00",
    "updateUser" : "zhangsan",
    "updateTime" : "2019-11-11 17:00",
    "owner" : "zhangsan"
  } ]
}

検索クエリ記録

POST /v1/datas/search

このインターフェースは、複数の条件（フィールドApiName、演算子、フィールド値、検索ロジック）を使用して検索を行い、一致するレコードのリストを返します。少量のデータクエリに適しており、データ量の閾値が10,000以下の場合に有効です。大量のデータクエリが必要な場合は、GET /v1/datas/scrollインターフェースの使用をお勧めします。

このインターフェースがサポートするフィールドタイプと、各フィールドがサポートする演算子は以下の表をご覧ください。

演算子の説明

演算子	説明
is	等しい
not	等しくない
contains	含む
not_contains	含まない
is_null	空である
is_not_null	空でない
is_any	いずれかが等しい
not_any	いずれも等しくない
contains_any	いずれかを含む
not_contains_any	いずれも含まない
greater_than	より大きい
greater_than_eq	以上
less_than	より小さい
less_than_eq	以下
greater_than_current	現在より大きい
greater_than_eq_current	現在以上
eq_current	現在と等しい
less_than_current	現在より小さい
less_than_eq_current	現在以下

フィールドがサポートする演算子の列挙

フィールド	サポートする演算子
自動番号	is、not、contains、not_contains、is_null、is_not_null
単一行テキスト	is、not、contains、not_contains、is_null、is_not_null
複数行テキスト	is、not、contains、not_contains、is_null、is_not_null
単一選択	is、not、is_any、not_any、is_null、is_not_null
複数選択	is、not、is_any、not_any、is_null、is_not_null
カスケードフィールド	is、not、is_null、is_not_null、contains、not_contains
電話	is_any、not_any、contains_any、not_contains_any、is_null、is_not_null
メール	is_any、not_any、contains_any、not_contains_any、is_null、is_not_null
日付	is、not、is_null、is_not_null、greater_than、greater_than_eq、less_than、less_than_eq、greater_than_current、greater_than_eq_current、eq_current、less_than_current、less_than_eq_current
日時	is、not、is_null、is_not_null、greater_than、greater_than_eq、less_than、less_than_eq、greater_than_current、greater_than_eq_current、eq_current、less_than_current、less_than_eq_current
数値	is、not、greater_than、greater_than_eq、less_than、less_than_eq、is_null、is_not_null
参照型	is、not、is_null、is_not_null
従業員参照	is、not、is_null、is_not_null
複数従業員参照	is、not、is_null、is_not_null、is_any、not_any、contains_all、not_contains_all
全員	is、not、is_null、is_not_null
##### リクエストパラメータ

パラメータ	タイプ	必須	説明
pageNum	整数型	否	ページ番号 Min: 1 , デフォルト：1.
pageSize	整数型	否	ページサイズ Min: 1 , Max: 100 , デフォルト：20.
filterId	整数型	是	フィルターID(特殊フィルターはサポートされていません).
objectApiName	文字列	是	オブジェクトAPI_NAME.
judgeStrategy	整数型	否	高度な式タイプ。1: すべての条件を満たす； 2: いずれかを満たす； 3:カスタムロジック。デフォルト:1
customJudgeLogic	文字列	否	高度な式。judgeStrategyが3の場合、このフィールドを設定する必要があります.
conditionList	配列	否	条件配列.
conditionList[].fieldApiName	文字列	是	フィールドApiName.
conditionList[].operator	文字列	是	フィールド演算子.
conditionList[].value	文字列	否	フィールド値,複数の場合はカンマで区切ります.
keyword	文字列	否	検索文字列、最大30文字までサポート、超えた場合は切り捨てられます.

レスポンスデータ

標準ページングオブジェクトページング

属性名	タイプ	説明
code	整数型	レスポンスコード.
message	文字列	レスポンスメッセージ.
visible	ブール型	表示/非表示, true / false .
paging	オブジェクト	ページングオブジェクト.
paging.pageNum	整数型	ページングページ番号.
paging.pageSize	整数型	ページングページサイズ.
paging.total	整数型	ページングクエリヒット総数.
data	配列	ビジネスオブジェクト.
data[].id	整数型	レコードID.
data[].fieldDataList	配列	フィールド情報リスト.
data[].fieldDataList[].fieldApiName	文字列	フィールドAPI名称.
data[].fieldDataList[].fieldTypeApiName	文字列	フィールドAPI名称.
data[].fieldDataList[].fieldValue	文字列	フィールド値.
data[].fieldDataList[].foreignDataName	文字列	関連オブジェクトレコード名.
data[].fieldDataList[].userEmail	文字列	関連スタッフメールアドレス.
data[].fieldDataList[].optionNameList	配列	オプション名リスト(選択タイプフィールド).
data[].fieldDataList[].tagValueList	配列	タグフィールド詳細情報(電話またはメール).
data[].fieldDataList[].tagValueList[].tagName	文字列	タグ名.
data[].fieldDataList[].tagValueList[].tagValue	文字列	タグ値.
data[].fieldDataList[].richText	オブジェクト	リッチテキストフィールド詳細情報(内容および添付ファイル).
data[].fieldDataList[].richText.content	文字列	リッチテキスト内容.
data[].fieldDataList[].richText.attachmentList	配列	添付ファイルリスト.
data[].fieldDataList[].richText.attachmentList[].name	文字列	元のファイル名.
data[].fieldDataList[].richText.attachmentList[].docAddress	文字列	外部リンク.
data[].fieldDataList[].richText.attachmentList[].size	整数型	サイズ.
data[].fieldDataList[].ownerResult	オブジェクト	所有者.
data[].fieldDataList[].ownerResult.ownerType	整数型	所有者タイプ.
data[].fieldDataList[].ownerResult.ownerName	文字列	所有者名.
data[].fieldDataList[].signDto	オブジェクト	署名情報.
data[].fieldDataList[].signDto.url	文字列	署名画像URL.
data[].fieldDataList[].signDto.time	文字列	署名日時.
##### リクエスト例

$ curl 'https://servicego.udesk.cn/api/v1/datas/search?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -H 'Content-Type: application/json' -H 'Accept: application/json' -d
{
    "pageNum": 1,
    "pageSize": 20,
    "filterId": 2,
    "objectApiName": "contact",
    "judgeStrategy": 3,
    "customJudgeLogic":"1 or 2 and 3",
    "conditionList": [
        {
            "fieldApiName": "name",
            "operator": "is",
            "value": "test"
        },
        {
            "fieldApiName": "weiyibiaoshi",
            "operator": "contains",
            "value": "13"
        },
         {
             "fieldApiName": "youxiang",
             "operator": "contains_any",
             "value": "test@qq.com"
         }
    ]
}

レスポンス例

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 1,
        "total": 1
    },
    "data": [
        {
            "id": 5826,
            "fieldDataList": [
                {
                    "fieldApiName": "name",
                    "fieldTypeApiName": "field_type_single_line",
                    "fieldValue": "test"
                },
                {
                    "fieldApiName": "calcFormula",
                    "fieldTypeApiName": "field_type_formular",
                    "fieldValue": "15.00"
                },
                {
                    "fieldApiName": "coordinate",
                    "fieldTypeApiName": "field_type_geography",
                    "fieldValue": ""
                }
            ]
        }
    ]
}

スクロール検索によるレコード照会

POST /v1/datas/scrollSearch

このインターフェースは、複数の条件（フィールドApiName、演算子、フィールド値、検索ロジック）を使用して検索を行い、一致するレコードのリストを返します。インターフェースはデフォルトで実際の作成時間の昇順で対象結果セットを並べ替え、scrollIdフィールドはページングに使用できます。デフォルト値0で最初のページを照会し、以降の照会では前回の照会で返された最大IDを設定値とします。(シンプルな検索照会の要件には、GET /v1/datas/searchインターフェースの使用を推奨します)

このインターフェースがサポートするフィールドタイプと、各フィールドがサポートする演算子は以下の表の通りです。

演算子の説明

演算子	説明
is	等しい
not	等しくない
contains	含む
not_contains	含まない
is_null	空である
is_not_null	空でない
is_any	いずれかが等しい
not_any	いずれも等しくない
contains_any	いずれかを含む
not_contains_any	いずれも含まない
greater_than	より大きい
greater_than_eq	以上
less_than	より小さい
less_than_eq	以下
greater_than_current	現在より大きい
greater_than_eq_current	現在以上
eq_current	現在と等しい
less_than_current	現在より小さい
less_than_eq_current	現在以下

フィールドがサポートする演算子の列挙

フィールド	サポートする演算子
自動採番	is、not、contains、not_contains、is_null、is_not_null
単一行テキスト	is、not、contains、not_contains、is_null、is_not_null
複数行テキスト	is、not、contains、not_contains、is_null、is_not_null
単一選択	is、not、is_any、not_any、is_null、is_not_null
複数選択	is、not、is_any、not_any、is_null、is_not_null
電話番号	is_any、not_any、contains_any、not_contains_any、is_null、is_not_null
メールアドレス	is_any、not_any、contains_any、not_contains_any、is_null、is_not_null
日付	is、not、is_null、is_not_null、greater_than、greater_than_eq、less_than、less_than_eq、greater_than_current、greater_than_eq_current、eq_current、less_than_current、less_than_eq_current
日時	is、not、is_null、is_not_null、greater_than、greater_than_eq、less_than、less_than_eq、greater_than_current、greater_than_eq_current、eq_current、less_than_current、less_than_eq_current
数値	is、not、greater_than、greater_than_eq、less_than、less_than_eq、is_null、is_not_null
参照型	is、not、is_null、is_not_null
従業員参照	is、not、is_null、is_not_null
所有者	is、not、is_null、is_not_null
##### リクエストパラメータ

パラメータ	タイプ	必須	説明
scrollId	整数	いいえ	スクロールレコードID 最小: 0 , デフォルト: 0.
pageSize	整数	いいえ	ページサイズ最小: 1 , 最大: 100 , デフォルト：20.
filterId	整数	はい	フィルターID(特殊フィルターはサポートされていません).
objectApiName	文字列	はい	オブジェクトAPI_NAME.
judgeStrategy	整数	いいえ	高度な式タイプ。1: すべての条件を満たす； 2: いずれかを満たす； 3:カスタムロジック。デフォルト:1
customJudgeLogic	文字列	いいえ	高度な式。judgeStrategyが 3 の場合、このフィールドを設定する必要があります.
conditionList	配列	いいえ	条件配列.
conditionList[].fieldApiName	文字列	はい	フィールドApiName.
conditionList[].operator	文字列	はい	フィールド演算子.
conditionList[].value	文字列	いいえ	フィールド値,複数の場合はカンマで区切ります.

レスポンスデータ

標準ページングオブジェクトページング

プロパティ名	タイプ	説明
code	整数	レスポンスコード.
message	文字列	レスポンスメッセージ.
visible	ブール型	表示/非表示, true / false .
paging	オブジェクト	ページングオブジェクト.
paging.pageNum	整数	ページ番号.
paging.pageSize	整数	ページサイズ.
paging.total	整数	ページングクエリヒット総数.
data	配列	ビジネスオブジェクト.
data[].id	整数	レコードID.
data[].fieldDataList	配列	フィールド情報リスト.
data[].fieldDataList[].fieldApiName	文字列	フィールドAPI名称.
data[].fieldDataList[].fieldTypeApiName	文字列	フィールドAPI名称.
data[].fieldDataList[].fieldValue	文字列	フィールド値.
data[].fieldDataList[].foreignDataName	文字列	関連オブジェクトレコード名称.
data[].fieldDataList[].userEmail	文字列	関連従業員メールアドレス.
data[].fieldDataList[].optionNameList	配列	オプション名称リスト(選択タイプフィールド).
data[].fieldDataList[].tagValueList	配列	タグフィールド詳細情報(電話またはメール).
data[].fieldDataList[].tagValueList[].tagName	文字列	タグ名称.
data[].fieldDataList[].tagValueList[].tagValue	文字列	タグ値.
data[].fieldDataList[].richText	オブジェクト	リッチテキストフィールド詳細情報(内容および添付ファイル).
data[].fieldDataList[].richText.content	文字列	リッチテキスト内容.
data[].fieldDataList[].richText.attachmentList	配列	添付ファイルリスト.
data[].fieldDataList[].richText.attachmentList[].name	文字列	元のファイル名.
data[].fieldDataList[].richText.attachmentList[].docAddress	文字列	外部リンク.
data[].fieldDataList[].richText.attachmentList[].size	整数	サイズ.
data[].fieldDataList[].ownerResult	オブジェクト	所有者.
data[].fieldDataList[].ownerResult.ownerType	整数	所有者タイプ.
data[].fieldDataList[].ownerResult.ownerName	文字列	所有者名称.
data[].fieldDataList[].signDto	オブジェクト	署名情報.
data[].fieldDataList[].signDto.url	文字列	署名画像アドレス.
data[].fieldDataList[].signDto.time	文字列	署名時間.
##### リクエスト例

$ curl 'https://servicego.udesk.cn/api/v1/datas/scrollSearch?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -H 'Content-Type: application/json' -H 'Accept: application/json' -d
{
    "scrollId": 0,
    "pageSize": 20,
    "filterId": 2,
    "objectApiName": "contact",
    "judgeStrategy": 3,
    "customJudgeLogic":"1 or 2 and 3",
    "conditionList": [
        {
            "fieldApiName": "name",
            "operator": "is",
            "value": "test"
        },
        {
            "fieldApiName": "weiyibiaoshi",
            "operator": "contains",
            "value": "13"
        },
         {
             "fieldApiName": "youxiang",
             "operator": "contains_any",
             "value": "test@qq.com"
         }
    ]
}

レスポンス例

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 1,
        "total": 1
    },
    "data": [
        {
            "id": 5826,
            "fieldDataList": [
                {
                    "fieldApiName": "name",
                    "fieldTypeApiName": "field_type_single_line",
                    "fieldValue": "test"
                },
                {
                    "fieldApiName": "calcFormula",
                    "fieldTypeApiName": "field_type_formular",
                    "fieldValue": "15.00"
                },
                {
                    "fieldApiName": "coordinate",
                    "fieldTypeApiName": "field_type_geography",
                    "fieldValue": ""
                }
            ]
        }
    ]
}

パラメータ	タイプ	必須	説明
pageNum	整数型	いいえ	ページ番号 Min: 1 , デフォルト：1.
pageSize	整数型	いいえ	ページサイズ Min: 1 , Max: 100 , デフォルト：20.
dataId	整数型	はい	親オブジェクトレコードID.
filterId	整数型	はい	UIフィルターID.
objectApiName	文字列型	はい	子オブジェクトAPI_NAME.
parentObjectApiName	文字列型	はい	親オブジェクトAPI_NAME.

リッチテキストフィールドへのファイルアップロード

POST /v1/data/field/attachments

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

リクエストパラメータ

パラメータ	タイプ	必須	説明
id	整数型	否	レコードID。 IDが空の場合、objectApiName、uniqueFieldApiName、uniqueFieldValueは必須です。
objectApiName	文字列	否	レコードオブジェクトのAPI名称。 objectApiName、uniqueFieldApiName、uniqueFieldValueが空の場合、IDは必須です。
uniqueFieldApiName	文字列	否	外部ユニークフィールドのAPI名称を指定します。 objectApiName、uniqueFieldApiName、uniqueFieldValueが空の場合、IDは必須です。
uniqueFieldValue	文字列	否	uniqueFieldApiNameに対応する外部ユニークフィールドの値。 objectApiName、uniqueFieldApiName、uniqueFieldValueが空の場合、IDは必須です。
fieldApiName	文字列	是	フィールドのApiName名称。
##### レスポンスデータ

属性名	型	説明
code	整数型	レスポンスコード。
message	文字列	レスポンスメッセージ。
visible	ブール型	表示/非表示, true / false 。

リクエスト例

$ curl 'https://servicego.udesk.cn/api/v1/data/field/attachments?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&id=1234&fieldApiName=description' -i -H 'Content-Type: multipart/form-data' -H 'Accept: application/json' -F 'file=helloWorld.pdf'

レスポンス例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false
}

リッチテキストフィールドの添付ファイル削除

PUT /v1/data/field/attachments

このAPIは、リッチテキストフィールドのレコード添付ファイルを削除するために使用されます。複数のレコードのリッチテキストフィールドから複数のファイルを一度に削除することができます。

リクエストパラメータ

パラメータ	型	必須	説明
deleteAttachmentList	配列	はい	以下を含みます：レコードID、オブジェクトAPI名、ユニークフィールドAPI名、ユニークフィールド値、リッチテキストフィールドAPI名、削除対象の添付ファイルID配列。
deleteAttachmentList[].dataId	整数型	いいえ	レコードID。 IDが空の場合、objectApiName、uniqueFieldApiName、uniqueFieldValueは必須です。
deleteAttachmentList[].objectApiName	文字列	いいえ	レコードオブジェクトのAPI名。 objectApiName、uniqueFieldApiName、uniqueFieldValueが空の場合、IDは必須です。
deleteAttachmentList[].uniqueFieldApiName	文字列	いいえ	外部ユニークフィールドのAPI名を指定します。 objectApiName、uniqueFieldApiName、uniqueFieldValueが空の場合、IDは必須です。
deleteAttachmentList[].uniqueFieldValue	文字列	いいえ	uniqueFieldApiNameに対応する外部ユニークフィールドの値。 objectApiName、uniqueFieldApiName、uniqueFieldValueが空の場合、IDは必須です。
deleteAttachmentList[].richTextFieldApiName	文字列	はい	リッチテキストフィールドのAPI名。
deleteAttachmentList[].docIdList	文字列配列	いいえ	削除する添付ファイルのID配列。

レスポンスデータ

属性名	型	説明
code	整数型	レスポンスコード。
message	文字列	レスポンスメッセージ。
visible	ブール型	表示/非表示, true / false 。
data	オブジェクト	削除結果
data.successList	整数型配列	実行に成功したレコードIDの集合
data.failMap	オブジェクト	削除に失敗したデータの集合（失敗理由を含む）
data.total	整数型	データ総数
data.failTotal	整数型	削除に失敗したデータの総数
data.successTotal	整数型	削除に成功したデータの総数
##### リクエスト例

$ curl 'https://servicego.udesk.cn/api/v1/data/field/attachments?email=1@test.cn&timestamp=1581673901&sign=34e94a54a8c1191df3663aa4168461d58c0fe03c' -i -X PUT -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
  "deleteAttachmentList" : [ {
    "dataId" : 56643,
    "richTextFieldApiName" : "description",
    "docIdList" : ["361"]
  } ]
}'

レスポンス例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : {
    "successList" : [],
    "failMap" : {},
    "total" : 1,
    "failTotal" : 0,
    "successTotal" : 1
  }
}

リッチテキストフィールドにアップロードされた添付ファイルリストの取得

GET /v1/data/field/attachments

このインターフェースは、リッチテキストフィールドにアップロードされた添付ファイルのリストを取得します。

リクエストパラメータ

パラメータ	タイプ	必須	説明
id	整数型	否	レコードID. IDが空の場合、objectApiName、uniqueFieldApiName、uniqueFieldValueは必須です。
objectApiName	文字列	否	レコードオブジェクトのAPI名称. objectApiName、uniqueFieldApiName、uniqueFieldValueが空の場合、IDは必須です。
uniqueFieldApiName	文字列	否	外部ユニークフィールドのAPI名称を指定. objectApiName、uniqueFieldApiName、uniqueFieldValueが空の場合、IDは必須です。
uniqueFieldValue	文字列	否	uniqueFieldApiNameに対応する外部ユニークフィールドの値. objectApiName、uniqueFieldApiName、uniqueFieldValueが空の場合、IDは必須です。
fieldApiName	文字列	是	フィールドのApiName名称.

レスポンスデータ

属性名	タイプ	説明
code	整数型	レスポンスコード.
message	文字列	レスポンスメッセージ.
visible	ブール型	表示/非表示, true / false .
data	配列	ビジネスオブジェクト.
data[].docId	文字列	添付ファイルID識別子.
data[].name	文字列	添付ファイル名.
data[].size	文字列	添付ファイルサイズ.

リクエスト例

$ curl 'https://servicego.udesk.cn/api/v1/data/field/attachments?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&id=1234&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
  } ]
}

リッチテキストフィールド添付ファイルのダウンロードリンクを取得

GET /v1/data/field/attachments/url

このインターフェースは、リッチテキストフィールドの添付ファイルのダウンロードリンクを取得します。ダウンロードリンクにアクセスすることで添付ファイルをダウンロードできます。注意：ダウンロードリンクは一定時間後に無効になります。無効になった後は、このインターフェースを再度リクエストして新しいダウンロードリンクを取得する必要があります。

リクエストパラメータ

パラメータ	タイプ	必須	説明
id	整数型	いいえ	レコードID. IDが空の場合、objectApiName、uniqueFieldApiName、uniqueFieldValueは必須です。
objectApiName	文字列型	いいえ	レコードオブジェクトのAPI名称. objectApiName、uniqueFieldApiName、uniqueFieldValueが空の場合、IDは必須です。
uniqueFieldApiName	文字列型	いいえ	指定された外部ユニークフィールドのAPI名称. objectApiName、uniqueFieldApiName、uniqueFieldValueが空の場合、IDは必須です。
uniqueFieldValue	文字列型	いいえ	uniqueFieldApiNameに対応する外部ユニークフィールドの値. objectApiName、uniqueFieldApiName、uniqueFieldValueが空の場合、IDは必須です。
fieldApiName	文字列型	はい	フィールドのApiName名称.
docId	文字列型	はい	添付ファイルID識別子。フィールドにアップロードされた添付ファイルリストを取得から取得します。

レスポンスデータ

属性名	タイプ	説明
code	整数型	レスポンスコード.
message	文字列型	レスポンスメッセージ.
visible	ブール型	表示/非表示, true / false .
data	オブジェクト	ビジネスオブジェクト.
data.docUrl	文字列型	ダウンロードリンク。一定時間後に無効になることに注意してください。無効になった後は、このインターフェースを再度リクエストして新しいダウンロードリンクを取得する必要があります。

リクエスト例

$ curl 'https://servicego.udesk.cn/api/v1/data/field/attachments/url?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78&id=1234&fieldApiName=description&docId=4f6adc8e1866f7dba9cd722c03b78d72' -i -H 'Content-Type: application/json' -H 'Accept: application/json'

レスポンス例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false
  "data": {
          "docUrl": "https://xxx.xxx.com/url/xxx/helloWorld.pdf"
  }
}

ファイルアップロード

POST /v1/data/file/upload

このインターフェースはファイルのアップロードに使用され、一度に複数のファイルをアップロードすることができます。リクエストボディはmultipart/form-dataタイプを使用します。keyはファイルのシーケンス番号または一意の識別子であり、返却時にはこの識別子がkeyとして使用され、valueは生成されたリンクとなります。現在サポートされている形式：pdf、doc(docx)、xls(xlsx)、ppt(pptx)、txt、png、jpg、jpeg、gif形式のファイル。

リクエストパラメータ

レスポンスデータ

属性名	タイプ	説明
code	整数型	レスポンスコード.
message	文字列	レスポンスメッセージ.
visible	ブール型	表示/非表示, true / false .
data	Object	データ
data.urlMap	Object	keyは一意の識別子、valueは生成されたリンク

リクエスト例

curl --location --request POST 'https://servicego.udesk.cn/api/v1/data/file/upload?email=1@test.cn&timestamp={{timestamp}}&sign={{sign}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--form 'a=@/home/user/1/1.png' \
--form 'b=@/home/user/1/2.png'

レスポンス例

{
    "code": 200,
    "visible": false,
    "data": {
        "urlMap": {
            "a": "https://servicego.udesk.cn/backend/storage/resource/8bfc9fc1-d3c3-4726-a765-6b1d9674c8c5",
            "b": "https://servicego.udesk.cn/backend/storage/resource/ae85940e-fe1f-4a0c-9ffd-d5ea885540de"
        }
    }
}

ファイルオブジェクトへのアップロード

POST /v1/data/file/object

このAPIは、ファイルをファイルオブジェクトとしてアップロードするために使用されます。複数ファイルの一括アップロードをサポートし、リクエストボディはmultipart/form-dataタイプです。keyはファイルのシーケンス番号または一意の識別子であり、レスポンスではこの識別子がkeyとして使用され、valueは生成されたレコードIDとなります。現在サポートされている形式: pdf、doc(docx)、xls(xlsx)、ppt(pptx)、txt、png、jpg、jpeg、gif、mkv、mp4、avi、swf、wmv、rmvb、mov、mpg。

リクエストパラメータ

レスポンスデータ

属性名	タイプ	説明
code	整数型	レスポンスコード.
message	文字列	レスポンスメッセージ.
visible	ブール型	表示/非表示, true / false .
data	Object	データ
data.idMap	Object	keyは一意の識別子、valueは保存されたファイルオブジェクトID
##### リクエスト例

curl --location --request POST 'https://servicego.udesk.cn/api/v1/data/file/object?email=1@test.cn&timestamp={{timestamp}}&sign={{sign}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--form 'a=@/home/user/1/1.png' \
--form 'b=@/home/user/1/2.png'

レスポンス例

{
    "code": 200,
    "visible": false,
    "data": {
        "idMap": {
            "a": 58342,
            "b": 58341
        }
    }
}

ファイルオブジェクトをレコードの添付ファイルコンポーネントに関連付ける

POST /v1/data/file/relate

このAPIは、ファイルオブジェクトを指定されたオブジェクトの特定レコードの添付ファイルコンポーネントに関連付けるために使用されます。

リクエストパラメータ

属性名	型	必須	説明
fileId	整数	はい	ファイルオブジェクトID
relateObjectApiName	文字列	はい	ターゲットオブジェクトAPI名
relateDataId	整数	いいえ	ターゲットレコードID. IDが空の場合、uniqueFieldApiNameとuniqueFieldValueは必須です
uniqueFieldApiName	文字列	いいえ	外部ユニークフィールドAPI名を指定します. uniqueFieldApiNameとuniqueFieldValueが空の場合、IDは必須です
uniqueFieldValue	文字列	いいえ	uniqueFieldApiNameに対応する外部ユニークフィールドの値. uniqueFieldApiNameとuniqueFieldValueが空の場合、IDは必須です
tag	文字列	いいえ	添付ファイルタグ

レスポンスデータ

属性名	型	説明
code	整数	レスポンスコード.
message	文字列	レスポンスメッセージ.
visible	ブール型	可視性, true / false .

リクエスト例

curl --location --request POST 'https://servicego.udesk.cn/api/v1/data/file/relate?email={{account}}&timestamp={{timestamp}}&sign={{sign}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "fileId": 1,
    "relateObjectApiName": "case",
    "relateDataId":2
}'

レスポンス例

{
    "code": 200,
    "message": "OK",
    "visible": false
}

レコード添付ファイルコンポーネントの取得

GET /v1/data/file/relate

このインターフェースは、レコード添付ファイルコンポーネント内のコンポーネントリスト情報を取得するために使用されます。

リクエストパラメータ

パラメータ	タイプ	必須	説明
objectApiName	文字列	いいえ	オブジェクトAPI_NAME。一意フィールドで検索する場合は必須です。
id	整数型	いいえ	レコードID。IDが空の場合、uniqueFieldApiNameとuniqueFieldValueは必須です。
uniqueFieldApiName	文字列	いいえ	外部一意フィールドAPI名称。uniqueFieldApiNameとuniqueFieldValueが空の場合、IDは必須です。
uniqueFieldValue	文字列	いいえ	uniqueFieldApiNameに対応する外部一意フィールドの値。uniqueFieldApiNameとuniqueFieldValueが空の場合、IDは必須です。

レスポンスデータ

属性名	タイプ	説明
code	整数型	レスポンスコード。
message	文字列	レスポンスメッセージ。
visible	ブール型	表示/非表示, true / false 。
data[]	Object	データ
data[].name	文字列	ファイル名
data[].size	整数型	ファイルサイズ
data[].url	文字列	ファイルアクセスリンク

リクエスト例

curl --location --request GET 'https://servicego.udesk.cn/api/v1/data/file/relate?email=1@test.cn&timestamp={{timestamp}}&sign={{sign}}&id=57054' \
--header 'Content-Type: application/json'

レスポンス例

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "paging": {
        "pageNum": 1,
        "pageSize": 2,
        "total": 2
    },
    "data": [
        {
            "name": "製品.png",
            "size": 8847,
            "url": "https://servicego.udesk.cn/backend/storage/resource?req=1194"
        },
        {
            "name": "製品.png",
            "size": 8847,
            "url": "https://servicego.udesk.cn/backend/storage/resource?req=1195"
        }
    ]
}

Keys	Action
`?`	Open this help
`n`	Next page
`p`	Previous page
`s`	Search

パラメータ	タイプ	必須	説明
objectRelationId	整数型	はい	関連付けタイプID.
relatedDataIdList	整数型配列	はい	関連付けレコードIDの集合.

パラメータ	タイプ	必須	説明
majorDataId	整数型	はい	主レコードID.
relateDataId	整数型	はい	関連付けレコードID.
##### レスポンスデータ

レコード作成

リクエストパラメータ

レスポンスデータ

リクエスト例

レスポンス例

レコード更新

リクエストパラメータ

リクエスト例

レスポンス例

レコードを検索する

リクエストパラメータ

レスポンスデータ

レスポンス例

レコード削除

リクエストパラメータ

レスポンスデータ

リクエスト例

レスポンス例

レコードリストの検索

リクエストパラメータ

レスポンスデータ

リクエスト例

レスポンス例

レコードリストのスクロールクエリ

リクエストパラメータ

レスポンスデータ

リクエスト例

レスポンス例

検索クエリ記録

レスポンスデータ

レスポンス例

スクロール検索によるレコード照会

レスポンスデータ

レスポンス例

関連レコードリストの検索

リクエストパラメータ

レスポンスデータ

レスポンス例

リッチテキストフィールドへのファイルアップロード

リクエストパラメータ

リクエスト例

レスポンス例

リッチテキストフィールドの添付ファイル削除

リクエストパラメータ

レスポンスデータ

レスポンス例

リッチテキストフィールドにアップロードされた添付ファイルリストの取得

リクエストパラメータ

レスポンスデータ

リクエスト例

レスポンス例

リッチテキストフィールド添付ファイルのダウンロードリンクを取得

リクエストパラメータ

レスポンスデータ

リクエスト例

レスポンス例

ファイルアップロード

リクエストパラメータ

レスポンスデータ

リクエスト例

レスポンス例

ファイルオブジェクトへのアップロード

リクエストパラメータ

レスポンスデータ

レスポンス例

ファイルオブジェクトをレコードの添付ファイルコンポーネントに関連付ける

リクエストパラメータ

レスポンスデータ

リクエスト例

レスポンス例

レコード添付ファイルコンポーネントの取得

リクエストパラメータ

レスポンスデータ

リクエスト例

レスポンス例

関連付けの作成

パスパラメータ

リクエストパラメータ

レスポンスデータ

リクエスト例