snapshots.settings.library

Get driver, workflow, and CSAT libraries with selections for each branch.

Facts

Arguments

Each section contains library definitions and selections with enabled IDs, names, and prompts. branch_id is null when branching is disabled; CSAT groups is null when grouping is disabled.

See workflow definitions and CSAT definitions for populated examples. Only custom drivers and workflows can be updated.

Example request

curl -X GET https://api.getdx.com/snapshots.settings.library \
  -H 'Authorization: Bearer xxxx-xxxxxxxxx-xxxx'

Example response

{
  "ok": true,
  "drivers": {
    "library": [
      {
        "id": "NTIxNDc",
        "name": "Toolchain efficiency",
        "prompt": "My tools help me work efficiently.",
        "ranking_item": "Improve tools",
        "target_role": "all",
        "custom": true,
        "scale_points": 5,
        "translations": {}
      }
    ],
    "selections": [
      {
        "branch_id": "NTIxMDA",
        "drivers": [
          {
            "id": "NTIxNDc",
            "name": "Toolchain efficiency",
            "prompt": "My tools help me work efficiently."
          }
        ],
        "minimum_drivers": 1,
        "maximum_drivers": 20
      }
    ]
  },
  "workflows": {
    "library": [],
    "selections": [
      {
        "branch_id": "NTIxMDA",
        "workflows": []
      }
    ]
  },
  "csat": {
    "library": [],
    "selections": [
      {
        "branch_id": "NTIxMDA",
        "csat": []
      }
    ],
    "groups": null
  }
}

Errors

not_authed or not_authorized for missing authentication or access. Unsupported arguments return 422 validation_error.