devguard

Assets

Get a paginated list of assets with hierarchy.

GET
/assets/

Authorization

Authorization
AuthorizationBearer <token>

In: header

Query Parameters

limit?number
Default100
Range5 <= value
page?number
Default1
Range1 <= value
organizationId*string
sortColumn?string
sortDirection?string
Value in"asc" | "desc"
filterByName?string
parentId?|
maxDepth?number
Default4
Range1 <= value <= 10

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.devguard.ch/api/assets/?organizationId=string"
{
  "items": [
    {
      "id": "string",
      "shortId": -9007199254740991,
      "slug": "string",
      "name": "string",
      "description": "string",
      "ownerId": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "organizationId": "string",
      "status": "ACTIVE",
      "parentId": "string",
      "assetClassId": "string",
      "locationId": "string",
      "retentionPeriodId": "string",
      "lastReviewId": "string",
      "confidentialityRating": 0,
      "integrityRating": 0,
      "availabilityRating": 0,
      "owner": {
        "id": "string",
        "slug": "string",
        "name": "string",
        "description": "string",
        "organizationId": "string",
        "users": [
          "string"
        ]
      },
      "location": {
        "id": "string",
        "slug": "string",
        "name": "string",
        "description": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "latitude": 0,
        "longitude": 0,
        "address": "string",
        "organizationId": "string"
      },
      "retentionPeriod": {
        "id": "string",
        "slug": "string",
        "name": "string",
        "description": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "organizationId": "string",
        "ruleSet": "string"
      },
      "assetMemberships": [
        {
          "assetId": "string",
          "businessRoleId": "string",
          "businessRole": {
            "id": "string",
            "slug": "string",
            "name": "string",
            "description": "string",
            "organizationId": "string",
            "users": [
              "string"
            ]
          }
        }
      ],
      "assetClass": {
        "id": "string",
        "slug": "string",
        "name": "string",
        "description": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "organizationId": "string",
        "confidentialityRating": 0,
        "integrityRating": 0,
        "availabilityRating": 0
      },
      "parent": {
        "id": "string",
        "shortId": -9007199254740991,
        "slug": "string",
        "name": "string",
        "description": "string",
        "ownerId": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "organizationId": "string",
        "status": "ACTIVE",
        "parentId": "string",
        "assetClassId": "string",
        "locationId": "string",
        "retentionPeriodId": "string",
        "lastReviewId": "string",
        "confidentialityRating": 0,
        "integrityRating": 0,
        "availabilityRating": 0
      },
      "level": 0,
      "controlLinks": [
        {
          "id": "string",
          "controlCoverageId": "string",
          "assetId": "string",
          "organizationId": "string",
          "linkedAt": "string",
          "linkedBy": "string",
          "controlCoverage": {
            "id": "string",
            "frameworkAdoptionId": "string",
            "controlId": "string",
            "coverageStatus": "FULL",
            "coverageGap": "string",
            "lastReviewedAt": "string",
            "reviewedBy": "string",
            "policyId": "string",
            "sectionUid": "string",
            "organizationId": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "control": {
              "id": "string",
              "frameworkId": "string",
              "parentId": "string",
              "identifier": "string",
              "slug": "string",
              "type": "CATEGORY",
              "isMandatory": true,
              "name": "string",
              "description": null,
              "purpose": "string",
              "isCentralized": true,
              "createdAt": "string",
              "updatedAt": "string"
            }
          }
        }
      ],
      "children": [
        {
          "id": "string",
          "shortId": -9007199254740991,
          "slug": "string",
          "name": "string",
          "description": "string",
          "ownerId": "string",
          "createdAt": "string",
          "updatedAt": "string",
          "organizationId": "string",
          "status": "ACTIVE",
          "parentId": "string",
          "assetClassId": "string",
          "locationId": "string",
          "retentionPeriodId": "string",
          "lastReviewId": "string",
          "confidentialityRating": 0,
          "integrityRating": 0,
          "availabilityRating": 0,
          "owner": {
            "id": "string",
            "slug": "string",
            "name": "string",
            "description": "string",
            "organizationId": "string",
            "users": [
              "string"
            ]
          },
          "location": {
            "id": "string",
            "slug": "string",
            "name": "string",
            "description": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "latitude": 0,
            "longitude": 0,
            "address": "string",
            "organizationId": "string"
          },
          "retentionPeriod": {
            "id": "string",
            "slug": "string",
            "name": "string",
            "description": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "organizationId": "string",
            "ruleSet": "string"
          },
          "assetMemberships": [
            {
              "assetId": "string",
              "businessRoleId": "string",
              "businessRole": {
                "id": "string",
                "slug": "string",
                "name": "string",
                "description": "string",
                "organizationId": "string",
                "users": [
                  "string"
                ]
              }
            }
          ],
          "assetClass": {
            "id": "string",
            "slug": "string",
            "name": "string",
            "description": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "organizationId": "string",
            "confidentialityRating": 0,
            "integrityRating": 0,
            "availabilityRating": 0
          },
          "parent": {
            "id": "string",
            "shortId": -9007199254740991,
            "slug": "string",
            "name": "string",
            "description": "string",
            "ownerId": "string",
            "createdAt": "string",
            "updatedAt": "string",
            "organizationId": "string",
            "status": "ACTIVE",
            "parentId": "string",
            "assetClassId": "string",
            "locationId": "string",
            "retentionPeriodId": "string",
            "lastReviewId": "string",
            "confidentialityRating": 0,
            "integrityRating": 0,
            "availabilityRating": 0
          },
          "level": 0,
          "controlLinks": [
            {
              "id": "string",
              "controlCoverageId": "string",
              "assetId": "string",
              "organizationId": "string",
              "linkedAt": "string",
              "linkedBy": "string",
              "controlCoverage": {
                "id": "string",
                "frameworkAdoptionId": "string",
                "controlId": "string",
                "coverageStatus": "FULL",
                "coverageGap": "string",
                "lastReviewedAt": "string",
                "reviewedBy": "string",
                "policyId": "string",
                "sectionUid": "string",
                "organizationId": "string",
                "createdAt": "string",
                "updatedAt": "string",
                "control": {
                  "id": "string",
                  "frameworkId": "string",
                  "parentId": "string",
                  "identifier": "string",
                  "slug": "string",
                  "type": "CATEGORY",
                  "isMandatory": true,
                  "name": "string",
                  "description": null,
                  "purpose": "string",
                  "isCentralized": true,
                  "createdAt": "string",
                  "updatedAt": "string"
                }
              }
            }
          ]
        }
      ]
    }
  ],
  "total": 0,
  "page": 0,
  "limit": 0
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

How is this guide?

Update a asset review by id. PATCH

Previous Page

Create a asset. POST

Next Page