機械翻訳について

ジャンプ先

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

関係タイプの取得

get

/crmRestApi/resources/11.13.18.05/relationshipTypes/{relationshipTypesUniqID}

リクエスト

パス・パラメータ

• relationshipTypesUniqID(required): string
  これは、リレーションシップ・タイプ・リソースのコンポジット・キー(RelationshipTypeId、LookupTypeおよびLookupCode)を構成する属性のハッシュ・キーで、リレーションシップ・タイプのインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、関係タイプの特定のインスタンスに移動するために、主キー値に対するフィルタを使用して、関係タイプ・コレクション・リソースを問い合せる必要があります。
  
  次に例を示します: relationshipTypes?q=RelationshipTypeId=<value1>;LookupType=<value2>;LookupCode=<value3>

問合せパラメータ

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

本文( )

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

タイプ: object

ソースを表示

• AllowCircularRelationships: string
  タイトル: Circular

  読取り専用: true

  最大長: 1

  この関係タイプを使用して循環関係が許可されるかどうかを示します。
• BackwardRelationshipCode: string
  読取り専用: true

  最大長: 30

  SUPPLIER_OFなどの関係を記述するために使用されるバック・ワード関係コード。
• CreatedByModule: string
  読取り専用: true

  最大長: 150

  レコードを作成したアプリケーション・モジュール。 すべてのwebサービス・ベースの作成では、デフォルトで値HZ_WSに設定されます。 有効な証明レベル・コードのリストは、参照HZ_CREATED_BY_MODULESで定義されます。 「設定およびメンテナンス」タスク、「取引先コミュニティ共通参照の管理」を使用して、コードをレビューおよび更新します。
• Description: string
  タイトル: Description

  読取り専用: true

  最大長: 240

  関係ロールの説明。
• DirectionCode: string
  読取り専用: true

  最大長: 30

  DIRECTION_CODE参照タイプによって検証される方向コード。 親の場合はP、子の場合はC、方向でない場合はN。
• EndDateActive: 文字列(日付)
  読取り専用: true

  関係ロールが終了する日付。
• ForwardRelationshipCode: string
  読取り専用: true

  最大長: 30

  CUSTOMER_OFなどの関係を記述するために使用されるフォワード関係コード。
• Language: string
  読取り専用: true

  最大長: 30

  関係ロール参照言語。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• LookupCode: string
  読取り専用: true

  最大長: 30

  関係ロール・コード。
• LookupType: string
  読取り専用: true

  最大長: 30

  ロール参照コードHZ_RELATIONSHIP_ROLE。
• Meaning: string
  読取り専用: true

  最大長: 80

  関係ロールの意味。
• ObjectType: string
  タイトル: Object Type

  読取り専用: true

  最大長: 30

  関係タイプのオブジェクト・タイプ。
• RelationshipType: string
  タイトル: Relationship Type

  読取り専用: true

  最大長: 30

  関係タイプの名前(CUSTOMER_SUPPLIERなど)。
• RelationshipTypeId: integer (int64)
  読取り専用: true

  関係タイプの一意の識別子。
• Role: string
  読取り専用: true

  最大長: 30

  関係タイプおよびフレーズに基づく一意の関係ロール参照コード。 HZ_RELATIONSHIP_ROLE参照タイプの意味は複数ロールで、説明は単数ロールです。
• SetId: integer (int64)
  読取り専用: true

  セットの一意の識別子、値0。
• SourceLang: string
  読取り専用: true

  最大長: 4

  関係ロールのソース言語。
• StartDateActive: 文字列(日付)
  読取り専用: true

  関係ロールが開始する日付。
• Status: string
  読取り専用: true

  最大長: 1

  関係タイプが非アクティブかアクティブかを示し、I(非アクティブ)、A(アクティブ)などの値があります。
• SubjectType: string
  タイトル: Subject Type

  読取り専用: true

  最大長: 30

  関係タイプのサブジェクト・タイプ。 この属性は一時フィールドであるため、ファインダとして使用できません。 この属性をファインダとして使用すると、レスポンスはエラーを返します。
• Tag: string
  読取り専用: true

  最大長: 150

  関係のロール・タグ。
• TerritoryCode: string
  読取り専用: true

  最大長: 2

  関係ロールのテリトリ・コード。
• ViewApplicationId: integer (int64)
  読取り専用: true

  関係ロール参照コードのビュー・アプリケーションの一意の識別子。

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the relationship type is inactive or active with values like I for Inactive, A for Active.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowCircularRelationships":{
            "title":"Circular",
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the circular relationships are allowed using  this relationship type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ViewApplicationId":{
            "type":"integer",
            "description":"The unique identifier of the view application of the relationship role lookup code.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the relationship role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipTypeId":{
            "type":"integer",
            "description":"The unique identifier of the relationship type.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LookupType":{
            "maxLength":30,
            "type":"string",
            "description":"The role lookup code HZ_RELATIONSHIP_ROLE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"The source language of the relationship role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipType":{
            "title":"Relationship Type",
            "maxLength":30,
            "type":"string",
            "description":"The name of the relationship type like CUSTOMER_SUPPLIER.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BackwardRelationshipCode":{
            "maxLength":30,
            "type":"string",
            "description":"The backward relationship code used to describe relationships like SUPPLIER_OF.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DirectionCode":{
            "maxLength":30,
            "type":"string",
            "description":"The direction code validated by DIRECTION_CODE lookup type. P for Parent, C for Child, and N for Not Directional.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupCode":{
            "maxLength":30,
            "type":"string",
            "description":"The relationship role code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Role":{
            "maxLength":30,
            "type":"string",
            "description":"The unique relationship role lookup code based on relationship type and phrase. In the HZ_RELATIONSHIP_ROLE lookup type meaning is the plural role and description is the singular role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectType":{
            "title":"Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The object type of the relationship type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "type":"string",
            "description":"The date when the relationship role starts.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "type":"string",
            "description":"The date when the relationship role ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubjectType":{
            "title":"Subject Type",
            "maxLength":30,
            "type":"string",
            "description":"The subject type of the relationship type. You can't use this attribute as a finder, because this is a transient field. The response will return an error if you use this attribute as a finder.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":30,
            "type":"string",
            "description":"The relationship role lookup language.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TerritoryCode":{
            "maxLength":2,
            "type":"string",
            "description":"The territory code of the relationship role.",
            "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"
            }
        },
        "Tag":{
            "maxLength":150,
            "type":"string",
            "description":"The role tag of the relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedByModule":{
            "maxLength":150,
            "type":"string",
            "description":"The application module that created the record. It is defaulted to value HZ_WS for all web service based creation. A list of valid certification level codes is defined in the lookup HZ_CREATED_BY_MODULES. Review and update the codes using the Setup and Maintenance task, Manage Trading Community Common Lookups.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SetId":{
            "type":"integer",
            "description":"The unique identifier of the set, value 0.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ForwardRelationshipCode":{
            "maxLength":30,
            "type":"string",
            "description":"The forward relationship code used to describe relationships like CUSTOMER_OF.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Meaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the relationship role.",
            "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."
        }
    }
}

「トップに戻る」