機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

最近のアイテムの更新

patch

/crmRestApi/resources/11.13.18.05/recentItems/{RecentItemId}

リクエスト

パス・パラメータ

• RecentItemId(required): string
  最近のアイテムの一意の識別子。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• AccessDate: string (date-time)
  最近のアイテムがアクセスされた時間。
• EntityName: string
  オブジェクトの名前。
• Flow: string
  アイテムのフロー。 有効な値は、READ、CREATE、UPDATE、ASSOCIATEおよびFAVORITEです。
• ObjectId: integer (int64)
  オブジェクトの一意の識別子。
• RecentItemId: string
  最大長: 32

  最近のアイテムの一意の識別子。

{
    "type":"object",
    "properties":{
        "RecentItemId":{
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the recent item.",
            "nullable":false
        },
        "AccessDate":{
            "type":"string",
            "description":"The time when the recent item was accessed.",
            "format":"date-time",
            "nullable":false
        },
        "EntityName":{
            "type":"string",
            "description":"The name of the object.",
            "nullable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique identifier of the object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Flow":{
            "type":"string",
            "description":"The flow of the item. The valid values are READ, CREATE, UPDATE, ASSOCIATE, and FAVORITE.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : recentItems-item-response

タイプ: object

ソースを表示

• AccessDate: string (date-time)
  最近のアイテムがアクセスされた時間。
• EntityName: string
  オブジェクトの名前。
• Flow: string
  アイテムのフロー。 有効な値は、READ、CREATE、UPDATE、ASSOCIATEおよびFAVORITEです。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectId: integer (int64)
  オブジェクトの一意の識別子。
• RecentItemId: string
  最大長: 32

  最近のアイテムの一意の識別子。

{
    "type":"object",
    "properties":{
        "RecentItemId":{
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the recent item.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccessDate":{
            "type":"string",
            "description":"The time when the recent item was accessed.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "EntityName":{
            "type":"string",
            "description":"The name of the object.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique identifier of the object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Flow":{
            "type":"string",
            "description":"The flow of the item. The valid values are READ, CREATE, UPDATE, ASSOCIATE, and FAVORITE.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

トップに戻る

例:

次の例は、RESTリソースに対してPATCHリクエストを発行して、最近のアイテムを更新する方法を示しています。

cURLコマンド

curl -u <username:password> \
 -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/recentItems/4dedd20286a1431c9480ec77f2d95c7f  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
   
   "EntityName": "partners"
   
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
    "ObjectId": 5,
    "RecentItemId": "4dedd20286a1431c9480ec77f2d95c7f",
    "Flow": null,
    "EntityName": "accounts",
    "AccessDate": "2022-08-09T10:36:00+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/recentItems/4dedd20286a1431c9480ec77f2d95c7f",
            "name": "recentItems",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/recentItems/4dedd20286a1431c9480ec77f2d95c7f",
            "name": "recentItems",
            "kind": "item"
        }
    ]
}

「トップに戻る」