devguard
EvidenceShortShortid

Get a single evidence by its per-organization short id.

GET
/evidence/short/{shortId}/

Authorization

Authorization
AuthorizationBearer <token>

In: header

Path Parameters

shortId*integer
Range-9007199254740991 <= value <= 9007199254740991

Query Parameters

organizationId*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/evidence/short/-9007199254740991/?organizationId=string"
{  "id": "string",  "shortId": -9007199254740991,  "organizationId": "string",  "createdAt": "string",  "updatedAt": "string",  "title": "string",  "description": "string",  "status": "TODO",  "categoryId": "string",  "ownerId": "string",  "approverId": "string",  "approvedAt": "string",  "approvedBy": "string",  "reviewFrequency": "MONTHLY",  "lastReviewedAt": "string",  "nextReviewAt": "string",  "automationActionId": "string",  "owner": {    "id": "string",    "slug": "string",    "name": "string",    "description": "string",    "archivedAt": "string",    "organizationId": "string",    "users": [      "string"    ]  },  "approver": {    "id": "string",    "slug": "string",    "name": "string",    "description": "string",    "archivedAt": "string",    "organizationId": "string",    "users": [      "string"    ]  },  "category": {    "id": "string",    "slug": "string",    "name": "string",    "description": "string",    "color": "string",    "organizationId": "string",    "createdAt": "string",    "updatedAt": "string"  },  "labels": [    {      "evidenceId": "string",      "labelId": "string",      "organizationId": "string",      "label": {        "id": "string",        "slug": "string",        "name": "string",        "scope": "string",        "color": "string",        "createdAt": "string",        "updatedAt": "string",        "archivedAt": "string",        "organizationId": "string"      }    }  ],  "controlLinksCount": 0,  "controlLinks": [    {      "id": "string",      "controlCoverageId": "string",      "evidenceId": "string",      "organizationId": "string",      "linkedAt": "string",      "linkedBy": "string",      "controlCoverage": {        "id": "string",        "frameworkAdoptionId": "string",        "controlId": "string",        "coverageStatus": "FULL",        "coverageGap": "string",        "lastReviewedAt": "string",        "reviewedBy": "string",        "isNotRelevant": true,        "notRelevantReason": "string",        "notRelevantAt": "string",        "notRelevantBy": "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": "string",          "purpose": "string",          "isCentralized": true,          "createdAt": "string",          "updatedAt": "string"        },        "frameworkAdoption": {          "id": "string",          "frameworkId": "string",          "organizationId": "string",          "adoptedAt": "string",          "adoptedBy": "string",          "notes": "string",          "targetDate": "string",          "framework": {            "id": "string",            "organizationId": "string",            "identifier": "string",            "slug": "string",            "version": "1.0",            "identifierColor": "string",            "publishedAt": "string",            "deprecatedAt": "string",            "isActive": true,            "requiredTier": "free-trial",            "name": "string",            "description": "string",            "isCentralized": true,            "lastSyncAt": "string",            "createdAt": "string",            "updatedAt": "string",            "createdBy": "string"          }        }      },      "derivedStatus": "FULL"    }  ],  "policyLinks": [    {      "id": "string",      "evidenceId": "string",      "policyId": "string",      "sectionUid": "string",      "organizationId": "string",      "linkedAt": "string",      "linkedBy": "string",      "policy": {        "id": "string",        "title": "string",        "slug": "string",        "order": -9007199254740991,        "categoryId": "string",        "organizationId": "string",        "approverId": "string",        "status": "DRAFT",        "content": null,        "currentVersion": "string",        "lastApprovedAt": "string",        "lastApprovedBy": "string",        "createdAt": "string",        "updatedAt": "string",        "archivedAt": "string"      }    }  ],  "files": [    {      "id": "string",      "organizationId": "string",      "uploadStatus": "PENDING_UPLOAD",      "filename": "string",      "originalName": "string",      "mimeType": "string",      "size": -9007199254740991,      "s3Key": "string",      "s3Bucket": "string",      "title": "string",      "description": "string",      "documentKind": "SOC2",      "issuedAt": "string",      "expiresAt": "string",      "sourceKey": "string",      "evidenceId": "string",      "assessmentId": "string",      "uploadedBy": "string",      "createdAt": "string",      "updatedAt": "string"    }  ],  "automationAction": {    "id": "string",    "shortId": -9007199254740991,    "name": "string",    "organizationId": "string",    "integrationCredentialId": "string",    "externalTicketConfiguration": null,    "scheduleId": "string",    "template": "string",    "status": "ACTIVE",    "createdAt": "string",    "updatedAt": "string",    "lastError": "string",    "lastErrorAt": "string"  },  "riskLinks": [    {      "id": "string",      "riskId": "string",      "risk": {        "id": "string",        "slug": "string",        "name": "string",        "shortId": -9007199254740991,        "treatmentType": "UNKNOWN",        "residualProbabilityRating": 0,        "residualImpactRating": 0      }    }  ],  "assetLinks": [    {      "id": "string",      "assetId": "string",      "asset": {        "id": "string",        "slug": "string",        "name": "string",        "shortId": -9007199254740991,        "status": "ACTIVE"      }    }  ],  "actionLinks": [    {      "id": "string",      "actionId": "string",      "action": {        "id": "string",        "name": "string",        "shortId": -9007199254740991      }    }  ],  "vendorLinks": [    {      "vendorId": "string",      "vendor": {        "id": "string",        "slug": "string",        "name": "string",        "shortId": -9007199254740991,        "status": "ACTIVE",        "category": "CLOUD"      }    }  ],  "incidentLinks": [    {      "id": "string",      "incidentId": "string",      "incident": {        "id": "string",        "slug": "string",        "name": "string",        "shortId": -9007199254740991,        "status": "OPEN",        "severity": "LOW"      }    }  ]}

How is this guide?