ケースの取得

get

/cases

ケースを取得します。

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

リクエスト

問合せパラメータ

limit

タイプ: integer

ページ当たりの項目の最大数。1から100を設定します。デフォルトは25です。

offset

タイプ: integer

リスト項目のページにある最初の項目の索引。デフォルトは1です。

レスポンス

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

• application/json
• application/xml

200 レスポンス

成功

本文

ルート・スキーマ: /paths/~1cases/get/responses/200/schema

application/jsonの例

{
    "type":"cases",
    "levels":3,
    "links":[
        {
            "rel":"self",
            "href":"http://example.com/bpm/api/3.0/cases/?limit=25&offset=0"
        }
    ],
    "title":"Case List",
    "casecount":0,
    "cases":[
        {
            "rel":"case instance",
            "title":"Car rental for Jim Mitch",
            "href":"http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c",
            "createdDate":"2015-06-05 17:42:50",
            "state":"ACTIVE"
        },
        {
            "rel":"case instance",
            "title":"Car rental for Jim Mitch",
            "href":"http://example.com/bpm/api/3.0/cases/c7c55f2c-33f7-4366-916e-748f6314615e",
            "createdDate":"2015-06-05 17:42:45",
            "state":"ACTIVE"
        }
    ]
}

例

次の例に、ケース・リストを取得する場合のレスポンス本文を示します。

{
			"type" : "cases",
			"levels" : 3,
			"links" : [{
					"rel" : "self",
					"href" : "http://example.com/bpm/api/3.0/cases/?limit=25&offset=0"
				}
			],
			"title" : "Case List",
			"casecount" : 0,
			"cases" : [{
					"rel" : "case instance",
					"title" : "Car rental for Jim Mitch",
					"href" : "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c",
					"createdDate" : "2015-06-05 17:42:50",
					"state" : "ACTIVE"
				}, {
					"rel" : "case instance",
					"title" : "Car rental for Jim Mitch",
					"href" : "http://example.com/bpm/api/3.0/cases/c7c55f2c-33f7-4366-916e-748f6314615e",
					"createdDate" : "2015-06-05 17:42:45",
					"state" : "ACTIVE"
				}
			]
		}

cURLの詳細は、「cURLの使用」を参照してください