Dashboard API

Authenticated API used by the internal Legaciti dashboard. Administrative endpoints are marked as internal where relevant.

Version: 1.0.0

Raw OpenAPI JSON: /openapi/dashboard-api.json

Servers

• https://dash.legaciti.org - Primary dashboard API domain
• https://my.legaciti.org - Alternate dashboard API domain

Endpoints

Import

Method	Path	Summary
POST	/api/import/orcid	Queue ORCID import
POST	/api/import/doi	Import DOI

POST /api/import/orcid

Queue ORCID import Queues ORCID imports from the import surface. Similar to ingestion queueing but exposed under import routes. Authentication: Cloudflare Access JWT Tags: Import

Parameters

No parameters.

Request Body

Content type: application/json

{
  "type": "object",
  "properties": {
    "orcid_ids": {
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "skip_existing": {
      "type": "boolean"
    }
  },
  "required": [
    "orcid_ids"
  ],
  "additionalProperties": false
}

Responses

202 - Queued import jobs.

Content type: application/json

{
  "type": "object",
  "properties": {
    "queued": {
      "type": "integer"
    },
    "jobs": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    }
  },
  "required": [
    "queued",
    "jobs"
  ]
}

400 - Invalid request body.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

POST /api/import/doi

Import DOI Fetches and upserts publication metadata directly from a DOI and optionally links researchers. Authentication: Cloudflare Access JWT Tags: Import

Parameters

No parameters.

Request Body

Content type: application/json

{
  "type": "object",
  "properties": {
    "doi": {
      "type": "string",
      "minLength": 1
    },
    "researcher_orcids": {
      "default": [],
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      }
    }
  },
  "required": [
    "doi",
    "researcher_orcids"
  ],
  "additionalProperties": false
}

Responses

200 - Existing publication refreshed.

Content type: application/json

{
  "type": "object",
  "additionalProperties": true
}

201 - New publication created from DOI import.

Content type: application/json

{
  "type": "object",
  "additionalProperties": true
}

400 - Invalid DOI import payload.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

Info

Method	Path	Summary
GET	/health	Health check
GET	/me	Current dashboard identity
GET	/debug-auth	Authentication debug payload

GET /health

Health check Simple health endpoint for worker availability. Authentication: Public Tags: Info

Parameters

No parameters.

Request Body

No request body.

Responses

200 - Worker health response.

Content type: application/json

{
  "type": "object",
  "properties": {
    "service": {
      "type": "string",
      "enum": [
        "dashboard-api"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "ok"
      ]
    }
  },
  "required": [
    "service",
    "status"
  ]
}

GET /me

Current dashboard identity Returns the authenticated dashboard email when Cloudflare Access authentication succeeds. Authentication: Cloudflare Access JWT Tags: Info

Parameters

No parameters.

Request Body

No request body.

Responses

200 - Authenticated email payload.

Content type: application/json

{
  "type": "object",
  "properties": {
    "email": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "email"
  ]
}

GET /debug-auth

Authentication debug payload Returns the parsed Cloudflare Access context and token hints for debugging authentication issues. Internal: yes Authentication: Public Tags: Info

Parameters

No parameters.

Request Body

No request body.

Responses

200 - Debug payload with identity and token-derived fields.

Content type: application/json

{
  "type": "object",
  "additionalProperties": true
}

Ingestion

Method	Path	Summary
POST	/api/ingest	Queue ORCID ingestion
GET	/api/ingest/status	Poll ingestion status
GET	/api/ingest/stuck	List stuck ingestion jobs
POST	/api/ingest/stuck/{jobId}/force-fail	Force-fail an ingestion job

POST /api/ingest

Queue ORCID ingestion Queues one or more ORCID ingestion jobs and returns the job records that were created. Authentication: Cloudflare Access JWT Tags: Ingestion

Parameters

No parameters.

Request Body

Content type: application/json

{
  "type": "object",
  "properties": {
    "orcid_ids": {
      "minItems": 1,
      "maxItems": 100,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "skip_existing": {
      "type": "boolean"
    }
  },
  "required": [
    "orcid_ids"
  ],
  "additionalProperties": false
}

Responses

202 - Queued ingestion jobs.

Content type: application/json

{
  "type": "object",
  "properties": {
    "queued": {
      "type": "integer"
    },
    "requested": {
      "type": "integer"
    },
    "jobs": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    }
  },
  "required": [
    "queued",
    "requested",
    "jobs"
  ]
}

400 - Invalid request body.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

GET /api/ingest/status

Poll ingestion status Returns the most recent ingestion status for each requested ORCID identifier. Authentication: Cloudflare Access JWT Tags: Ingestion

Parameters

Name	In	Type	Required	Description
orcid_ids	query	string	yes	Comma-separated ORCID identifiers.

Request Body

No request body.

Responses

200 - Status payloads by ORCID.

Content type: application/json

{
  "type": "object",
  "properties": {
    "statuses": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    }
  },
  "required": [
    "statuses"
  ]
}

400 - Missing query parameter.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

GET /api/ingest/stuck

List stuck ingestion jobs Lists queued or processing ingestion jobs older than a configurable threshold. Internal: yes Authentication: Cloudflare Access JWT Tags: Ingestion

Parameters

Name	In	Type	Required	Description
threshold_seconds	query	integer	no	Age threshold in seconds.
limit	query	integer	no	Maximum stuck jobs to return.

Request Body

No request body.

Responses

200 - Stuck ingestion jobs across shards.

Content type: application/json

{
  "type": "object",
  "additionalProperties": true
}

POST /api/ingest/stuck/{jobId}/force-fail

Force-fail an ingestion job Marks a queued or processing ingestion job as failed for operational recovery. Internal: yes Authentication: Cloudflare Access JWT Tags: Ingestion

Parameters

Name	In	Type	Required	Description
jobId	path	string	yes	Ingestion job identifier.

Request Body

Content type: application/json

{
  "type": "object",
  "properties": {
    "orcid_id": {
      "type": "string"
    },
    "error_message": {
      "type": "string"
    }
  },
  "required": [
    "orcid_id"
  ]
}

Responses

200 - Forced failure result.

Content type: application/json

{
  "type": "object",
  "additionalProperties": true
}

400 - Invalid request body.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

404 - Job not found or not active.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

Publications

Method	Path	Summary
GET	/api/publications	List publications
GET	/api/publications/stats	Publication totals
GET	/api/publications/stats/timeseries	Publication timeseries
GET	/api/publications/{id}	Get publication
PATCH	/api/publications/{id}	Patch publication
DELETE	/api/publications/{id}	Soft-delete publication
POST	/api/publications/bulk	Bulk publication action

GET /api/publications

List publications Lists dashboard publications across shards with filters for visibility, deletion state, ownership, and metadata fields. Authentication: Cloudflare Access JWT Tags: Publications

Parameters

Name	In	Type	Required	Description
page	query	integer	yes	1-based page number.
perPage	query	integer	yes	Items per page.
orcid_id	query	string	no	Filter to publications linked to a researcher ORCID.
q	query	string	yes	Search term applied to title and author text.
sort	query	string	yes	Sort field.
dir	query	string	yes	Sort direction.
visibility	query	string	yes	Visibility filter.
status	query	string	yes	Deletion-state filter.
publication_type	query	string	no	Exact publication type filter.
publication_year	query	integer	no	Publication year filter.
min_cited_by	query	integer	no	Minimum citation count filter.

Request Body

No request body.

Responses

200 - Paginated publication list.

Content type: application/json

{
  "type": "object",
  "properties": {
    "publications": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "researcher_orcids": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "researchers": {
            "type": "array",
            "items": {
              "type": "object",
              "additionalProperties": true
            }
          },
          "title": {
            "type": [
              "string",
              "null"
            ]
          },
          "apa_citation": {
            "type": [
              "string",
              "null"
            ]
          },
          "doi_url": {
            "type": "string"
          },
          "publication_date": {
            "type": [
              "string",
              "null"
            ]
          },
          "publication_year": {
            "type": [
              "integer",
              "null"
            ]
          },
          "publication_type": {
            "type": [
              "string",
              "null"
            ]
          },
          "cited_by_count": {
            "type": [
              "integer",
              "null"
            ]
          },
          "last_fetched_at": {
            "type": "integer"
          },
          "edit_count": {
            "type": "integer"
          },
          "visible": {
            "type": "boolean"
          },
          "deleted_at": {
            "type": [
              "string",
              "null"
            ]
          }
        },
        "required": [
          "id",
          "researcher_orcids",
          "researchers",
          "doi_url",
          "last_fetched_at",
          "edit_count",
          "visible"
        ],
        "additionalProperties": true
      }
    },
    "page": {
      "type": "integer"
    },
    "per_page": {
      "type": "integer"
    },
    "total": {
      "type": "integer"
    },
    "pages": {
      "type": "integer"
    },
    "sort": {
      "type": "string"
    },
    "dir": {
      "type": "string"
    },
    "q": {
      "type": "string"
    },
    "visibility": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "publication_type": {
      "type": [
        "string",
        "null"
      ]
    },
    "publication_year": {
      "type": [
        "integer",
        "null"
      ]
    },
    "min_cited_by": {
      "type": [
        "integer",
        "null"
      ]
    }
  },
  "required": [
    "publications",
    "page",
    "per_page",
    "total",
    "pages",
    "sort",
    "dir",
    "q",
    "visibility",
    "status"
  ]
}

400 - Invalid query parameters.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

GET /api/publications/stats

Publication totals Returns aggregate publication totals used by the dashboard overview widgets. Authentication: Cloudflare Access JWT Tags: Publications

Parameters

No parameters.

Request Body

No request body.

Responses

200 - Publication totals.

Content type: application/json

{
  "type": "object",
  "properties": {
    "total_publications": {
      "type": "integer"
    },
    "edited_publications": {
      "type": "integer"
    },
    "hidden_publications": {
      "type": "integer"
    },
    "orcid_sources": {
      "type": "integer"
    }
  },
  "required": [
    "total_publications",
    "edited_publications",
    "hidden_publications",
    "orcid_sources"
  ]
}

GET /api/publications/stats/timeseries

Publication timeseries Returns recent daily and monthly ingestion counts for dashboard charts. Authentication: Cloudflare Access JWT Tags: Publications

Parameters

No parameters.

Request Body

No request body.

Responses

200 - Daily and monthly publication counts.

Content type: application/json

{
  "type": "object",
  "properties": {
    "daily_last_7_days": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "count": {
            "type": "integer"
          }
        },
        "required": [
          "key",
          "label",
          "count"
        ]
      }
    },
    "monthly_last_6_months": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "label": {
            "type": "string"
          },
          "count": {
            "type": "integer"
          }
        },
        "required": [
          "key",
          "label",
          "count"
        ]
      }
    }
  },
  "required": [
    "daily_last_7_days",
    "monthly_last_6_months"
  ]
}

GET /api/publications/{id}

Get publication Returns the original, edited, and merged publication payload along with linked researchers and promoted metadata. Authentication: Cloudflare Access JWT Tags: Publications

Parameters

Name	In	Type	Required	Description
id	path	string	yes	Normalized or raw DOI identifier.

Request Body

No request body.

Responses

200 - Publication detail payload.

Content type: application/json

{
  "type": "object",
  "additionalProperties": true
}

400 - Missing identifier.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

404 - Publication not found.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

PATCH /api/publications/{id}

Patch publication Applies a JSON Patch document to publication metadata or toggles visibility. Authentication: Cloudflare Access JWT Tags: Publications

Parameters

Name	In	Type	Required	Description
id	path	string	yes	Normalized or raw DOI identifier.

Request Body

Content type: application/json

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "op": {
        "type": "string"
      },
      "path": {
        "type": "string"
      },
      "value": {}
    },
    "required": [
      "op",
      "path"
    ],
    "additionalProperties": true
  }
}

Responses

200 - Patch result.

Content type: application/json

{
  "type": "object",
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "visible": {
      "type": "boolean"
    },
    "edit_count": {
      "type": "integer"
    }
  },
  "required": [
    "ok",
    "visible"
  ],
  "additionalProperties": true
}

400 - Invalid patch payload.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

404 - Publication not found.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

DELETE /api/publications/{id}

Soft-delete publication Marks a publication as deleted without removing the row. Authentication: Cloudflare Access JWT Tags: Publications

Parameters

Name	In	Type	Required	Description
id	path	string	yes	Normalized or raw DOI identifier.

Request Body

No request body.

Responses

200 - Deletion acknowledged.

Content type: application/json

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ]
}

400 - Missing identifier.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

POST /api/publications/bulk

Bulk publication action Soft-deletes or restores a list of publications. Authentication: Cloudflare Access JWT Tags: Publications

Parameters

No parameters.

Request Body

Content type: application/json

{
  "type": "object",
  "properties": {
    "ids": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "action": {
      "type": "string",
      "enum": [
        "delete",
        "restore"
      ]
    }
  },
  "required": [
    "ids",
    "action"
  ],
  "additionalProperties": false
}

Responses

200 - Bulk action acknowledged.

Content type: application/json

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ]
}

400 - Invalid bulk request body.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

Researchers

Method	Path	Summary
GET	/api/researchers	List researchers
GET	/api/researchers/{orcid}	Get researcher
PATCH	/api/researchers/{orcid}	Update researcher profile
GET	/api/researchers/{orcid}/publications	List researcher publications
PATCH	/api/researchers/{orcid}/affiliation	Update researcher affiliation

GET /api/researchers

List researchers Lists researchers with optional affiliation and search filters. Authentication: Cloudflare Access JWT Tags: Researchers

Parameters

Name	In	Type	Required	Description
page	query	integer	yes	1-based page number.
perPage	query	integer	yes	Items per page.
q	query	string	yes	Search by researcher name or ORCID.
sort	query	string	yes	Sort field.
dir	query	string	yes	Sort direction.
entity_id	query	string	no	Entity filter such as cesam.
affiliation_status	query	string	no	Normalized affiliation status filter.
active_only	query	boolean	yes	Only include currently active memberships.

Request Body

No request body.

Responses

200 - Paginated researcher list.

Content type: application/json

{
  "type": "object",
  "properties": {
    "researchers": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "page": {
      "type": "integer"
    },
    "per_page": {
      "type": "integer"
    },
    "total": {
      "type": "integer"
    },
    "pages": {
      "type": "integer"
    }
  },
  "required": [
    "researchers",
    "page",
    "per_page",
    "total",
    "pages"
  ]
}

400 - Invalid query parameters.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

GET /api/researchers/{orcid}

Get researcher Returns a single researcher including current normalized affiliation fields. Authentication: Cloudflare Access JWT Tags: Researchers

Parameters

Name	In	Type	Required	Description
orcid	path	string	yes	Researcher ORCID identifier.

Request Body

No request body.

Responses

200 - Researcher payload.

Content type: application/json

{
  "type": "object",
  "additionalProperties": true
}

400 - Missing ORCID.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

404 - Researcher not found.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

PATCH /api/researchers/{orcid}

Update researcher profile Updates the manually editable researcher name and biography fields. Authentication: Cloudflare Access JWT Tags: Researchers

Parameters

Name	In	Type	Required	Description
orcid	path	string	yes	Researcher ORCID identifier.

Request Body

Content type: application/json

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1
    },
    "biography": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "name"
  ],
  "additionalProperties": false
}

Responses

200 - Profile update acknowledged.

Content type: application/json

{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    }
  },
  "required": [
    "success"
  ]
}

400 - Invalid profile payload.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

GET /api/researchers/{orcid}/publications

List researcher publications Returns publications linked to a single researcher, with optional inclusion of soft-deleted rows. Authentication: Cloudflare Access JWT Tags: Researchers

Parameters

Name	In	Type	Required	Description
orcid	path	string	yes	Researcher ORCID identifier.
page	query	integer	yes	1-based page number.
perPage	query	integer	yes	Items per page.
includeDeleted	query	boolean	yes	Include soft-deleted publications.

Request Body

No request body.

Responses

200 - Paginated publication list for a single researcher.

Content type: application/json

{
  "type": "object",
  "additionalProperties": true
}

400 - Invalid query parameters.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

PATCH /api/researchers/{orcid}/affiliation

Update researcher affiliation Closes the current active membership row and creates a new one for the given entity and status. Authentication: Cloudflare Access JWT Tags: Researchers

Parameters

Name	In	Type	Required	Description
orcid	path	string	yes	Researcher ORCID identifier.

Request Body

Content type: application/json

{
  "type": "object",
  "properties": {
    "entity_id": {
      "type": "string",
      "minLength": 1
    },
    "status": {
      "type": "string",
      "enum": [
        "cesam",
        "external"
      ]
    },
    "starts_at": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "entity_id",
    "status"
  ],
  "additionalProperties": false
}

Responses

200 - Affiliation update payload.

Content type: application/json

{
  "type": "object",
  "additionalProperties": true
}

400 - Invalid affiliation request.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

404 - Researcher or entity not found.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

Site Tools

Method	Path	Summary
POST	/api/site-tools/reset-data	Reset dashboard data
POST	/api/site-tools/clear-stuck-jobs	Clear stuck jobs
POST	/api/site-tools/repair-author-links	Repair author links for a DOI
POST	/api/site-tools/repair-author-links/bulk	Bulk repair author links

POST /api/site-tools/reset-data

Reset dashboard data Administrative endpoint to delete dashboard data across shards. Protected by additional email checks. Internal: yes Authentication: Cloudflare Access JWT Tags: Site Tools

Parameters

No parameters.

Request Body

Content type: application/json

{
  "type": "object",
  "properties": {
    "confirmation": {
      "type": "string"
    },
    "dryRun": {
      "type": "boolean"
    },
    "clearIngestionJobs": {
      "type": "boolean"
    }
  },
  "required": [
    "confirmation"
  ],
  "additionalProperties": false
}

Responses

200 - Reset result.

Content type: application/json

{
  "type": "object",
  "additionalProperties": true
}

400 - Invalid request or confirmation mismatch.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

403 - Forbidden for non-admin identities.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

500 - One or more shards failed.

Content type: application/json

{
  "type": "object",
  "additionalProperties": true
}

POST /api/site-tools/clear-stuck-jobs

Clear stuck jobs Administrative endpoint to force-fail stale queued or processing ingestion jobs across shards. Internal: yes Authentication: Cloudflare Access JWT Tags: Site Tools

Parameters

No parameters.

Request Body

Content type: application/json

{
  "type": "object",
  "properties": {
    "thresholdSeconds": {
      "type": "integer",
      "minimum": 60,
      "maximum": 86400
    },
    "dryRun": {
      "type": "boolean"
    },
    "reason": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "additionalProperties": false
}

Responses

200 - Clear stuck jobs result.

Content type: application/json

{
  "type": "object",
  "additionalProperties": true
}

400 - Invalid request body.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

403 - Forbidden for non-admin identities.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

500 - One or more shards failed.

Content type: application/json

{
  "type": "object",
  "additionalProperties": true
}

POST /api/site-tools/repair-author-links

Repair author links for a DOI Administrative endpoint to reconcile author matches for a single publication DOI. Internal: yes Authentication: Cloudflare Access JWT Tags: Site Tools

Parameters

No parameters.

Request Body

Content type: application/json

{
  "type": "object",
  "properties": {
    "doi": {
      "type": "string",
      "minLength": 1
    },
    "dryRun": {
      "type": "boolean"
    },
    "cesamOnly": {
      "type": "boolean"
    }
  },
  "required": [
    "doi"
  ],
  "additionalProperties": false
}

Responses

200 - Repair result for one publication.

Content type: application/json

{
  "type": "object",
  "additionalProperties": true
}

400 - Invalid request body or DOI.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

403 - Forbidden for non-admin identities.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

404 - Publication not found.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

POST /api/site-tools/repair-author-links/bulk

Bulk repair author links Administrative endpoint to scan multiple publications per shard and reconcile author links in bulk. Internal: yes Authentication: Cloudflare Access JWT Tags: Site Tools

Parameters

No parameters.

Request Body

Content type: application/json

{
  "type": "object",
  "properties": {
    "dryRun": {
      "type": "boolean"
    },
    "cesamOnly": {
      "type": "boolean"
    },
    "limitPerShard": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000
    }
  },
  "additionalProperties": false
}

Responses

200 - Bulk repair result.

Content type: application/json

{
  "type": "object",
  "additionalProperties": true
}

400 - Invalid request body.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}

403 - Forbidden for non-admin identities.

Content type: application/json

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "details": {
      "oneOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "error"
  ],
  "additionalProperties": true
}