機械翻訳について

ジャンプ先

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

ユースケース選択フィールドの更新

patch

/crmRestApi/resources/11.13.18.05/salesMLUsecases/{UsecaseCode}/child/ZcaOmlUsecaseFixedFields/{ZcaOmlUsecaseFixedFieldsUniqID}

リクエスト

パス・パラメータ

• UsecaseCode(required): string
  このパラメータの値は、リソース・アイテムを一意に識別するために使用されるキーのハッシュである可能性があります。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはフィルタを使用してコレクション・リソースを問い合せ、特定のリソース・アイテムにナビゲートする必要があります。 例: products?q=InventoryItemId=
• ZcaOmlUsecaseFixedFieldsUniqID(required): string
  これは、ユースケース選択済フィールド・リソースのコンポジット・キー(FieldNameおよびUsecaseCode ---)を構成する属性のハッシュ・キーで、ユースケース選択済フィールドのインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、ユースケース選択済フィールドの特定のインスタンスに移動するために、主キー値に対するフィルタを使用して、ユースケース選択済フィールド・コレクション・リソースを問い合せる必要があります。
  
  次に例を示します: ZcaOmlUsecaseFixedFields?q=FieldName=<value1>;UsecaseCode=<value2>

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• AdditionalMetadata: 文字列(バイト)
  レコードのオブジェクト・バージョン番号。
• FieldDataType: string
  最大長: 200

  文字列、ブールなど、フィールドのデータ型。
• FieldName: string
  最大長: 800

  使用可能なフィールドの表示名。
• ObjectVersionNumber: 整数(int32)
  レコードのオブジェクト・バージョン番号。
• UsecaseCode: string
  最大長: 200

  ユース・ケースの検索に使用されるユース・ケースの一意の識別子。

{
    "type":"object",
    "properties":{
        "FieldDataType":{
            "maxLength":200,
            "type":"string",
            "description":"The data type of the field such as string, boolean, and so on.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "FieldName":{
            "maxLength":800,
            "type":"string",
            "description":"The display name of the available field.",
            "nullable":false
        },
        "UsecaseCode":{
            "maxLength":200,
            "type":"string",
            "description":"The unique identifier of the use case used to find a use case.",
            "nullable":false
        },
        "AdditionalMetadata":{
            "type":"string",
            "description":"The object version number for the record.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : salesMLUsecases-ZcaOmlUsecaseFixedFields-item-response

タイプ: object

ソースを表示

• AdditionalMetadata: 文字列(バイト)
  レコードのオブジェクト・バージョン番号。
• CreatedBy: string
  読取り専用: true

  最大長: 64

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

  レコードが作成された日付。
• FieldDataType: string
  最大長: 200

  文字列、ブールなど、フィールドのデータ型。
• FieldName: string
  最大長: 800

  使用可能なフィールドの表示名。
• LastUpdateDate: string (date-time)
  読取り専用: true

  モデル・レコードが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

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

  最大長: 32

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

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectVersionNumber: 整数(int32)
  レコードのオブジェクト・バージョン番号。
• UsecaseCode: 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 when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FieldDataType":{
            "maxLength":200,
            "type":"string",
            "description":"The data type of the field such as string, boolean, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the record.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AdditionalMetadata":{
            "type":"string",
            "description":"The object version number for the record.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FieldName":{
            "maxLength":800,
            "type":"string",
            "description":"The display name of the available field.",
            "nullable":false,
            "x-queryable":true
        },
        "UsecaseCode":{
            "maxLength":200,
            "type":"string",
            "description":"The unique identifier of the use case used to find a use case.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the model record 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 model.",
            "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."
        }
    }
}

「トップに戻る」