System View

Get all System Views

Get all System View resources.

GET /api/v2/system-view/

Query Parameters

Fields Required Description
search No Filter search queries by name. 
GET /api/v2/system-view/ 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 Name 1",
            "description": "",
            "projects": [],
            "created": "2025-02-06T12:40:57.196015-05:00",
            "created_by": 1,
            "modified": "2025-02-06T12:40:57.196021-05:00",
            "modified_by": 1
        },
        {
            "id": 2,
            "name": "Sample Name 2",
            "description": "",
            "projects": [1, 2],
            "created": "2025-02-06T12:40:58.003904-05:00",
            "created_by": 1,
            "modified": "2025-02-06T12:40:58.003911-05:00",
            "modified_by": 1
        }
    ]
}

Expand Parameters

See the Expand Parameters section for more details.

Parameter Description
projects projects field is expanded.
created_by created_by field is expanded.
modified_by modified_by field is expanded. 
GET /api/v2/system-view/?expand=projects,created_by,modified_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 Name 1",
      "description": "",
      "projects": [],
      "created_by": {
        "id": 1,
        "email": "admin@example.com",
        "first_name": "Admin",
        "last_name": "Testerton",
        "is_active": true,
        "role": {
          "id": "UR4",
          "name": "Administrator"
        }
      },
      "modified": "2025-02-06T12:40:58.003911-05:00",
      "modified_by": {
        "id": 1,
        "email": "admin@example.com",
        "first_name": "Admin",
        "last_name": "Testerton",
        "is_active": true,
        "role": {
          "id": "UR4",
          "name": "Administrator"
        }
      }
    },
    {
      "id": 2,
      "name": "Sample Name 2",
      "description": "",
      "projects": [
        {
            "id": 1,
            "name": "Sample Project",
            "archived": false,
            "application": {
                "id": 1,
                "name": "Sample App"
            },
            "business_unit": {
                "id": 1,
                "name": "Sample BU"
            }
        },
        {
            "id": 2,
            "name": "Sample Project 2",
            "archived": true,
            "application": {
                "id": 2,
                "name": "Sample App 2"
            },
            "business_unit": {
                "id": 1,
                "name": "Sample BU"
            }
        }
      ],
      "created": "2025-02-06T12:40:58.003904-05: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-02-06T12:40:58.003911-05:00",
      "modified_by": {
        "id": 1,
        "email": "admin@example.com",
        "first_name": "Admin",
        "last_name": "Testerton",
        "is_active": true,
        "role": {
          "id": "UR4",
          "name": "Administrator"
        }
      }
    }
  ]
}

Get a specific System View

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

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

URL Parameters

Parameter Description
system_view_id The ID of an existing System View to be retrieved. 
GET /api/v2/system-view/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": "System View Name",
    "description": "",
    "projects": [],
    "created": "2025-02-06T12:40:57.196015-05:00",
    "created_by": 1,
    "modified": "2025-02-06T12:40:57.196021-05:00",
    "modified_by": 1
}

Expand Parameters

See the Expand Parameters section for more details.

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

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

{
  "id": 2,
  "name": "Sample Name 2",
  "description": "",
  "projects": [
    {
      "id": 1,
      "name": "Sample Project",
      "archived": false,
      "application": {
        "id": 1,
        "name": "Sample App"
      },
      "business_unit": {
        "id": 1,
        "name": "Sample BU"
      }
    },
    {
      "id": 2,
      "name": "Sample Project 2",
      "archived": true,
      "application": {
        "id": 2,
        "name": "Sample App 2"
      },
      "business_unit": {
        "id": 1,
        "name": "Sample BU"
      }
    }
  ],
  "created": "2025-02-06T12:40:58.003904-05: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-02-06T12:40:58.003911-05:00",
  "modified_by": {
    "id": 1,
    "email": "admin@example.com",
    "first_name": "Admin",
    "last_name": "Testerton",
    "is_active": true,
    "role": {
      "id": "UR4",
      "name": "Administrator"
    }
  }
}

Create a System View

Creates a new System View resource for a given project.

POST /api/v2/system-view/

Payload

Fields Required Description
name Yes The name of the System View.
description No The description of the System View.
projects No A list of IDs for the projects to be included in the System View. 
POST /api/v2/system-view/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

{
    "name": "Sample Name",
    "description": "Sample Description",
    "projects": [1, 2]
}

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

{
    "id": 1,
    "name": "Sample Name",
    "description": "Sample Description",
    "projects": [1, 2],
    "created": "2025-02-10T17:23:41.937177-05:00",
    "created_by": 1,
    "modified": "2025-02-10T17:23:41.937183-05:00",
    "modified_by": 1
}

Update a System View

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

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

URL Parameters

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

Payload

Fields Required Description
name No The name of the System View.
description No The description of the System View.
projects No A list of IDs for the new projects included in the System View. 
PATCH /api/v2/system-view/1/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

{
    "name": "Sample Name",
    "description": "Sample Description",
    "projects": [1, 2]
}

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

{
    "id": 1,
    "name": "Sampe Name",
    "description": "Sample Description",
    "projects": [1, 2],
    "created": "2025-02-06T12:40:57.196015-05:00",
    "created_by": 1,
    "modified": "2025-02-10T16:36:16.025383-05:00",
    "modified_by": 1
}

Delete a Sytem View

Deletes a Sytem View resource for a given project.

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

URL Parameters

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

HTTP/1.1 204 NO CONTENT

results matching ""

    No results matching ""