機械翻訳について

ジャンプ先

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

スマート・テキスト・ユーザー変数の作成

post

/crmRestApi/resources/11.13.18.05/smartTextUserVariables

リクエスト

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

• application/json

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

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

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

タイプ: object

ソースを表示

• Attribute: string
  最大長: 50

  置換の値を保持するオブジェクトのフィールドまたは属性。
• BuOrgId: integer (int64)
  タイトル: Business Unit

  ユーザー変数に対するビジネス・ユニット組織の一意の識別子。
• Context: string
  タイトル: Domain

  最大長: 50

  デフォルト値: ORA_SVC_SR

  この変数が使用されるアプリケーションまたはコンテキスト。
• Description: string
  最大長: 50

  変数の簡単な説明。
• Object: string
  タイトル: Object

  最大長: 150

  これは、変数に置換する値を保持するオブジェクトへの参照です。
• StripeCd: string
  タイトル: Stripe Code

  最大長: 30

  CRM、HCM、PRMなどのストライプ・コードを示す参照コード。
• SubstitutionMethod: string
  最大長: 255

  デフォルト値: Prompt

  導出に使用されるメソッドの摘要値です。 値には、プロンプト、値および評価があります。
• ValChar: string
  タイトル: Value

  最大長: 150

  変数置換の静的文字値。
• VariableCode: string
  タイトル: Variable

  最大長: 50

  コンテキストを実際の値に置換するためにUIに表示される変数。
• VariableNumber: string
  最大長: 30

  公開サロゲート・キー。
• VariableUniqueNumber: string
  最大長: 30

  必須の公開一意サロゲート・キー。

{
    "type":"object",
    "properties":{
        "Context":{
            "title":"Domain",
            "maxLength":50,
            "type":"string",
            "description":"The application or context with which this variable is used.",
            "nullable":false,
            "default":"ORA_SVC_SR",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "VariableUniqueNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public unique surrogate key which is required.",
            "nullable":false
        },
        "VariableCode":{
            "title":"Variable",
            "maxLength":50,
            "type":"string",
            "description":"The variable that is displayed in the UI for context substitution into actual value.",
            "nullable":false
        },
        "Description":{
            "maxLength":50,
            "type":"string",
            "description":"The short description of the variable.",
            "nullable":true
        },
        "Attribute":{
            "maxLength":50,
            "type":"string",
            "description":"The field or attribute of the object that holds the value for substitution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubstitutionMethod":{
            "maxLength":255,
            "type":"string",
            "description":"The descriptive value for the method used for derivation. Values include 'Prompt', 'Value' and 'Eval'.",
            "nullable":true,
            "default":"Prompt",
            "x-queryable":false
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates the stripe code, such as CRM, HCM, or PRM.",
            "nullable":false
        },
        "ValChar":{
            "title":"Value",
            "maxLength":150,
            "type":"string",
            "description":"The static character value for the variable substitution.",
            "nullable":true
        },
        "Object":{
            "title":"Object",
            "maxLength":150,
            "type":"string",
            "description":"This is the reference to the object that holds the value for substituting the variable.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BuOrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit organization for the user variable.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "VariableNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public surrogate key.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• Attribute: string
  最大長: 50

  置換の値を保持するオブジェクトのフィールドまたは属性。
• BuOrgId: integer (int64)
  タイトル: Business Unit

  ユーザー変数に対するビジネス・ユニット組織の一意の識別子。
• Context: string
  タイトル: Domain

  最大長: 50

  デフォルト値: ORA_SVC_SR

  この変数が使用されるアプリケーションまたはコンテキスト。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  スマート・テキスト・ユーザー変数を作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  スマート・テキスト・ユーザー変数が作成された日時。
• Description: string
  最大長: 50

  変数の簡単な説明。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  スマート・テキスト・ユーザー変数が最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  スマート・テキスト・ユーザー変数を最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  スマート・テキスト・ユーザー変数を最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• Object: string
  タイトル: Object

  最大長: 150

  これは、変数に置換する値を保持するオブジェクトへの参照です。
• StripeCd: string
  タイトル: Stripe Code

  最大長: 30

  CRM、HCM、PRMなどのストライプ・コードを示す参照コード。
• SubstitutionMethod: string
  最大長: 255

  デフォルト値: Prompt

  導出に使用されるメソッドの摘要値です。 値には、プロンプト、値および評価があります。
• ValChar: string
  タイトル: Value

  最大長: 150

  変数置換の静的文字値。
• VariableCode: string
  タイトル: Variable

  最大長: 50

  コンテキストを実際の値に置換するためにUIに表示される変数。
• VariableId: integer (int64)
  タイトル: Variable ID

  読取り専用: true

  スマート・テキスト・ユーザー変数の一意の識別子。
• VariableNumber: string
  最大長: 30

  公開サロゲート・キー。
• VariableUniqueNumber: string
  最大長: 30

  必須の公開一意サロゲート・キー。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the smart text user variable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Context":{
            "title":"Domain",
            "maxLength":50,
            "type":"string",
            "description":"The application or context with which this variable is used.",
            "nullable":false,
            "default":"ORA_SVC_SR",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the smart text user variable was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the smart text user variable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "VariableCode":{
            "title":"Variable",
            "maxLength":50,
            "type":"string",
            "description":"The variable that is displayed in the UI for context substitution into actual value.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "maxLength":50,
            "type":"string",
            "description":"The short description of the variable.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute":{
            "maxLength":50,
            "type":"string",
            "description":"The field or attribute of the object that holds the value for substitution.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VariableNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public surrogate key.",
            "nullable":true,
            "x-queryable":true
        },
        "VariableUniqueNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The public unique surrogate key which is required.",
            "nullable":false,
            "x-queryable":true
        },
        "SubstitutionMethod":{
            "maxLength":255,
            "type":"string",
            "description":"The descriptive value for the method used for derivation. Values include 'Prompt', 'Value' and 'Eval'.",
            "nullable":true,
            "default":"Prompt",
            "x-queryable":false
        },
        "StripeCd":{
            "title":"Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates the stripe code, such as CRM, HCM, or PRM.",
            "nullable":false,
            "x-queryable":true
        },
        "ValChar":{
            "title":"Value",
            "maxLength":150,
            "type":"string",
            "description":"The static character value for the variable substitution.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Object":{
            "title":"Object",
            "maxLength":150,
            "type":"string",
            "description":"This is the reference to the object that holds the value for substituting the variable.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "VariableId":{
            "title":"Variable ID",
            "type":"integer",
            "description":"The unique identifier of the smart text user variable.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BuOrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit organization for the user variable.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the smart text user variable was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the smart text user variable.",
            "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."
        }
    }
}

「トップに戻る」