データ分類 API

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：13分

    • データ分類 API は、データをタイプ別にグループ化するためのエンドポイントを提供します。

    データ分類 API を使用すると、次のことができます。
    • 既存の辞書エントリにデータ分類を割り当てます。
    • 特定の辞書エントリのデータ分類を検索します。
    • 特定の辞書エントリに関連付けられているすべてのデータ分類を削除します。
    • 現在のドメインで利用可能なすべてのデータ分類のリストを取得します。

    この API には、データ分類 [com.glide.data_classification] プラグインが必要です。

    詳細については、「 データ分類」を参照してください。

    データ分類 - GET /data_classification/getAllDataClasses

    現在のドメインで利用可能なすべてのデータ分類のリストを返します。

    admin、data_classification_admin、または data_classification_auditor ロールが必要です。

    URL 形式

    デフォルトの URL：/api/now/data_classification/getAllDataClasses

    サポートされている要求パラメーター

    表 : 1. パスパラメーター
    名前 説明
    なし
    表 : 2. クエリパラメータ
    名前 説明
    なし
    表 : 3. 要求本文パラメーター (XML または JSON)
    名前 説明
    なし

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 4. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 5. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 6. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    result

    要求の結果です。利用可能な各データ分類の sys_id と名前を返します。データ分類がない場合は、空のアレイを返します。

    データ分類は親子関係に整理できます。親データ分類がある場合は、それらが結果で識別されます。

    データタイプ：アレイ

    "result": [
  {
    "parent": {Object},
    "sys_id": "String",
    "name": "String"
  }
]
    result.parent 親データ分類のエントリです。

    データタイプ：オブジェクト

    "parent": {
  "sys_id": "String",
  "name": "String"
}
    result.parent.sys_id データ分類 [data_classification] テーブルからの親データ分類の sys_id です。

    データタイプ：文字列
    result.parent.name 親データ分類の名前です。

    データタイプ：文字列
    result.sys_id データ分類 [data_classification] テーブルからのデータ分類の sys_id です。

    データタイプ：文字列
    result.name データ分類名。

    データタイプ：文字列

    cURL 要求

    利用可能なすべてのデータ分類のリストを取得します。

    curl "https://instance.servicenow.com/api/now/data_classification/getAllDataClasses" \
--request GET \
--header "Accept:application/json" \
--user 'username':'password'
    {
  "result": [
    {
      "parent": {
        "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",
        "name": "Confidential"
      },
      "sys_id": "348107b951d71010f877f3f178e7dd0d",
      "name": "Personally identifiable information"
    },
    {
      "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",
      "name": "Confidential"
    },
    {
      "sys_id": "59b7070b73fc1010ae8dd21efaf6a764",
      "name": "Restricted"
    },
    {
      "sys_id": "11d60fc773fc1010ae8dd21efaf6a744",
      "name": "Internal"
    },
    {
      "sys_id": "f5b4cf4773fc1010ae8dd21efaf6a766",
      "name": "Public"
    }
  ]
}

    データ分類 - POST /data_classification/classify

    既存の辞書エントリに事前定義済みまたはユーザー定義のデータ分類を割り当てます。

    admin または data_classification_admin ロールが必要です。

    URL 形式

    デフォルトの URL：/api/now/data_classification/classify

    サポートされている要求パラメーター

    表 : 7. パスパラメーター
    名前 説明
    なし
    表 : 8. クエリパラメータ
    名前 説明
    なし
    表 : 9. 要求本文パラメーター (XML または JSON)
    名前 説明
    dictionary_entries 必須です。 分類するレコードの sys_id。sys_id はディクショナリ [sys_dictionary] テーブルからのものです。文字列で囲まれたカンマ区切りリストとして入力します。

    データタイプ：文字列
    data_classes 必須です。 割り当てるデータ分類の sys_id。sys_id は、データ分類 [data_classification] テーブルからのものです。文字列で囲まれたカンマ区切りリストとして入力します。

    データタイプ：文字列

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 10. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 11. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 12. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    result 操作の結果を説明するメッセージ。

    データタイプ：文字列

    cURL 要求

    辞書エントリにデータ分類を割り当てます。

    curl "https://instance.servicenow.com/api/now/data_classification/classify" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"dictionary_entries\": \"445de0a6dba30300efc57416bf9619b0\",
    \"data_classes\": \"40edb1f51bbcec50b92a10a61a4bcb8a\"
}" \
--user 'username':'password'

    {
  "result": "Successfully stored the data classification configurations"
}

    データ分類 - POST /data_classification/clear

    指定された辞書エントリのすべてのデータ分類を削除します。

    admin または data_classification_admin ロールが必要です。

    URL 形式

    デフォルトの URL：/api/now/data_classification/clear

    サポートされている要求パラメーター

    表 : 13. パスパラメーター
    名前 説明
    なし
    表 : 14. クエリパラメータ
    名前 説明
    なし
    表 : 15. 要求本文パラメーター (XML または JSON)
    名前 説明
    dictionary_entries 必須です。 分類を削除するレコードの sys_id。sys_id はディクショナリ [sys_dictionary] テーブルからのものです。文字列で囲まれたカンマ区切りリストとして入力します。

    データタイプ：文字列

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 16. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 17. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 18. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    result 操作の結果を説明するメッセージ。

    データタイプ：文字列

    cURL 要求

    辞書エントリのデータ分類をクリアします。

    curl "https://instance.servicenow.com/api/now/data_classification/clear" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"dictionary_entries\": \"445de0a6dba30300efc57416bf9619b0\"
}" \
--user 'username':'password'

    {
  "result": "Classifications removed for the specified dictionary entries"
}

    データ分類 - POST /data_classification/getClassification

    指定された辞書エントリのすべてのデータ分類を取得します。

    admin、data_classification_admin、または data_classification_auditor ロールが必要です。

    URL 形式

    デフォルトの URL：/api/now/data_classification/getClassification

    サポートされている要求パラメーター

    表 : 19. パスパラメーター
    名前 説明
    なし
    表 : 20. クエリパラメータ
    名前 説明
    なし
    表 : 21. 要求本文パラメーター (XML または JSON)
    名前 説明
    dictionary_entries 必須です。 分類を取得するレコードの sys_id。sys_id はディクショナリ [sys_dictionary] テーブルからのものです。文字列で囲まれたカンマ区切りリストとして入力します。

    データタイプ：文字列

    ヘッダー

    次のリクエストや応答ヘッダーは、この HTTP アクションにのみ適用されるか、またはこのアクションに別個の方法で適用されます。REST API で使用される一般的なヘッダーのリストについては、「 サポートされている REST API ヘッダー」を参照してください。

    表 : 22. 要求ヘッダー
    ヘッダー 説明
    承認 応答本文のデータフォーマット。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    Content-Type 要求本文のデータ形式。サポートされるタイプ：application/json または application/xml。

    デフォルト： application/json
    表 : 23. 応答ヘッダー
    ヘッダー 説明
    なし

    ステータスコード

    この HTTP アクションには、次のステータスコードが適用されます。REST API で使用される可能性のあるステータスコードのリストについては、「 REST API HTTP 応答コード」を参照してください。

    表 : 24. ステータスコード
    ステータスコード 説明
    200 成功。要求が正常に処理されました。
    500 内部サーバーエラー。要求の処理中に予期しないエラーが発生しました。応答に、エラーに関する追加情報が含まれます。

    応答本文のパラメーター (JSON または XML)

    名前 説明
    result

    要求の結果です。各辞書エントリの sys_id とその関連データ分類のアレイを含む JSON オブジェクトを返します。関連するデータ分類がない場合は、操作の結果を記述するメッセージを返します。

    データ分類は親子関係に整理できます。親データ分類がある場合は、それらが結果で識別されます。

    データタイプ：オブジェクト

    "result": {
  <sys_dictionary_sys_id>: [
    {
      "parent": {Object},
      "sys_id": "String",
      "name": "String"
    }
  ]
}
    result.name データ分類名。

    データタイプ：文字列
    result.parent 親データ分類のエントリです。

    データタイプ：オブジェクト

    "parent": {
  "sys_id": "String",
  "name": "String"
}
    result.parent.name 親データ分類の名前です。

    データタイプ：文字列
    result.parent.sys_id データ分類 [data_classification] テーブルからの親データ分類の sys_id です。

    データタイプ：文字列
    result.sys_id データ分類 [data_classification] テーブルからのデータ分類の sys_id です。

    データタイプ：文字列

    cURL 要求

    特定の辞書エントリに関連付けられているデータ分類を取得します。

    curl "https://instance.servicenow.com/api/now/data_classification/getClassification" \
--request POST \
--header "Accept:application/json" \
--header "Content-Type:application/json" \
--data "{
    \"dictionary_entries\": \"445de0a6dba30300efc57416bf9619b0\"
}" \
--user 'username':'password'

    {
  "result": {
    "445de0a6dba30300efc57416bf9619b0": [
      {
        "parent": {
          "sys_id": "a9670fc773fc1010ae8dd21efaf6a735",
          "name": "Confidential"
        },
        "sys_id": "348107b951d71010f877f3f178e7dd0d",
        "name": "Personally identifiable information"
      }
    ]
  }
}