Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

オーケストレーションの取得

get

/crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}

リクエスト

パス・パラメータ

OrchestrationNumber(required): string

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

問合せパラメータ

dependency: string

このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。通常、これらは属性変更の影響をプレビューするために使用されます。このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。この問合せパラメータの値は、依存性フィールドのセットです。例: dependency=ProductId=2

フォーマット: <attr1>=<val1>,<attr2>=<value2>
expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

Metadata-Context:

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

タイプ: object

ソースを表示

ActivationDateTime: string (date-time)

タイトル: Activation Date Time

オーケストレーションがアクティブ化される日時。
AssociationCriteriaExpression: 文字列(バイト)

タイトル: Association Criteria Expression

オーケストレーション・オブジェクトをトランザクション・オブジェクトに関連付けるために使用される、JSON形式の基準式。
AssociationRank: integer

タイトル: Association Rank

関連付け時にオーケストレーションを処理する必要があるランク。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

行を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

行が作成された日時。
DeleteFlag: boolean

読取り専用: true

オーケストレーションを削除できるかどうかを示します。この値は、ドラフト・ステータスのオーケストレーションに当てはまります。
ErrorLogs: array Error Logs

タイトル: Error Logs

エラー・ログ・リソースは、エラー詳細の表示に使用されます。
ImportedDateTime: string (date-time)

タイトル: Import Date Time

オーケストレーションが別の環境から最後にインポートされた日時。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

行が最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

行を最後に更新したユーザー。
LifecycleAttributeName: string

タイトル: Lifecycle Attribute Name

最大長: 100

ライフサイクル属性の名前。
links: array Links

タイトル: Links

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

タイトル: Object Code

最大長: 100

オーケストレーション・オブジェクトの現在の行の言語非依存コード。
OrchestrationDescription: string

タイトル: Orchestration Description

最大長: 2000

オーケストレーション・オブジェクトの説明テキスト。
OrchestrationId: integer (int64)

タイトル: Orchestration ID

オーケストレーションの一意の識別子。
OrchestrationName: string

タイトル: Orchestration Name

最大長: 100

オーケストレーションの名前。
OrchestrationNumber: string

タイトル: Orchestration Number

最大長: 64

オーケストレーションの公開一意識別子。
OrchestrationType: string

タイトル: Orchestration Type

最大長: 30

オーケストレーションのタイプ。値は、ガイド付き販売、プログラム・ビルダーなどです。
SimulationCriteriaExpression: 文字列(バイト)

タイトル: Simulation Criteria Expression

トランザクション・オブジェクトに対するオーケストレーションのシミュレートに使用される基準式(JSON形式)。
SourceOrchestrationId: integer (int64)

タイトル: Source Orchestration ID

現在のオーケストレーション行がクローニングされたときのクローニングされたソース・オーケストレーションの識別子。
Stages: array Stages

タイトル: Stages

ステージ・リソースは、オーケストレーション・ステージの表示、作成、更新および削除に使用されます。ステージは、ステップと目標、関連付けの集合です。
StatusCode: string

タイトル: Status Code

最大長: 30

オーケストレーション・オブジェクトのステータス。取り得る値はDRAFT、ACTIVE、およびARCHIVEDです。
StripingAttributeName: string

タイトル: Striping Attribute Name

最大長: 100

ストライプ化属性名。ストライプ化属性名によって、使用されるオーケストレーション・プロセスが決まります。
StripingAttributeValue: string

タイトル: Striping Attribute Value

最大長: 2000

JSON形式のストライプ化属性値。
UpdateFlag: boolean

読取り専用: true

オーケストレーションを更新できるかどうかを示します。この値は、ドラフト・ステータスのオーケストレーションに当てはまります。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivationDateTime":{
            "title":"Activation Date Time",
            "type":"string",
            "description":"The date and time when the orchestration is activated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":100,
            "type":"string",
            "description":"The language independent code for the current row of the orchestrations object.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status of the orchestration object. Possible values are DRAFT, ACTIVE, and ARCHIVED.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceOrchestrationId":{
            "title":"Source Orchestration ID",
            "type":"integer",
            "description":"The identifier of the cloned source orchestration when the current orchestration row is cloned.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the orchestration can be updated. The value is true for orchestrations in Draft status.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            },
            "x-queryable":true
        },
        "LifecycleAttributeName":{
            "title":"Lifecycle Attribute Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the lifecycle attribute.",
            "nullable":false,
            "x-queryable":false
        },
        "SimulationCriteriaExpression":{
            "title":"Simulation Criteria Expression",
            "type":"string",
            "description":"Criteria expression (in JSON format) used to simulate Orchestration against transactional objects.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "StripingAttributeValue":{
            "title":"Striping Attribute Value",
            "maxLength":2000,
            "type":"string",
            "description":"The striping attribute value in JSON format.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationType":{
            "title":"Orchestration Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of orchestration. The values are guided selling, program builder, and so on.",
            "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"
            }
        },
        "ImportedDateTime":{
            "title":"Import Date Time",
            "type":"string",
            "description":"The date and time when the orchestration was last imported from a different environment.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AssociationRank":{
            "title":"Association Rank",
            "type":"integer",
            "description":"The rank in which the orchestrations need to be processed during association.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorLogs":{
            "title":"Error Logs",
            "type":"array",
            "description":"The error logs resource is used to view the error details.",
            "items":{
                "$ref":"#/components/schemas/orchestrations-ErrorLogs-item-response"
            }
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration.",
            "nullable":false,
            "x-queryable":true
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationDescription":{
            "title":"Orchestration Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description text of the orchestration object.",
            "nullable":true,
            "x-queryable":false
        },
        "Stages":{
            "title":"Stages",
            "type":"array",
            "description":"The stages resource is used to view, create, update, and delete an orchestration stage. The stages are a collection of steps, objectives, and associations.",
            "items":{
                "$ref":"#/components/schemas/orchestrations-Stages-item-response"
            }
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the orchestration can be deleted. The value is true for orchestrations in Draft status.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            },
            "x-queryable":true
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration.",
            "nullable":false,
            "x-queryable":true
        },
        "StripingAttributeName":{
            "title":"Striping Attribute Name",
            "maxLength":100,
            "type":"string",
            "description":"The striping attribute name. The striping attribute name determines which orchestration process will be used.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssociationCriteriaExpression":{
            "title":"Association Criteria Expression",
            "type":"string",
            "description":"The criteria expression, in JSON format, used to associate orchestration objects to transactional objects.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

タイプ: array

タイトル: Error Logs

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

ソースを表示

Array of: object orchestrations-ErrorLogs-item-response

{
    "title":"Error Logs",
    "type":"array",
    "description":"The error logs resource is used to view the error details.",
    "items":{
        "$ref":"#/components/schemas/orchestrations-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

タイトル: Stages

ステージ・リソースは、オーケストレーション・ステージの表示、作成、更新および削除に使用されます。ステージは、ステップと目標、関連付けの集合です。

ソースを表示

Array of: object orchestrations-Stages-item-response

{
    "title":"Stages",
    "type":"array",
    "description":"The stages resource is used to view, create, update, and delete an orchestration stage. The stages are a collection of steps, objectives, and associations.",
    "items":{
        "$ref":"#/components/schemas/orchestrations-Stages-item-response"
    }
}

ネストされたスキーマ : orchestrations-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 row.",
            "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 and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique 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 row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorText":{
            "title":"Error Text",
            "maxLength":2000,
            "type":"string",
            "description":"Specifies the error call stack.",
            "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 the orchestration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration.",
            "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 steps object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration stage.",
            "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 public unique identifier of the orchestration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectId":{
            "title":"Source Object ID",
            "type":"integer",
            "description":"The unique identifier of the source object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"SourceObjectCode",
            "maxLength":100,
            "type":"string",
            "description":"The language independent code of the transactional object. For example, Lead or Opportunity.",
            "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 public unique identifier or alternate key of the orchestration error log.",
            "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 and time when the row 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."
        }
    }
}

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

タイプ: object

ソースを表示

ContainErrorsFlag: boolean

タイトル: Contain Errors

最大長: 1

オーケストレーション・ステージに検証エラーが含まれているかどうかを示します。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

行を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

行が作成された日時。
DisplaySequence: 整数(int32)

タイトル: Display Sequence

オーケストレーション管理者ランタイム・ユーザー・インタフェースでのオーケストレーション・ステージの順序。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

行が最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

行を最後に更新したユーザー。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
OrchestrationId: integer (int64)

タイトル: Orchestration ID

オーケストレーションの一意の識別子。
OrchestrationName: string

タイトル: Orchestration Name

読取り専用: true

最大長: 100

オーケストレーションの名前。
OrchestrationNumber: string

タイトル: Orchestration Number

読取り専用: true

最大長: 64

オーケストレーションの公開一意識別子。
OrchestrationStageId: integer (int64)

タイトル: Orchestration Stage ID

オーケストレーション・ステージ・オブジェクトの一意の識別子。
OrchestrationStageNumber: string

タイトル: Orchestration Stage Number

最大長: 64

オーケストレーション・ステージ・オブジェクトの公開一意識別子。
StageDescription: string

タイトル: Objective Description

最大長: 2000

オーケストレーション・ステージ・オブジェクトの説明テキスト。
StageName: string

タイトル: Stage Name

最大長: 100

オーケストレーション・ステージの名前。
StageObjectives: array Stage Objectives

タイトル: Stage Objectives

ステージ目標リソースは、ステージ目標の表示、作成、更新および削除に使用されます。特定のステージで達成する目標の自由形式です。
StepObjectivesAssociations: array Step Objective Associations

タイトル: Step Objective Associations

ステップ目標関連リソースは、ステップ目標関連の表示、作成、更新および削除に使用されます。これは、ステップを実行する目的です。 1つのステップを複数の目標にマップできます。
Steps: array Steps

タイトル: Steps

ステップ・リソースは、ステップの表示、作成、更新および削除に使用されます。ステップとは、スマート・アクションの実行、Eメールの送信、電話の作成など、個々のアクション・アイテムです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Steps":{
            "title":"Steps",
            "type":"array",
            "description":"The steps resource is used to view, create, update, and delete a step. Steps are individual action items such as execute a smart action, send an email, make a phone call, and so on.",
            "items":{
                "$ref":"#/components/schemas/orchestrations-Stages-Steps-item-response"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration stage object.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the orchestration stages in the orchestration administrator run time user interfaces.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "StageName":{
            "title":"Stage Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration stage.",
            "nullable":false,
            "x-queryable":true
        },
        "OrchestrationName":{
            "title":"Orchestration Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OrchestrationId":{
            "title":"Orchestration ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrchestrationNumber":{
            "title":"Orchestration Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StageDescription":{
            "title":"Objective Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description text of the orchestration stage object.",
            "nullable":true,
            "x-queryable":false
        },
        "StepObjectivesAssociations":{
            "title":"Step Objective Associations",
            "type":"array",
            "description":"The step objective associations resource is used to view, create, update, and delete a step objective association. It's the objective of performing a step. One step can be mapped to multiple objectives.",
            "items":{
                "$ref":"#/components/schemas/orchestrations-Stages-StepObjectivesAssociations-item-response"
            }
        },
        "ContainErrorsFlag":{
            "title":"Contain Errors",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the orchestration stage contains any validation errors.",
            "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
        },
        "StageObjectives":{
            "title":"Stage Objectives",
            "type":"array",
            "description":"The stage objectives resource is used to view, create, update, and delete a stage objective. It's a free form of goals to achieve in a particular stage.",
            "items":{
                "$ref":"#/components/schemas/orchestrations-Stages-StageObjectives-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row 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"
    }
}

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

タイプ: array

タイトル: Stage Objectives

ステージ目標リソースは、ステージ目標の表示、作成、更新および削除に使用されます。特定のステージで達成する目標の自由形式です。

ソースを表示

Array of: object orchestrations-Stages-StageObjectives-item-response

{
    "title":"Stage Objectives",
    "type":"array",
    "description":"The stage objectives resource is used to view, create, update, and delete a stage objective. It's a free form of goals to achieve in a particular stage.",
    "items":{
        "$ref":"#/components/schemas/orchestrations-Stages-StageObjectives-item-response"
    }
}

ネストされたスキーマ : ステップ目標の関連付け

タイプ: array

タイトル: Step Objective Associations

ステップ目標関連リソースは、ステップ目標関連の表示、作成、更新および削除に使用されます。これは、ステップを実行する目的です。 1つのステップを複数の目標にマップできます。

ソースを表示

Array of: object orchestrations-Stages-StepObjectivesAssociations-item-response

{
    "title":"Step Objective Associations",
    "type":"array",
    "description":"The step objective associations resource is used to view, create, update, and delete a step objective association. It's the objective of performing a step. One step can be mapped to multiple objectives.",
    "items":{
        "$ref":"#/components/schemas/orchestrations-Stages-StepObjectivesAssociations-item-response"
    }
}

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

タイプ: array

タイトル: Steps

ステップ・リソースは、ステップの表示、作成、更新および削除に使用されます。ステップとは、スマート・アクションの実行、Eメールの送信、電話の作成など、個々のアクション・アイテムです。

ソースを表示

Array of: object orchestrations-Stages-Steps-item-response

{
    "title":"Steps",
    "type":"array",
    "description":"The steps resource is used to view, create, update, and delete a step. Steps are individual action items such as execute a smart action, send an email, make a phone call, and so on.",
    "items":{
        "$ref":"#/components/schemas/orchestrations-Stages-Steps-item-response"
    }
}

ネストされたスキーマ : orchestrations-Stages-StageObjectives-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

行を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

行が作成された日時。
DisplaySequence: 整数(int32)

タイトル: Display Sequence

オーケストレーション管理者ランタイム・ユーザー・インタフェースでの目標の順序。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

行が最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

行を最後に更新したユーザー。
links: array Links

タイトル: Links

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

タイトル: Objective Description

最大長: 2000

オーケストレーション・ステージ目標オブジェクトの説明テキスト。
ObjectiveName: string

タイトル: Objective Name

最大長: 100

オーケストレーション・ステージ目標オブジェクトの名前。
ObjectiveStatus: string

タイトル: Objective Status

最大長: 30

目標のステータス。指定可能な値はNEWまたはMAPPEDです。
OrchestrationStageId: integer (int64)

タイトル: Orchestration Stage ID

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

タイトル: Stage Name

読取り専用: true

最大長: 100

オーケストレーション・ステージの名前。
OrchestrationStageNumber: string

タイトル: Orchestration Stage Number

読取り専用: true

最大長: 64

オーケストレーション・ステージ・オブジェクトの公開一意識別子。
StageObjectiveId: integer (int64)

タイトル: Stage Objective ID

オーケストレーション・ステージ目標オブジェクトの一意の識別子。
StageObjectiveNumber: string

タイトル: Stage Objective Number

最大長: 64

オーケストレーション・ステージ目標オブジェクトの公開一意識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique 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 row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the objectives in the orchestration administrator runtime user interface.",
            "format":"int32",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StageObjectiveId":{
            "title":"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
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestrations stage object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StageObjectiveNumber":{
            "title":"Stage Objective Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration stage objective object.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectiveStatus":{
            "title":"Objective Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the objective. Possible values are NEW or MAPPED.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectiveName":{
            "title":"Objective Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration stage objective object.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectiveDescription":{
            "title":"Objective Description",
            "maxLength":2000,
            "type":"string",
            "description":"The description text of the orchestration stage objective object.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row 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"
    }
}

ネストされたスキーマ : orchestrations-Stages-StepObjectivesAssociations-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

行を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

行が作成された日時。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

行が最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

行を最後に更新したユーザー。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
OrchestrationStageId: integer (int64)

タイトル: Orchestration Stage ID

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

タイトル: Stage Name

読取り専用: true

最大長: 100

オーケストレーション・ステージの名前。
OrchestrationStageNumber: string

タイトル: Orchestration Stage Number

読取り専用: true

最大長: 64

オーケストレーション・ステージ・オブジェクトの公開一意識別子。
OrchestrationStageObjectiveId: integer

タイトル: Stage Objective ID

オーケストレーション・ステージ目標オブジェクトの一意の識別子。
OrchestrationStepId: integer

タイトル: Orchestration Step ID

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

タイトル: Orchestration Step Name

読取り専用: true

最大長: 100

オーケストレーション・ステップの名前。
OrchestrationStepNumber: string

タイトル: Orchestration Step Number

読取り専用: true

最大長: 64

オーケストレーション・ステップ・オブジェクトの公開一意識別子。
StageObjectiveName: string

タイトル: Objective Name

読取り専用: true

最大長: 100

オーケストレーション・ステージ目標オブジェクトの名前。
StageObjectiveNumber: string

タイトル: Stage Objective Number

読取り専用: true

最大長: 64

オーケストレーション・ステージ目標オブジェクトの公開一意識別子。
StepObjectiveAssocId: integer (int64)

タイトル: Step Objective Association ID

オーケストレーション・ステップ目標関連オブジェクトの一意の識別子。
StepObjectiveAssocNumber: string

タイトル: Step Objective Association Number

最大長: 64

オーケストレーション・ステップ目標関連オブジェクトの公開一意識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique 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 row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "StepObjectiveAssocId":{
            "title":"Step Objective Association ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration step objectives association 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 steps object.",
            "nullable":false,
            "x-queryable":true
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StepObjectiveAssocNumber":{
            "title":"Step Objective Association Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration step objectives association object.",
            "nullable":false,
            "x-queryable":true
        },
        "StageObjectiveName":{
            "title":"Objective Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration stage objective object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrchestrationStageObjectiveId":{
            "title":"Stage Objective ID",
            "type":"integer",
            "description":"The unique identifier of the Orchestration stage objective object.",
            "nullable":false,
            "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
        },
        "StageObjectiveNumber":{
            "title":"Stage Objective Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration stage objective object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row 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"
    }
}

ネストされたスキーマ : orchestrations-Stages-Steps-item-response

タイプ: object

ソースを表示

ActivityTemplateId: integer (int64)

タイトル: Activity Template ID

タスクおよびポイント・テンプレートの識別子。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

行を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

行が作成された日時。
DaysToWait: 整数(int32)

タイトル: Days to Wait

デフォルト値: 0

待機する日数を指定します。
DisplaySequence: integer

タイトル: Display Sequence

オーケストレーション管理者ランタイムUIでのステップの順序。
EmailContactsFilterCriteria: 文字列(バイト)

タイトル: Email Contacts Filter Criteria

Eメール・コンタクトをフィルタするための基準式。
EmailContsObjectCd: string

タイトル: Email Contact Filter Object

最大長: 1000

Eメール・コンタクト基準が作成されるオブジェクト、emailFieldおよびdneFieldの名前を指定します。
EmailTemplateId: integer (int64)

タイトル: Email Template ID

実行時にデフォルト設定されるEメール・テンプレートの一意の識別子。
ExecutionMethod: string

タイトル: Execution Method

最大長: 30

オーケストレーション・ステップの実行タイプ。指定可能な値は手動および自動です。
FailureStepId: integer (int64)

タイトル: Failure Step ID

現在のステップが失敗した場合の、次のステップの一意の識別子。
FailureStepName: string

タイトル: Orchestration Step Name

読取り専用: true

最大長: 100

オーケストレーション・ステップの名前。
FailureStepNumber: string

タイトル: Orchestration Step Number

読取り専用: true

最大長: 64

オーケストレーション・ステップ・オブジェクトの公開一意識別子。
FieldUpdateJson: 文字列(バイト)

タイトル: Field Update JSON

ソース・オブジェクトで更新するフィールドのリストを含むJSON構造。
GracePeriod: integer

タイトル: Grace Period

ステップを失敗として処理する前に待機する時間数を指定します。これは手動ステップにのみ適用されます。
HoursToWait: integer

タイトル: Hours to Wait

デフォルト値: 0

待機する時間数。
IATemplateValue: string

タイトル: IA Template Value

最大長: 100

インテリジェント・アドバイザ・ガイド・テンプレートの名前。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

行が最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

行を最後に更新したユーザー。
links: array Links

タイトル: Links

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

タイトル: Next Stage Value

最大長: 100

進行する必要があるステージの値。
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

最大長: 100

オーケストレーション・ステップの名前。
OrchestrationStepNumber: string

タイトル: Orchestration Step Number

最大長: 64

オーケストレーション・ステップ・オブジェクトの公開一意識別子。
SMARTActionId: integer (int64)

タイトル: Smart Action ID

スマート処理の一意の識別子。
StepSuggestionText: string

タイトル: Step Suggestion Text

最大長: 2000

オーケストレーション・ステップの提案テキスト。
StepType: string

タイトル: Step Type

最大長: 30

ステップ・タイプ
SuccessCriteria: 文字列(バイト)

タイトル: Success Criteria

ステップが成功したかどうかの識別に使用する基準。
SuccessStepId: integer (int64)

タイトル: Success Step ID

現在のステップが成功した場合の次のステップの一意の識別子。
SuccessStepName: string

タイトル: Orchestration Step Name

読取り専用: true

最大長: 100

オーケストレーション・ステップの名前。
SuccessStepNumber: string

タイトル: Orchestration Step Number

読取り専用: true

最大長: 64

オーケストレーション・ステップ・オブジェクトの公開一意識別子。
WaitForRepliesFlag: boolean

タイトル: Wait for Replies Flag

最大長: 1

デフォルト値: false

ステップが応答を待機する必要があるかどうかを示します。

{
    "type":"object",
    "properties":{
        "DaysToWait":{
            "title":"Days to Wait",
            "type":"integer",
            "description":"Specifies the number of days to wait.",
            "format":"int32",
            "nullable":true,
            "default":0,
            "x-queryable":false,
            "x-hints":{
                "precision":9
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SuccessStepId":{
            "title":"Success Step ID",
            "type":"integer",
            "description":"The unique identifier of the next step if current step succeeds.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The order of the steps in the orchestration administrator runtime UIs.",
            "nullable":false,
            "x-queryable":false
        },
        "StepType":{
            "title":"Step Type",
            "maxLength":30,
            "type":"string",
            "description":"Step Type",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OrchestrationStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object.",
            "nullable":false,
            "x-queryable":true
        },
        "EmailTemplateId":{
            "title":"Email Template ID",
            "type":"integer",
            "description":"The unique identifier of the email template that will be defaulted at run time.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrchestrationStageName":{
            "title":"Stage Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of the orchestration stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailContactsFilterCriteria":{
            "title":"Email Contacts Filter Criteria",
            "type":"string",
            "description":"The criteria expression to filter the email contacts.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SuccessStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EmailContsObjectCd":{
            "title":"Email Contact Filter Object",
            "maxLength":1000,
            "type":"string",
            "description":"Specifies the object,emailField and dneField names on which the email contacts criteria is built.",
            "nullable":true,
            "x-queryable":false
        },
        "FailureStepId":{
            "title":"Failure Step ID",
            "type":"integer",
            "description":"The unique identifier of the next step if the current step fails.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "FieldUpdateJson":{
            "title":"Field Update JSON",
            "type":"string",
            "description":"The JSON structure containing the list of fields to update on source object.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStageId":{
            "title":"Orchestration Stage ID",
            "type":"integer",
            "description":"The unique identifier of the orchestrations 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"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "FailureStepNumber":{
            "title":"Orchestration Step Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique identifier of the orchestration steps object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HoursToWait":{
            "title":"Hours to Wait",
            "type":"integer",
            "description":"The number of hours to wait.",
            "nullable":true,
            "default":0,
            "x-queryable":false
        },
        "IATemplateValue":{
            "title":"IA Template Value",
            "maxLength":100,
            "type":"string",
            "description":"The name of the intelligent advisor guide template.",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStageNumber":{
            "title":"Orchestration Stage Number",
            "maxLength":64,
            "type":"string",
            "description":"The public unique 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 row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SMARTActionId":{
            "title":"Smart Action ID",
            "type":"integer",
            "description":"The unique identifier of the smart action.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "OrchestrationStepId":{
            "title":"Orchestration Step ID",
            "type":"integer",
            "description":"The unique identifier of the orchestration steps object.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SuccessStepName":{
            "title":"Orchestration Step Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityTemplateId":{
            "title":"Activity Template ID",
            "type":"integer",
            "description":"The identifier for the Task and Appointment templates.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WaitForRepliesFlag":{
            "title":"Wait for Replies Flag",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the step has to wait for replies.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SuccessCriteria":{
            "title":"Success Criteria",
            "type":"string",
            "description":"The criteria used to identify whether a step is successful.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "OrchestrationStepName":{
            "title":"Orchestration Step Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "x-queryable":true
        },
        "ExecutionMethod":{
            "title":"Execution Method",
            "maxLength":30,
            "type":"string",
            "description":"The execution type for the orchestration step. The possible values are Manual and Automatic.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FailureStepName":{
            "title":"Orchestration Step Name",
            "maxLength":100,
            "type":"string",
            "description":"The name of orchestration step.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NextStageValue":{
            "title":"Next Stage Value",
            "maxLength":100,
            "type":"string",
            "description":"The value of the Stage to which you need to progress.",
            "nullable":true,
            "x-queryable":false
        },
        "StepSuggestionText":{
            "title":"Step Suggestion Text",
            "maxLength":2000,
            "type":"string",
            "description":"The suggestion text of the orchestration step.",
            "nullable":true,
            "x-queryable":false
        },
        "GracePeriod":{
            "title":"Grace Period",
            "type":"integer",
            "description":"Specifies the number of hours to wait before treating the Step as failed. This is applicable only for manual steps.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row 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"
    }
}

リンク

ErrorLogs

操作: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/ErrorLogs

パラメータ:

OrchestrationNumber: $request.path.OrchestrationNumber

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

OrchestrationSourceObjectsVA

操作: /crmRestApi/resources/11.13.18.05/orchestrationSupportedObjects

パラメータ:

ファインダ: OrchSupportedObjectsFinder

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

ソース属性: ObjectCode;ターゲット属性: ObjectCode
表示属性: DisplayName

OrchestrationTypeVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_DT_TYPE

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

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

ステージ

操作: /crmRestApi/resources/11.13.18.05/orchestrations/{OrchestrationNumber}/child/Stages

パラメータ:

OrchestrationNumber: $request.path.OrchestrationNumber

StatusCodeVA

操作: /crmRestApi/resources/11.13.18.05/fndStaticLookups

パラメータ:

ファインダ: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_ZCA_ORCH_DT_STATUS

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

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

トップに戻る

例:

次の例は、RESTリソースに対してGETリクエストを発行してオーケストレーションを取得する方法を示しています。

cURLコマンド

curl -u <username:password> \
 -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/orchestrations/CDRM_1001  \
 -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json'  | json_pp

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
    "OrchestrationId": 300100563170364,
    "OrchestrationNumber": "CDRM_1001",
    "OrchestrationName": "YYYA8",
    "OrchestrationDescription": "From REST_042",
    "ObjectCode": "Lead",
    "StripingAttributeName": null,
    "StripingAttributeValue": null,
    "LifecycleAttributeName": "StatusCode",
    "OrchestrationType": "GUIDEDSELLING",
    "SourceOrchestrationId": null,
    "StatusCode": "DRAFT",
    "ActivationDateTime": null,
    "AssociationRank": 1,
    "CreationDate": "2022-09-26T05:57:07+00:00",
    "CreatedBy": "SALES_ADMIN",
    "LastUpdatedBy": "SALES_ADMIN",
    "LastUpdateDate": "2022-09-26T05:57:09.285+00:00",
    "DeleteFlag": true,
    "UpdateFlag": true,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/orchestrations/CDRM_1001",
            "name": "orchestrations",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/orchestrations/CDRM_1001",
            "name": "orchestrations",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/orchestrations/CDRM_1001/child/ErrorLogs",
            "name": "ErrorLogs",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/orchestrations/CDRM_1001/child/Stages",
            "name": "Stages",
            "kind": "collection"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/orchestrations/CDRM_1001/enclosure/AssociationCriteriaExpression",
            "name": "AssociationCriteriaExpression",
            "kind": "other"
        }
    ]
}

「トップに戻る」