sObject Describe

指定されたオブジェクトのすべてのレベルで、個別のメタデータを完全に説明します。たとえば、これは、Account オブジェクトの項目、URL、および子リレーションを取得するために使用できます。

取得されるメタデータについての詳細は、『SOAP API 開発者ガイド』の「DescribesObjectResult」を参照してください。

このリソースでは、If-Modified-Since ヘッダーまたは If-Unmodified-Since ヘッダーを使用できます。If-Modified-Since ヘッダーが使用される場合、指定の日付以降に使用可能なオブジェクトのメタデータが変更されていないと、レスポンスボディなしで 304 Not Modified 状況コードが返されます。

URI

/services/data/vXX.X/sobjects/sObject/describe/

形式

JSON、XML

HTTP メソッド

GET

認証

Authorization: Bearer token

パラメータ

パラメータ	説明
sObject	オブジェクトの名前。たとえば、Account などです。 必須のパスパラメータ。
If-Modified-Since	日時を指定する省略可能なヘッダー。この要求では、その日時以降に変更されたレコードが返されます。 形式は EEE, dd MMM yyyy HH:mm:ss z です。例: If-Modified-Since: Mon, 30 Nov 2020 08:34:54 MST。
If-Unmodified-Since	日時を指定する省略可能なヘッダー。この要求では、その日時以降に変更されなかったレコードが返されます。 形式は EEE, dd MMM yyyy HH:mm:ss z です。例: If-Unmodified-Since: Mon, 30 Nov 2020 08:34:54 MST。

例

「オブジェクトの項目と他のメタデータを取得する」を参照してください。If-Modified-Since HTTP ヘッダーの使用例は、「オブジェクトのメタデータの変更の取得」を参照してください。