Platform

---

List platforms

Get a list of platforms.

const response = await geocore.Platform.platformList({
  name: "name",
  companyId: "companyId",
  page: 1,
  limit: 10,
});

Prerequisites

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

Parameters

name	type	data type	description
name	optional	string	Search by platform name
companyId	optional	string	Company ID to get platform configuration
page	optional	number	Page ordinal number
limit	optional	number	Number of records per page

Create platform

Create a new platform.

const response = await geocore.Platform.createPlatform({
  name: "string",
  description: "string",
});

Prerequisites

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

Parameters

name	type	data type	description
name	required	string	Platform name
description	required	string	Platform description

Update platform

Update a platform.

const response = await geocore.Platform.updatePlatform(
  platformId,
  {
    name: "string",
    description: "string",
  }
);

Prerequisites

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

Parameters

name	type	data type	description
platformId	required	string	ID of platform
name	required	string	Platform name
description	required	string	Platform description

Delete platform

Delete a platform.

const response = await geocore.Platform.deletePlatform(platformId);

Prerequisites

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

Parameters

name	type	data type	description
platformId	required	string	Platform ID