機械翻訳について

ジャンプ先

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

オーケストレーション関連付けの作成

post

/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations

リクエスト

パス・パラメータ

• OptyNumber(required): string
  商談の一意の代替識別子。

ヘッダー・パラメータ

• 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

ソースを表示

• AssociationStatusCode(required): string
  タイトル: Association Status Code

  最大長: 30

  関連付けのステータス。
• ErrorLogs: array Error Logs
  タイトル: Error Logs

  エラー・ログ・リソースは、オーケストレーション・アソシエーションに関連付けられたエラー・ログを表示するために使用されます。
• OrchestrationAssociationId: integer (int64)
  タイトル: Orchestration Association ID

  オーケストレーション関連の一意の識別子。
• OrchestrationAssociationNumber: string
  タイトル: Orchestration Association Number

  最大長: 64

  オーケストレーション関連付けの代替識別子。
• OrchestrationId(required): integer (int64)
  タイトル: Orchestration ID

  オーケストレーション・オブジェクトの一意の識別子。
• SourceObjectCode(required): string
  タイトル: Source Object Code

  最大長: 100

  言語に依存しないオブジェクト・コード。
• SourceObjectId(required): integer (int64)
  タイトル: Source Object ID

  ソース・オブジェクト・コードの一意の識別子。
• StageObjectives: array Stage Objectives
  タイトル: Stage Objectives

  ステージ目標リソースは、オーケストレーション関連付けのステージ目標を表示するために使用されます。
• Stages: array Stages
  タイトル: Stages

  ステージ・リソースは、オーケストレーション関連付けのステージを表示するために使用されます。
• Steps: array Steps
  タイトル: Steps

  ステップ・リソースは、オーケストレーション関連付けのステップを表示するために使用されます。
• StepTransitions: array Step Transitions
  タイトル: Step Transitions

  ステップ遷移リソースは、オーケストレーション関連付けのステップ・トランジションを表示するために使用されます。

{
    "required":[
        "AssociationStatusCode",
        "OrchestrationId",
        "SourceObjectCode",
        "SourceObjectId"
    ],
    "type":"object",
    "properties":{
        "Steps":{
            "title":"Steps",
            "type":"array",
            "description":"The steps resource is used to view the steps of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-Steps-item-post-request"
            }
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier for the source object code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":100,
            "type":"string",
            "description":"The language independent object code.",
            "nullable":false
        },
        "ErrorLogs":{
            "title":"Error Logs",
            "type":"array",
            "description":"The error logs resource is used to view error logs associated to the orchestration associations.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-ErrorLogs-item-post-request"
            }
        },
        "StageObjectives":{
            "title":"Stage Objectives",
            "type":"array",
            "description":"The stage objectives resource is used to view the stage objectives of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-StageObjectives-item-post-request"
            }
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AssociationStatusCode":{
            "title":"Association Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status of the association.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Stages":{
            "title":"Stages",
            "type":"array",
            "description":"The stages resource is used to view the stage of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-Stages-item-post-request"
            }
        },
        "OrchestrationAssociationNumber":{
            "title":"Orchestration Association Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration association.",
            "nullable":false
        },
        "StepTransitions":{
            "title":"Step Transitions",
            "type":"array",
            "description":"The step transitions resource is used to view the step transitions of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-StepTransitions-item-post-request"
            }
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

ネストされたスキーマ : エラー・ログ

タイプ: array

タイトル: Error Logs

エラー・ログ・リソースは、オーケストレーション・アソシエーションに関連付けられたエラー・ログを表示するために使用されます。

ソースを表示

• Array of: object opportunities-OrchestrationAssociations-ErrorLogs-item-post-request

{
    "title":"Error Logs",
    "type":"array",
    "description":"The error logs resource is used to view error logs associated to the orchestration associations.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-ErrorLogs-item-post-request"
    }
}

ネストされたスキーマ : ステージ目標

タイプ: array

タイトル: Stage Objectives

ステージ目標リソースは、オーケストレーション関連付けのステージ目標を表示するために使用されます。

ソースを表示

• Array of: object opportunities-OrchestrationAssociations-StageObjectives-item-post-request

{
    "title":"Stage Objectives",
    "type":"array",
    "description":"The stage objectives resource is used to view the stage objectives of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-StageObjectives-item-post-request"
    }
}

ネストされたスキーマ : ステージ

タイプ: array

タイトル: Stages

ステージ・リソースは、オーケストレーション関連付けのステージを表示するために使用されます。

ソースを表示

• Array of: object opportunities-OrchestrationAssociations-Stages-item-post-request

{
    "title":"Stages",
    "type":"array",
    "description":"The stages resource is used to view the stage of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-Stages-item-post-request"
    }
}

ネストされたスキーマ : ステップ

タイプ: array

タイトル: Steps

ステップ・リソースは、オーケストレーション関連付けのステップを表示するために使用されます。

ソースを表示

• Array of: object opportunities-OrchestrationAssociations-Steps-item-post-request

{
    "title":"Steps",
    "type":"array",
    "description":"The steps resource is used to view the steps of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-Steps-item-post-request"
    }
}

ネストされたスキーマ : ステップ遷移

タイプ: array

タイトル: Step Transitions

ステップ遷移リソースは、オーケストレーション関連付けのステップ・トランジションを表示するために使用されます。

ソースを表示

• Array of: object opportunities-OrchestrationAssociations-StepTransitions-item-post-request

{
    "title":"Step Transitions",
    "type":"array",
    "description":"The step transitions resource is used to view the step transitions of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-StepTransitions-item-post-request"
    }
}

ネストされたスキーマ : opportunities-OrchestrationAssociations-ErrorLogs-item-post-request

タイプ: object

ソースを表示

• ErrorDescription: 文字列(バイト)
  タイトル: Error Description

  エラーの説明。
• ErrorLogsId: integer (int64)
  タイトル: Error Logs ID

  オーケストレーション・エラー・ログの一意の識別子。
• ErrorLogsNumber: string
  タイトル: Error Logs Number

  最大長: 64

  オーケストレーション・エラー・ログの代替識別子。
• ErrorText: string
  タイトル: Error Text

  最大長: 2000

  簡単なエラーの詳細。
• OrchestrationAssociationId: integer (int64)
  タイトル: Orchestration Association ID

  オーケストレーション関連の一意の識別子。
• OrchestrationId: integer (int64)
  タイトル: Orchestration ID

  オーケストレーション・オブジェクトの一意の識別子。
• OrchestrationStageId: integer (int64)
  タイトル: Orchestration Stage ID

  オーケストレーション・ステージ・オブジェクトの一意の識別子。
• OrchestrationStepId: integer (int64)
  タイトル: Orchestration Step ID

  オーケストレーション・ステップ・オブジェクトの一意の識別子。
• SourceObjectCode: string
  タイトル: SourceObjectCode

  最大長: 100

  言語に依存しないオブジェクト・コード。
• SourceObjectId: integer (int64)
  タイトル: Source Object ID

  ソース・オブジェクト・コードの一意の識別子。

{
    "type":"object",
    "properties":{
        "ErrorDescription":{
            "title":"Error Description",
            "type":"string",
            "description":"The description of the error.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier for the source object code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ErrorText":{
            "title":"Error Text",
            "maxLength":2000,
            "type":"string",
            "description":"The brief error details.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorLogsId":{
            "title":"Error Logs ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration error logs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SourceObjectCode":{
            "title":"SourceObjectCode",
            "maxLength":100,
            "type":"string",
            "description":"The language independent object code.",
            "nullable":true
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ErrorLogsNumber":{
            "title":"Error Logs Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration error logs.",
            "nullable":false
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

ネストされたスキーマ : opportunities-OrchestrationAssociations-StageObjectives-item-post-request

タイプ: object

ソースを表示

• DisplaySequence: integer
  タイトル: Display Sequence

  ステージが実行またはUIに表示される順序。
• OrchestrationAssociationId: integer (int64)
  タイトル: Orchestration Association ID

  オーケストレーション関連の一意の識別子。
• OrchestrationId: integer (int64)
  タイトル: Orchestration ID

  オーケストレーション・オブジェクトの一意の識別子。
• OrchestrationStageId: integer (int64)
  タイトル: Orchestration Stage ID

  オーケストレーション・ステージ・オブジェクトの一意の識別子。
• OrchestrationStageObjectiveId: integer (int64)
  タイトル: Stage Objective ID

  オーケストレーション・ステージ目標オブジェクトの一意の識別子。
• RunTimeStageObjectiveId: integer (int64)
  タイトル: Run Time Stage Objective ID

  オーケストレーション・ステージ目標オブジェクトの一意の識別子。
• RunTimeStageObjectiveNumber: string
  タイトル: Run Time Stage Objective Number

  最大長: 64

  オーケストレーション・ステージ目標オブジェクトの代替識別子。
• RunTimeStatus: string
  タイトル: Run Time Status

  最大長: 30

  オーケストレーション・ステージ目標遷移のステータス。

{
    "type":"object",
    "properties":{
        "RunTimeStageObjectiveId":{
            "title":"Run Time Stage Objective ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage objective object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the stages are to be executed or shown back in UI.",
            "nullable":true
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the orchestration stage objective transition.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RunTimeStageObjectiveNumber":{
            "title":"Run Time Stage Objective Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration stage objective object.",
            "nullable":false
        },
        "OrchestrationStageObjectiveId":{
            "title":"Stage Objective ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage objective object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

ネストされたスキーマ : opportunities-OrchestrationAssociations-Stages-item-post-request

タイプ: object

ソースを表示

• DisplaySequence: integer
  タイトル: Display Sequence

  ステージ目標の実行順序またはUIでの表示順序。
• OrchestrationAssociationId: integer (int64)
  タイトル: Orchestration Association ID

  オーケストレーション関連の一意の識別子。
• OrchestrationId: integer (int64)
  タイトル: Orchestration ID

  オーケストレーション・オブジェクトの一意の識別子。
• OrchestrationStageId: integer (int64)
  タイトル: Orchestration Stage ID

  オーケストレーション・ステージ・オブジェクトの一意の識別子。
• RuntimeStageId: integer (int64)
  タイトル: Run Time Stage ID

  オーケストレーション・ステージ・ランタイム・オブジェクトの一意の識別子。
• RuntimeStageNumber: string
  タイトル: Run Time Stage Number

  最大長: 64

  オーケストレーション・ステージ・ランタイム・オブジェクトの代替識別子。
• RunTimeStatus: string
  タイトル: Run Time Status

  最大長: 30

  オーケストレーション・ステージのステータス。

{
    "type":"object",
    "properties":{
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the stage objectives are to be executed or shown back in UI.",
            "nullable":true
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RuntimeStageNumber":{
            "title":"Run Time Stage Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration stages runtime object.",
            "nullable":false
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the orchestration stages.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RuntimeStageId":{
            "title":"Run Time Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stages runtime object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

ネストされたスキーマ : opportunities-OrchestrationAssociations-Steps-item-post-request

タイプ: object

ソースを表示

• DisplaySequence: integer
  タイトル: Display Sequence

  UIで実行または表示されるステップの順序。
• OrchestrationAssociationId: integer (int64)
  タイトル: Orchestration Association ID

  オーケストレーション関連の一意の識別子。
• OrchestrationId: integer (int64)
  タイトル: Orchestration ID

  オーケストレーション・オブジェクトの一意の識別子。
• OrchestrationStageId: integer (int64)
  タイトル: Orchestration Stage ID

  オーケストレーション・ステージ・オブジェクトの一意の識別子。
• OrchestrationStepId: integer (int64)
  タイトル: Orchestration Step ID

  オーケストレーション・ステップ・オブジェクトの一意の識別子。
• RunTimeStatus: string
  タイトル: Run Time Status

  最大長: 30

  オーケストレーション・ステージ目標遷移の実行時ステータス。
• RunTimeStepId: integer (int64)
  タイトル: Run Time Step ID

  オーケストレーション・ステップ・ランタイム・オブジェクトの一意の識別子。
• RunTimeStepNumber: string
  タイトル: Run Time Step Number

  最大長: 64

  オーケストレーション・ステップ・ランタイム・オブジェクトの代替識別子。

{
    "type":"object",
    "properties":{
        "RunTimeStepNumber":{
            "title":"Run Time Step Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration steps runtime object.",
            "nullable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the steps are to be executed or shown back in UI.",
            "nullable":true
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":30,
            "type":"string",
            "description":"The run time status of the orchestration stage objective transition.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RunTimeStepId":{
            "title":"Run Time Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration steps runtime object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

ネストされたスキーマ : opportunities-OrchestrationAssociations-StepTransitions-item-post-request

タイプ: object

ソースを表示

• ActivityId: integer (int64)
  タイトル: Activity ID

  アクティビティの一意の識別子。
• Comments: string
  タイトル: Comments

  最大長: 2000

  実行時ステップ遷移行に必要な簡単なコメントを指定します。
• ConversationId: integer (int64)
  タイトル: Conversation ID

  会話メッセージの一意の識別子。
• EmailType: string
  タイトル: Email Type

  最大長: 30

  オーケストレーション・ステップ遷移ランタイムEメール・タイプ。
• InboundConvMsgId: integer (int64)
  タイトル: Inbound Conversation Message ID

  インバウンド会話メッセージの一意の識別子。
• InteractionId: integer (int64)
  タイトル: Interaction ID

  顧客対応の一意の識別子。
• OrchestrationAssociationId: integer (int64)
  タイトル: Orchestration Association ID

  オーケストレーション関連の一意の識別子。
• OrchestrationId: integer (int64)
  タイトル: Orchestration ID

  オーケストレーション・オブジェクトの一意の識別子。
• OrchestrationStageId: integer (int64)
  タイトル: Orchestration Stage ID

  オーケストレーション・ステージ・オブジェクトの一意の識別子。
• OrchestrationStepId: integer (int64)
  タイトル: Orchestration Step ID

  オーケストレーション・ステップ・オブジェクトの一意の識別子。
• OutboundConvMsgId: integer (int64)
  タイトル: Outbound Conversation Message ID

  アウトバウンド会話メッセージの一意の識別子。
• StepTransitionId: integer (int64)
  タイトル: Step Transition ID

  オーケストレーション・ステップ遷移オブジェクトの一意の識別子。
• StepTransitionNumber: string
  タイトル: Step Transition Number

  最大長: 64

  オーケストレーション・ステップ遷移オブジェクトの代替識別子。
• StepType: string
  タイトル: Step Type

  最大長: 30

  ステップの遷移が対応しているステップのタイプ。
• SuccessCriteriaEvalFlag: boolean
  タイトル: Success Criteria Evaluation Flag

  最大長: 1

  ステップの成功基準評価結果を指定します。
• TransitionDueDateTime: string (date-time)
  タイトル: Transition Due Date Time

  ステップ遷移の期日である日時。
• TransitionEndDateTime: string (date-time)
  タイトル: Transition End Date Time

  ステップ遷移が終了した日時。
• TransitionStartDateTime: string (date-time)
  タイトル: Transition Start Date Time

  ステップ遷移が開始した日時。
• TransitionStatus: string
  タイトル: Transition Status

  最大長: 30

  オーケストレーション・ステップ遷移のステータス。
• WrapUpId: integer (int64)
  タイトル: Wrap-up ID

  まとめの一意の識別子。

{
    "type":"object",
    "properties":{
        "ConversationId":{
            "title":"Conversation ID",
            "type":"integer",
            "description":"The unique identifier of conversation message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EmailType":{
            "title":"Email Type",
            "maxLength":30,
            "type":"string",
            "description":"The orchestration step transition runtime email type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "WrapUpId":{
            "title":"Wrap-up ID",
            "type":"integer",
            "description":"The unique identifier of the wrap up.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "StepType":{
            "title":"Step Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the step to which the step transitions correspond to.",
            "nullable":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Specifies the brief comments required for runtime step transition row.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the activity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TransitionDueDateTime":{
            "title":"Transition Due Date Time",
            "type":"string",
            "description":"The date and time when the step transition is due.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "InboundConvMsgId":{
            "title":"Inbound Conversation Message ID",
            "type":"integer",
            "description":"The unique identifier of inbound conversation message.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TransitionEndDateTime":{
            "title":"Transition End Date Time",
            "type":"string",
            "description":"The date and time when the step transition ended.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "TransitionStartDateTime":{
            "title":"Transition Start Date Time",
            "type":"string",
            "description":"The date and time when the step transition started.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StepTransitionId":{
            "title":"Step Transition ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step transition object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SuccessCriteriaEvalFlag":{
            "title":"Success Criteria Evaluation Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Specifies the success criteria evaluation result for the step.",
            "nullable":true,
            "x-queryable":false
        },
        "TransitionStatus":{
            "title":"Transition Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the orchestration step transition.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OutboundConvMsgId":{
            "title":"Outbound Conversation Message ID",
            "type":"integer",
            "description":"The unique identifier of outbound conversation message.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "StepTransitionNumber":{
            "title":"Step Transition Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration step transition object.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : opportunities-OrchestrationAssociations-item-response

タイプ: object

ソースを表示

• AssociationStatusCode: string
  タイトル: Association Status Code

  最大長: 30

  関連付けのステータス。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日付。
• ErrorLogs: array Error Logs
  タイトル: Error Logs

  エラー・ログ・リソースは、オーケストレーション・アソシエーションに関連付けられたエラー・ログを表示するために使用されます。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• OrchestrationAssociationId: integer (int64)
  タイトル: Orchestration Association ID

  オーケストレーション関連の一意の識別子。
• OrchestrationAssociationNumber: string
  タイトル: Orchestration Association Number

  最大長: 64

  オーケストレーション関連付けの代替識別子。
• OrchestrationId: integer (int64)
  タイトル: Orchestration ID

  オーケストレーション・オブジェクトの一意の識別子。
• OrchestrationName: string
  タイトル: Orchestration Name

  読取り専用: true

  最大長: 100

  オーケストレーション・オブジェクトの名前。
• OrchestrationNumber: string
  タイトル: Orchestration Number

  読取り専用: true

  最大長: 64

  オーケストレーション・オブジェクトの代替識別子。
• SourceObjectCode: string
  タイトル: Source Object Code

  最大長: 100

  言語に依存しないオブジェクト・コード。
• SourceObjectId: integer (int64)
  タイトル: Source Object ID

  ソース・オブジェクト・コードの一意の識別子。
• StageObjectives: array Stage Objectives
  タイトル: Stage Objectives

  ステージ目標リソースは、オーケストレーション関連付けのステージ目標を表示するために使用されます。
• Stages: array Stages
  タイトル: Stages

  ステージ・リソースは、オーケストレーション関連付けのステージを表示するために使用されます。
• Steps: array Steps
  タイトル: Steps

  ステップ・リソースは、オーケストレーション関連付けのステップを表示するために使用されます。
• StepTransitions: array Step Transitions
  タイトル: Step Transitions

  ステップ遷移リソースは、オーケストレーション関連付けのステップ・トランジションを表示するために使用されます。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Steps":{
            "title":"Steps",
            "type":"array",
            "description":"The steps resource is used to view the steps of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-Steps-item-response"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record 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 record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorLogs":{
            "title":"Error Logs",
            "type":"array",
            "description":"The error logs resource is used to view error logs associated to the orchestration associations.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-ErrorLogs-item-response"
            }
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Stages":{
            "title":"Stages",
            "type":"array",
            "description":"The stages resource is used to view the stage of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-Stages-item-response"
            }
        },
        "OrchestrationAssociationNumber":{
            "title":"Orchestration Association Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration association.",
            "nullable":false,
            "x-queryable":true
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier for the source object code.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":100,
            "type":"string",
            "description":"The language independent object code.",
            "nullable":false,
            "x-queryable":true
        },
        "StageObjectives":{
            "title":"Stage Objectives",
            "type":"array",
            "description":"The stage objectives resource is used to view the stage objectives of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-StageObjectives-item-response"
            }
        },
        "AssociationStatusCode":{
            "title":"Association Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status of the association.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "StepTransitions":{
            "title":"Step Transitions",
            "type":"array",
            "description":"The step transitions resource is used to view the step transitions of the orchestration association.",
            "items":{
                "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-StepTransitions-item-response"
            }
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : エラー・ログ

タイプ: array

タイトル: Error Logs

エラー・ログ・リソースは、オーケストレーション・アソシエーションに関連付けられたエラー・ログを表示するために使用されます。

ソースを表示

• Array of: object opportunities-OrchestrationAssociations-ErrorLogs-item-response

{
    "title":"Error Logs",
    "type":"array",
    "description":"The error logs resource is used to view error logs associated to the orchestration associations.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-ErrorLogs-item-response"
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

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

ネストされたスキーマ : ステージ目標

タイプ: array

タイトル: Stage Objectives

ステージ目標リソースは、オーケストレーション関連付けのステージ目標を表示するために使用されます。

ソースを表示

• Array of: object opportunities-OrchestrationAssociations-StageObjectives-item-response

{
    "title":"Stage Objectives",
    "type":"array",
    "description":"The stage objectives resource is used to view the stage objectives of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-StageObjectives-item-response"
    }
}

ネストされたスキーマ : ステージ

タイプ: array

タイトル: Stages

ステージ・リソースは、オーケストレーション関連付けのステージを表示するために使用されます。

ソースを表示

• Array of: object opportunities-OrchestrationAssociations-Stages-item-response

{
    "title":"Stages",
    "type":"array",
    "description":"The stages resource is used to view the stage of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-Stages-item-response"
    }
}

ネストされたスキーマ : ステップ

タイプ: array

タイトル: Steps

ステップ・リソースは、オーケストレーション関連付けのステップを表示するために使用されます。

ソースを表示

• Array of: object opportunities-OrchestrationAssociations-Steps-item-response

{
    "title":"Steps",
    "type":"array",
    "description":"The steps resource is used to view the steps of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-Steps-item-response"
    }
}

ネストされたスキーマ : ステップ遷移

タイプ: array

タイトル: Step Transitions

ステップ遷移リソースは、オーケストレーション関連付けのステップ・トランジションを表示するために使用されます。

ソースを表示

• Array of: object opportunities-OrchestrationAssociations-StepTransitions-item-response

{
    "title":"Step Transitions",
    "type":"array",
    "description":"The step transitions resource is used to view the step transitions of the orchestration association.",
    "items":{
        "$ref":"#/components/schemas/opportunities-OrchestrationAssociations-StepTransitions-item-response"
    }
}

ネストされたスキーマ : opportunities-OrchestrationAssociations-ErrorLogs-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日付。
• ErrorDescription: 文字列(バイト)
  タイトル: Error Description

  エラーの説明。
• ErrorLogsId: integer (int64)
  タイトル: Error Logs ID

  オーケストレーション・エラー・ログの一意の識別子。
• ErrorLogsNumber: string
  タイトル: Error Logs Number

  最大長: 64

  オーケストレーション・エラー・ログの代替識別子。
• ErrorText: string
  タイトル: Error Text

  最大長: 2000

  簡単なエラーの詳細。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• OrchestrationAssociationId: integer (int64)
  タイトル: Orchestration Association ID

  オーケストレーション関連の一意の識別子。
• OrchestrationId: integer (int64)
  タイトル: Orchestration ID

  オーケストレーション・オブジェクトの一意の識別子。
• OrchestrationName: string
  タイトル: Orchestration Name

  読取り専用: true

  最大長: 100

  オーケストレーション・オブジェクトの名前。
• OrchestrationNumber: string
  タイトル: Orchestration Number

  読取り専用: true

  最大長: 64

  オーケストレーション・オブジェクトの代替識別子。
• OrchestrationStageId: integer (int64)
  タイトル: Orchestration Stage ID

  オーケストレーション・ステージ・オブジェクトの一意の識別子。
• OrchestrationStageName: string
  タイトル: Stage Name

  読取り専用: true

  最大長: 100

  オーケストレーション・ステージ・オブジェクトの名前。
• OrchestrationStageNumber: string
  タイトル: Orchestration Stage Number

  読取り専用: true

  最大長: 64

  オーケストレーション・ステージ・オブジェクトの代替識別子。
• OrchestrationStepId: integer (int64)
  タイトル: Orchestration Step ID

  オーケストレーション・ステップ・オブジェクトの一意の識別子。
• OrchestrationStepName: string
  タイトル: Orchestration Step Name

  読取り専用: true

  最大長: 100

  オーケストレーション・ステップの名前。
• OrchestrationStepNumber: string
  タイトル: Orchestration Step Number

  読取り専用: true

  最大長: 64

  オーケストレーション・ステップ・オブジェクトの代替識別子。
• SourceObjectCode: string
  タイトル: SourceObjectCode

  最大長: 100

  言語に依存しないオブジェクト・コード。
• SourceObjectId: integer (int64)
  タイトル: Source Object ID

  ソース・オブジェクト・コードの一意の識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ErrorDescription":{
            "title":"Error Description",
            "type":"string",
            "description":"The description of the error.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorText":{
            "title":"Error Text",
            "maxLength":2000,
            "type":"string",
            "description":"The brief error details.",
            "nullable":true,
            "x-queryable":false
        },
        "ErrorLogsId":{
            "title":"Error Logs ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration error logs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration step object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier for the source object code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"SourceObjectCode",
            "maxLength":100,
            "type":"string",
            "description":"The language independent object code.",
            "nullable":true,
            "x-queryable":true
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ErrorLogsNumber":{
            "title":"Error Logs Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration error logs.",
            "nullable":false,
            "x-queryable":true
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "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."
        }
    }
}

ネストされたスキーマ : opportunities-OrchestrationAssociations-StageObjectives-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日付。
• DisplaySequence: integer
  タイトル: Display Sequence

  ステージが実行またはUIに表示される順序。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• OrchestrationAssociationId: integer (int64)
  タイトル: Orchestration Association ID

  オーケストレーション関連の一意の識別子。
• OrchestrationId: integer (int64)
  タイトル: Orchestration ID

  オーケストレーション・オブジェクトの一意の識別子。
• OrchestrationName: string
  タイトル: Orchestration Name

  読取り専用: true

  最大長: 100

  オーケストレーション・オブジェクトの名前。
• OrchestrationNumber: string
  タイトル: Orchestration Number

  読取り専用: true

  最大長: 64

  オーケストレーション・オブジェクトの代替識別子。
• OrchestrationStageDisplaySequence: 整数(int32)
  タイトル: Display Sequence

  読取り専用: true

  オーケストレーション管理ランタイムUIでのステージの順序。
• OrchestrationStageId: integer (int64)
  タイトル: Orchestration Stage ID

  オーケストレーション・ステージ・オブジェクトの一意の識別子。
• OrchestrationStageName: string
  タイトル: Stage Name

  読取り専用: true

  最大長: 100

  オーケストレーション・ステージ・オブジェクトの名前。
• OrchestrationStageObjDisplaySequence: 整数(int32)
  タイトル: Display Sequence

  読取り専用: true

  オーケストレーション管理ランタイムUIでのステージの順序。
• OrchestrationStageObjectiveId: integer (int64)
  タイトル: Stage Objective ID

  オーケストレーション・ステージ目標オブジェクトの一意の識別子。
• OrchestrationStageObjName: string
  タイトル: Objective Name

  読取り専用: true

  最大長: 100

  オーケストレーション・ステージ目標オブジェクトの名前。
• OrchestrationStageObjNumber: string
  タイトル: Stage Objective Number

  読取り専用: true

  最大長: 64

  オーケストレーション・ステージ目標オブジェクトの代替識別子。
• RunTimeStageObjectiveId: integer (int64)
  タイトル: Run Time Stage Objective ID

  オーケストレーション・ステージ目標オブジェクトの一意の識別子。
• RunTimeStageObjectiveNumber: string
  タイトル: Run Time Stage Objective Number

  最大長: 64

  オーケストレーション・ステージ目標オブジェクトの代替識別子。
• RunTimeStatus: string
  タイトル: Run Time Status

  最大長: 30

  オーケストレーション・ステージ目標遷移のステータス。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record 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 record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the stages are to be executed or shown back in UI.",
            "nullable":true,
            "x-queryable":true
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStageObjDisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the stages in the orchestration admin run time UIs.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "OrchestrationStageObjName":{
            "title":"Objective Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration stage objective object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the orchestration stage objective transition.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageObjectiveId":{
            "title":"Stage Objective ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage objective object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStageDisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the stages in the orchestration admin run time UIs.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "RunTimeStageObjectiveId":{
            "title":"Run Time Stage Objective ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage objective object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStageObjNumber":{
            "title":"Stage Objective Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration stage objective object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RunTimeStageObjectiveNumber":{
            "title":"Run Time Stage Objective Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration stage objective object.",
            "nullable":false,
            "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"
    }
}

ネストされたスキーマ : opportunities-OrchestrationAssociations-Stages-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日付。
• DisplaySequence: integer
  タイトル: Display Sequence

  ステージ目標の実行順序またはUIでの表示順序。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• OrchestrationAssociationId: integer (int64)
  タイトル: Orchestration Association ID

  オーケストレーション関連の一意の識別子。
• OrchestrationId: integer (int64)
  タイトル: Orchestration ID

  オーケストレーション・オブジェクトの一意の識別子。
• OrchestrationName: string
  タイトル: Orchestration Name

  読取り専用: true

  最大長: 100

  オーケストレーション・オブジェクトの名前。
• OrchestrationNumber: string
  タイトル: Orchestration Number

  読取り専用: true

  最大長: 64

  オーケストレーション・オブジェクトの代替識別子。
• OrchestrationStageId: integer (int64)
  タイトル: Orchestration Stage ID

  オーケストレーション・ステージ・オブジェクトの一意の識別子。
• OrchestrationStageName: string
  タイトル: Stage Name

  読取り専用: true

  最大長: 100

  オーケストレーション・ステージ・オブジェクトの名前。
• OrchestrationStageNumber: string
  タイトル: Orchestration Stage Number

  読取り専用: true

  最大長: 64

  オーケストレーション・ステージ・オブジェクトの代替識別子。
• RuntimeStageId: integer (int64)
  タイトル: Run Time Stage ID

  オーケストレーション・ステージ・ランタイム・オブジェクトの一意の識別子。
• RuntimeStageNumber: string
  タイトル: Run Time Stage Number

  最大長: 64

  オーケストレーション・ステージ・ランタイム・オブジェクトの代替識別子。
• RunTimeStatus: string
  タイトル: Run Time Status

  最大長: 30

  オーケストレーション・ステージのステータス。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the stage objectives are to be executed or shown back in UI.",
            "nullable":true,
            "x-queryable":true
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the orchestration stages.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuntimeStageNumber":{
            "title":"Run Time Stage Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration stages runtime object.",
            "nullable":false,
            "x-queryable":true
        },
        "RuntimeStageId":{
            "title":"Run Time Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stages runtime object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

ネストされたスキーマ : opportunities-OrchestrationAssociations-Steps-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日付。
• DisplaySequence: integer
  タイトル: Display Sequence

  UIで実行または表示されるステップの順序。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• OrchestrationAssociationId: integer (int64)
  タイトル: Orchestration Association ID

  オーケストレーション関連の一意の識別子。
• OrchestrationId: integer (int64)
  タイトル: Orchestration ID

  オーケストレーション・オブジェクトの一意の識別子。
• OrchestrationName: string
  タイトル: Orchestration Name

  読取り専用: true

  最大長: 100

  オーケストレーション・オブジェクトの名前。
• OrchestrationNumber: string
  タイトル: Orchestration Number

  読取り専用: true

  最大長: 64

  オーケストレーション・オブジェクトの代替識別子。
• OrchestrationStageId: integer (int64)
  タイトル: Orchestration Stage ID

  オーケストレーション・ステージ・オブジェクトの一意の識別子。
• OrchestrationStageName: string
  タイトル: Stage Name

  読取り専用: true

  最大長: 100

  オーケストレーション・ステージ・オブジェクトの名前。
• OrchestrationStageNumber: string
  タイトル: Orchestration Stage Number

  読取り専用: true

  最大長: 64

  オーケストレーション・ステージ・オブジェクトの代替識別子。
• OrchestrationStepId: integer (int64)
  タイトル: Orchestration Step ID

  オーケストレーション・ステップ・オブジェクトの一意の識別子。
• OrchestrationStepName: string
  タイトル: Orchestration Step Name

  読取り専用: true

  最大長: 100

  オーケストレーション・ステップの名前。
• OrchestrationStepNumber: string
  タイトル: Orchestration Step Number

  読取り専用: true

  最大長: 64

  オーケストレーション・ステップ・オブジェクトの代替識別子。
• RunTimeStatus: string
  タイトル: Run Time Status

  最大長: 30

  オーケストレーション・ステージ目標遷移の実行時ステータス。
• RunTimeStepId: integer (int64)
  タイトル: Run Time Step ID

  オーケストレーション・ステップ・ランタイム・オブジェクトの一意の識別子。
• RunTimeStepNumber: string
  タイトル: Run Time Step Number

  最大長: 64

  オーケストレーション・ステップ・ランタイム・オブジェクトの代替識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order in which the steps are to be executed or shown back in UI.",
            "nullable":true,
            "x-queryable":true
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration step object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RunTimeStatus":{
            "title":"Run Time Status",
            "maxLength":30,
            "type":"string",
            "description":"The run time status of the orchestration stage objective transition.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RunTimeStepNumber":{
            "title":"Run Time Step Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration steps runtime object.",
            "nullable":false,
            "x-queryable":true
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RunTimeStepId":{
            "title":"Run Time Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration steps runtime object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

ネストされたスキーマ : opportunities-OrchestrationAssociations-StepTransitions-item-response

タイプ: object

ソースを表示

• ActivityId: integer (int64)
  タイトル: Activity ID

  アクティビティの一意の識別子。
• Comments: string
  タイトル: Comments

  最大長: 2000

  実行時ステップ遷移行に必要な簡単なコメントを指定します。
• ConversationId: integer (int64)
  タイトル: Conversation ID

  会話メッセージの一意の識別子。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日付。
• EmailType: string
  タイトル: Email Type

  最大長: 30

  オーケストレーション・ステップ遷移ランタイムEメール・タイプ。
• InboundConvMsgId: integer (int64)
  タイトル: Inbound Conversation Message ID

  インバウンド会話メッセージの一意の識別子。
• InteractionId: integer (int64)
  タイトル: Interaction ID

  顧客対応の一意の識別子。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• OrchestrationAssociationId: integer (int64)
  タイトル: Orchestration Association ID

  オーケストレーション関連の一意の識別子。
• OrchestrationAssociationNumber: string
  タイトル: Orchestration Association Number

  読取り専用: true

  最大長: 64

  オーケストレーション関連付けの代替識別子。
• OrchestrationId: integer (int64)
  タイトル: Orchestration ID

  オーケストレーション・オブジェクトの一意の識別子。
• OrchestrationName: string
  タイトル: Orchestration Name

  読取り専用: true

  最大長: 100

  オーケストレーション・オブジェクトの名前。
• OrchestrationNumber: string
  タイトル: Orchestration Number

  読取り専用: true

  最大長: 64

  オーケストレーション・オブジェクトの代替識別子。
• OrchestrationStageId: integer (int64)
  タイトル: Orchestration Stage ID

  オーケストレーション・ステージ・オブジェクトの一意の識別子。
• OrchestrationStageName: string
  タイトル: Stage Name

  読取り専用: true

  最大長: 100

  オーケストレーション・ステージ・オブジェクトの名前。
• OrchestrationStageNumber: string
  タイトル: Orchestration Stage Number

  読取り専用: true

  最大長: 64

  オーケストレーション・ステージ・オブジェクトの代替識別子。
• OrchestrationStepId: integer (int64)
  タイトル: Orchestration Step ID

  オーケストレーション・ステップ・オブジェクトの一意の識別子。
• OrchestrationStepName: string
  タイトル: Orchestration Step Name

  読取り専用: true

  最大長: 100

  オーケストレーション・ステップの名前。
• OrchestrationStepNumber: string
  タイトル: Orchestration Step Number

  読取り専用: true

  最大長: 64

  オーケストレーション・ステップ・オブジェクトの代替識別子。
• OrchestrationStepType: string
  タイトル: Step Type

  読取り専用: true

  最大長: 30

  ステップのタイプ。
• OutboundConvMsgId: integer (int64)
  タイトル: Outbound Conversation Message ID

  アウトバウンド会話メッセージの一意の識別子。
• StepTransitionId: integer (int64)
  タイトル: Step Transition ID

  オーケストレーション・ステップ遷移オブジェクトの一意の識別子。
• StepTransitionNumber: string
  タイトル: Step Transition Number

  最大長: 64

  オーケストレーション・ステップ遷移オブジェクトの代替識別子。
• StepType: string
  タイトル: Step Type

  最大長: 30

  ステップの遷移が対応しているステップのタイプ。
• SuccessCriteriaEvalFlag: boolean
  タイトル: Success Criteria Evaluation Flag

  最大長: 1

  ステップの成功基準評価結果を指定します。
• TransitionDueDateTime: string (date-time)
  タイトル: Transition Due Date Time

  ステップ遷移の期日である日時。
• TransitionEndDateTime: string (date-time)
  タイトル: Transition End Date Time

  ステップ遷移が終了した日時。
• TransitionStartDateTime: string (date-time)
  タイトル: Transition Start Date Time

  ステップ遷移が開始した日時。
• TransitionStatus: string
  タイトル: Transition Status

  最大長: 30

  オーケストレーション・ステップ遷移のステータス。
• WrapUpId: integer (int64)
  タイトル: Wrap-up ID

  まとめの一意の識別子。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConversationId":{
            "title":"Conversation ID",
            "type":"integer",
            "description":"The unique identifier of conversation message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmailType":{
            "title":"Email Type",
            "maxLength":30,
            "type":"string",
            "description":"The orchestration step transition runtime email type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "WrapUpId":{
            "title":"Wrap-up ID",
            "type":"integer",
            "description":"The unique identifier of the wrap up.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StepType":{
            "title":"Step Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the step to which the step transitions correspond to.",
            "nullable":false,
            "x-queryable":true
        },
        "ActivityId":{
            "title":"Activity ID",
            "type":"integer",
            "description":"The unique identifier of the activity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrchestrationAssociationNumber":{
            "title":"Orchestration Association Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration association.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration step object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TransitionDueDateTime":{
            "title":"Transition Due Date Time",
            "type":"string",
            "description":"The date and time when the step transition is due.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "InboundConvMsgId":{
            "title":"Inbound Conversation Message ID",
            "type":"integer",
            "description":"The unique identifier of inbound conversation message.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TransitionStartDateTime":{
            "title":"Transition Start Date Time",
            "type":"string",
            "description":"The date and time when the step transition started.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransitionStatus":{
            "title":"Transition Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the orchestration step transition.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OutboundConvMsgId":{
            "title":"Outbound Conversation Message ID",
            "type":"integer",
            "description":"The unique identifier of outbound conversation message.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration stage object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "InteractionId":{
            "title":"Interaction ID",
            "type":"integer",
            "description":"The unique identifier of interaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Specifies the brief comments required for runtime step transition row.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TransitionEndDateTime":{
            "title":"Transition End Date Time",
            "type":"string",
            "description":"The date and time when the step transition ended.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StepTransitionId":{
            "title":"Step Transition ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step transition object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SuccessCriteriaEvalFlag":{
            "title":"Success Criteria Evaluation Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Specifies the success criteria evaluation result for the step.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration association.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStepType":{
            "title":"Step Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StepTransitionNumber":{
            "title":"Step Transition Number",
            "maxLength":64,
            "type":"string",
            "description":"The alternate identifier of the orchestration step transition object.",
            "nullable":false,
            "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"
    }
}

リンク

AssociationStatusCodeVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

• ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_ASSOC_RT_STATUS

オーケストレーション・オブジェクト関連の実行時ステータスを示す値リスト。

ErrorLogs

操作: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/ErrorLogs

パラメータ:

• OptyNumber: $request.path.OptyNumber
• OrchestrationAssociationNumber: $request.path.OrchestrationAssociationNumber

エラー・ログ・リソースは、エラー詳細の表示に使用されます。

StageObjectives

操作: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StageObjectives

パラメータ:

• OptyNumber: $request.path.OptyNumber
• OrchestrationAssociationNumber: $request.path.OrchestrationAssociationNumber

ステージ目標リソースは、オーケストレーション関連付けのステージ目標を表示するために使用されます。

ステージ

操作: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/Stages

パラメータ:

• OptyNumber: $request.path.OptyNumber
• OrchestrationAssociationNumber: $request.path.OrchestrationAssociationNumber

ステージ・リソースは、オーケストレーション関連付けのステージを表示するために使用されます。

StepTransitions

操作: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/StepTransitions

パラメータ:

• OptyNumber: $request.path.OptyNumber
• OrchestrationAssociationNumber: $request.path.OrchestrationAssociationNumber

ステップ遷移リソースは、オーケストレーション関連付けのステップ・トランジションを表示するために使用されます。

ステップ

操作: /crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/OrchestrationAssociations/{OrchestrationAssociationNumber}/child/Steps

パラメータ:

• OptyNumber: $request.path.OptyNumber
• OrchestrationAssociationNumber: $request.path.OrchestrationAssociationNumber

ステップ・リソースは、オーケストレーション関連付けのステップを表示するために使用されます。

「トップに戻る」