ServiceDesk Plus Cloud ナレッジベース

技術担当者の追加フィールドを表すAPIフォーマットの変更


本情報の確認日:2023年8月18日

今後、技術担当者の追加フィールドを表すAPIフォーマットが変更されます。詳細は以下の通りです。

変更の概要
[管理] > [カスタマイズ] > [追加フィールド] > [技術担当者] に登録されている、技術担当者の追加フィールドを表すAPIフォーマットが
udf_fields」から「technician_udf_fields」に変更されます。

詳細

例えば、URIが「https://servicedeskplus.jp/api/v3/technicians」の場合、現在、そのレスポンスは以下のような形式となります。

{
"response_status": [{
"status_code": 2000,
"status": "success"
}],
"technicians": [{
"email_id": "*****@example.com",
"reporting_to": null,
"cost_per_hour": "0",
"id": "1***************",
"is_vip_user": false,
"photo_url": "https://contacts.zoho.jp/file?exp=10&ID=9**********&t=user&height=60&width=60",
"department": null,
"first_name": "Test",
"job_title": null,
"created_time": {
"display_value": "Aug 8, 2023 09:37 AM",
"value": "1************0"
},
"mobile": "8*********2",
"last_name": "Test",
"user_scope": "internal_user",
"sms_mail_id": null,
"site": {
"deleted": false,
"name": "Base Site",
"id": "1**************1",
"is_default": true
},
"login_user": true,
"phone": null,
"employee_id": null,
"udf_fields": {
"udf_char1": "追加フィールド"
},
"name": "Test",
"technician_udf_fields": {
"udf_char1": "追加フィールド"
}
}],
"list_info": {
"has_more_rows": false,
"sort_field": "name",
"row_count": 1
}
}

上記レスポンス内には、技術担当者の追加フィールドを表す箇所が2つ存在します。

・箇所1

"udf_fields": {
"udf_char1": "追加フィールド"
},

・箇所2

"technician_udf_fields": {
"udf_char1": "追加フィールド"
}

※以前は、レスポンスには箇所1(udf_fields)のみが含まれておりましたが、現在は箇所2(technician_udf_fields)も併記されるようになりました。

今後は、レスポンスから箇所1(udf_fields)が削除され、箇所2(technician_udf_fields)のみがレスポンス内に含まれるようになります。

APIコール「api/v3/technicians」をご利用になっている場合には、技術担当者の追加フィールドの値を取得または更新するにあたり「udf_fields」を使用していないかをご確認ください。

また、「udf_fields」を使用している場合、今後レスポンスから箇所1(udf_fields)が削除される前に、「udf_fields」を「technician_udf_fields」に置換してください。

置換しなかった場合、今後、APIコールに失敗し、技術担当者の追加フィールドの値の取得または更新ができなくなります。