機械翻訳について

ジャンプ先

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

コピー・マップの取得

get

/crmRestApi/resources/11.13.18.05/copyMaps/{XMLId}

リクエスト

パス・パラメータ

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

本文( )

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

タイプ: object

ソースを表示

• ForceActivityCopy: string
  マッピングにアクティビティのコピーを強制する必要があるかどうかを示します。
• From: string
  エンティティまたは属性のコピー元となるソース修飾オブジェクト。
• FromAttribute: string
  属性マッピングのソース属性。
• FromEntity: string
  エンティティ・マッピングのソース・エンティティまたはVO。
• FromExpression: string
  ソース・エンティティ属性を使用して作成された式。 属性マッピングの値として使用されます。
• InMemoryFilter: string
  エンティティ・マッピングで使用されるフィルタ条件。
• JoinEntity: string
  エンティティ・マッピングでソース・エンティティと結合するオブジェクト。
• JoinEntityAttribute: string
  エンティティ・マッピングでエンティティを結合するために使用する属性。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• MappingName: string
  コピー・マップの名前。
• Path: string
  コピー・マップの相対パス。
• PrimaryKeyAttribute: string
  属性マッピングのターゲット属性がエンティティの主キーかどうかを示します。
• QueryAttribute: string
  エンティティ・マッピングの問合せ属性。
• QueryType: string
  エンティティ・マッピングの問合せタイプ。
• To: string
  エンティティまたは属性のコピー先のターゲット修飾オブジェクト。
• ToAttribute: string
  属性マッピングのターゲット属性。
• ToEntity: string
  エンティティ・マッピングのターゲット・エンティティまたはVO。
• ToParentAttributeName: string
  属性マッピングの親エンティティのターゲット親属性。
• ToParentEntityName: string
  属性マッピングのターゲット親エンティティ。
• ToReferencedEntity: string
  属性マッピングのターゲット参照エンティティ。
• UseExisting: string
  既存のビュー・オブジェクトを属性マッピングで使用するかどうかを示します。
• XMLId: string
  コピー・マップの一意の識別子。

{
    "type":"object",
    "properties":{
        "Path":{
            "type":"string",
            "description":"The relative path of the copy map.",
            "nullable":true,
            "x-queryable":true
        },
        "ToParentEntityName":{
            "type":"string",
            "description":"The target parent entity in the attribute mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "FromAttribute":{
            "type":"string",
            "description":"The source attribute in the attribute mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "ToEntity":{
            "type":"string",
            "description":"The target entity or VO in an entity mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "From":{
            "type":"string",
            "description":"The source qualified object from which the entity or attributes should be copied.",
            "nullable":true,
            "x-queryable":true
        },
        "XMLId":{
            "type":"string",
            "description":"The unique identifier of the copy map.",
            "nullable":true,
            "x-queryable":true
        },
        "FromExpression":{
            "type":"string",
            "description":"The expression built using source entity attributes. It's used as a value in the attribute mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "UseExisting":{
            "type":"string",
            "description":"Indicates if the existing view object should be used in an attribute mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "ToReferencedEntity":{
            "type":"string",
            "description":"The target referenced entity in the attribute mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "InMemoryFilter":{
            "type":"string",
            "description":"The filter condition used in the entity mappings.",
            "nullable":true,
            "x-queryable":true
        },
        "ToParentAttributeName":{
            "type":"string",
            "description":"The target parent attribute in a parent entity in the attribute mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "FromEntity":{
            "type":"string",
            "description":"The source entity or VO in the entity mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryKeyAttribute":{
            "type":"string",
            "description":"Indicates if the target attribute in an attribute mapping is the primary key for the entity.",
            "nullable":true,
            "x-queryable":true
        },
        "QueryAttribute":{
            "type":"string",
            "description":"The query attribute for an entity mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "JoinEntityAttribute":{
            "type":"string",
            "description":"The attribute used to join entity in an entity mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "ForceActivityCopy":{
            "type":"string",
            "description":"Indicates if copying Activities must be enforced for the mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "To":{
            "type":"string",
            "description":"The target qualified object to which the entity or attributes should be copied.",
            "nullable":true,
            "x-queryable":true
        },
        "MappingName":{
            "type":"string",
            "description":"The name of the copy map.",
            "nullable":true,
            "x-queryable":true
        },
        "QueryType":{
            "type":"string",
            "description":"The query type for an entity mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "ToAttribute":{
            "type":"string",
            "description":"The target attribute in an attribute mapping.",
            "nullable":true,
            "x-queryable":true
        },
        "JoinEntity":{
            "type":"string",
            "description":"The object to be joined with source entity in an entity mapping.",
            "nullable":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."
        }
    }
}

「トップに戻る」