ジャンプ先

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

すべてのRESTモジュールの数の取得

get

/ords/rest/overview/objects/modules_summary

公開済、未公開、完全保護、部分的に保護および一意に保護されたすべてのRESTモジュールを要約します。

リクエスト

問合せパラメータ

• limit(optional): integer(int32)
  戻すレコードの最大数。
• q(optional): string
  フィルタリングは、全コレクションで見つかった項目のサブセットが含まれている複数ページのリソース全体に対し、リクエストごとの動的フィルタ定義を使用してコレクション・リソースを制限する処理です。フィルタリングは、大規模なコレクションの効率的な走査を可能にします。

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/json

200 レスポンス

公開済、未公開、完全保護、部分的に保護および一意に保護されたすべてのRESTモジュールのサマリー。

本文 ()

ルート・スキーマ : ItemsCollection

タイプ: object

ソースの表示

• count(optional): integer
  現在のレスポンス内のレコードの合計数
• hasMore(optional): boolean
  取得するレコードがさらにあるかどうか
• items(optional): array items
• limit(optional): integer
  サーバーによって適用されるレコード数に関する実際のページ・サイズ制限
• links(optional): array links
• offset(optional): integer
  項目リソースの返戻元となる実際の索引

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResourceItem"
            }
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates if there are more records to be retrieved."
        },
        "limit":{
            "type":"integer",
            "description":"The actual page size limit on number of records applied by the server."
        },
        "offset":{
            "type":"integer",
            "description":"The actual index from which the item resources are returned."
        },
        "count":{
            "type":"integer",
            "description":"Total number of records in the current response."
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkRelation"
            }
        }
    }
}

ネストされたスキーマ: items

タイプ: array

ソースの表示

• 配列: オブジェクト ResourceItem
  使用可能なその他のプロパティ: true

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ResourceItem"
    }
}

ネストされたスキーマ: links

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkRelation"
    }
}

ネストされたスキーマ : ResourceItem

タイプ: object

使用可能なその他のプロパティ: true

ソースの表示

• links(optional): array links

{
    "type":"object",
    "additionalProperties":true,
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkRelation"
            }
        }
    }
}

ネストされたスキーマ: links

タイプ: array

ソースの表示

• 配列: オブジェクト LinkRelation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkRelation"
    }
}

ネストされたスキーマ: LinkRelation

タイプ: object

ソースの表示

• href: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "required":[
        "rel",
        "href"
    ]
}

先頭に戻る