機械翻訳について

ジャンプ先

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

構成の更新

patch

/crmRestApi/resources/11.13.18.05/sensingAgentConfigurations/{ConfigurationCode}

リクエスト

パス・パラメータ

• ConfigurationCode(required): string
  このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• AdditionalContext: 文字列(バイト)
  構成の追加コンテキスト(存在する場合)。
• ConfigurationValue: string
  最大長: 200

  構成の構成値。
• EffectiveEndDate: 文字列(日付)
  関連付けられた構成が有効である最終日。
• EffectiveStartDate: 文字列(日付)
  関連付けられた構成が有効である開始日。

{
    "type":"object",
    "properties":{
        "AdditionalContext":{
            "type":"string",
            "description":"The additional context for the configuration, if any.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ConfigurationValue":{
            "maxLength":200,
            "type":"string",
            "description":"The configuration value for the configuration.",
            "nullable":false
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The date till which the associated configuration is valid.",
            "format":"date",
            "nullable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The date from which the associated configuration is valid.",
            "format":"date",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• AdditionalContext: 文字列(バイト)
  構成の追加コンテキスト(存在する場合)。
• ConfigurationCode: string
  最大長: 200

  構成の構成コード。
• ConfigurationMeaning: string
  最大長: 700

  構成の構成内容。
• ConfigurationValue: string
  最大長: 200

  構成の構成値。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  構成が作成された日時。
• EffectiveEndDate: 文字列(日付)
  関連付けられた構成が有効である最終日。
• EffectiveStartDate: 文字列(日付)
  関連付けられた構成が有効である開始日。
• LastUpdateDate: string (date-time)
  読取り専用: true

  構成が最後に更新された日時。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  モデルを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  構成を最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• SaContextCode: string
  最大長: 80

  構成のコンテキスト・コード。
• SaContextValue: string
  最大長: 200

  構成のコンテキスト値。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the model.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the configuration was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The date till which the associated configuration is valid.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SaContextCode":{
            "maxLength":80,
            "type":"string",
            "description":"The context code for the configuration.",
            "nullable":false,
            "x-queryable":true
        },
        "ConfigurationCode":{
            "maxLength":200,
            "type":"string",
            "description":"The configuration code of the configuration.",
            "nullable":false,
            "x-queryable":true
        },
        "ConfigurationMeaning":{
            "maxLength":700,
            "type":"string",
            "description":"The configuration meaning of the configuration.",
            "nullable":false,
            "x-queryable":true
        },
        "AdditionalContext":{
            "type":"string",
            "description":"The additional context for the configuration, if any.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ConfigurationValue":{
            "maxLength":200,
            "type":"string",
            "description":"The configuration value for the configuration.",
            "nullable":false,
            "x-queryable":true
        },
        "SaContextValue":{
            "maxLength":200,
            "type":"string",
            "description":"The context value for the configuration.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The date from which the associated configuration is valid.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the configuration was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the configuration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: 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."
        }
    }
}

「トップに戻る」