機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. プロセスMetadata

すべてのプロセス・メタデータの取得

get

/crmRestApi/resources/11.13.18.05/processMetadata

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

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

    子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
  • コレクションを検索するための事前定義済ファインダとして使用されます。

    フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • AltKey : 指定された代替キーを持つプロセス・メタデータを検索します。
      ファインダ変数:
      • ProcessInterfaceName; string;プロセス・インタフェースの名前。
      • ProcessKey; string; Process Cloudの一意のプロセスの識別子。
      • ProcessTypeCd; string; 指定されたProcess Cloudプロセスが構造化されているプロセスまたは動的プロセスであるかどうかを示す参照コード。
    • PrimaryKey : 指定された主キーを持つプロセス・メタデータを検索します。
      ファインダ変数:
      • ProcessMetadataId; integer; プロセス・メタデータの一意の識別子。
    • ProcessMetadataPuidAltKey : 指定された代替一意識別子を持つプロセス・メタデータを検索します。
      ファインダ変数:
      • ProcessMetadataNumber; string; プロセス・メタデータの参照番号を示します。
    • findByProcessMetadataNumber : 指定された代替一意識別子を持つプロセス・メタデータを検索します。
      ファインダ変数:
      • ProcessMetadataNumber; string; プロセス・メタデータの参照番号を示します。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

    フォーマット : ?q=expression1;expression2

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CreatedBy; string; プロセス・メタデータを作成したユーザー。
    • CreationDate; string; プロセス・メタデータが作成された日時。
    • LastUpdateDate; string; プロセス・メタデータが最後に更新された日付。
    • LastUpdateLogin; string;プロセス・メタデータを最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; プロセス・メタデータを最後に更新したユーザー。
    • ProcessApplicationName; string;プロセス・アプリケーションの名前。
    • ProcessConnectionTypeCd; string; Process Cloudへの接続が基本か統合かを示す参照コード。
    • ProcessInterfaceName; string; プロセス・インタフェースに関連付けられた識別子。
    • ProcessKey; string; プロセス・クラウド内のプロセスを一意に識別する識別子。
    • ProcessMetadataId; integer; プロセス・メタデータの一意の識別子。
    • ProcessMetadataNumber; string;プロセス・メタデータの参照番号。
    • ProcessName; string;プロセスの名前。
    • ProcessTypeCd; string; 指定されたProcess Cloudプロセスが構造化されているプロセスまたは動的プロセスであるかどうかを示す参照コード。
    • ProcessVersion; string;一意のプロセス・バージョン。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : processMetadata
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : processMetadata-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    プロセス・メタデータを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    プロセス・メタデータが作成された日時。
  • タイトル: LastUpdateDate
    読取り専用: true
    プロセス・メタデータが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    プロセス・メタデータを最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    プロセス・メタデータを最後に更新したユーザーのログイン。
  • Links
  • タイトル: Process Application Name
    最大長: 220
    プロセス・アプリケーションの名前。
  • タイトル: Process Connection Type Code
    最大長: 30
    デフォルト値: Integrated
    Process Cloudへの接続が基本か統合かを示す参照コード。
  • タイトル: Process Interface Name
    最大長: 510
    プロセス・インタフェースに関連付けられた識別子。
  • タイトル: Process Key
    最大長: 510
    プロセス・クラウド内のプロセスを一意に識別する識別子。
  • タイトル: Process Metadata ID
    読取り専用: true
    プロセス・メタデータの一意の識別子。
  • タイトル: Process Metadata Number
    最大長: 30
    プロセス・メタデータの参照番号。
  • タイトル: Process Name
    最大長: 220
    プロセスの名前。
  • タイトル: Process Type Code
    最大長: 30
    指定されたプロセスがProcess Cloudプロセスの構造化または動的であるかどうかを示す参照コード。
  • タイトル: Process Version
    最大長: 60
    一意のプロセス・バージョン。
「トップに戻る」