Skip to main content

​
Outline Management

Outlines are the structured page and navigation definitions that control what appears in the portal. The Nexudus platform provides built-in system outlines and allows operators to create custom outlines. These endpoints cover listing, retrieving, creating, updating, and deleting outlines.

​
List All System Outlines

Returns all system outlines available for the current portal. System outlines are the built-in page definitions provided by the Nexudus platform.

​
Authentication

Requires a valid customer bearer token.

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.all
// => '/api/public/outlines/all'

const response = await httpClient.get(url)

​
List Custom Outlines

Returns all custom outlines created by the operator for the current portal.

​
Authentication

Requires a valid customer bearer token.

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.custom
// => '/api/public/outlines/custom'

​
Get Custom Outline by ID

Returns a specific custom outline by its numeric file identifier.

​
Path Parameters

​
fileId
number
required
The numeric identifier of the custom outline to retrieve.

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.getCustom(fileId)
// => '/api/public/outlines/custom/42'

​
Get Published Custom Outline by ID

Returns the published version of a specific custom outline. Only published outlines are shown to members.

​
Path Parameters

​
fileId
number
required
The numeric identifier of the published custom outline.

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.getCustomPublished(fileId)
// => '/api/public/outlines/custom/published/42'

​
List Published Custom Outlines

Returns all published custom outlines for the current portal.

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.customPublished
// => '/api/public/outlines/custom/published'

​
Update a System Outline

Updates a named system outline. Requires operator-level permissions.

​
Path Parameters

​
name
string
required
The machine-readable name of the system outline to update.

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.update('navigation')
// => '/api/public/outlines/navigation'

await httpClient.put(url, updatedOutlineData)

​
Delete a System Outline

Deletes a named system outline. Requires operator-level permissions.

​
Path Parameters

​
name
string
required
The machine-readable name of the system outline to delete.

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.delete('my-custom-page')
// => '/api/public/outlines/my-custom-page'

await httpClient.delete(url)

​
Create a Custom Outline

Creates a new custom outline for the portal.

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.createCustom()
// => '/api/public/outlines/custom'

await httpClient.post(url, newOutlineData)

​
Update a Custom Outline

Updates an existing custom outline by its numeric ID.

​
Path Parameters

​
id
number
required
The numeric identifier of the custom outline to update.

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.updateCustom(42)
// => '/api/public/outlines/custom/42'

await httpClient.put(url, updatedData)

​
Delete a Custom Outline

Deletes a custom outline by its numeric ID.

​
Path Parameters

​
id
number
required
The numeric identifier of the custom outline to delete.

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const url = endpoints.system.outlines.deleteCustom(42)
// => '/api/public/outlines/custom/42'

await httpClient.delete(url)

​
Error Responses

​
401 Unauthorized
error
The bearer token is missing, expired, or invalid.
​
403 Forbidden
error
The authenticated user does not have operator-level permission to manage outlines.
​
404 Not Found
error
No outline with the given name or ID was found.
MethodEndpointDescription
GET/api/public/outlines/navigationGet the portal navigation outline
GET/api/public/configurationGet portal feature configuration