機械翻訳について

ジャンプ先

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

分類コードの取得

get

/crmRestApi/resources/11.13.18.05/classCodes/{classCodesUniqID}

リクエスト

パス・パラメータ

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

問合せパラメータ

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

本文( )

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

タイプ: object

ソースを表示

• ChildCount: integer (int64)
  タイトル: Child Count

  親の子カウント。
• ClassCategory: string
  タイトル: Classification Category

  読取り専用: true

  最大長: 30

  区分カテゴリ。
• ClassCategoryDescription: string
  タイトル: Classification Category Description

  読取り専用: true

  最大長: 240

  区分カテゴリの摘要。
• ClassCategoryGroup: string
  読取り専用: true

  最大長: 255

  区分カテゴリ・グループ。
• ClassCode: string
  タイトル: Classification Code

  読取り専用: true

  最大長: 30

  クラス・コード。
• ClassCodeDescription: string
  タイトル: Classification Code Description

  読取り専用: true

  最大長: 240

  クラス・コードの摘要。
• ClassCodeMeaning: string
  タイトル: Classification Code Meaning

  読取り専用: true

  最大長: 80

  クラス・コードの意味。
• CreatedBy: string
  読取り専用: true

  最大長: 64

  行を作成したユーザー。
• CreationDate: string (date-time)
  読取り専用: true

  行が作成された日時。
• DataSourceId: string
  タイトル: Data Source ID

  最大長: 32

  データ・ソースの一意の識別子。
• Depth: integer (int64)
  階層ツリーの深さレベル。
• LastUpdateDate: string (date-time)
  読取り専用: true

  行が最後に更新された日時。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  行を最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  行を最後に更新したユーザーのログイン詳細。
• links: array Links
  タイトル: Links

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

  最大長: 30

  コードの参照タイプ。
• Meaning: string
  タイトル: Classification Category Meaning

  読取り専用: true

  最大長: 80

  クラス・カテゴリの意味。
• ParentDataSourceId: string
  タイトル: Parent Data Source ID

  最大長: 32

  親データ・ソースの一意の識別子。
• ParentPk1Value: string
  タイトル: Parent Primary Key 1 Value

  最大長: 100

  親区分カテゴリ。
• ParentPk2Value: string
  タイトル: Parent Primary Key 2 Value

  最大長: 100

  親クラス・コード。
• ParentPk3Value: string
  タイトル: Parent Primary Key 3 Value

  最大長: 100

  親ビュー・アプリケーションの結合解除識別子。
• ParentPk4Value: string
  タイトル: Parent Primary Key 4 Value

  最大長: 100

  該当なし
• ParentPk5Value: string
  タイトル: Parent Primary Key 5 Value

  最大長: 100

  該当なし
• ParentTreeLabelId: string
  タイトル: Parent Tree Label ID

  最大長: 32

  該当なし
• ParentTreeNodeId: string
  タイトル: Parent Tree Node ID

  最大長: 32

  親ツリー・ノードの一意の識別子。
• Pk1EndValue: string
  タイトル: Primary Key 1 End

  最大長: 100

  該当なし
• Pk1StartValue: string
  タイトル: Classification Category

  最大長: 100

  区分カテゴリ。
• Pk2EndValue: string
  タイトル: Primary Key 2 End

  最大長: 100

  該当なし
• Pk2StartValue: string
  タイトル: Classification Code

  最大長: 100

  クラス・コード。
• Pk3EndValue: string
  タイトル: Primary Key 3 End

  最大長: 100

  該当なし
• Pk3StartValue: string
  タイトル: Primary Key 3 Start

  最大長: 100

  ビュー・アプリケーションの一意の識別子。
• Pk4EndValue: string
  タイトル: Primary Key 4 End

  最大長: 100

  該当なし
• Pk4StartValue: string
  タイトル: Primary Key 4 Start

  最大長: 100

  該当なし
• Pk5EndValue: string
  タイトル: Primary Key 5 End

  最大長: 100

  該当なし
• Pk5StartValue: string
  タイトル: Primary Key 5 Start

  最大長: 100

  該当なし
• ReferenceTreeCode: string
  タイトル: Reference Tree Code

  最大長: 30

  該当なし
• ReferenceTreeVersionId: string
  タイトル: Reference Tree Version ID

  最大長: 32

  該当なし
• SortOrder: integer (int64)
  タイトル: Sort Order

  ソート順
• TreeCode: string
  タイトル: Classification Category

  最大長: 30

  ツリー・コード。
• TreeLabelId: string
  タイトル: Tree Label ID

  最大長: 32

  該当なし
• TreeNodeId: string
  タイトル: Tree Node ID

  最大長: 32

  ツリー・ノードの一意の識別子。
• TreeStructureCode: string
  タイトル: Tree Structure Code

  最大長: 30

  ツリー・コードの構造。
• TreeVersionId: string
  タイトル: Tree Version ID

  最大長: 32

  ツリー・バージョンの一意の識別子。
• ViewApplicationId: integer (int64)
  読取り専用: true

  ビュー・アプリケーションの一意の識別子。

{
    "type":"object",
    "properties":{
        "Pk3StartValue":{
            "title":"Primary Key 3 Start",
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of view application.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassCodeMeaning":{
            "title":"Classification Code Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the class code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassCodeDescription":{
            "title":"Classification Code Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the class code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentPk3Value":{
            "title":"Parent Primary Key 3 Value",
            "maxLength":100,
            "type":"string",
            "description":"The untie identifier of the parent view application.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassCategoryDescription":{
            "title":"Classification Category Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the class category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassCategory":{
            "title":"Classification Category",
            "maxLength":30,
            "type":"string",
            "description":"The class category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Depth":{
            "type":"integer",
            "description":"The depth level in the hierarchy tree.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Pk4EndValue":{
            "title":"Primary Key 4 End",
            "maxLength":100,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "TreeVersionId":{
            "title":"Tree Version ID",
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the tree version.",
            "nullable":false,
            "x-queryable":true
        },
        "Pk3EndValue":{
            "title":"Primary Key 3 End",
            "maxLength":100,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "Pk5StartValue":{
            "title":"Primary Key 5 Start",
            "maxLength":100,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceTreeCode":{
            "title":"Reference Tree Code",
            "maxLength":30,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "TreeLabelId":{
            "title":"Tree Label ID",
            "maxLength":32,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "Pk2EndValue":{
            "title":"Primary Key 2 End",
            "maxLength":100,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParentPk4Value":{
            "title":"Parent Primary Key 4 Value",
            "maxLength":100,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "Pk1EndValue":{
            "title":"Primary Key 1 End",
            "maxLength":100,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentPk1Value":{
            "title":"Parent Primary Key 1 Value",
            "maxLength":100,
            "type":"string",
            "description":"The parent class category.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentTreeLabelId":{
            "title":"Parent Tree Label ID",
            "maxLength":32,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentTreeNodeId":{
            "title":"Parent Tree Node ID",
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the parent tree node.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ViewApplicationId":{
            "type":"integer",
            "description":"The unique identifier of view application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LookupType":{
            "maxLength":30,
            "type":"string",
            "description":"The lookup type of the code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Pk4StartValue":{
            "title":"Primary Key 4 Start",
            "maxLength":100,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "Pk2StartValue":{
            "title":"Classification Code",
            "maxLength":100,
            "type":"string",
            "description":"The class code.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassCategoryGroup":{
            "maxLength":255,
            "type":"string",
            "description":"The class category group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentDataSourceId":{
            "title":"Parent Data Source ID",
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the parent data source.",
            "nullable":true,
            "x-queryable":true
        },
        "SortOrder":{
            "title":"Sort Order",
            "type":"integer",
            "description":"The sort order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReferenceTreeVersionId":{
            "title":"Reference Tree Version ID",
            "maxLength":32,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentPk5Value":{
            "title":"Parent Primary Key 5 Value",
            "maxLength":100,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "Pk5EndValue":{
            "title":"Primary Key 5 End",
            "maxLength":100,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "ClassCode":{
            "title":"Classification Code",
            "maxLength":30,
            "type":"string",
            "description":"The class code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentPk2Value":{
            "title":"Parent Primary Key 2 Value",
            "maxLength":100,
            "type":"string",
            "description":"The parent class code.",
            "nullable":true,
            "x-queryable":true
        },
        "TreeStructureCode":{
            "title":"Tree Structure Code",
            "maxLength":30,
            "type":"string",
            "description":"The structure of the tree code.",
            "nullable":false,
            "x-queryable":true
        },
        "ChildCount":{
            "title":"Child Count",
            "type":"integer",
            "description":"The child count of the parent.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TreeNodeId":{
            "title":"Tree Node ID",
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the tree node.",
            "nullable":false,
            "x-queryable":true
        },
        "TreeCode":{
            "title":"Classification Category",
            "maxLength":30,
            "type":"string",
            "description":"The tree code.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Pk1StartValue":{
            "title":"Classification Category",
            "maxLength":100,
            "type":"string",
            "description":"The class category.",
            "nullable":true,
            "x-queryable":true
        },
        "Meaning":{
            "title":"Classification Category Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the class category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSourceId":{
            "title":"Data Source ID",
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the data source.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the row.",
            "nullable":true,
            "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."
        }
    }
}

「トップに戻る」