atrusDocs
Guía de integración›Convenciones›Ids con prefijo

Ids con prefijo

Un id de la API es un prefijo, un guión bajo y 32 caracteres hexadecimales: doc_0104f9ae5df240be8a3a57c1d2e3f4a5. El prefijo es presentación: es el mismo identificador que ves en la consola, con su tipo adelante. La ventaja se nota en los registros: un id suelto en un log no dice nada; uno con prefijo dice qué es.

Los prefijos

PrefijoRecurso
cmp_company
key_API key
usr_console user
cat_catalogue entry
trd_third party
cor_consent correction
mrg_subject merge
prs_rights process
pub_document publication
agr_agreement
ent_consent entry
evd_evidence
frm_consent form
tpl_consent template
csr_consent request
dsr_data subject request
sub_data subject
pa_processing activity
snp_register snapshot
doc_document
prc_processor
inc_incident
ntf_incident notification
dcs_incident decision
dpa_impact assessment
rsk_risk assessment
tsk_task
ppl_roster person
tcn_training content
tdf_training campaign
ack_training acknowledgement
rpt_report
whk_webhook
cnx_connector
run_connector run
prp_inventory proposal
exp_export
dlv_webhook delivery
bnt_mass notice to data subjects
pnt_public breach notice
inq_DPO inquiry
ais_AI system
ctl_control
cev_control evidence
rrg_register risk
dpr_DPIA risk

Cuando el prefijo no calza

Si mandas un id de otro recurso, la petición no llega a la base: responde 400 validation_error nombrando lo que mandaste y lo que se esperaba.

GET /api/v1/documents/tsk_0104f9ae5df240be8a3a57c1d2e3f4a5

{
  "type": "validation_error",
  "title": "Validation error",
  "status": 400,
  "requestId": "req_…",
  "errors": [{ "field": "id", "message": "Expected the id of a document (`doc_…`), but this is the id of a task." }]
}

req_ está reservado: es el requestId de cada petición, no un recurso.