ジャンプ先

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

すべてのシステム・プロパティの検索

get

/iam/governance/adminservice/api/v1/systemconfiguration/

URLパラメータとしてプロパティ名を指定して、すべてのシステム・プロパティを取得します。ソートとページ区切りがサポートされています。

リクエスト

問合せパラメータ

• limit: integer(int32)
  startindexから返されるシステム・プロパティの数。
• offset: integer(int32)
  結果を返す際のページ区切りの開始索引
• orderBy: string
  ソートを実行する必要がある属性(コロンとソート順序が後に続きます)。
• property: string
  検索する必要があるプロパティ名。

先頭に戻る

レスポンス

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

• application/json

200レスポンス

操作に成功しました。

本文()

ルート・スキーマ: schema

型: array

ソースを表示

• 配列: object SystemProperty

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

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

型: object

ソースを表示

• id: string
  システム・プロパティのID。
• ptyDataLevel: string
  システム・プロパティのプロパティ・データ・レベル。
• ptyKeyword: string
  システム・プロパティのキーワード。
• ptyName: string
  システム・プロパティの名前。
• ptyValue: string
  システム・プロパティの値。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of system property."
        },
        "ptyKeyword":{
            "type":"string",
            "description":"Keyword of system property."
        },
        "ptyValue":{
            "type":"string",
            "description":"Value of system property."
        },
        "ptyName":{
            "type":"string",
            "description":"Name of system property."
        },
        "ptyDataLevel":{
            "type":"string",
            "description":"Property data level of system property."
        }
    }
}

400レスポンス

入力が無効です。

先頭に戻る

例

次の例は、cURLを使用したGETリクエストの発行でプロパティ名をURLパラメータとして指定することにより、すべてのシステム・プロパティを取得する方法を示しています。ソートとページ区切りがサポートされています。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

cURLの例

curl -i -X GET -u username:password \
--header 'Content-Type: application/json' \
'http://pseudo.com/iam/governance/adminservice/api/v1/systemconfiguration'

レスポンス本文の例

次の例は、すべてのシステム・プロパティを取得するリクエストに対するJSONレスポンスを示しています:

{
   "links":[
      {
         "rel":"self",
         "href":"http://pseudo.com/iam/governance/adminservice/api/v1/systemconfiguration?offset=1&limit=10"
      },
      {
         "rel":"first",
         "href":"http://pseudo.com/iam/governance/adminservice/api/v1/systemconfiguration?offset=1&limit=10"
      },
      {
         "rel":"next",
         "href":"http://pseudo.com/iam/governance/adminservice/api/v1/systemconfiguration?offset=11&limit=10"
      }
   ],
   "count":10,
   "hasMore":true,
   "totalResult":162,
   "offset":1,
   "limit":10,
   "systemPropertyTOS":[
      {
         "id":"118",
         "ptyKeyword":"demoKey2",
         "ptyValue":"2",
         "ptyName":"demoName2",
         "ptyDataLevel":"2"
      },
      {
         "id":"117",
         "ptyKeyword":"demoKey2",
         "ptyValue":"true",
         "ptyName":"demoName2",
         "ptyDataLevel":"2"
      },
      {
         "id":"53",
         "ptyKeyword":"demoKey2",
         "ptyValue":"FALSE",
         "ptyName":"demoName2",
         "ptyDataLevel":"2"
      },
      {
         "id":"116",
         "ptyKeyword":"demoKey2",
         "ptyValue":"-1",
         "ptyName":"demoName2",
         "ptyDataLevel":"2"
      },
      {
         "id":"96",
         "ptyKeyword":"demoKey2",
         "ptyValue":"[^\\w]",
         "ptyName":"demoName2",
         "ptyDataLevel":"2"
      },
      {
         "id":"55",
         "ptyKeyword":"demoKey2",
         "ptyValue":"demoValue2",
         "ptyName":"demoName2",
         "ptyDataLevel":"2"
      },
      {
         "id":"54",
         "ptyKeyword":"demoKey2",
         "ptyValue":"demoValue2",
         "ptyName":"demoName2",
         "ptyDataLevel":"2"
      },
      {
         "id":"52",
         "ptyKeyword":"demoKey2",
         "ptyValue":"demoValue2",
         "ptyName":"demoName2",
         "ptyDataLevel":"2"
      },
      {
         "id":"56",
         "ptyKeyword":"demoKey2",
         "ptyValue":"15",
         "ptyName":"demoName2",
         "ptyDataLevel":"2"
      },
      {
         "id":"153",
         "ptyKeyword":"demoKey2",
         "ptyValue":"demoValue2",
         "ptyName":"demoName2",
         "ptyDataLevel":"2"
      }
   ]
}

先頭に戻る