System View Reports

Get all Reports for a System View

Get all Reports resources for a System View.

GET /api/v2/system-view/{system_view_id}/reports/

Query Parameters

Fields Required Description
search No Filter search queries by name. 
GET /api/v2/system-view/1/reports/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "Sample Report 1",
            "description": "",
            "system_view": {
                "id": 1,
                "name": "View One"
            },
            "regulation": {
        "db_id": 1,
                "item_id": "REG1",
                "name": "Regulation One"
            },
            "created": "2025-04-16T14:59:37.971395-04:00",
            "created_by": 1,
            "modified": "2025-04-16T14:59:55.568031-04:00",
            "modified_by": 1
        },
        {
            "id": 2,
            "name": "Sample Report 2",
            "description": "",
            "system_view": {
                "id": 1,
                "name": "View One"
            },
            "regulation": {
        "db_id": 11,
                "item_id": "REG11",
                "name": "Regulation Eleven"
            },
            "created": "2025-04-16T15:03:04.256405-04:00",
            "created_by": 1,
            "modified": "2025-04-16T15:03:36.926868-04:00",
            "modified_by": 1
        }
    ]
}

Expand Parameters

See the Expand Parameters section for more details.

Parameter Description
created_by created_by field is expanded. 
GET /api/v2/system-view/3/reports/?expand=created_by HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

{
  "count": 2,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "Sample Report 1",
      "description": "",
      "system_view": {
        "id": 3,
        "name": "View One"
      },
      "regulation": {
        "db_id": 2,
        "item_id": "REG2",
        "name": "HIPAA"
      },
      "created": "2025-05-26T15:03:15.354990-04:00",
      "created_by": {
        "id": 1,
        "email": "admin@example.com",
        "first_name": "Admin",
        "last_name": "Testerton",
        "is_active": true,
        "role": {
          "id": "UR4",
          "name": "Administrator"
        }
      },
      "modified": "2025-05-26T15:03:15.355002-04:00",
      "modified_by": 1
    },
    {
      "id": 2,
      "name": "Sample Report 2",
      "description": "",
      "system_view": {
        "id": 3,
        "name": "View One"
      },
      "regulation": {
        "db_id": 2,
        "item_id": "REG2",
        "name": "HIPAA"
      },
      "created": "2025-05-26T15:03:43.625842-04:00",
      "created_by": {
        "id": 1,
        "email": "admin@example.com",
        "first_name": "Admin",
        "last_name": "Testerton",
        "is_active": true,
        "role": {
          "id": "UR4",
          "name": "Administrator"
        }
      },
      "modified": "2025-05-26T15:03:43.625853-04:00",
      "modified_by": 1
    }
  ]
}

Get a specific Report for a System View

Returns a single System View Report resource for a System View, as specified by the URL parameter.

GET /api/v2/system-view/{system_view_id}/reports/{system_view_report_id}/

URL Parameters

Parameter Description
system_view_id The ID of an existing System View to be retrieved.
system_view_report_id The ID of an existing System View Report to be retrieved. 
GET /api/v2/system-view/1/reports/1/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json
{
    "id": 1,
    "name": "Sample Report 1",
    "description": "",
    "system_view": {
        "id": 1,
        "name": "View One"
    },
    "regulation": {
        "db_id": 1,
        "item_id": "REG1",
        "name": "Regulation One"
    },
    "created": "2025-04-16T14:59:37.971395-04:00",
    "created_by": 1,
    "modified": "2025-04-16T14:59:55.568031-04:00",
    "modified_by": 1
}

Expand Parameters

See the Expand Parameters section for more details.

Parameter Description
created_by created_by field is expanded. 
GET /api/v2/system-view/3/reports/1/?expand=created_by HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": 1,
  "name": "Sample Report 1",
  "description": "",
  "system_view": {
    "id": 3,
    "name": "View One"
  },
  "regulation": {
    "db_id": 2,
    "item_id": "REG2",
    "name": "HIPAA"
  },
  "created": "2025-05-26T15:03:15.354990-04:00",
  "created_by": {
    "id": 1,
    "email": "admin@example.com",
    "first_name": "Admin",
    "last_name": "Testerton",
    "is_active": true,
    "role": {
      "id": "UR4",
      "name": "Administrator"
    }
  },
  "modified": "2025-05-26T15:03:15.355002-04:00",
  "modified_by": 1
}

Create a System View Report

Creates a new System View Report resource for a given System View and Regulation.

POST /api/v2/system-view/{system_view_id}/reports/

Payload

Fields Required Description
name No The name of the System View Report.
regulation Yes The compliance regulation for the created the report
description No The description of the System View Report 
POST /api/v2/system-view/1/reports/
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

{
  "name": "GDPR Report",
  "regulation": 1
}

HTTP/1.1 201 Created
Content-Type: application/json

{
    "id": 1,
    "name": "GDPR Report",
    "description": "",
    "system_view": {
        "id": 1,
        "name": "View One"
    },
    "regulation": {
    "db_id": 1,
        "item_id": "REG1",
        "name": "Regulation One"
    },
    "created": "2025-04-21T15:26:24.480098-04:00",
    "created_by": 1,
    "modified": "2025-04-21T15:26:24.480110-04:00",
    "modified_by": 1
}

Payload Without Name

The name field is optional. If not provided, the system will generate a name for the report.

POST /api/v2/system-view/1/reports/
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

{
  "regulation": 1
}

HTTP/1.1 201 Created
Content-Type: application/json

{
    "id": 1,
    "name": "View One_Regulation One_Compliance Report",
    "description": "",
    "system_view": {
        "id": 1,
        "name": "View One"
    },
    "regulation": {
        "db_id": 1,
        "item_id": "REG1",
        "name": "Regulation One"
    },
    "created": "2025-04-21T15:26:24.480098-04:00",
    "created_by": 1,
    "modified": "2025-04-21T15:26:24.480110-04:00",
    "modified_by": 1
}

Update a System View Report for a System View

Update a single System View Report resource for a System View, as specified by the URL parameter.

PATCH /api/v2/system-view/{system_view_id}/reports/{system_view_report_id}/

URL Parameters

Parameter Description
system_view_id The ID of an existing System View to be retrieved.
system_view_report_id The ID of an existing System View Report to be retrieved.

Payload

Fields Required Description
name No The name of the System View Report.
description No The description of the System View Report. 
PATCH /api/v2/system-view/1/reports/1/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"
{
    "name": "Sample Report Name",
    "description": "Sample Report Description"
}

HTTP/1.1 200 OK
Content-Type: application/json
{
    "id": 1,
    "name": "Sample Report Name",
    "description": "Sample Report Description",
    "system_view": {
        "id": 1,
        "name": "View One"
    },
    "regulation": {
        "db_id": 1,
        "item_id": "REG1",
        "name": "Regulation One"
    },
    "created": "2025-04-16T14:59:37.971395-04:00",
    "created_by": 1,
    "modified": "2025-04-16T14:59:55.568031-04:00",
    "modified_by": 1
}

Delete a Sytem View Report

Deletes a Sytem View Report resource for a given system view.

DELETE /api/v2/system-view/{system_view_id}/reports/{system_view_report_id}/

URL Parameters

Parameter Description
system_view_id The ID of an existing System View.
system_view_report_id The ID of an existing Report for the associated System View. 
DELETE /api/v2/system-view/1/system-view-reports/1/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 204 NO CONTENT

results matching ""

    No results matching ""