機械翻訳について

ジャンプ先

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

オーケストレーションでサポートされているオブジェクトの取得

get

/crmRestApi/resources/11.13.18.05/orchestrationSupportedObjects/{orchestrationSupportedObjectsUniqID}

リクエスト

パス・パラメータ

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

本文( )

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

タイプ: object

ソースを表示

• AlternateKeys: string
  タイトル: Alternate Keys

  読取り専用: true

  オブジェクトの代替キー。
• APPStripe: string
  最大長: 80

  オブジェクトのAppStripe値。 AppStripeは、オブジェクトのキーストアを含むストリップの名前です。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

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

  読取り専用: true

  行が作成された日時。
• Description: string
  タイトル: Description

  読取り専用: true

  オブジェクトの説明。
• DescriptionResourceId: string
  タイトル: Description Resource ID

  読取り専用: true

  リソース識別子の説明。
• DisplayName: string
  タイトル: Display Name

  読取り専用: true

  オブジェクトの表示名。
• DisplayNamePlural: string
  タイトル: Plural Title

  読取り専用: true

  オブジェクトの複数タイトル。
• ExtensibleViewDefinition: string
  タイトル: Extensible View Definition

  最大長: 600

  オブジェクトの拡張可能ビュー・オブジェクト。 VOが拡張可能でない場合、NULLが格納されます。
• IsCustomFlag: boolean
  タイトル: Custom Object

  最大長: 1

  デフォルト値: false

  オブジェクトがカスタム・オブジェクトかどうかを示します。
• IsExtensible: string
  タイトル: Is Extensible

  読取り専用: true

  オブジェクトが拡張可能オブジェクトかどうかを示します。
• KeyAttributes: string
  タイトル: User Keys

  読取り専用: true

  オブジェクトのユーザー・キー。
• LabelResourceId: string
  タイトル: Label Resource ID

  最大長: 700

  オブジェクトのラベル・リソース識別子。 オブジェクトの表示名の決定に使用されます。
• LastUpdateDate: string (date-time)
  タイトル: Last Update Date

  読取り専用: true

  行が最後に更新された日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

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

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

  最大長: 128

  一括インポートでの対応するオブジェクトの言語独立コード。
• ObjectDefinition: string
  タイトル: Object Definition

  最大長: 600

  オブジェクトの定義。
• ParentObjectCode: string
  タイトル: Parent Object

  最大長: 2000

  現在のオブジェクトの潜在的な親を識別するために使用されるLANG_INDEPENDENT_CODE値のカンマ区切りリスト。
• PluralLabelResourceId: string
  タイトル: Plural Label Resource ID

  最大長: 700

  オブジェクトの複数ラベル・リソース識別子。
• PrimaryEntityDefinition: string
  タイトル: Primary Entity Definition

  最大長: 600

  対応するビュー・オブジェクトのプライマリ・エンティティ・オブジェクト定義。
• PuidAttribute: string
  タイトル: Primary Alternate Key

  最大長: 100

  オブジェクトの公開一意識別子。
• RestResource: string
  タイトル: REST Resource Code

  最大長: 100

  オブジェクトのRESTリソース・コード。
• RestResourceIdentifier: string
  タイトル: REST Resource Identifier

  最大長: 100

  オブジェクトのRESTリソース行識別子。
• UcmAccount: string
  タイトル: Account

  最大長: 120

  ファイルがアップロードされるUCMフォルダ名。

{
    "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
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"The description of an object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateKeys":{
            "title":"Alternate Keys",
            "type":"string",
            "description":"The alternate keys for the object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RestResource":{
            "title":"REST Resource Code",
            "maxLength":100,
            "type":"string",
            "description":"The REST resource code of the object.",
            "nullable":true,
            "x-queryable":true
        },
        "APPStripe":{
            "maxLength":80,
            "type":"string",
            "description":"The AppStripe value for the object. An AppStripe is the name of the strip containing the keystore for an object.",
            "nullable":true,
            "x-hints":{
                "sortable":false
            },
            "x-queryable":true
        },
        "PluralLabelResourceId":{
            "title":"Plural Label Resource ID",
            "maxLength":700,
            "type":"string",
            "description":"The plural label resource identifier of an object.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Name",
            "maxLength":128,
            "type":"string",
            "description":"The language independent code of the corresponding object in bulk import.",
            "nullable":false,
            "x-queryable":true
        },
        "DescriptionResourceId":{
            "title":"Description Resource ID",
            "type":"string",
            "description":"The description of the resource identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IsCustomFlag":{
            "title":"Custom Object",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the object is a custom object.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "PrimaryEntityDefinition":{
            "title":"Primary Entity Definition",
            "maxLength":600,
            "type":"string",
            "description":"The primary entity object definition for the corresponding view object.",
            "nullable":true,
            "x-queryable":true
        },
        "RestResourceIdentifier":{
            "title":"REST Resource Identifier",
            "maxLength":100,
            "type":"string",
            "description":"The REST resource row identifier of the object.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "type":"string",
            "description":"The display name of an object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DisplayNamePlural":{
            "title":"Plural Title",
            "type":"string",
            "description":"The plural title of the object.",
            "nullable":true,
            "readOnly":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":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PuidAttribute":{
            "title":"Primary Alternate Key",
            "maxLength":100,
            "type":"string",
            "description":"The public unique identifier of the object.",
            "nullable":true,
            "x-queryable":true
        },
        "KeyAttributes":{
            "title":"User Keys",
            "type":"string",
            "description":"The user keys of an object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectDefinition":{
            "title":"Object Definition",
            "maxLength":600,
            "type":"string",
            "description":"The definition for the object.",
            "nullable":false,
            "x-queryable":true
        },
        "UcmAccount":{
            "title":"Account",
            "maxLength":120,
            "type":"string",
            "description":"The UCM folder name where files are uploaded.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentObjectCode":{
            "title":"Parent Object",
            "maxLength":2000,
            "type":"string",
            "description":"The comma separated list of LANG_INDEPENDENT_CODE values used to identify potential parent of object of a current object.",
            "nullable":true,
            "x-queryable":true
        },
        "ExtensibleViewDefinition":{
            "title":"Extensible View Definition",
            "maxLength":600,
            "type":"string",
            "description":"The extensible view object for the object. If VO isn't extensible, then it stores null.",
            "nullable":true,
            "x-queryable":true
        },
        "IsExtensible":{
            "title":"Is Extensible",
            "type":"string",
            "description":"Indicates whether the object is an extensible object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LabelResourceId":{
            "title":"Label Resource ID",
            "maxLength":700,
            "type":"string",
            "description":"The label resource identifier for the object. It will be used to determine the display name for the object.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update 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."
        }
    }
}

「トップに戻る」