[New Release] API 改善リリースに関するお知らせ

いくつかのAPI改善版が開発環境へリリースされましたので、ご連絡差し上げます。
本稼働環境へは今週木曜日の夜に反映される予定です。

今回は利用者様からのリクエストを中心に、いくつかの個別機能を改善いたしました。
今後も継続的に機能改善を行ってまいりますので、お気づきの点等ございましたら、遠慮なくお問い合わせください。
どうぞよろしくお願いいたします。

ResetPassword APIの改善

ResetPassword API


において、リダイレクト先の指定と、パラメータを渡すことが可能となりました。

本件はこちらのご要望への対応となります。貴重なご要望、ありがとうございました。

新規作成APIにて、新規作成用のActionIDを指定可能になりました

CreateItem APIにおいて、

従来は、デフォルトの固定Actionが自動的に利用されておりましたが、
今回action_idをPayloadにて渡すことで、特定のActionIDを利用して新規作成が利用できるようになりました。

注意)新規作成Actionのみ指定可能です。その他のActionIDを渡した場合は、エラー(400)となります。

本件は、こちらのご要望の対応となります。貴重なご要望、ありがとうございました。

データレポートの結果に、OptionやStatusなどの{IDと値} を含められるようになりました。

改善対象API

従来、選択肢型などのデータレポートの結果にOptionIDなどのIDは含まれず、IDから変換された値のみが返却されていました。
この場合、選択肢IDを利用したくてもプログラムから利用することができませんでした。

今回の変更では、Payloadに

"return_id_value_results": true,

というフラグを渡すことで、ID-Value値をObjectで返却できるようになりました。
以下例に示すとおり、従来返却される値とは別に、

 "id_value_results": { ...  } 

という形で、該当フィールドIDごとに ID-ValueのObjectが返却されるようになります。

    {
            "AssigneeText": "X",
            "Category": "A",
            "Checkbox": "22",
            "DateOld": "2021/05/26",
            "DateTime1": "2021-05-27T18:38:13Z",
            "DueDate": "2016/01/22",
            "Lookup1": "",
            "Number": 11,
            "Radio": "B",
            "Title": "タスクE",
            "UserType": "",
            "i_id": "5f267f1628dc5c6988bc2fee",
            "id_value_results": { // <---- 該当するフィールドに、選択肢型またはステータス、またはユーザー型がある場合、付加されます
                "Category": {
                    "id": "A",
                    "value": "A"
                },
                "Checkbox": [  // <---- Checkboxの場合、複数選択肢に対する配列が返ります
                    {
                        "id": "3ce8c186-89a6-455c-8b80-f962333b3eb0",
                        "value": "22"
                    }
                ],
                "Radio": {
                    "id": "OptionB",
                    "value": "B"
                },
                "status1": {
                    "id": "InReview",
                    "value": "In Review"
                }
            },
            "rev_no": 24,
            "status1": "In Review"
        },

以下、フィールド型ごとに、返却される形が変わります。

選択肢型、ラジオ型、ステータスについては、id/valueを含むObject型で返却されます。

"id_value_results": { 
    "フィールドID": {
        id:"(選択肢などのdisplay_id)",
        value: "(選択肢の値)"
    },
    ...
}

チェックボックス型、User型については、複数の候補が含まれるため、Objectの配列で返却されます。

"id_value_results": { 
    "フィールドID": [
        {
            id:"(選択肢などのdisplay_id)",
            value: "(選択肢の値)"
        },
        {
            id:"(選択肢などのdisplay_id)",
            value: "(選択肢の値)"
        },
        ...
    ],
    ...
}

こちらは、以下ご要望の対応となります。貴重なご要望、ありがとうございました。