フィールドタイプ説明

レコードを作成または更新する際は、フィールドタイプに応じて、以下の形式でデータを組み立ててください。

フィールドタイプ	タイプ名	フィールド値形式	説明
field_type_single_line	単行テキスト	"テスト_single_line"	テキスト型フィールド。長さは制限を超えないでください。
field_type_text_long	長文テキスト	"テスト_text_long"	テキスト型フィールド。長さは制限を超えないでください。
field_type_rich_text	リッチテキスト	"テスト_rich_text"	テキスト型フィールド。長さは制限を超えないでください。
field_type_multi_line	複数行テキスト	"テスト_multi_line"	テキスト型フィールド。長さは制限を超えないでください。
field_type_date	日付	"2020-01-01"	"yyyy-MM-dd"
field_type_date_time	日時	"2020-01-01 12:12:12"	"yyyy-MM-dd HH:mm:ss "、秒まで。
field_type_numeric	数値	"1"
field_type_telephone	電話	"13300000001,13300000002"	複数の番号はカンマで区切ります。 番号は有効である必要があります。 1. 携帯電話番号: "1[3456789]"で始まる 2. 電話番号: ハイフンを含まない 3. 400番号 4. 通信事業者番号: 10086, 10010, 10000
field_type_email	メールアドレス	"admin1@test.cn,admin2@test.cn"	複数のメールアドレスはカンマで区切ります。 メールアドレスは有効である必要があります。
field_type_single_listbox	単一選択リスト	"オプション名1"
field_type_multi_listbox	複数選択リスト	"オプション名1,オプション名2"	複数のオプションはカンマで区切ります。
field_type_auto_number	自動採番		自動採番フィールドはAPIによる変更をサポートしていません。
field_type_formular	計算式		計算式フィールドはAPIによる変更をサポートしていません。
field_type_lookup	ルックアップ型	"000001" "13300000001" "admin1@test.cn"	参照先オブジェクトの一意フィールドの値。foreignExternalFieldApiNameと組み合わせて使用する必要があります。foreignExternalFieldApiNameを指定しない場合、fieldDataList[].fieldValueにはdataIdを渡してください。
field_type_staff	担当者検索	"admin3@test.cn"	担当者のメールアドレス。
field_type_percent	パーセント	"0.3"	元の値。例：30%の場合は0.3を渡します。
field_type_owner	所有者		所有者フィールドはAPIによる変更をサポートしていません。
field_type_work_time	作業時間	"テスト作業時間01"
field_type_geography	座標	"116.1884784900,39.9902888700"	経度、緯度の順で、カンマで区切ります。
field_type_wechat	WeChat		"公式アカウントID,OpenId"、カンマ区切り。
field_type_sign	署名		署名フィールドはAPIによる変更をサポートしていません。
field_type_voice	音声		音声フィールドはAPIによる変更をサポートしていません。
field_type_lead_pool	リードプール	"テストリードプール01"
field_type_statistics	統計		統計フィールドはAPIによる変更をサポートしていません。
field_type_timer	タイマー		タイマーフィールドはAPIによる変更をサポートしていません。
field_type_cascade	カスケード	"オプション1,オプション11"	"親オプション名,子オプション名"、英語のカンマで区切ります。
field_type_customize_structure	カスタム	"{\"values\":[]}"	カスタムフィールドの値
#### フィールドリストの取得

GET /v1/fields

リクエストパラメータ

パラメータ	タイプ	必須	説明
objectApiName	文字列	はい	オブジェクトのAPI_NAME.

レスポンスデータ

属性名	タイプ	説明
code	整数	レスポンスコード.
message	文字列	レスポンスメッセージ.
visible	ブール型	表示可否, true / false .
data	配列	ビジネスオブジェクト.
data[].id	整数	フィールドID.
data[].label	文字列	表示名.
data[].apiName	文字列	API名.
data[].fieldTypeName	文字列	フィールドタイプ.
data[].permissionCode	整数	フィールド権限コード：1非表示；2読み取り専用；3必須；4任意.
data[].optionList	配列	単一選択または複数選択フィールドのオプション情報
data[].optionList[].id	整数	オプションID
data[].optionList[].name	文字列	オプション名

リクエスト例

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

レスポンス例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : [ {
    "id" : 7,
    "label" : "氏名",
    "apiName" : "name",
    "fieldTypeName" : "単一行テキスト",
    "permissionCode" : 3,
    "optionList":[]
  }, {
    "id" : 13,
    "label" : "メールアドレス",
    "apiName" : "mailAddress",
    "fieldTypeName" : "Eメール",
    "permissionCode" : 4,
    "optionList":[]
  }, {
    "id" : 14,
    "label" : "電話番号",
    "apiName" : "phone",
    "fieldTypeName" : "電話",
    "permissionCode" : 4
    "optionList":[]
  }, {
    "id" : 15,
    "label" : "性別",
    "apiName" : "gender",
    "fieldTypeName" : "性別",
    "permissionCode" : 4
    "optionList":[ {
            "id": 1,
            "name": "男性"
        }, {
            "id": 2,
            "name": "女性"
        } ]
  } ]
}

一部のフィールドを検索

POST /v1/fields

リクエストパラメータ

パラメータ	タイプ	必須	説明
objectApiName	文字列	はい	オブジェクトAPI_NAME.
fieldApiNameList	配列	いいえ	フィールドAPI_NAME配列

レスポンスデータ

属性名	タイプ	説明
code	整数	レスポンスコード.
message	文字列	レスポンスメッセージ.
visible	ブール型	表示可否, true / false .
data	配列	ビジネスオブジェクト.
data[].id	整数	フィールドID.
data[].label	文字列	表示名.
data[].apiName	文字列	API名.
data[].fieldTypeName	文字列	フィールドタイプ.
data[].permissionCode	整数	フィールド権限コード：1非表示；2読み取り専用；3必須；4任意.
data[].optionList	配列	単一選択または複数選択フィールドのオプション情報
data[].optionList[].id	整数	オプションID
data[].optionList[].name	文字列	オプション名

リクエスト例

$ curl 'https://servicego.udesk.cn/api/v1/fields?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
    "objectApiName":"case",
    "fieldApiNameList":["name","mailAddress","phone","gender"]
}'

レスポンス例

{
  "code" : 200,
  "message" : "OK",
  "visible" : false,
  "data" : [ {
    "id" : 7,
    "label" : "氏名",
    "apiName" : "name",
    "fieldTypeName" : "単行テキスト",
    "permissionCode" : 3,
    "optionList":[]
  }, {
    "id" : 13,
    "label" : "メールアドレス",
    "apiName" : "mailAddress",
    "fieldTypeName" : "Eメール",
    "permissionCode" : 4,
    "optionList":[]
  }, {
    "id" : 14,
    "label" : "電話番号",
    "apiName" : "phone",
    "fieldTypeName" : "電話",
    "permissionCode" : 4
    "optionList":[]
  }, {
    "id" : 15,
    "label" : "性別",
    "apiName" : "gender",
    "fieldTypeName" : "性別",
    "permissionCode" : 4
    "optionList":[ {
            "id": 1,
            "name": "男性"
        }, {
            "id": 2,
            "name": "女性"
        } ]
  } ]
}

フィールド情報を更新する

PUT /v1/field

リクエストパラメータ

パラメータ	タイプ	必須	説明
id	整数型	はい	フィールドID.
fieldType	整数型	はい	フィールドタイプ
customizeStructure	文字列型	いいえ	fieldTypeが35（カスタムフィールド）の場合、このフィールド情報を使用します

レスポンスデータ

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

リクエスト例

curl --location --request PUT 'http://servicego.udesk.cn/v1/field?email=1@test.cn&timestamp=1608114461&sign=74cfd90f2e7a62d5cba147719f014d6a94d325a3' \
--header 'Content-Type: application/json' \
--data-raw '{
  "customizeStructure": "[{}]",
  "fieldType": 35,
  "id": 26745
}'

レスポンス例

成功レスポンス：
{
    "code": 200,
    "visible": false,
    "message": "OK"
}
失敗レスポンス：
{
    "code": 400,
    "message": "フィールドタイプは空にできません！",
    "visible": true
}

フィールドオプション値の作成

単一選択、複数選択、およびカスケードフィールドのオプション値を作成します。

POST /v1/fields/options

リクエストパラメータ

パラメータ	タイプ	必須	説明
objectApiName	文字列	はい	カスタムオブジェクトAPI名称
fieldDataList[]	オブジェクト配列	はい	フィールド情報
fieldDataList[].fieldApiName	文字列	はい	オブジェクトカスタムフィールドAPI名称、単一選択フィールド、複数選択フィールド、カスケードフィールドのみサポート
fieldDataList[].options[]	文字列配列	はい	フィールドオプション値、各文字列は1つのオプション値を表します。カスケードフィールドは英語のコロンを使用します。

レスポンスデータ

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

リクエスト例

$ curl 'https://servicego.udesk.cn/api/v1/fields/options?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{
    "objectApiName":"case",
    "fieldDataList":[{
        "fieldApiName":"level",
        "options":["一星级", "二星级","三星级"]
    },{
        "fieldApiName":"cascadeField",
        "options":["北京:海淀", "北京:西城","上海"]
    }]
}'

レスポンス例

成功レスポンス：
{
    "code": 200,
    "visible": false,
    "message": "OK"
}
失敗レスポンス：
{
    "code": 400,
    "message": "オブジェクトApiNameは空にできません",
    "visible": true
}

カスケード関係のクエリ

GET /v1/cascadeFields/{ids}

リクエストパラメータ

パラメータ	タイプ	必須	説明
ids	String	はい	カスケード関係ID。複数の場合は英語のカンマで区切ります

レスポンスデータ

属性名	タイプ	説明
code	整数	レスポンスコード.
message	文字列	レスポンスメッセージ.
visible	ブール型	表示/非表示, true / false .
data	配列	ビジネスオブジェクト.
data.name	文字列	カスケード関係名.
data.id	整数	カスケード関係ID.
data.supperFieldId	整数	上位フィールドID.
data.supperFieldName	文字列	上位フィールド名.
data.subFieldId	整数	下位フィールドID.
data.subFieldName	文字列	下位フィールド名.
data.objectId	整数	カスケード関係に対応するオブジェクトID.
data.relationList	配列	カスケード関係.
data.relationList[].supperId	整数	上位フィールドオプションID.
data.relationList[].subIdList[]	配列	下位フィールドオプションIDリスト.

リクエスト例

$ curl 'https://servicego.udesk.cn/api/v1/cascadeFields/3?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b7&cascadeId=3&customObjectId=15 -i -H 'Content-Type: application/json' -H 'Accept: application/json'

レスポンス例

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "data": [
        {
            "name": "カスケード関係",
            "supperFieldId": 428,
            "supperFieldName": "カスケード上位",
            "subFieldId": 429,
            "subFieldName": "下位",
            "objectId": 15,
            "relationList": [
                {
                    "supperId": 2,
                    "subIdList": [
                        2,
                        9,
                        10
                    ]
                },
                {
                    "supperId": 3,
                    "subIdList": [
                        1,
                        2,
                        3,
                        4,
                        5,
                        6,
                        7,
                        8,
                        9,
                        10
                    ]
                },
                {
                    "supperId": 6,
                    "subIdList": [
                        10
                    ]
                }
            ]
        }
    ]
}

カスケード関係の新規追加

POST /v1/cascadeFields

リクエストパラメータ

パラメータ	タイプ	必須	説明
name	String	はい	フィールド関係名
objectId	int	はい	オブジェクトID
supperFieldId	int	はい	上位フィールドID
subFieldId	int	はい	下位フィールドID
relationList	配列	はい	フィールドカスケード関係データ
relationList[].supperId	整数型	はい	上位フィールドオプションID.
relationList[].subIdList[]	配列	はい	下位フィールドオプションIDリスト.
##### レスポンスデータ

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

リクエスト例

$ curl 'https://servicego.udesk.cn/api/v1/cascadeFields?email=admin@udesk.cn&timestamp=1496631984&sign=ef506d04ef74e1031f91025494244e88f3559b78' -i -X POST -H 'Content-Type: application/json' -H 'Accept: application/json' -d  '{"name":"省市","supperFieldId":42028,"subFieldId":42029,"relationList":[{"supperId":1,"subIdList":[1]},{"supperId":3,"subIdList":[2,3,4]},{"supperId":4,"subIdList":[8]},{"supperId":5,"subIdList":[6]},{"supperId":6,"subIdList":[7]},{"supperId":8,"subIdList":[5]}],"objectId":"2230"}'

レスポンス例

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

カスケード関係の編集

PUT /v1/cascadeFields

リクエストパラメータ

パラメータ	タイプ	必須	説明
name	String	はい	フィールド関係名
id	int	はい	関係ID
supperFieldId	int	はい	親フィールドID
subFieldId	int	はい	子フィールドID
relationList	配列	はい	フィールドカスケード関係データ
relationList[].supperId	整数	はい	親フィールドオプションID.
relationList[].subIdList[]	配列	はい	子フィールドオプションIDリスト.
relationListShow	配列	いいえ	フィールドカスケード関係データ表示用
relationListShow[].supperId	整数	いいえ	親フィールドオプションID.
relationListShow[].subIdList[]	配列	いいえ	子フィールドオプションIDリスト.
##### レスポンスデータ

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

リクエスト例

$ curl --location --request PUT 'https://servicego.udesk.cn/v1/cascadeFields?email=1@test.cn&timestamp=1608114461&sign=74cfd90f2e7a62d5cba147719f014d6a94d325a3' --header 'Content-Type: application/json' --data-raw '{"id":33,"name":"llk","supperFieldId":1546,"subFieldId":1547,"fieldRelation":"[{\"supperId\":1,\"subIdList\":[1]},{\"supperId\":2,\"subIdList\":[2,3,4,5]}]","relationList":[{"supperId":1,"subIdList":[1]},{"supperId":2,"subIdList":[2,3,4]}]}'

レスポンス例

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

ツリーフィールドの検索

GET /v1/field

リクエストパラメータ

パラメータ	タイプ	必須	説明
objectApiName	String	はい	オブジェクトのAPI名
fieldApiName	String	はい	フィールドのAPI名

レスポンスデータ

属性名	タイプ	説明
code	整数	レスポンスコード.
message	文字列	レスポンスメッセージ.
visible	ブール型	表示/非表示, true / false .
data	オブジェクト	フィールドデータ.
data.label	文字列	フィールドラベル.
data.id	整数	フィールドID.
data.customObjectId	整数	オブジェクトID.
data.fieldType	整数	フィールドタイプ.
data.optionList	配列	ツリーフィールドのオプション.
data.optionList[].id	整数	オプションID.
data.optionList[].name	文字列	オプション値.
data.optionList[].optionPermissionFlag	整数	オプション選択権限 0:表示権限なし 1:表示権限あり.
data.optionList[].parentId	整数	ツリーフィールドの親ノード
data.optionList[].isTag	整数	タグ識別子
data.optionList[].parentIds	文字列	ツリーフィールドの上位ノード
data.optionList[].color	文字列	色
data.optionList[].textColor	文字列	文字色
data.optionList[].sort	整数	ソート順序
##### リクエスト例

$ curl 'https://servicego.udesk.cn/v1/field?email=admin@udesk.cn&timestamp=1608114461&sign=74cfd90f2e7a62d5cba147719f014d6a94d325a3&objectApiName=wanglufeideceshi&fieldApiName=shuxingziduan -i -H 'Content-Type: application/json' -H 'Accept: application/json' 

レスポンス例

{
    "code": 200,
    "message": "OK",
    "visible": false,
    "data": {
        "id": 1549,
        "customObjectId": 88,
        "label": "ツリーフィールド",
        "apiName": "shuxingziduan",
        "fieldType": 34,
        "optionList": [
            {
                "id": 1,
                "name": "カスタマーサポートシステム",
                "optionPermissionFlag": 1,
                "parentId": 0,
                "isTag": 0,
                "parentIds": "0",
                "color": "#ffffff",
                "textColor": "#000000",
                "sort": 1
            },
            {
                "id": 2,
                "name": "コールセンター",
                "optionPermissionFlag": 1,
                "parentId": 1,
                "isTag": 1,
                "parentIds": "0,1",
                "color": "#ffffff",
                "textColor": "#000000",
                "sort": 2
            },
            {
                "id": 3,
                "name": "オンラインサポート",
                "optionPermissionFlag": 1,
                "parentId": 1,
                "isTag": 1,
                "parentIds": "0,1",
                "color": "#ffffff",
                "textColor": "#000000",
                "sort": 3
            },
            {
                "id": 4,
                "name": "チケット",
                "optionPermissionFlag": 1,
                "parentId": 1,
                "isTag": 1,
                "parentIds": "0,1",
                "color": "#ffffff",
                "textColor": "#000000",
                "sort": 4
            },
            {
                "id": 5,
                "name": "その他のシステム",
                "optionPermissionFlag": 1,
                "parentId": 0,
                "isTag": 0,
                "parentIds": "0",
                "color": "#ffffff",
                "textColor": "#000000",
                "sort": 5
            },
            {
                "id": 6,
                "name": "BIシステム",
                "optionPermissionFlag": 1,
                "parentId": 5,
                "isTag": 0,
                "parentIds": "0,5",
                "color": "#ffffff",
                "textColor": "#000000",
                "sort": 6
            },
            {
                "id": 7,
                "name": "Insight",
                "optionPermissionFlag": 1,
                "parentId": 6,
                "isTag": 1,
                "parentIds": "0,5,6",
                "color": "#ffffff",
                "textColor": "#000000",
                "sort": 7
            },
            {
                "id": 8,
                "name": "AIシステム",
                "optionPermissionFlag": 1,
                "parentId": 5,
                "isTag": 0,
                "parentIds": "0,5",
                "color": "#ffffff",
                "textColor": "#000000",
                "sort": 8
            },
            {
                "id": 9,
                "name": "テキストボット",
                "optionPermissionFlag": 1,
                "parentId": 8,
                "isTag": 1,
                "parentIds": "0,5,8",
                "color": "#ffffff",
                "textColor": "#000000",
                "sort": 9
            },
            {
                "id": 10,
                "name": "音声ボット",
                "optionPermissionFlag": 1,
                "parentId": 8,
                "isTag": 1,
                "parentIds": "0,5,8",
                "color": "#ffffff",
                "textColor": "#000000",
                "sort": 10
            }
        ]
    }
}

ツリーフィールドの修正

PUT /v1/treeField

リクエストパラメータ

パラメータ	タイプ	必須	説明
objectApiName	String	はい	オブジェクトのAPI名
fieldApiName	String	はい	フィールドのAPI名
label	文字列	いいえ	フィールドのラベル.
fieldType	整数型	はい	フィールドタイプ（ツリー-34）.
optionList	配列	いいえ	ツリーフィールドのオプション.
optionList[].id	整数型	いいえ	オプションID.
optionList[].name	文字列	いいえ	オプション値.
optionList[].optionPermissionFlag	整数型	いいえ	オプションの表示権限 0:表示権限なし 1:表示権限あり.
optionList[].parentId	整数型	いいえ	ツリーフィールドの親ノード
optionList[].isTag	整数型	いいえ	タグ識別子
optionList[].parentIds	文字列	いいえ	ツリーフィールドの上位ノード
optionList[].color	文字列	いいえ	色
optionList[].textColor	文字列	いいえ	文字色
optionList[].sort	整数型	いいえ	ソート順序

レスポンスデータ

プロパティ名	タイプ	説明
code	整数型	レスポンスコード.
message	文字列	レスポンスメッセージ.
visible	ブール型	表示/非表示, true / false .

リクエスト例

$ curl --location --request PUT 'https://servicego.udesk.cn/v1/treeField?email=1@test.cn&timestamp=1608114461&sign=74cfd90f2e7a62d5cba147719f014d6a94d325a3' --header 'Content-Type: application/json' --data-raw
'{
     "objectApiName":"wanglufeideceshi",
     "label":"ツリーフィールド",
     "fieldApiName":"shuxingziduan",
     "fieldType":34,
     "optionList":[
         {
             "id":1,
             "parentId":0,
             "parentIds":"0",
             "name":"カスタマーサポートシステム",
             "textColor":"#000000",
             "color":"#ffffff",
             "isTag":0,
             "sort":1
         },
         {
             "id":2,
             "parentId":1,
             "parentIds":"0,1",
             "name":"コールセンター",
             "textColor":"#000000",
             "color":"#ffffff",
             "isTag":1,
             "sort":2
         },
         {
             "id":3,
             "parentId":1,
             "parentIds":"0,1",
             "name":"オンラインサポート",
             "textColor":"#000000",
             "color":"#ffffff",
             "isTag":1,
             "sort":3
         },
         {
             "id":4,
             "parentId":1,
             "parentIds":"0,1",
             "name":"チケット",
             "textColor":"#000000",
             "color":"#ffffff",
             "isTag":1,
             "sort":4
         },
         {
             "id":5,
             "parentId":0,
             "parentIds":"0",
             "name":"その他のシステム",
             "textColor":"#000000",
             "color":"#ffffff",
             "isTag":0,
             "sort":5
         },
         {
             "id":6,
             "parentId":5,
             "parentIds":"0,5",
             "name":"BIシステム",
             "textColor":"#000000",
             "color":"#ffffff",
             "isTag":0,
             "sort":6
         },
         {
             "id":7,
             "parentId":6,
             "parentIds":"0,5,6",
             "name":"Insight",
             "textColor":"#000000",
             "color":"#ffffff",
             "isTag":1,
             "sort":7
         },
         {
             "id":8,
             "parentId":5,
             "parentIds":"0,5",
             "name":"AIシステム",
             "textColor":"#000000",
             "color":"#ffffff",
             "isTag":0,
             "sort":8
         },
         {
             "id":9,
             "parentId":8,
             "parentIds":"0,5,8",
             "name":"テキストボット",
             "textColor":"#000000",
             "color":"#ffffff",
             "isTag":1,
             "sort":9
         },
         {
             "id":10,
             "parentId":8,
             "parentIds":"0,5,8",
             "name":"音声ボット",
             "textColor":"#000000",
             "color":"#ffffff",
             "isTag":1,
             "sort":10
         },
         {
             "id":11,
             "parentId":0,
             "parentIds":"0",
             "name":"セールスシステム",
             "iconUrl":"",
             "textColor":"#000000",
             "color":"#ffffff",
             "isTag":0,
             "sort":11
         }
     ]
 }' 

レスポンス例

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