ManagementAPI

Client

• Management

Projects

Méthode	Types expected	Return	Description
get	None		Récupère la liste de tous les projets.
create	CreateProjectProps	CreateProjectResponse	Crée un nouveau projet avec les propriétés spécifiées.
config	None		Récupère la configuration d’un projet spécifique.
archive	None		Archiver un projet spécifique.
delete	None		Supprime un projet de manière permanente.

// Get all projects
ManagementAPI().Projects().get<[]>();

// Get one project
ManagementAPI().Projects( "projectId" ).get();

ManagementAPI().Projects().create({ ...Management.CreateProjectProps... });

// Get one project configuration
ManagementAPI().Projects( "projectId" ).config();

// Get one project's archive
ManagementAPI().Projects( "projectId" ).archive();

// Delete project
ManagementAPI().Projects( "projectId" ).delete();

Users

Méthode	Types expected	Return	Description
get	None	Management.User | Management.User[]	Récupère la liste de tous les utilisateurs associés au projet.
create	Management.User	Management.User	Crée un utilisateur avec les propriétés spécifiées.
update	Management.User	Management.User	Met à jour un utilisateur existant.
deploy	Management.User	Management.User	Applique la configuration utilisateur par défaut au projet.
delete	None	boolean	Supprime un utilisateur spécifique.

// Get all users
ManagementAPI().Projects('projectId')
.Users().get<[]>();

// Get one user
ManagementAPI().Projects('projectId')
.Users( "userId" ).get();

// Create one user
ManagementAPI().Projects('projectId')
.Users().create({ ...Management.User... });

// Update one user
ManagementAPI().Projects('projectId')
.Users( "userId" ).update({ ...Management.User... });

// Deploy default user configuration to project
ManagementAPI().Projects('projectId')
.Users( "userId" ).deploy({ ...Management.User... });

// Delete one user
ManagementAPI().Projects('projectId')
.Users( "userId" ).delete();

Groups

Méthode	Types expected	Return	Description
get	None	Management.Group | Management.Group[]	Récupère la liste de tous les groupes associés au projet.
create	Management.Group	Management.Group	Crée un groupe avec les propriétés spécifiées.
update	Management.Group	Management.Group	Met à jour un groupe existant.
deploy	Management.Group	Management.Group	Applique la configuration par défaut du groupe au projet.
delete	None	boolean	Supprime un groupe spécifique.

// Get all groups
ManagementAPI().Projects('projectId')
.Groups().get<[]>();

// Get one group
ManagementAPI().Projects('projectId')
.Groups( "groupId" ).get();

// Create one group
ManagementAPI().Projects('projectId')
.Groups().create({ ...Management.Group... });

// Update one group
ManagementAPI().Projects('projectId')
.Groups( "groupId" ).update({ ...Management.Group... });

// Deploy default group configuration to project
ManagementAPI().Projects('projectId')
.Groups( "groupId" ).deploy({ ...Management.Group... });

// Delete one group
ManagementAPI().Projects('projectId')
.Groups( "groupId" ).delete();

Documents

Méthode	Types expected	Return	Description
get	None	Management.DocumentListOutput	Récupère la liste de tous les documents associés au projet.
download	None	None	Télécharge un document spécifique à partir du projet.
create	FormData	Management.DocumentOutput	Crée un document dans le projet avec les propriétés spécifiées.
delete	None	None	Supprime un document spécifique du projet.

// Get all documents
ManagementAPI().Projects( "projectId" )
.Documents().get<[]>();

// Get one document
ManagementAPI().Projects( "projectId" )
.Documents( "documentKey" ).get();

// Download one document
ManagementAPI().Projects( "projectId" )
.Documents( "documentKey" ).download();

// Create one document
ManagementAPI().Projects( "projectId" )
.Documents().create();

// Update one document
ManagementAPI().Projects( "projectId" )
.Documents( "documentKey" ).update();

// Delete one document
ManagementAPI().Projects( "projectId" )
.Documents( "documentKey" ).delete();

Commits

Méthode	Types expected	Return	Description
get	None	Management.Commit | Management.Commit[]	Récupère la liste de tous les commits associés au projet.
delete	None	boolean	Supprime un commit spécifique du projet.

// Get all commits
ManagementAPI().Projects( "projectId" )
.Commits().get();

// Get one commit
ManagementAPI().Projects( "projectId" )
.Commits( "commitId" ).get<[]>();

// Delete one commit
ManagementAPI().Projects( "projectId" )
.Commits( "commitId" ).delete();

Backups

Méthode	Types expected	Return	Description
get	None	Management.DocumentListOutput	Récupère la liste de toutes les sauvegardes associées au projet.
create	None	Management.DocumentOutput	Crée une sauvegarde pour le projet spécifié.
delete	None	boolean	Supprime une sauvegarde spécifique du projet.
download	None	None	Télécharge une sauvegarde spécifique du projet.
restore	None	None	Restaure une sauvegarde spécifique pour le projet.

// Get all backups
ManagementAPI().Projects( "projectId" )
.Backups().get();

// Get all backups
ManagementAPI().Projects( "projectId" )
.Backups( "backupId" ).get<[]>();

// Create one backup
ManagementAPI().Projects( "projectId" )
.Backups().create();

// Download one backup
ManagementAPI().Projects( "projectId" )
.Backups( "backupId" ).download();

Database

Méthode	Types expected	Return	Description
delete	None	None	Supprime un projet spécifique de la base de données.

// Delete all project from database
MangementAPI().DB().Projects( "projectId" ).delete()

Queues

Méthode	Types expected	Return	Description
get	None	None	Supprime un projet spécifique de la base de données.
create	None	None	Supprime un projet spécifique de la base de données.

ManagementAPI().Queues().get<[]>();

ManagementAPI().Queues( "queueId" ).get();

ManagementAPI().Queues().create();

Jobs

Méthode	Types expected	Return	Description
get	None	None	Supprime un projet spécifique de la base de données.
create	None	None	Supprime un projet spécifique de la base de données.

ManagementAPI().Queues( "queueId" ).Jobs().get<[]>();

ManagementAPI().Queues( "queueId" ).Jobs( "jobId" ).get();

ManagementAPI().Queues( "queueId" ).Jobs()create();

Default Project

ManagementAPI().Projects('default').get();

ManagementAPI().Projects('default')
.Users().get<[]>();

ManagementAPI().Projects('default')
.Users( "userId" ).get();

ManagementAPI().Projects('default')
.Users().create({ ...user... });

ManagementAPI().Projects('default')
.Users( "userId" ).update({ ...user... });

ManagementAPI().Projects('default')
.Users( "userId" ).deploy({ ...user... });

ManagementAPI().Projects('default')
.Users( "userId" ).delete();