機械翻訳について

ジャンプ先

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

マイルストンの作成

post

/crmRestApi/resources/11.13.18.05/milestones

リクエスト

ヘッダー・パラメータ

• 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

ソースを表示

• AllowAgentCompletionFlag: boolean
  タイトル: Allow Agent Completion

  最大長: 1

  デフォルト値: false

  エージェントがマイルストンを完了としてマークすることを許可
• AllowDueDateOverrideFlag: boolean
  タイトル: Allow Due Date Override

  最大長: 1

  デフォルト値: false

  エージェントがマイルストン期日を上書きすることを許可
• BUOrgId: integer (int64)
  マイルストン構成に関連付けられたビジネス・ユニット名の一意のID。
• DeletedFlag: boolean
  最大長: 1

  デフォルト値: false

  削除済フラグ
• DisabledFlag: boolean
  タイトル: Disabled

  最大長: 1

  デフォルト値: false

  使用不可フラグ
• MilestoneCode: string
  タイトル: Milestone Code

  最大長: 255

  マイルストンに関連付けられた一意のコード。
• MilestoneLabel: string
  タイトル: Milestone Label

  最大長: 255

  マイルストンのわかりやすいラベル。
• MilestoneType: string
  タイトル: Milestone Type

  最大長: 255

  デフォルト値: ORA_SVC_NO_REPEAT

  マイルストンのタイプ。
• ObjectName: string
  最大長: 255

  マイルストン構成に関連付けられたオブジェクトの名前
• PauseCondition: string
  タイトル: Pauses When

  最大長: 1000

  一時停止条件
• PauseConditionLabel: string
  タイトル: Pauses When

  最大長: 1000

  マイルストンの一時停止条件のわかりやすいラベル。
• StartCondition: string
  タイトル: Starts When

  最大長: 1000

  開始条件
• StartConditionLabel: string
  タイトル: Starts When

  最大長: 1000

  マイルストンの開始条件のユーザー・フレンドリなラベル。
• StopCondition: string
  タイトル: Complete When

  最大長: 1000

  停止条件
• StopConditionLabel: string
  タイトル: Completes When

  最大長: 1000

  マイルストンの停止条件のユーザー・フレンドリなラベル。
• ThresholdCode: string
  タイトル: Threshold Code

  最大長: 255

  しきい値に関連付けられた一意のコード。
• TzPreferenceCd: string
  タイトル: Time Zone Override Source

  最大長: 30

  カバレッジからのタイム・ゾーンの上書きに使用されるオブジェクトを示します。

{
    "type":"object",
    "properties":{
        "MilestoneLabel":{
            "title":"Milestone Label",
            "maxLength":255,
            "type":"string",
            "description":"The user-friendly label of the milestone.",
            "nullable":true
        },
        "TzPreferenceCd":{
            "title":"Time Zone Override Source",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the object that will be used to override the time zone from the coverage.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "MilestoneCode":{
            "title":"Milestone Code",
            "maxLength":255,
            "type":"string",
            "description":"The unique code associated with the milestone.",
            "nullable":false
        },
        "StartConditionLabel":{
            "title":"Starts When",
            "maxLength":1000,
            "type":"string",
            "description":"The user-friendly label of the milestone's start condition.",
            "nullable":true
        },
        "PauseConditionLabel":{
            "title":"Pauses When",
            "maxLength":1000,
            "type":"string",
            "description":"The user-friendly label of the milestone's pause condition.",
            "nullable":true
        },
        "StartCondition":{
            "title":"Starts When",
            "maxLength":1000,
            "type":"string",
            "description":"Start Condition",
            "nullable":true
        },
        "MilestoneType":{
            "title":"Milestone Type",
            "maxLength":255,
            "type":"string",
            "description":"The type of the milestone.",
            "nullable":false,
            "default":"ORA_SVC_NO_REPEAT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ThresholdCode":{
            "title":"Threshold Code",
            "maxLength":255,
            "type":"string",
            "description":"The unique code associated with the threshold.",
            "nullable":true
        },
        "ObjectName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the object associated to the Milestone Configuration",
            "nullable":false
        },
        "StopConditionLabel":{
            "title":"Completes When",
            "maxLength":1000,
            "type":"string",
            "description":"The user-friendly label of the milestone's stop condition.",
            "nullable":true
        },
        "DisabledFlag":{
            "title":"Disabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Disabled Flag",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "AllowAgentCompletionFlag":{
            "title":"Allow Agent Completion",
            "maxLength":1,
            "type":"boolean",
            "description":"Allow Agent to mark milestone as complete",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "PauseCondition":{
            "title":"Pauses When",
            "maxLength":1000,
            "type":"string",
            "description":"Pause Condition",
            "nullable":true
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Deleted Flag",
            "nullable":false,
            "default":false
        },
        "StopCondition":{
            "title":"Complete When",
            "maxLength":1000,
            "type":"string",
            "description":"Stop Condition",
            "nullable":true
        },
        "BUOrgId":{
            "type":"integer",
            "description":"The unique ID of the business unit name associated to the Milestone Config.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "AllowDueDateOverrideFlag":{
            "title":"Allow Due Date Override",
            "maxLength":1,
            "type":"boolean",
            "description":"Allow Agent to override milestone due date",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• AllowAgentCompletionFlag: boolean
  タイトル: Allow Agent Completion

  最大長: 1

  デフォルト値: false

  エージェントがマイルストンを完了としてマークすることを許可
• AllowDueDateOverrideFlag: boolean
  タイトル: Allow Due Date Override

  最大長: 1

  デフォルト値: false

  エージェントがマイルストン期日を上書きすることを許可
• BUOrgId: integer (int64)
  マイルストン構成に関連付けられたビジネス・ユニット名の一意のID。
• BusinessUnitName: string
  タイトル: Business Unit Name

  読取り専用: true

  最大長: 240

  マイルストン構成に関連付けられたビジネス・ユニットの名前
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  作成者
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  作成日
• DeletedFlag: boolean
  最大長: 1

  デフォルト値: false

  削除済フラグ
• DisabledFlag: boolean
  タイトル: Disabled

  最大長: 1

  デフォルト値: false

  使用不可フラグ
• 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

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

  最大長: 255

  マイルストンに関連付けられた一意のコード。
• MilestoneConfigId: integer (int64)
  タイトル: Milestone Configuration ID

  読取り専用: true

  マイルストン構成の一意の識別子。
• MilestoneLabel: string
  タイトル: Milestone Label

  最大長: 255

  マイルストンのわかりやすいラベル。
• MilestoneType: string
  タイトル: Milestone Type

  最大長: 255

  デフォルト値: ORA_SVC_NO_REPEAT

  マイルストンのタイプ。
• MilestoneTypeMeaning: string
  読取り専用: true

  マイルストン・タイプ参照コードに対応する表示値を示します。
• ObjectName: string
  最大長: 255

  マイルストン構成に関連付けられたオブジェクトの名前
• ObjectNameMeaning: string
  読取り専用: true

  オブジェクト名参照コードに対応する表示値を示します。
• PauseCondition: string
  タイトル: Pauses When

  最大長: 1000

  一時停止条件
• PauseConditionLabel: string
  タイトル: Pauses When

  最大長: 1000

  マイルストンの一時停止条件のわかりやすいラベル。
• StartCondition: string
  タイトル: Starts When

  最大長: 1000

  開始条件
• StartConditionLabel: string
  タイトル: Starts When

  最大長: 1000

  マイルストンの開始条件のユーザー・フレンドリなラベル。
• StopCondition: string
  タイトル: Complete When

  最大長: 1000

  停止条件
• StopConditionLabel: string
  タイトル: Completes When

  最大長: 1000

  マイルストンの停止条件のユーザー・フレンドリなラベル。
• ThresholdCode: string
  タイトル: Threshold Code

  最大長: 255

  しきい値に関連付けられた一意のコード。
• TzPreferenceCd: string
  タイトル: Time Zone Override Source

  最大長: 30

  カバレッジからのタイム・ゾーンの上書きに使用されるオブジェクトを示します。
• TzPreferenceMeaning: string
  読取り専用: true

  最大長: 255

  タイム・ゾーン・オブジェクト参照コードに対応する表示値を示します。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Creation Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartConditionLabel":{
            "title":"Starts When",
            "maxLength":1000,
            "type":"string",
            "description":"The user-friendly label of the milestone's start condition.",
            "nullable":true,
            "x-queryable":true
        },
        "DisabledFlag":{
            "title":"Disabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Disabled Flag",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "AllowAgentCompletionFlag":{
            "title":"Allow Agent Completion",
            "maxLength":1,
            "type":"boolean",
            "description":"Allow Agent to mark milestone as complete",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "PauseCondition":{
            "title":"Pauses When",
            "maxLength":1000,
            "type":"string",
            "description":"Pause Condition",
            "nullable":true,
            "x-queryable":true
        },
        "AllowDueDateOverrideFlag":{
            "title":"Allow Due Date Override",
            "maxLength":1,
            "type":"boolean",
            "description":"Allow Agent to override milestone due date",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"check_box"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BusinessUnitName":{
            "title":"Business Unit Name",
            "maxLength":240,
            "type":"string",
            "description":"The name of the business unit associated to the Milestone Configuration",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Last Updated By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MilestoneLabel":{
            "title":"Milestone Label",
            "maxLength":255,
            "type":"string",
            "description":"The user-friendly label of the milestone.",
            "nullable":true,
            "x-queryable":true
        },
        "TzPreferenceCd":{
            "title":"Time Zone Override Source",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the object that will be used to override the time zone from the coverage.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Created By",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MilestoneCode":{
            "title":"Milestone Code",
            "maxLength":255,
            "type":"string",
            "description":"The unique code associated with the milestone.",
            "nullable":false,
            "x-queryable":true
        },
        "PauseConditionLabel":{
            "title":"Pauses When",
            "maxLength":1000,
            "type":"string",
            "description":"The user-friendly label of the milestone's pause condition.",
            "nullable":true,
            "x-queryable":true
        },
        "StartCondition":{
            "title":"Starts When",
            "maxLength":1000,
            "type":"string",
            "description":"Start Condition",
            "nullable":true,
            "x-queryable":true
        },
        "MilestoneType":{
            "title":"Milestone Type",
            "maxLength":255,
            "type":"string",
            "description":"The type of the milestone.",
            "nullable":false,
            "default":"ORA_SVC_NO_REPEAT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ThresholdCode":{
            "title":"Threshold Code",
            "maxLength":255,
            "type":"string",
            "description":"The unique code associated with the threshold.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the object associated to the Milestone Configuration",
            "nullable":false,
            "x-queryable":true
        },
        "StopConditionLabel":{
            "title":"Completes When",
            "maxLength":1000,
            "type":"string",
            "description":"The user-friendly label of the milestone's stop condition.",
            "nullable":true,
            "x-queryable":true
        },
        "TzPreferenceMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the display value corresponding to the time zone object lookup code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectNameMeaning":{
            "type":"string",
            "description":"Indicates the display value corresponding to the object name lookup code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Deleted Flag",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "StopCondition":{
            "title":"Complete When",
            "maxLength":1000,
            "type":"string",
            "description":"Stop Condition",
            "nullable":true,
            "x-queryable":true
        },
        "BUOrgId":{
            "type":"integer",
            "description":"The unique ID of the business unit name associated to the Milestone Config.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "MilestoneConfigId":{
            "title":"Milestone Configuration ID",
            "type":"integer",
            "description":"The unique identifier of the milestone configuration.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MilestoneTypeMeaning":{
            "type":"string",
            "description":"Indicates the display value corresponding to the milestone type lookup code.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "MilestoneType"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Last Update Date",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"Last Update Login",
            "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."
        }
    }
}

リンク

YesNoLookup

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DYES_NO

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: AllowAgentCompletionFlag;ターゲット属性: LookupCode
• 表示属性: 意味

「トップに戻る」