機械翻訳について

ジャンプ先

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

すべてのオーケストレーション関連付けの取得

get

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations

リクエスト

パス・パラメータ

• leadsUniqID(required): string
  これは、営業リード・リソースの複合キーを構成し、営業リードのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、営業リードの特定のインスタンスに移動してハッシュ・キーを取得するために、営業リード・コレクション・リソースを問い合せる必要があります。

問合せパラメータ

• 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
• finder: string
  コレクションを検索するための事前定義済ファインダとして使用されます。
  
  フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  使用可能なファインダ名および対応するファインダ変数を次に示します:
  
  

  • OrchAssocNumberAltKey : 公開一意識別子に基づいてオーケストレーション関連を検索します。
    ファインダ変数:
    • OrchestrationAssociationNumber; string;オーケストレーション関連付けの公開一意識別子。
  • PrimaryKey : 主キーとのオーケストレーション関連を検索します。
    ファインダ変数:
    • OrchestrationAssociationId; integer; オーケストレーション関連付けの主キー。
• limit: integer
  このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• offset: integer
  リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
• onlyData: boolean
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
• orderBy: string
  このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
• q: string
  この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
  
  フォーマット : ?q=expression1;expression2
  
  次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
  

  • AssociationStatusCode; string; アソシエーションのステータス。
  • CreationDate; string;レコードが作成された日付。
  • LastUpdateDate; string; レコードが最後に更新された日付。
  • LastUpdatedBy; string; レコードを最後に更新したユーザー。
  • OrchestrationAssociationId; integer;オーケストレーション関連付けの代替識別子。
  • OrchestrationAssociationNumber; string;オーケストレーション関連付けの一意の識別子。
  • OrchestrationId; integer;オーケストレーション・オブジェクトの一意の識別子。
  • OrchestrationNumber; string;オーケストレーション・オブジェクトの代替識別子。
  • SourceObjectCode; string;言語に依存しないオブジェクト・コード。
  • SourceObjectId; integer; ソース・オブジェクト・コードの一意の識別子。
• totalResults: boolean
  "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。

ヘッダー・パラメータ

• 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のデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : leads-OrchestrationAssociations

タイプ: object

ソースを表示

• count(required): integer
  現在の範囲で返されたリソース・インスタンスの数。
• hasMore(required): boolean
  サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
• items: array Items
  タイトル: Items

  コレクション内のアイテム。
• limit(required): integer
  サーバーで使用される実際のページング・サイズ。
• links(required): array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• offset(required): integer
  現在のページで使用されるオフセット値。
• totalResults: integer
  "?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/leads-OrchestrationAssociations-item-response"
            }
        }
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

• Array of: object leads-OrchestrationAssociations-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/leads-OrchestrationAssociations-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"
    }
}

ネストされたスキーマ : leads-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/leads-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/leads-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/leads-OrchestrationAssociations-Stages-item-response"
            }
        },
        "OrchestrationAssociationNumber":{
            "title":"Orchestration Association Number",
            "maxLength":64,
            "type":"string",
            "description":"The unique 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/leads-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/leads-OrchestrationAssociations-StepTransitions-item-response"
            }
        },
        "OrchestrationAssociationId":{
            "title":"Orchestration Association ID",
            "type":"integer",
            "description":"The alternate 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 leads-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/leads-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 leads-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/leads-OrchestrationAssociations-StageObjectives-item-response"
    }
}

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

タイプ: array

タイトル: Stages

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

ソースを表示

• Array of: object leads-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/leads-OrchestrationAssociations-Stages-item-response"
    }
}

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

タイプ: array

タイトル: Steps

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

ソースを表示

• Array of: object leads-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/leads-OrchestrationAssociations-Steps-item-response"
    }
}

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

タイプ: array

タイトル: Step Transitions

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

ソースを表示

• Array of: object leads-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/leads-OrchestrationAssociations-StepTransitions-item-response"
    }
}

ネストされたスキーマ : leads-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."
        }
    }
}

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

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

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

  読取り専用: true

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

  ユーザー・インタフェースで実行または表示されるステージの順序。
• 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 to be executed or displayed in the User Interface.",
            "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"
    }
}

ネストされたスキーマ : leads-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":"Order in which the Stages to be executed/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"
    }
}

ネストされたスキーマ : leads-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":"Order in which the Stages to be executed/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"
    }
}

ネストされたスキーマ : leads-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 type of the email to which the step transitions is associated with.",
            "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 step.",
            "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 alternate 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 unique 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"
    }
}

リンク

detachAssociatedOrchestration

操作: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/action/detachAssociatedOrchestration

パラメータ:

• leadsUniqID: $request.path.leadsUniqID

このメソッドを使用すると、オーケストレーションとトランザクション・オブジェクトの関連付けを解除できます。

getNotHelpfulObjectiveDetails

操作: /crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/OrchestrationAssociations/action/getNotHelpfulObjectiveDetails

パラメータ:

• leadsUniqID: $request.path.leadsUniqID

このメソッドを使用すると、役に立たない目標の詳細を取得できます。

「トップに戻る」