Skip to main content

System configuration


Find system configuration

Get a list of system configurations.

const response = await geocore.SystemConfiguration.find({
host: "host",
page: 1,
limit: 20,
});

Prerequisites

Successfully get the IdToken with systemOwner access level from login API.

Parameters

nametypedata typedescription
hostoptionalstringHost name
pageoptionalnumberPage ordinal number, default is 1
limitoptionalnumberNumber of records per page, default is 20
Create system configuration

Create a new system configuration.

const response = await geocore.SystemConfiguration.create({
host: "host",
description: "description",
permissions: ["permission"],
});

Prerequisites

Successfully get the IdToken with systemOwner access level from login API.

Parameters

nametypedata typedescription
hostrequiredstringHost name
descriptionoptionalstringHost description
permissionsoptionalstringPermissions can be accessed by this host name
Update system configuration

Update a system configuration.

const response = await geocore.SystemConfiguration.update(configId, {
host: "host",
description: "description",
permissions: ["permission"],
});

Prerequisites

Successfully get the IdToken with systemOwner access level from login API.

Parameters

nametypedata typedescription
configIdrequiredstringConfig ID
hostrequiredstringHost name
descriptionoptionalstringHost description
permissionsoptionalstringPermissions can be accessed by this host name
Delete system configuration

Delete a system configuration.

const response = await geocore.SystemConfiguration.delete(configId);

Prerequisites

Successfully get the IdToken with systemOwner access level from login API.

Parameters

nametypedata typedescription
configIdrequiredstringConfig ID