devguard

AssetsId

Get the details of a single asset by id.

GET
/assets/{id}/

Authorization

Authorization
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.devguard.ch/api/assets/string/"
{
  "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"
            }
          }
        }
      ]
    }
  ]
}
{
  "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?

Delete a asset by id. DELETE

Previous Page

Update a asset by id. PATCH

Next Page