会社
企業は、リードレコードが属する組織を表します。 会社にリードを追加するには、 リードの同期または リードの一括読み込み エンドポイントを使用して、そのexternalCompanyId フィールドに入力します。
別の会社にリードを追加しない限り、会社からリードを削除することはできません。 会社レコードにリンクされたリードは、そのレコードから値を継承し、その値がリードレコードに存在するかのように処理します。
企業APIは、Microsoft Dynamics SyncまたはSFDC Syncが有効になっているサブスクリプションに対して、読み取り専用アクセスを提供します。
説明
会社レコードを操作するために必要な情報を取得する会社オブジェクトを記述します。
GET /rest/v1/companies/describe.json
{
"success":true,
"requestId":"5847#14d44113ad7",
"result":[
{
"name":"Company",
"description":"Company object",
"createdAt":"2015-05-11T17:11:32Z",
"updatedAt":"2015-05-11T17:11:32Z",
"idField":"id",
"dedupeFields":[
"externalCompanyId"
],
"searchableFields":[
[
"externalCompanyId"
],
[
"id"
],
[
"company"
]
],
"fields":[
{
"name":"createdAt",
"displayName":"Created At",
"dataType":"datetime",
"updateable":false
},
{
"name":"externalCompanyId",
"displayName":"External Company Id",
"dataType":"string",
"length":100,
"updateable":false
},
{
"name":"id",
"displayName":"Id",
"dataType":"integer",
"updateable":false
},
{
"name":"updatedAt",
"displayName":"Updated At",
"dataType":"datetime",
"updateable":false
},
{
"name":"annualRevenue",
"displayName":"Annual Revenue",
"dataType":"currency",
"updateable":true
}
{
"name":"company",
"displayName":"Company Name",
"dataType":"string",
"length":255,
"updateable":true
}
]
}
]
}
クエリ
企業のクエリのパターンは、リード APIに密接に従っています。 ただし、filterType パラメーターは、Describe Companies レスポンスまたはdedupeFieldsのsearchableFields配列にリストされているフィールドのみを受け入れます。
クエリパラメーターは次のとおりです。
filterTypeとfilterValues：必須パラメーター。fields、nextPageToken、およびbatchSize: リードと商談APIの対応するパラメーターと同様に機能するオプションのパラメーター。
fieldsのリストをリクエストする場合、返されないリクエストされたフィールドの暗黙的な値はnullです。
fields パラメーターを省略すると、応答はデフォルトで次のフィールドを返します。
- id
- dedupeFields
- updatedAt
- createdAt
GET /rest/v1/companies.json?filterType=id&filterValues=3433,5345
{
"requestId":"e42b#14272d07d78",
"success":true,
"result":[
{
"seq":0,
"id":3433,
"externalCompanyId":"19UYA31581L000000",
"company":"Google"
},
{
"seq":1,
"id":5345,
"externalCompanyId":"29UYA31581L000000",
"company":"Yahoo"
}
]
}
作成と更新
Sync Companies エンドポイントは、会社オブジェクトの配列を含む必須のinput パラメーターを受け入れます。
商談と同様に、エンドポイントは3つの作成モードと更新モード（createOnly、updateOnly、createOrUpdate）をサポートしています。 リクエストのaction パラメーターでモードを指定します。
dedupeByおよびaction パラメーターはオプションです。 デフォルトでは、それぞれdedupeFieldsとcreateOrUpdateです。
POST /rest/v1/companies.json
Content-Type: application/json
{
"action":"createOrUpdate",
"dedupeBy":"dedupeFields",
"input":[
{
"externalCompanyId":"19UYA31581L000000",
"company":"Google"
},
{
"externalCompanyId":"29UYA31581L000000",
"company":"Yahoo"
}
]
}
{
"requestId":"e42b#14272d07d78",
"success":true,
"result":[
{
"seq":0,
"status":"updated",
"id":1232
},
{
"seq":1,
"status":"created",
"id":1323
}
]
}
フィールド
company オブジェクトには、表示名、API名、dataTypeなどの属性で定義されたフィールドが含まれます。 これらの属性をメタデータと呼びます。
次のエンドポイントは、会社オブジェクトのフィールドをクエリします。 API ユーザーには、Read-Write Schema Standard Field権限、Read-Write Schema Custom Field権限、またはその両方を持つ役割が必要です。
クエリフィールド
API名で1つの会社フィールドをクエリするか、すべての会社フィールドを取得します。
名前別
名前で会社フィールドを取得 エンドポイントは、会社オブジェクトの1つのフィールドのメタデータを取得します。 必須のfieldApiName パスパラメーターは、フィールドのAPI名を指定します。
応答はDescribe Company応答に似ていますが、追加のメタデータが含まれています。 例えば、isCustom属性は、フィールドがカスタムかどうかを示します。
GET /rest/v1/companies/schema/fields/industry.json
{
"requestId": "88f6#17e976d6ab4",
"result": [
{
"displayName": "Industry",
"name": "industry",
"description": null,
"dataType": "string",
"length": 255,
"isHidden": false,
"isHtmlEncodingInEmail": true,
"isSensitive": false,
"isCustom": false,
"isApiCreated": false
}
],
"success": true
}
参照
会社フィールドを取得エンドポイントでは、会社オブジェクトのすべてのフィールドのメタデータを取得します。 デフォルトでは、最大300件のレコードが返されます。 この数を減らすには、batchSize クエリパラメーターを使用します。
moreResult 属性が true の場合、さらに多くの結果が使用可能です。 moreResultがfalseになるまで、返されたnextPageTokenでエンドポイントの呼び出しを続行します。
GET /rest/v1/companies/schema/fields.json?batchSize=5
{
"requestId": "b50e#17e995c2d35",
"result": [
{
"displayName": "Company Name",
"name": "company",
"description": null,
"dataType": "string",
"length": 255,
"isHidden": false,
"isHtmlEncodingInEmail": true,
"isSensitive": false,
"isCustom": false,
"isApiCreated": false
},
{
"displayName": "Site",
"name": "site",
"description": null,
"dataType": "string",
"length": 255,
"isHidden": false,
"isHtmlEncodingInEmail": true,
"isSensitive": false,
"isCustom": false,
"isApiCreated": false
},
{
"displayName": "Website",
"name": "website",
"description": null,
"dataType": "url",
"length": 255,
"isHidden": false,
"isHtmlEncodingInEmail": true,
"isSensitive": false,
"isCustom": false,
"isApiCreated": false
},
{
"displayName": "Main Phone",
"name": "mainPhone",
"description": null,
"dataType": "string",
"length": 255,
"isHidden": false,
"isHtmlEncodingInEmail": true,
"isSensitive": false,
"isCustom": false,
"isApiCreated": false
},
{
"displayName": "Annual Revenue",
"name": "annualRevenue",
"description": null,
"dataType": "currency",
"isHidden": false,
"isHtmlEncodingInEmail": false,
"isSensitive": false,
"isCustom": false,
"isApiCreated": false
}
],
"success": true,
"nextPageToken": "L7XD3EFJ3OLFZKXKJBWYULOTRA======",
"moreResult": true
}
削除
削除条件をinput配列内の検索値のリストとして指定します。 deleteBy パラメーターで削除方法を指定します。
許可される値はdedupeFieldsとidFieldです。 デフォルトはdedupeFieldsです。
Content-Type: application/json
POST /rest/v1/companies/delete.json
{
"deleteBy":"dedupeFields",
"input":[
{
"externalCompanyId":"19UYA31581L000000"
},
{
"externalCompanyId":"29UYA31581L000000"
},
{
"externalCompanyId":"39UYA31581L000000"
}
]
}
{
"requestId":"e42b#14272d07d78",
"success":true,
"result":[
{
"seq":0,
"id":1234,
"status":"deleted"
},
{
"seq":1,
"id":56456,
"status":"deleted"
},
{
"seq":2,
"status":"skipped",
"reasons":[
{
"code":"1013",
"message":"Record not found"
}
]
}
]
}
タイムアウト
- 特に明記されていない限り、企業エンドポイントのタイムアウトは30秒です。
- Sync Companiesのタイムアウトは60秒です。
- Delete Companiesのタイムアウトは60秒です。