機械翻訳について

ジャンプ先

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

すべての構造階層の取得

get

/crmRestApi/resources/11.13.18.05/structureHierarchies

リクエスト

問合せパラメータ

• 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
• finder: string
  コレクションを検索するための事前定義済ファインダとして使用されます。
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  使用可能なファインダ名および対応するファインダ変数を次に示します
  
  

  • PrimaryKey指定した主キーを持つ構造階層ルートを検索 - サポートされていません。
    ファインダ変数
    • Id; integer;構造階層ルートの一意の識別子。
  • getStructureHierarchy指定されたルート・アイテムから始まる構造階層を検索します。
    ファインダ変数
    • Bind_HierarchyLevel; number;階層内のレベル数を表示するために使用されるファインダ。
    • Bind_Id; string;
    • Bind_OrgId; string; ルート・アイテムの組織識別子の一意の識別子。
• limit: integer
  このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• offset: integer
  リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
• onlyData: boolean
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
• orderBy: string
  このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
• q: string
  この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
  
  フォーマット : ?q=expression1;expression2
  
  次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
  

  • HierarchyLevel; number;階層のレベル。
  • Id; integer;構造体またはコンポーネントの識別子。 親識別子がNULLの場合、これは構造識別子になります。
  • ItemDescription; string; 構造またはコンポーネントのアイテムの説明。 親識別子がNULLの場合、これは構成品目摘要になります。
  • ItemId; integer; 構造またはコンポーネントのアイテム識別子。 親識別子がNULLの場合、これは構成品目識別子になります。
  • ItemName; string;構造またはコンポーネントの項目名。 親識別子がNULLの場合、これは構成品目名になります。
  • ItemNumber; string;構造またはコンポーネントの項目番号。 親識別子がNULLの場合、これは構成品目番号になります。
  • ItemSequenceNumber; number;コンポーネント順序番号。
  • OrgId; integer; 構造またはコンポーネントの組織識別子。 親識別子がNULLの場合、これは構造組織識別子です。
  • ParentId; number;親の一意の識別子。
  • ParentItemId; number;親アイテムの一意の識別子。
• totalResults: boolean
  "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。

ヘッダー・パラメータ

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

本文( )

ルート・スキーマ : structureHierarchies

タイプ: object

ソースを表示

• count(required): integer
  現在の範囲で返されたリソース・インスタンスの数。
• hasMore(required): boolean
  サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
• items: array Items
  タイトル: Items

  コレクション内のアイテム。
• limit(required): integer
  サーバーで使用される実際のページング・サイズ。
• links(required): array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• offset(required): integer
  現在のページで使用されるオフセット値。
• totalResults: integer
  "?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/structureHierarchies-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

• Array of: object structureHierarchies-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/structureHierarchies-item-response"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : structureHierarchies-item-response

タイプ: object

ソースを表示

• HierarchyLevel: number
  タイトル: Hierarchy Level

  読取り専用: true

  階層のレベル。
• Id: integer (int64)
  タイトル: ID

  読取り専用: true

  構成またはコンポーネントの識別子。 親識別子がNULLの場合、これは構造識別子になります。
• ItemDescription: string
  タイトル: Description

  読取り専用: true

  最大長: 4000

  構成またはコンポーネントの品目摘要。 親識別子がNULLの場合、これは構成品目摘要になります。
• ItemId: integer (int64)
  タイトル: Inventory Item ID

  読取り専用: true

  構成またはコンポーネントの品目識別子。 親識別子がNULLの場合、これは構成品目識別子になります。
• ItemName: string
  タイトル: Name

  読取り専用: true

  最大長: 255

  構成またはコンポーネントの品目名。 親識別子がNULLの場合、これは構成品目名になります。
• ItemNumber: string
  タイトル: Product Number

  読取り専用: true

  最大長: 300

  構成またはコンポーネントの品目番号。 親識別子がNULLの場合、これは構成品目番号になります。
• ItemSequenceNumber: number
  タイトル: Item Sequence

  読取り専用: true

  コンポーネント連番。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• OrgId: integer (int64)
  タイトル: Organization ID

  読取り専用: true

  構成またはコンポーネントの組織識別子。 親識別子がNULLの場合、これは構造組織識別子です。
• ParentId: number
  タイトル: Parent ID

  読取り専用: true

  親の一意の識別子。
• ParentItemId: number
  タイトル: Parent Inventory Item ID

  読取り専用: true

  親アイテムの一意の識別子。

{
    "type":"object",
    "properties":{
        "ParentId":{
            "title":"Parent ID",
            "type":"number",
            "description":"The unique identifier of the parent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemSequenceNumber":{
            "title":"Item Sequence",
            "type":"number",
            "description":"The component sequence number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"The organization identifier of the structure or component. If parent identifier is null, this is the structure organization identifier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HierarchyLevel":{
            "title":"Hierarchy Level",
            "type":"number",
            "description":"The level of the hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Product Number",
            "maxLength":300,
            "type":"string",
            "description":"The item number of the structure or component. If parent identifier is null, this will be the structure item number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemName":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"The item name of the structure or component. If parent identifier is null, this will be the structure item name.",
            "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"
            }
        },
        "Id":{
            "title":"ID",
            "type":"integer",
            "description":"The identifier of a structure or component. If parent identifier is null, this will be the structure identifier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Description",
            "maxLength":4000,
            "type":"string",
            "description":"The item description of the structure or component. If parent identifier is null, this will be the structure item description.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The item identifier of the structure or component. If parent identifier is null, this will be the structure item identifier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentItemId":{
            "title":"Parent Inventory Item ID",
            "type":"number",
            "description":"The unique identifier of the parent item.",
            "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."
        }
    }
}

「トップに戻る」