Project

Create a project

POST /{instanceName}/api/v1/{locale}/project

Creates a project from a template and returns the full entity. 201 with a Location header.

Request body

application/json → ProjectCreateDto

Responses

Example

curl -X POST "https://api.visena.example/acme/api/v1/en/project" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Warehouse rollout",
    "templateId": "tM2qL6",
    "ownerGroupId": "gH8dF3",
    "companyId": "bQ4wR8"
  }'

Get a project

GET /{instanceName}/api/v1/{locale}/project/{projectId}

Returns the full entity. 404 if unknown; 400 if the id cannot be unmasked.

Parameters

Responses

Example

curl "https://api.visena.example/acme/api/v1/en/project/pJ7wN2" \
  -H "Authorization: Bearer $TOKEN"

List projects (offset-paginated)

GET /{instanceName}/api/v1/{locale}/project

Offset/limit paging with a real total. Optional filters: isActive, companyId; and a created/modified/name sort. RFC 8288 navigation links are in the body.

Parameters

Responses

Example

curl "https://api.visena.example/acme/api/v1/en/project?offset=0&limit=20" \
  -H "Authorization: Bearer $TOKEN"

List projects (cursor-paginated, insert-stable)

GET /{instanceName}/api/v1/{locale}/project/cursor

Keyset paging over the monotonic entity id (insertion order). Pass the opaque cursor from a previous page's nextCursor/prevCursor; omit it for the first page. No total. Same filters as the offset list: isActive, companyId.

Cursor paging and the timeline below are two different read modes, not two page shapes. Which one suits a single-pass extract, which one you resume from, whether a row can arrive twice, and what a list response says when a project disappears are all settled once for the whole API in Lists, paging and sync — read it before you build a synchronisation loop on this endpoint or on listProjectsByTime.

Parameters

Responses

Example

curl "https://api.visena.example/acme/api/v1/en/project/cursor?limit=100" \
  -H "Authorization: Bearer $TOKEN"

List projects (time-windowed, cursor-paginated)

GET /{instanceName}/api/v1/{locale}/project/timeline

Keyset paging from an optional since lower bound on the coalesced modified-or-created timestamp. RFC 9557 Z timestamps.

Parameters

Responses

Example

curl "https://api.visena.example/acme/api/v1/en/project/timeline?since=2026-08-20T02:00:00Z" \
  -H "Authorization: Bearer $TOKEN"

Replace a project

PUT /{instanceName}/api/v1/{locale}/project/{projectId}

Full replace (PUT): omitted optional fields are cleared.

Parameters

Request body

application/json → ProjectUpdateDto

Responses

Example

curl -X PUT "https://api.visena.example/acme/api/v1/en/project/pJ7wN2" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Warehouse rollout",
    "templateId": "tM2qL6",
    "ownerGroupId": "gH8dF3",
    "companyId": "bQ4wR8"
  }'

Partially update a project (RFC 7396 JSON Merge Patch)

PATCH /{instanceName}/api/v1/{locale}/project/{projectId}

Absent fields are unchanged, JSON null clears, a value sets. An empty body {} is a no-op. Wrong content type → 415.

Parameters

Request body

application/merge-patch+json → object

Responses

Example

curl -X PATCH "https://api.visena.example/acme/api/v1/en/project/pJ7wN2" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/merge-patch+json" \
  -d '{
    "name": "Warehouse rollout — phase 2"
  }'

Delete (close) a project

DELETE /{instanceName}/api/v1/{locale}/project/{projectId}

Soft-close: sets the project inactive through the same flow the Visena UI uses. 204 on success.

Parameters

Responses

Example

curl -X DELETE "https://api.visena.example/acme/api/v1/en/project/pJ7wN2" \
  -H "Authorization: Bearer $TOKEN"