メソッド

削除

エンドポイントURL

v1/teams/services/companyTeam/{gsid}

パラメータ

成功応答の例

{
  "result": true,
  "errorCode": null,
  "errorDesc": null,
  "requestId": "8863e73c-a465-4fc6-a385-f7b3200720dc",
  "data": "Record with GSID: 1I0054U9FAKXZ0H26H4H0U5VRD65H9JW66FJ successfully deleted.",
}

失敗応答のサンプル

{ 
  "result": false,
  "errorCode": "GSOBJ_1XXX",
  "errorDesc": "No data found for given criteria",
  "requestId": "58222b97-eaf0-402e-854d-1914987c4b49",
  "data": null,
}   

メソッド

ポスト

エンドポイントURL

v1/teams/services/companyTeam/delete

リクエスト本文の例

[
"1P01936XHTA4SF76ZU5RWZWIMDDL54UB7UF9",
"1P01936XHTA4SF76ZUUXHOUMVVSFH9YJM15A",
"1P01936XHTA4SF76ZUW5J2RVEZZ8H33C8MAM"]   

パラメーター

成功応答の例

    
{
  
    "result": true,
  
    "errorCode": null,
  
    "errorDesc": null,
  
    "requestId":   "8863e73c-a465-4fc6-a385-f7b3200720dc",
  
    "data": {
  
      "success": {
  
        "gsid": [
  
          "1P01936XHTA4SF76ZU5RWZWIMDDL54UB7UF9",
  
          "1P01936XHTA4SF76ZUUXHOUMVVSFH9YJM15A"
  
      ]
  
    },
  
      "errors": [
  
      {
  
          "gsid": [
  
            "1P01936XHTA4SF76ZU5RWZWIMDDL54UB7UF9",
  
            "1P01936XHTA4SF76ZUUXHOUMVVSFH9YJM15A"
  
        ],
  
          "errorCode": "GSOBJ_1XXX",
  
          "errorDesc": "No data found for given criteria"
  
      }
  
    ]
  
  }
  
}
  
  

失敗応答のサンプル

{
    "result": false,
    "errorCode": "GU_1129",
    "errorDesc": "Invalid GSID value.",
    "localizedErrorDesc": "Invalid GSID value.",
    "requestId": "a0f958fb-fee7-4a15-8029-e334350ce1b7",
    "data": null,
    "message": null,
    "localizedMessage": null}   
    

メソッド

入力

エンドポイントURL

v1/teams/services/companyTeam?key=CompanyGsid,UserGsid

または

v1/teams/services/companyTeam?key=Gsid

重要:

• キーオプション:
  • キーパラメータには、GSID (key=GSID) またはCompanyGsidとUserGsidの組み合わせ (key=CompanyGsid, UserGsid) のいずれかがあります。
• 必須フィールド:
  • GSIDが識別子 (key=GSID) として指定されている場合は、リクエスト本文にGSIDフィールドを含めることが必須となります。
  • CompanyGsidとUserGsidが識別子 (key=CompanyGsid, UserGsid) として指定されている場合は、リクエスト本文にCompanyGsidとUserGsidを含めることが必須となります。
• デフォルトの識別子:
  • エンドポイントURLにキーパラメータが指定されていない場合は、デフォルトの識別子としてCompanyGsidとUserGsidが使用されます。したがって、エンドポイントURLにキーが渡されていない場合は、リクエスト本文にCompanyGsidフィールドとUserGsidフィールドを指定することが必須となります。

リクエスト本文の例

以下は、CompanyNameとusernameが含まれるリクエスト本文の例です。

 {
    "records": [
        {
            "UserRole" : "Account Manager",
            "CompanyName": "IBM",
            "UserName": "Sandeep Kumar",
            "TeamAdmin" : "true",
            "Custom_String1__gc" : "hello",
            "Custom_Picklist__gc" : "Account Manager",
        },
        {
            "UserRole" : "Account Manager",
            "CompanyName": "Youtube",
            "UserName": "Sandeep Kumar",
            "TeamAdmin" : "true",
            "Custom_String__gc" : "hello",
            "Custom_Picklist__gc" : "Account Manager"
        }
    ],
      "lookups": {
        "CompanyGsid": {
            "fields": {
                "CompanyName": "Name"
            },
            "lookupField": "Gsid",
            "objectName": "Company",
            "multiMatchOption": "FIRSTMATCH"
        },
        "UserGsid": {
            "fields": {
                "UserName": "Name"
            },
            "lookupField": "Gsid",
            "objectName": "GsUser"
        }
    }
     
}
 

以下は、CompanyGsidとUserGsidが含まれるリクエスト本文の例です。

     
{
  
      "records": [
  
        {
  
              "UserRole" : "Account Manager",
  
              "CompanyName": "IBM",
  
              "UserName": "Sandeep Kumar",
  
              "TeamAdmin" : "true",
  
              "Custom_String1__gc" : "hello",
  
              "Custom_Picklist__gc" : "Account Manager",
  
        },
  
        {
  
              "UserRole" : "Account Manager",
  
              "CompanyName": "Youtube",
  
              "UserName": "Sandeep Kumar",
  
              "TeamAdmin" : "true",
  
              "Custom_String__gc" : "hello",
  
              "Custom_Picklist__gc" : "Account Manager"
  
        }
  
    ],
  
        "lookups": {
  
        "CompanyGsid": {
  
            "fields": {
  
                "CompanyGsid":   "Gsid"
  
            },
  
            "lookupField":   "Gsid",
  
            "objectName":   "Company",
  
            "multiMatchOption":   "FIRSTMATCH"
  
        },
  
        "UserGsid": {
  
            "fields": {
  
                "UserGsid": "Gsid"
  
            },
  
            "lookupField":   "Gsid",
  
            "objectName":   "GsUser"
  
        }
  
      } 
  
    
  
}
  

パラメータ

以下はkey = CompanyGsid, UserGsidの場合のパラメータのリストです。

以下は、key = Gsidの場合のパラメータのリストです。

成功応答の例

    
 
      
{
  
    "result": true,
  
    "errorCode": null,
  
    "errorDesc": null,
  
    "localizedErrorDesc": null,
  
    "requestId":   "6672f3fd-f049-4434-8a4b-46a1b7b09308",
  
    "data": {
  
        "success": {
  
            "records": [
  
                {
  
                    "UserGsid":   "1P01A7JNOWRLONI81IADNSU9OSAE8VW22OGV",
  
                      "Custom_Picklist__gc": "Account Manager",
  
                    "CompanyGsid":   "1P02EWJH7V1ARTU135948UTCK78QC96QL78G",
  
                    "CreatedBy":   "123",
  
                    "UserRole":   "Account Manager",
  
                    "TeamAdmin":   "true",
  
                      "Custom_String1__gc": "hello",
  
                    "ModifiedBy":   "Sandeep Kumar"
  
                },
  
                {
  
                   {
  
                      "UserRole" :   "Account Manager",
  
                      "CompanyGsid": "1P02EWJH7V1ARTU135948UTCK78QC96ABCWE",
  
                        "UserGsid": "1P01A7JNOWRLONI81IADNSU9OSAE8VW22OGV",
  
                      "TeamAdmin" :   "true",
  
                        "Custom_String__gc" : "hello",
  
                       "Custom_Picklist__gc" : "Account Manager"
  
                }
  
            ]
  
        },
  
        "errors": null
  
    },
  
    "message": null,
  
    "localizedMessage": null
  
}
  

失敗応答のサンプル

{
            "result": false,
            "errorCode": "GU_2403",
            "errorDesc": "Lookup objects [Company1] are not valid",
            "requestId": "0bf61426-63ad-4774-ad95-4bd2f6c43c25",
            "data": null,
            "message": null
}     

メソッド

ポスト

エンドポイントURL

v1/teams/services/companyTeam/list

リクエスト本文の例

{
    "limit": 25,
    "page": 0,
    "orderBy": {
        "ModifiedDate": "desc"
    },
    "select": [
        "Gsid",
        "CompanyName",
        "UserName",
        "UserRole",
        "ModifiedDate"
    ],
    "where": {
        "conditions": [
            {
                "name": "CompanyName",
                "alias": "companyNotIn",
                "value": [
                    "Youtube"
                ],
                "operator": "NOT_IN"
            },
            {
                "alias": "companyIn",
                "name": "CompanyName",
                "operator": "IN",
                "value": [
                    "IBM"
                ]
            }
        ],
        "expression": "companyNotIn AND (companyIn)"
    }} 
    

パラメーター

応答成功のサンプル

{
    "result": true,
    "errorCode": null,
    "errorDesc": null,
    "localizedErrorDesc": null,
    "requestId": "b518fb98-336d-404f-83ab-40fb01730867",
    "data": {
        "page": 0,
        "size": 1,
        "limit": 25,
        "records": [
            {
                "Gsid": "1P071TST1Z6DTGBG44KDYJG9KBNTDQMQ3QHO",
                "UserRole": "Pre-Sales Consultant",
                "ModifiedDate": "2023-10-03T10:03:32Z",
                "Name": "Admin User",
                "CompanyName": "IBM"
            }
        ]
    },
    "message": null,
    "localizedMessage": null}
    

失敗応答のサンプル

{
    "result": false,
    "errorCode": "GU_1707",
    "errorDesc": "Failed to fetch records.",
    "localizedErrorDesc": "Failed to fetch records.",
    "requestId": "667951ba-b04f-4407-b326-1347645efdc6",
    "data": null,
    "message": null,
    "localizedMessage": null
}