コールトゥアクション (CTA)APIドキュメンテーション

最後の更新
PDFとして保存

重要 - 画像/情報は四半期ごとのリリースで更新されます!

四半期ごとのリリースにて、最新の機能・情報を反映し、画像を含めた情報は更新されます。

アクションへの呼びかけ(CTA) APIは、REST (Representational State Transfer) を中心に構成されています。この記事では、これらのREST APIを使ってCTAを作成及び更新する方法、及びCTAの詳細を取得してCTAを構成する方法の詳細を管理者に解説します。

はじめに

Gainsightを使うと、ユーザーはCTAを作成及び更新できるだけでなく、CTAの詳細を取得して、コックピット Rest API を使ってCTAを構成することもできます。 CTAにアクセスすることで恩恵を受ける全てのチームが常にGainsightを使用しているわけではありません。彼らは自分たちで選んでよく使っているシステムを持っており、Gainsightがそれらとよりよく統合することを期待しています。開発リソースをお持ちのお客様は、APIを使用して、Gainsightと使用している他のシステムとの間で、より緊密でカスタマイズされた統合を構築できます。これらのAPIにより、ユーザーはコックピットデータを統合し、これらのワークフローを他のシステムで構築することが可能です。

ビジネスユースケース:

財務チームは、顧客が気分たちが使っているシステム (Salesforce/Zuora など) から支払いを行っていない場合に、CSMのCTAを作りたいと考えます。
ユーザーがSalesforceでケースをクローズするとき、そのケースに関連付けられているすべてのCTAのリストをユーザーに表示したいと考えます。又、ユーザーはそのケースとともにクローズしたいCTAを選択する必要があります。
エグゼクティブが表示するExcel/GoogleシートでリスクCTAデータをエクスポート及び更新します。
管理者として、ワークスペースなどのツールを使って、今後のCTAとユーザー自身のCTAについてCSMに通知を送信したいと考えます。又、ユーザーがCTAステータスの更新、コメントの投稿、CTAのクローズなどの簡単な操作を実行できるようにしたいと考えます。

重要：リッチテキストフィールドの場合、APIの利用者は、送信するデータがクリーンで、悪意のあるタグが含まれていないことを確認する必要があります。

認証する

API アクセスは、固有のアクセスキーを使用して制御されます。REST API要求を送信するGainsightテナントのアクセスキーを取得するにはGainsight 管理者に連絡してください。アクセスキーを生成または共有する方法の詳細については、Gainsight 管理者は API アクセスキーの生成の記事を参照できます。
アクセスキーを取得した後は、GainsightへのすべてのAPIリクエストのリクエストヘッダー「accesskey」の一部として、アクセスキーを渡す必要があります。

注意：AccessKeyに有効期限はありません。

ヘッダー

キー	値
アクセスキー	アクセスキーを生成する方法の詳細については、「認証する」セクションを参照してください。
コンテンツタイプ	JSON

スロットリング制限

API	レートリミット
非同期APIコール	1時間あたり10 コール/1日あたり100コール
同期APIコール	1 分あたり 100 回の API 呼び出し/1 日あたり 50,000 回の API 呼び出し

CTA APIの作成

CTA APIの作成はGainsightで新しいCTAを作成するために使われます。会社ID、CTAタイプ、CTA名、所有者ID入力などの必須フィールドを渡して、CTAを作成することができます。ユーザーは日付フィールドをYYYY-MM-DD形式で入力する必要があります。カスタムフィールドに入力するには、ユーザーは「__gc」を付け加える必要があります。

ユーザーはプレイブックの詳細を適用して、作成したCTAに関連付けるオブジェクトを提供することも可能です。任意の識別子を使って、会社IDと所有者IDに対応する会社を分解します。参照IDはエラーが発生したCTAの作成を返すために使われます。

ユーザーはCTAの作成時に入力するCTAオブジェクトに追加のフィールドを提供することができます。CTA標準フィールドの場合、値が指定されていない場合は、システムはタイプに基づくデフォルト値を使います。フィールド名はルックアップ構成のインポートの一部として入力する必要があり、大文字と小文字が区別されます。

注意：

ユーザーは一度に1つのCTAのみを作成/更新することができます。
外部参照IDはCTAを作成するための必須パスです。

メソッド

ポスト

エンドポイントのURL

/v2/cockpit/cta/

リクエストのサンプル

{
    "requests": [
        {
            "record": {
                "referenceId": "1",
                "Name": "Too many Support Tickets open for customer",
                "SFDCID": "TZHYUJB8QBNHYUIIY",//Used to Resolve the CompanyID
                "OwnerEmail": "hsharma@gainsight.com", //Used to Resolve the OwnerID
                "DueDate": "2020-05-02",
                "type": "Risk",               //Pass Name of CTA Type
                "reason": "Support Risk",     //Pass Name of CTA Reason
                "status": "New",              //Pass Name of CTA Status
                "priority": "High",           //Pass Name of CTA Priority
                "playbook": "Support Risk Playbook", // Name of playbook to apply
                "Comments": "Support risk since too many tickets are open",
                "isEscalaed__gc": false,        // Custom Fields to populate
                "DT_Date__gc": "2020-04-28",
                "DT_DateTime__gc": "2020-04-17T22:30:00Z",
                "AdditionalNotes__gc": "Custom String field to populate",
                "DT_Email__gc": "test@test.com",
                "DT_MutliDDList__gc": "C; D",   // Multi-select values with names
                "DT_Percentage__gc": "15.67",
                "DT_String__gc": "Hey there",
                "Support_URL__gc": "https://www.google.com",
                "DT_RichTextArea__gc": "Hey there, How are you!!!"
            },
            "linkedObjects": [       //Linking an object while creating a CTA
                {
                    "id": "1Z021IVUBQ4OXQAILPJLBKGVQ2XS41KZ9L8S",
                    "store": "MDA",
                    "objectName": "support__gc" //Linked Object Name
                }
            ]
        }
    ],
    "lookups": {                  // To Resolve GSID Fields using any key
        "OwnerId": {              // Resolving CTA Owner via
            "fields": {
                "OwnerEmail": "Email"
            },
            "lookupField": "Gsid",
            "objectName": "gsuser",
            "multiMatchOption": "FIRSTMATCH",
            "onNoMatch": "ERROR"
        },
        "CompanyId": {         // Resolving Company using SFDCID
            "fields": {
                "SFDCID": "sfdcid"
            },
            "lookupField": "Gsid",
            "objectName": "company",
            "multiMatchOption": "FIRSTMATCH",
            "onNoMatch": "ERROR"
        }

    }
}

注意：APIは有効なJSONをサポートしています。読みやすくするために、機能に関するいくつかのJSONキーにコメントを追加しました。リクエストの準備中に、それらを削除する必要があります。

応答成功のサンプル

{
  "result": true,
    "errorCode": null,
    "errorDesc": null,
    "requestId": "0bf2f76c-01d6-42a2-b292-eb9166d77aa7",
    "data": {
        "success": [
            {
                "1": "1S01B8KR0ST6J5HC5NHIE7VNUDERF7E7QTC3"
            }
        ],
        "failure": []
  },
    "message": null
}

応答失敗のサンプル

{
    "result": false,
    "errorCode": <ERROR_CODE>,
    "errorDesc": <ERROR_DESC>, // If the issue comes while resolving the request
    "requestId": <REQUEST_ID>,   
    "data": {
        "success": [],
        "failure": [
        {
            "1": "ERROR_MESSAGE" // Reference ID to highlight issue when creating
        }
      ]
    },
    "message": null
}

無効なルックアップオブジェクト構成に対する失敗時の応答のサンプル

{
    "result": false,
    "errorCode": "COCKPIT_9703",
    "errorDesc": "Following lookup field have invalid filter configuration to resolve - User_Lookup__gc-> gsuser: UserLookup",
    "requestId": "8e35c24e-adf4-46fa-a0b5-48e26af1fbd7",
    "data": {},
    "message": null
}

無効なリンクアップオブジェクト構成に対する失敗時の応答のサンプル

リンクされたオブジェクトとリンクされていないタイプ

HTTPステータス: 200

{
    "result": true,
    "errorCode": null,
    "errorDesc": null,
    "requestId": "02159926-4cba-4ed9-97a8-ec8c1c2d99f8",
    "data": {
        "success": [],
        "failure": [
            {
                "1": "COCKPIT_9702: Object(s) are not linked to the specific CTA type - customobjecttt1__gc"
            }
        ]
    },
    "message": null
}

CTA APIの更新

CTA APIの更新はGainsight の既存のCTAを更新するために使われます。CTA ID (GSID) と参照IDは、このAPIが更新するCTAを識別し、結果をフォーマットするための2つの必須パラメーターです。ユーザーはフィールドのリストとその値を入力して、要件に従ってCTAを更新することができます。

ユーザーはCTAに関連付けるオブジェクトを入力することもできます。例えば、レコードを既存のCTAにリンクして、レコードを変更しないでください。

注意：外部参照IDはCTAを更新するため必須パスです。

以下は、期日の利用可能なカスケードオプションです:

ALL_OPEN_TASKS (Default)
PLAYBOOK_TASKS
いいえ

以下は、所有者の利用可能なカスケードオプションです:

OWNER (Default)
ALL_OPEN_TASKS
いいえ

CTA更新の成功又は失敗は、失敗の理由とともに応答で送信されます。

メソッド

入力

エンドポイントのURL

/v2/cockpit/cta/

リクエストのサンプル

{
  "requests": [
    {
      "record": {
        "referenceId": "1",                               //ID to return errors
        "Gsid": "1S01B8KR0ST6J5HC5N9LNPIQ4ID70SCNKM1T",  //CTA Id to identify the record to update
        "Name": "Onboarding CTA",                        //CTA Name
        "OwnerEmail": "hsharma@gainsight.com",
        "DueDate": "2020-05-05",
        "reason": "Bugs Risk",                           //Update CTA Reason
        "status": "New",                                 //Update CTA Status
        "priority": "High",                              //Update CTA Priority
        "PlaybookId__gr.Name": "Add Playbook",           //Apply or Append Playbook
        "Comments": "CTA Comments",                      //Replace the CTA Comments
        "dt_boolean__gc": true,                          //Update Custom Fields
        "DT_Currency__gc": 35.65,
        "DT_Date__gc": "2020-04-29",
        "DT_DateTime__gc": "2020-04-19T20:30:00Z",
        "DT_DDList__gc": "Kicked Off",
        "DT_GSID__gc": "1S01B8KR0ST6J5HC5N3OHVEVCVEFTGTLHIIX",
        "DT_MutliDDList__gc": "C; D",
        "DT_Percentage__gc": "18.93",
        "DT_String__gc": "Hello",
        "CompanyLookup": "Gainsight",
        "Name_Lookup1__gc": "Gainsight",
        "UserLookup": "Hitesh Sharma",
        "ownerCriteria": “ALL_OPEN_TASKS”,
        “dueDateCriteria”: “PLAYBOOK_TASKS”      },
      "linkedObjects": [                                  //Append Linked Object
        {
          "id": "1Z027IA57F6SFBKJUYU9B0BI41YYIRB8IIEH",
          "store": "MDA",                               //SFDC For SFDC Objects
          "objectName": "support__gc"
        }
      ]
    }
  ],
  "lookups": {
    "OwnerId": {                                       //Updates the CTA Owner
      "fields": {
        "OwnerEmail": "Email"
      },
      "lookupField": "Gsid",
      "objectName": "gsuser",
      "multiMatchOption": "FIRSTMATCH",
      "onNoMatch": "ERROR"
    },
    "Comp_Lookup__gc": {                              //Updating custom lookup fields
      "fields": {
        "CompanyLookup": "Name"
      },
      "lookupField": "Gsid",
      "objectName": "company",
      "multiMatchOption": "FIRSTMATCH",
      "onNoMatch": "ERROR"
    },
  }
}

応答成功のサンプル

{
  "result": true,
    "errorCode": null,
    "errorDesc": null,
    "requestId": "93ce3633-383b-4e2d-a07a-15e74e2f6d0a",
    "data": {      
        "success": [
            {
                "5": "1S01B8KR0ST6J5HC5N9LNPIQ4ID70SCNKM1T"
            }
        ],
        "failure": []
    },    "message": null
}

応答失敗テンプレートのサンプル

{
    "result": false,
    "errorCode": <ERROR_CODE>,
    "errorDesc": <ERROR_DESC>, // If the issue comes while resolving the request
    "requestId": <REQUEST_ID>,   
    "data": {
        "success": [],
        "failure": [
        {
            "REFERENCE_ID": "ERROR_MESSAGE" // If the issue comes while processing the records
        }
      ]
    },
    "message": null

}

CTA APIの取得

CTA APIの取得は、CTAをGainsightに取り込むために使われます。1回のリクエストで最大1000個のCTAを取得できます。それ以上ある場合は、ページ番号/ページサイズを使って、全てのCTAの詳細を取得します。

デフォルトでは、このAPIを使って次の標準CTAフィールドが取得されます。会社ID、関係ID (関係CTAの場合)、期日、CTAの GSID、isImportant、所有者ID、所有者の氏名、電子メール、優先度 ID、優先度名、理由ID、理由名、ステータスID、ステータス名、タイプ ID、タイプ名、エンティティタイプ (会社又は関係)、会社名、関係タイプ ID、及び関係タイプ名。

日付フィールドはYYYY-MM-DD形式で返され、時刻はGMTで返されます.「linkedObject = True」を入力して、リンクされたオブジェクトデータを要求することもできます。

ユーザーは追加のフィールドを要求することもできます。カスタムフィールドには「__gc」を加える必要があり、ルックアップフィールドには「__gr」を加える必要があります。

ユーザーはフィルターパラメーターを使用することもできます。フィルターパラメーターは、フィールド又はリンクされたオブジェクトレコードにすることができます。シンプル及び高度な取得呼び出しフィルタの詳細については、CTA を取得するサンプルフィルタセクションを参照してください。

メソッド

ポスト

エンドポイントのURL

/v2/cockpit/cta/list

リクエストのサンプル

{
    "select": [          
        "name",
        "customDate__gc",             // Additional Custom Field
        "CompanyId__gr.Name",         // Get data from lookup fields
        "CompanyId__gr.Arr",
        "CompanyId__gr.Csm_gr.Email", // Second level lookup fields
        "Comments",
        "Days Due"
        "Quoted_ARR__gc",
        "custom_picklist__gc",
        "Renewal_Date__gc"
    ],
    "linkedObject": true,             //Fetch Linked Objects Data as well
    "where": {                        //Filter Conditions
        "conditions": [
        {
          "associatedRecord": true,   //Filter based on Linked Objects
          "value": [
              "5002v00002ikxl0AAA",
              "1Z02G2ZIY14G9VKJ2NW0N6VN0EQE780AR0HZ"
          ],
          "alias": "A",
          "operator": "INCLUDES"
        },
        {
          "fieldName": "DueDate",
          "value": [
              "2020-04-14"
            ],
            "alias": "B",
            "operator": "EQ"
            }
        ],
        "expression": "A AND B"
    },
    "pageSize": 100,
    "pageNumber": 1
}

応答成功のサンプル

{
    "result": true,
    "errorCode": null,
    "errorDesc": null,
    "requestId": "f742e83d-4af3-4285-bd20-48686a2b3e17",
    "data": [
        {
            "CompanyId": "1P02ZUWNMOPV5SZ6ZLG7TZJMDCB8QNDDCACX",
            "CompanyId__gr.Arr": 998765.00000000000,
            "CompanyId__gr.Company_Test_Field__gc": "Company test field",
            "CompanyId__gr.CreatedBy": "1P015825RVB81GPY5OJQ2I4OLHR6DNBOYVZU",
            "CompanyId__gr.CurrencyIsoCode": "USD",
            "CompanyId__gr.Name": "IBM",
            "DueDate": "2020-04-14T11:30:00Z",
            "EntityType": "COMPANY",
            "Gsid": "1S01B8KR0ST6J5HC5N9X9GVU1LXJCHOYG7IS",
            "IsClosed": false,
            "IsImportant": false,
            "Name": "Tomorrow",
            "OwnerId": "1P015825RVB81GPY5OTDQ4GYW31IZC14GWQR",
            "OwnerId__gr.FirstName": "Hitesh",
            "OwnerId__gr.LastName": "Sharma",
            "OwnerId__gr.User_Number__gc": 56738,
            "PriorityId": "1I0016MVH7ECQMT12KZPJI2HPSK7AC2E4VCR",
            "PriorityId__gr.IsActive": true,
            "PriorityId__gr.Name": "Medium",
            "ReasonId": "1I003F6D392Y2KJ97AYOAB5WH6C1RSE1XT0E",
            "ReasonId__gr.Name": "Other",
            "StatusId": "1I0017YS8AFRMU8633PP4GQ7M1OFAHSBMCK0",
            "StatusId__gr.Name": "New",
            "TypeId": "1I00650WACZ7F0X9HR1K21ZPDOQ71DFE4KFG",
            "TypeId__gr.Name": "Risk",
            "associatedRecords": [
                {
                    "recordId": "1Z02G2ZIY14G9VKJ2NW0N6VN0EQE780AR0HZ",
                    "objectName": "customobject__gc",
                    "source": "MDA"
                }
            ]
        },
        {
            "CompanyId": "1P02ZUWNMOPV5SZ6ZLG7TZJMDCB8QNDDCACX",
            "CompanyId__gr.Arr": 998765.00000000000,
            "CompanyId__gr.Company_Test_Field__gc": "Company test field for string filters to do the test",
            "CompanyId__gr.CreatedBy": "1P015825RVB81GPY5OJQ2I4OLHR6DNBOYVZU",
            "CompanyId__gr.CurrencyIsoCode": "USD",
            "CompanyId__gr.Name": "IBM",
            "CustomDateTime__gc": "2020-04-17T22:00:00Z",
            "CustomDate__gc": "2020-04-22",
            "Custom_picklist__gc": "1I0054U9FAKXZ0H26HCDNCOD7NQT456P7RJL",
            "DueDate": "2020-04-14T11:30:00Z",
            "EntityType": "COMPANY",
            "Gsid": "1S01B8KR0ST6J5HC5NFP4LHLPQK80RWOD1NJ",
            "IsClosed": false,
            "IsImportant": false,
            "Name": "Today",
            "Name_Lookup1__gc": "IBM",
            "Name_Lookup1__gr.ModifiedDate": "2020-04-14T09:21:25.612Z",
            "Name_Lookup1__gr.Name": "IBM",
            "OwnerId": "1P015825RVB81GPY5OTDQ4GYW31IZC14GWQR",
            "OwnerId__gr.FirstName": "Hitesh",
            "OwnerId__gr.LastName": "Sharma",
            "OwnerId__gr.User_Number__gc": 56738,
            "PriorityId": "1I0016MVH7ECQMT12KZPJI2HPSK7AC2E4VCR",
            "PriorityId__gr.IsActive": true,
            "PriorityId__gr.Name": "Medium",
            "ReasonId": "1I003F6D392Y2KJ97AYOAB5WH6C1RSE1XT0E",
            "ReasonId__gr.Name": "Other",
            "StatusId": "1I0017YS8AFRMU8633PP4GQ7M1OFAHSBMCK0",
            "StatusId__gr.Name": "New",
            "TypeId": "1I00650WACZ7F0X9HR1K21ZPDOQ71DFE4KFG",
            "TypeId__gr.Name": "Risk",
            "User_Lookup__gc": "1P015825RVB81GPY5OTDQ4GYW31IZC14GWQR",
            "User_Lookup__gr.ModifiedDate": "2020-04-14T09:22:03.178Z",
            "User_Lookup__gr.Name": "Hitesh Sharma",
            "associatedRecords": [
                {
                    "recordId": "5002v00002ikxl0AAA",
                    "objectName": "Case",
                    "source": "SFDC"
                },
                {
                    "recordId": "1Z02G2ZIY14G9VKJ2NW0N6VN0EQE780AR0HZ",
                    "objectName": "customobject__gc",
                    "source": "MDA"
                }
            ]
        }
    ],
    "message": null
}

応答失敗のサンプル

選択句でフィールドが渡されない場合:

{
    "result": false,
    "errorCode": "COCKPIT_5101",
    "errorDesc": "Please add fields in the select clause",
    "requestId": "cfb0da1e-90dd-42dc-88ff-2ff1d2671ce6",
    "data": {},
    "message": null
}

式の値が渡されない場合：

{
    "result": false,
    "errorCode": "COCKPIT_5101",
    "errorDesc": "Please pass the expression for the respective conditions",
    "requestId": "91fbd3e5-0d41-412b-9e0b-858ec054004b",
    "data": {},
    "message": null
}

式は渡されたが、条件が利用できない場合：

{
    "result": false,
    "errorCode": "COCKPIT_5101",
    "errorDesc": "Please pass the correct conditions",
    "requestId": "255a29ce-faa8-4a6f-b91a-6c446ade7037",
    "data": {},
    "message": null
}

ページサイズ又はページ数の入力が無効：

{
    "result": false,
    "errorCode": "COCKPIT_5101",
    "errorDesc": "Invalid page size or, number",
    "requestId": "255a29ce-faa8-4a6f-b91a-6c446ade7037",
    "data": {},
    "message": null
}

選択句の無効なフィールド：

{
    "result": false,
    "errorCode": "COCKPIT_5101",
    "errorDesc": "Invalid fields in select clause - gsidasdf",
    "requestId": "255a29ce-faa8-4a6f-b91a-6c446ade7037",
    "data": {},
    "message": null
}

フィルタに無効なフィールド又は演算子が渡された：

{
    "result": false,
    "errorCode": "COCKPIT_5101",
    "errorDesc": "Invalid fields or operator in where clause - MultiSelect__gc",
    "requestId": "e0b56748-1c81-4659-9734-4ada612971f2",
    "data": {},
    "message": null
}

CTAを取得するサンプルフィルタ

以下で説明する全てのフィルタは、エンコードしてからURLで提供する必要があります。ここで、前述のフィルターはデコードされたバージョンです。

高度な取得呼び出し

次に、高度な取得呼び出しフィルターの例をいくつか示します：

日付フィルター

以下は、高度な日付フィルターの取得呼び出しでサポートされている演算子の一部です:

～の間

{
  "fieldName": "DueDate",
  "value": ["2020-04-01","2020-04-30"],
  "alias": "A",
  "operator": "BTW"
}

に等しい

{
  "fieldName": "DueDate",
  "value": ["2020-04-14"],
  "alias": "A",
  "operator": "EQ"
}

等しくない

{
  "fieldName": "DueDate",
  "value": ["2020-04-14"],
  "alias": "A",
  "operator": "NE"
}

より大きい

{
  "fieldName": "DueDate",
  "value": ["2020-04-14"],
  "alias": "A",
  "operator": "GT"
}

より大きいまたは等しい

{
  "fieldName": "DueDate",
  "value": ["2020-04-14"],
  "alias": "A",
  "operator": "GTE"
}

未満

{
  "fieldName": "DueDate",
  "value": ["2020-04-14"],
  "alias": "A",
  "operator": "LT"
}

より小さいまたは等しい

{
  "fieldName": "DueDate",
  "value": ["2020-04-14"],
  "alias": "A",
  "operator": "LTE"
}

NULLです

{
  "fieldName": "CustomDate__gc",
  "value": [],
  "alias": "A",
  "operator": "IS_NULL"
}

NULLではない

{
  "fieldName": "CustomDate__gc",
  "value": [],
  "alias": "A",
  "operator": "IS_NOT_NULL"
}

日付フィルターの特殊なケース

日付フィルターで使うことができる多くの特別なトークンがあります。以下は、日付フィルターを使ってCTAを取得するために使うことができる特殊なケースの一部です:

今日：

{
  "fieldName": "DueDate",
  "value": [],
  "alias": "A",
  "operator": "EQ",
  "literal": "TODAY"
}

昨日

{
  "fieldName": "DueDate",
  "value": [],
  "alias": "A",
  "operator": "EQ",
  "literal": "YESTERDAY"
}

明日

{
  "fieldName": "DueDate",
  "value": [],
  "alias": "A",
  "operator": "EQ",
  "literal": "TOMORROW"
}

次のN日間

{
  "fieldName": "DueDate",
  "value": [30],
  "alias": "A",
  "operator": "EQ",
  "literal": "LAST_N_DAYS"
}

ユーザーフィルター

これはルックアップがGSUserオブジェクト上にある場合にのみ使うことができる特別なタイプのフィルタです。以下は、高度なユーザーフィルターの取得呼び出しでサポートされている演算子の一部です:

に等しい
等しくない
から始まる
含む
含まない

日付フィルターの特殊なケース

ユーザーフィルターで使うことができる３つの特別なトークンがあります。これらのトークンは、に等しい及び等しくない演算子でのみ使うことができます:

現在のユーザーフィルター

{
  "fieldName": "OwnerId",
  "value": [],
  "alias": "A",
  "operator": "EQ",
  "literal": "CURRENT_USER"
}

すべてのユーザーフィルター

{
  "fieldName": "OwnerId",
  "value": [],
  "alias": "A",
  "operator": "EQ",
  "literal": "ALL_USERS"
}

その他のユーザーフィルター

{
  "fieldName": "OwnerId",
  "value": ["1P015825RVB81GPY5OTDQ4GYW31IZC14GWQR"],
  "alias": "A",
  "operator": "NE",
  "literal": "OTHER_USER"
}

文字列フィルター

以下は、高度な文字列フィルターの取得呼び出しでサポートされている演算子の一部です:

に等しい

{
  "fieldName": "CompanyId__gr.Company_Test_Field__gc",
  "value": ["Manufacturing process has started"],
  "alias": "A",
  "operator": "EQ"
}

等しくない

{
  "fieldName": "CompanyId__gr.Company_Test_Field__gc",
  "value": ["Manufacturing process has started"],
  "alias": "A",
  "operator": "NE"
}

から始まる

{
  "fieldName": "CompanyId__gr.Company_Test_Field__gc",
  "value": ["Manufacturing"],
  "alias": "A",
  "operator": "STARTS_WITH"
}

含む

{
  "fieldName": "CompanyId__gr.Company_Test_Field__gc",
  "value": ["process"],
  "alias": "A",
  "operator": "CONTAINS"
}

含まない

{
  "fieldName": "CompanyId__gr.Company_Test_Field__gc",
  "value": ["process"],
  "alias": "A",
  "operator": "DOES_NOT_CONTAINS"
}

NULLです

{
  "fieldName": "CompanyId__gr.Company_Test_Field__gc",
  "value": [],
  "alias": "A",
  "operator": "IS_NULL"
}

NULLではない

{
  "fieldName": "CompanyId__gr.Company_Test_Field__gc",
  "value": [],
  "alias": "A",
  "operator": "IS_NOT_NULL"
}

ブールフィルタ

以下は、高度なブーリアンフィルターの取得呼び出しでサポートされている演算子の一部です:

に等しい

{  "fieldName": "IsImportant",
  "value": [true],
  "alias": "A",
  "operator": "NE"
}

等しくない

{
  "fieldName": "CompanyId__gr.CompanyBoolean__gc",  "value": [true],
  "alias": "A",
  "operator": "EQ"
}

数値フィルター

以下は、高度な数値フィルターの取得呼び出しでサポートされている演算子の一部です:

に等しい

{
  "fieldName": "ownerId__gr.user_number__gc",
  "value": [10],
  "alias": "A",
  "operator": "EQ"
}

等しくない

{
  "fieldName": "age",
  "value": [10],
  "alias": "A",
  "operator": "NE"
}

より大きい

{
  "fieldName": "companyId__gr.csm__gr.user_number__gc",
  "value": [10],
  "alias": "A",
  "operator": "GT"
}

より大きいまたは等しい

{
  "fieldName": "age",
  "value": [10],
  "alias": "A",
  "operator": "GTE"
}

未満

{
  "fieldName": "age",
  "value": [10],
  "alias": "A",
  "operator": "LT"
}

より小さいか等しい

{
  "fieldName": "age",
  "value": [10],
  "alias": "A",
  "operator": "LTE"
}

NULLです

{
  "fieldName": "companyId__gr.csm__gr.user_number__gc",
  "value": [],
  "alias": "A",
  "operator": "IS_NULL"
}

NULLではない

{
  "fieldName": "companyId__gr.csm__gr.user_number__gc",
  "value": [],
  "alias": "A",
  "operator": "IS_NOT_NULL"
}

パーセンテージフィルター

以下は、高度なパーセンテージフィルターの取得呼び出しでサポートされている演算子の一部です:

に等しい

{
  "fieldName": "companyId__gr.company_percentage__gc",
  "value": [83],
  "alias": "A",
  "operator": "EQ"
}

等しくない

{
  "fieldName": "companyId__gr.company_percentage__gc",
  "value": [83],
  "alias": "A",
  "operator": "NE"
}

より大きい

{
  "fieldName": "companyId__gr.csm__gr.user_percentage__gc",
  "value": [10],
  "alias": "A",
  "operator": "GT"
}

より大きいまたは等しい

{
  "fieldName": "companyId__gr.csm__gr.user_percentage__gc",
  "value": [10],
  "alias": "A",
  "operator": "GTE"
}

未満

{
  "fieldName": "ownerId__gr.user_percentage__gc",
  "value": [60],
  "alias": "A",
  "operator": "LT"
}

より小さいか等しい

{
  "fieldName": "ownerId__gr.user_percentage__gc",
  "value": [30],
  "alias": "A",
  "operator": "LTE"
}

NULLです

{
  "fieldName": "companyId__gr.csm__gr.user_percentage__gc",
  "value": [],
  "alias": "A",
  "operator": "IS_NULL"
}

NULLではない

{
  "fieldName": "companyId__gr.csm__gr.user_percentage__gc",
  "value": [],
  "alias": "A",
  "operator": "IS_NOT_NULL"
}

通貨フィルター

以下は、高度な通貨フィルターの取得呼び出しでサポートされている演算子の一部です:

に等しい

{
  "fieldName": "ownerId__gr.user_currency__gc",
  "value": [83],
  "alias": "A",
  "operator": "EQ"
}

等しくない

{
  "fieldName": "companyId__gr.company_currency__gc",
  "value": [83],
  "alias": "A",
  "operator": "NE"
}

より大きい

{
  "fieldName": "companyId__gr.csm__gr.user_currency__gc",
  "value": [10],
  "alias": "A",
  "operator": "GT"
}

より大きいまたは等しい

{
  "fieldName": "companyId__gr.csm__gr.user_currency__gc",
  "value": [10],
  "alias": "A",
  "operator": "GTE"
}

未満

{
  "fieldName": "ownerId__gr.user_currency__gc",
  "value": [60],
  "alias": "A",
  "operator": "LT"
}

より小さいか等しい

{ 
  "fieldName": "ownerId__gr.user_percentage__gc",
  "value": [30],
  "alias": "A",
  "operator": "LTE"
}

NULLです

{
  "fieldName": "companyId__gr.csm__gr.user_percentage__gc",
  "value": [],
  "alias": "A",
  "operator": "IS_NULL"
}

NULLではない

{
  "fieldName": "companyId__gr.csm__gr.user_percentage__gc",
  "value": [],
  "alias": "A",
  "operator": "IS_NOT_NULL"
}

ピックリストフィルター

以下は、高度なピックリストフィルターの取得呼び出しでサポートされている演算子の一部です:

に等しい

{
  "fieldName": "companyId__gr.csm__gr.user_picklist__gc",
  "value": ["1I0054U9FAKXZ0H26HF3ESSG4UYB5YTTPQVV"],
  "alias": "A",
  "operator": "EQ"
}

等しくない

{
  "fieldName": "CompanyId__gr.company_picklist__gc",
  "value": ["1I0054U9FAKXZ0H26HF3ESSG4UYB5YTTPQVV"],
  "alias": "A",
  "operator": "NE"
}

から始まる

{
  "fieldName": "custom_picklist__gc",
  "value": ["1I0054U9FAKXZ0H26HCDNCOD7NQT456P7RJL"],
  "alias": "A",
  "operator": "STARTS_WITH"
}

含む

{
  "fieldName": "ownerId__gr.user_picklist__gc",
  "value": ["1I0054U9FAKXZ0H26HF3ESSG4UYB5YTTPQVV"],
  "alias": "A",
  "operator": "CONTAINS"
}

含まない

{
  "fieldName": "custom_picklist__gc",
  "value": ["process"],
  "alias": "A",
  "operator": "DOES_NOT_CONTAINS"
}

含まれる

{
  "fieldName": "ownerId__gr.user_picklist__gc",
  "value": ["1I0054U9FAKXZ0H26HF3ESSG4UYB5YTTPQVV","1I0054U9FAKXZ0H26HTD7Y3TC7VE7MCN6BD0"],
  "alias": "A",
  "operator": "INCLUDES"
}

除外する

{
  "fieldName": "ownerId__gr.user_picklist__gc",
  "value": ["1I0054U9FAKXZ0H26HTD7Y3TC7VE7MCN6BD0","1I0054U9FAKXZ0H26HCDNCOD7NQT456P7RJL"],
  "alias": "A",
  "operator": "CONTAINS"
}

NULLです

{
  "fieldName": "companyId__gr.csm__gr.user_picklist__gc",
  "value": [],
  "alias": "A",
  "operator": "IS_NULL"
}

NULLではない

{
  "fieldName": "companyId__gr.csm__gr.user_picklist__gc",
  "value": [],
  "alias": "A",
"operator": "IS_NOT_NULL"
}

マルチピックリストフィルター

以下は、高度なマルチピックリストフィルターの取得呼び出しでサポートされている演算子の一部です:

含まれる

{
  "fieldName": "ownerId__gr.user_multipicklist__gc",
  "value": ["1I0054U9FAKXZ0H26HF3ESSG4UYB5YTTPQVV","1I0054U9FAKXZ0H26HTD7Y3TC7VE7MCN6BD0"],
  "alias": "A",
  "operator": "INCLUDES"
}

除外する

{
  "fieldName": "ownerId__gr.user_multipicklist__gc",
  "value": ["1I0054U9FAKXZ0H26HTD7Y3TC7VE7MCN6BD0","1I0054U9FAKXZ0H26HCDNCOD7NQT456P7RJL"],
  "alias": "A",
  "operator": "EXCLUDES"
}

GSIDフィルター

以下は、高度なGSIDフィルターの取得呼び出しでサポートされている演算子の一部です:

に等しい

{
  "fieldName": "gsid",
  "value": ["1S01B8KR0ST6J5HC5N0R2NDNAVC5V9P4GABM"],
  "alias": "A",
  "operator": "EQ"
}

等しくない

{
  "fieldName": "CompanyId__gr.gsid",
  "value": ["1P02ZUWNMOPV5SZ6ZLG7TZJMDCB8QNDDCACX"],
  "alias": "A",
  "operator": "NE"
}

から始まる

{
  "fieldName": "CompanyId__gr.gsid",
  "value": ["1P02ZUWNMOPV5"],
  "alias": "A",
"operator": "STARTS_WITH"
}

含む

{
  "fieldName": "CompanyId__gr.csm__gr.gsid",
  "value": ["5HC5N0R2NDNAV"],
  "alias": "A",
  "operator": "CONTAINS"
}

含まない

{
  "fieldName": "ownerId",
  "value": ["VC5V9P4GABM"],
  "alias": "A",
  "operator": "DOES_NOT_CONTAINS"
}

NULLです

{
  "fieldName": "CompanyId__gr.csm__gr.gsid",
  "value": [],
  "alias": "A",
  "operator": "IS_NULL"
}

NULLではない

{
  "fieldName": "companyId__gr.csm__gr.gsid",
  "value": [],
  "alias": "A",
  "operator": "IS_NOT_NULL"
}

ルックアップフィルター

以下は、高度のルックアップフィルターの取得呼び出しでサポートされている演算子の一部です:

に等しい

{
  "fieldName": "companyId",
  "value": ["1P02ZUWNMOPV5SZ6ZLG7TZJMDCB8QNDDCACX"],
  "alias": "A",
"operator": "EQ"
}

等しくない

{
  "fieldName": "companyId",
  "value": ["1P02ZUWNMOPV5SZ6ZLG7TZJMDCB8QNDDCACX"],
  "alias": "A",
  "operator": "NE"
}

から始まる

{
  "fieldName": "CompanyId",
  "value": ["1P02ZUWNMOP"],
  "alias": "A",
  "operator": "STARTS_WITH"
}

含む

{
  "fieldName": "ownerId",
  "value": ["PV5SZ6ZLG7TZJMD"],
  "alias": "A",
  "operator": "CONTAINS"
}

含まない

{
  "fieldName": "ownerId",
  "value": ["1S01B8KR0ST6J5HC5N0R2NDNAVC5V9P4GABM"],
  "alias": "A",
  "operator": "DOES_NOT_CONTAINS"
}

NULLです

{
  "fieldName": "companyId",
  "value": [],
  "alias": "A",
  "operator": "IS_NULL"
}

NULLではない

{
  "fieldName": "companyId",
"value": [],
  "alias": "A",
  "operator": "IS_NOT_NULL"
}

リンクされたオブジェクトのフィルター

以下は、高度のリンクされたオブジェクトのフィルターの取得呼び出しでサポートされている演算子の一部です:

に等しい

{
  "value": ["1Z027IA57F6SFBKJUYMKE58DPGDEHC14BP2F"],
  "associatedRecord" : true,
  "alias": "A",
  "operator": "EQ"
}

等しくない

{
  "value": ["1Z027IA57F6SFBKJUYMKE58DPGDEHC14BP2F"],
  "associatedRecord" : true,
  "alias": "A",
  "operator": "NE"
}

含まれる

{
  "value": ["1Z027IA57F6SFBKJUYMKE58DPGDEHC14BP2F", "1Z027IA57F6SFBKJUYT86Y0KE4JV9FK2IOCR"],
  "associatedRecord" : true,
  "alias": "A",
  "operator": "INCLUDES"
}

除外する

{
  "value": ["1Z027IA57F6SFBKJUYMKE58DPGDEHC14BP2F", "1Z027IA57F6SFBKJUYT86Y0KE4JV9FK2IOCR"],
  "associatedRecord" : true,
  "alias": "A",
  "operator": "EXCLUDES"
}

CTA構成の取得 (getコックピットConfig) API

CTA構成の取得APIは、CTAタイプ、理由、ステータス、及び優先度の CTA設定を取得するために使われます。ユーザーは返すピックリスト値を選択できます。例えば、category=CTA_StatusはCTAステータスのみを返します。

CTAタイプデータの場合、システムは依存する全ての選択リストを返します。例えば、CTAタイプが返される場合、ステータス、優先度、及び理由の全ての値が返されます。

「et」は選択リスト構成を返す必要があるエンティティタイプに使われます。「entityid」は関係タイプIDである関係のエンティティIDです。

メソッド

ゲット

エンドポイントのURL

v2/cockpit/admin/picklist/lite?category=CTA_STATUS,CTA_PRIORITY,CTA_TYPE&et=COMPANY

応答成功のサンプル

次のリクエストはCTAの理由に対するものです：

{
  "result": true,
  "errorCode": null,
  "errorDesc": null,
  "requestId": "1fb36683-fab0-4c2e-90cd-ab5feff015da",
  "data": {
    "CTA_REASON": [
      {
        "name": "Usage Drop",
        "gsid": "1I003F6D392Y2KJ97AOGZLY1OQHFA7AF1PGQ",
        "active": true,
        "entityType": "GLOBAL",
        "picklistCategory": "CTA_REASON",
        "typeId": "1I00650WACZ7F0X9HRPORQFJY1E53HXG18T8",
        "typeName": "ALL_CTA_TYPE"
      },
      {
        "name": "New Customer Kickoff",
        "gsid": "1I003F6D392Y2KJ97AN2OW5I69WFNBPJTY6A",
        "active": true,
        "entityType": "GLOBAL",
        "picklistCategory": "CTA_REASON",
        "typeId": "1I00650WACZ7F0X9HRPORQFJY1E53HXG18T8",
        "typeName": "ALL_CTA_TYPE"
      },
      {
        "name": "Onboarding",
        "gsid": "1I003F6D392Y2KJ97A2VH5Q8FGAI458OH3KT",
        "active": true,
        "entityType": "GLOBAL",
        "picklistCategory": "CTA_REASON",
        "typeId": "1I00650WACZ7F0X9HRPORQFJY1E53HXG18T8",
        "typeName": "ALL_CTA_TYPE"
      },
      {
        "name": "Habits Risk",
        "gsid": "1I003F6D392Y2KJ97AFO9J9X36I4IU97KNH7",
        "active": true,
        "entityType": "GLOBAL",
        "picklistCategory": "CTA_REASON",
        "typeId": "1I00650WACZ7F0X9HRPORQFJY1E53HXG18T8",
        "typeName": "ALL_CTA_TYPE"
      },
      {
        "name": "Bugs Risk",
        "gsid": "1I003F6D392Y2KJ97ANP5QXASLDHSPLT4W0D",
        "active": true,
        "entityType": "GLOBAL",
        "picklistCategory": "CTA_REASON",
        "typeId": "1I00650WACZ7F0X9HRPORQFJY1E53HXG18T8",
        "typeName": "ALL_CTA_TYPE"
      }
    ]
  },
  "message": null
}

次のリクエストはCTAの状態に対するものです：

{
  "result": true,
  "errorCode": null,
  "errorDesc": null,
  "requestId": "eeb9e58b-0b64-444b-bb62-5da18b85c11a",
  "data": {
    "CTA_STATUS": [
      {
        "name": "Closed Invalid",
        "gsid": "1I0017YS8AFRMU8633C2ZBBD51H55X5JDOA6",
        "active": true,
        "entityType": "GLOBAL",
        "picklistCategory": "CTA_STATUS",
        "typeId": "1I00650WACZ7F0X9HRPORQFJY1E53HXG18T8",
        "typeName": "ALL_CTA_TYPE"
      },
      {
        "name": "Closed Success",
        "gsid": "1I0017YS8AFRMU8633IA46KYK36YXW881F0W",
        "active": true,
        "entityType": "GLOBAL",
        "picklistCategory": "CTA_STATUS",
        "typeId": "1I00650WACZ7F0X9HRPORQFJY1E53HXG18T8",
        "typeName": "ALL_CTA_TYPE"
      }
    ]
  },
  "message": null
}

エラーコード

次の表は様々な種類のエラーメッセージと失敗の理由を示しています:

エラーコード	エラーメッセージ	理由	HTTPステータスコード
コックピット_9705	日付/日時フィールドの問題 - %Field問題のある名前%	日付/日時フィールドの形式が無効です	400
コックピット_5101	CTAタイプの詳細は使用できません	CTAタイプ名又はIDが提供されていない場合	400
コックピット_5101	入力されたタイプはシステムに存在しません	システム内のCTAタイプが無効です	400
コックピット_5101	オブジェクトでフィールドを使うことができません - %フィールド名に問題があります%	リクエストのフィールドが無効です	400
コックピット_5103	関連付けられたレコードが無効です - %フィールド名に問題があります%	関連レコードに無効なIDが入力されました	400
コックピット_6007	CTAの無効なGSID - %フィールド名に問題があります%	リクエストのCTAのGSIDが無効です。	400
コックピット_6007	ピックリスト/マルチピックリスト入力の問題 - %フィールド名に問題があります%	ピックリスト/マルチピックリスト入力に無効な値が指定されました	400
コックピット_7501	プレイブック名が無効です	リクエストで入力されたプレイブック名が無効です	400
コックピット_7501	プレイブックIDが無効です	リクエストで入力されたプレイブックIdが無効です	400
コックピット_9702	オブジェクトは特定のCTAタイプにリンクされていません - %フィールド名に問題があります%	リクエストに記載されているオブジェクトが特定のCTAタイプに設定されていない場合	400
コックピット_9703	ルックアップ構成の次のオブジェクトが無効です - %フィールド名に問題があります%	ルックアップ構成で入力されたオブジェクト名が無効です	400
コックピット_9703	リクエストに無効なルックアップフィールドが見つかりました - %フィールド名に問題があります%	リクエストで入力されたルックアップフィールドが無効です。	400
コックピット_9703	次のルックアップフィールドには、解決すべき無効なフィルタ構成があります - %フィールド名に問題があります%	ルックアップフィールドのフィルタ構成が無効です	400
コックピット_9704	次のルックアップフィールドには、解決すべきフィルタが少なくとも１つあります - %フィールド名に問題があります%	ルックアップフィールドにフィルターが指定されていない場合。	400
コックピット_9700	作成する必須フィールドがありません - %フィールド名に問題があります%	CTAアクションの作成に必須フィールドは使用することができません 400	400
コックピット_9700	更新する必須フィールドがありません - %フィールド名に問題があります%	CTAアクションの更新に必須フィールドは使用することができません	400
コックピット_9707	無効なピックリスト - %フィールド名に問題があります%	リクエストで入力された標準ピックリストが無効です	400