What is the GlobalSuite API and when to use it
The GlobalSuite API allows the platform to connect with other corporate systems to query, create, update, or relate business information. In practice, it avoids repetitive manual tasks and facilitates keeping GlobalSuite synchronized with tools like CMDB, ITSM, procurement solutions, document repositories, data lakes, dashboards, or compliance platforms.
|
Need |
What the API provides |
|
Import information |
Create or update records in GlobalSuite based on data maintained in another system, such as assets, employees, suppliers, or evidence. |
|
Query information |
Extract data from GlobalSuite to analyze, consolidate, or display it in other corporate systems. |
|
Maintain relationships |
Link records to each other, such as suppliers with services, assets with threats, tickets with responsible parties, or evidence with controls. |
|
Execute processes |
Launch specific actions or calculations, such as risk calculation requests or impact calculations associated with continuity. |
|
Automate reporting |
Prepare integrations with data repositories, dashboards, or executive reports without relying solely on manual exports. |
|
Key idea
|
Before starting: access, security, and limits
Before designing an integration, it is advisable to validate four aspects: environment, authentication, data scope, and usage limits.
|
Aspect |
What should be validated |
|
Documentation environment |
Reference documentation is consulted in Swagger UI. In the Europe demo environment, https://demo-eu.globalsuitesolutions.com/docs can be used. In other environments, it must be replaced with the URL published for the corresponding client or region. |
|
Integration URL |
Actual calls must be directed to the API URL of the corresponding environment, for example https://api-demo-eu.globalsuitesolutions.com/v1/ for the Europe demo environment. |
|
API Key |
Authenticated calls require an API Key or token with a defined validity period. If the key is outside its validity range, the API will return a 403 error. |
|
Subentities |
If the client works with multiple sub-entities, a specific API Key usually needs to be generated for each entity to be integrated, as the data belongs to each one. |
|
Rate limit |
The limit indicated on the current page is 180 calls per minute per API Key. If exceeded, the API may respond with 429 'Too Many Attempts.' |
|
Versioning |
The API is offered in the Current version. If a breaking change occurs, the previous version may become Deprecated to allow time to adapt integrations. |
|
Startup recommendation
|
How to read Swagger documentation
Swagger UI displays the available models and operations. For functional users, the important thing is not to memorize the syntax but to understand what each operation represents and its impact on the data.
|
Item |
How to interpret it |
|
Resource or model |
GlobalSuite business object: asset, ticket, supplier, employee, evidence, service, process, control, etc. |
|
GET method |
Queries one or more records. It is commonly used for listings, filters, prior validations, and data extraction. |
|
POST method |
Creates a record or executes a business action. It can also be used to associate objects or launch calculations. |
|
PUT method |
Updates an existing record or relationship. It should be used with special care to avoid overwriting information. |
|
DELETE method |
Deletes or disassociates a record. It should be limited to controlled processes with prior validations. |
|
Path parameters |
Values like {modelId}, {objectId}, {analysisId}, or {riskId} identify the specific record being acted upon. |
|
Query parameters |
Filters, sorting, pagination, or extended relationships. In some listings, expand can be used to bring related information if the endpoint allows it. |
Swagger reference: GlobalSuite API - Swagger UI
Use cases by functional area
The following examples help understand what business problems the API can solve and which endpoints to review in Swagger to implement each integration.
1. Synchronize the asset inventory from a CMDB or ITSM tool
|
Business objective |
Maintain an updated inventory of assets, categories, dimensions, and dependencies in GlobalSuite without performing recurring manual uploads. |
|
Scenario example |
The IT team maintains servers, applications, or technical services in a CMDB. GlobalSuite needs these assets for risk analysis, BIA, compliance, or reporting. |
|
Recommended flow |
1) Query available catalogs and dimensions. 2) Search if the asset already exists. 3) Create or update the asset. 4) Maintain dependencies and dimensions. 5) Register traceability in the source system. |
|
User benefit |
Reduces inventory duplication, improves data quality, and ensures that risk analysis, continuity, and compliance are based on a common foundation. |
|
Method |
Endpoint |
Indicative use |
|
GET |
/assets |
Query existing assets and avoid duplicates. |
|
POST |
/assets |
Create new assets to be managed in GlobalSuite. |
|
PUT |
/assets/{modelId} |
Update attributes of an existing asset. |
|
GET |
/categories |
Query available asset categories. |
|
GET |
/dimensions |
Query applicable dimensions and levels. |
|
POST |
/assets/{modelId}/dependency/{objectId} |
Create dependencies between assets. |
|
PUT |
/assets/{modelId}/dimensions/{objectId} |
Update asset dimension values. |
|
Recommendation
|
2. Create and update tickets from external tools
|
Business objective |
Connect GlobalSuite with support, audit, compliance, or action management tools so that tickets are created and kept synchronized. |
|
Scenario example |
An external tool detects an incident, finding, or corrective action. The organization wants to manage it in GlobalSuite with responsible parties, evidence, relationships, and tracking. |
|
Recommended flow |
1) Identify the ticket type and its fields. 2) Create the ticket. 3) Associate responsible parties, employees, files, or relationships. 4) Update the ticket when the status changes in the external system. |
|
User benefit |
Allows centralizing tracking in GlobalSuite without requiring teams to manually input information that already exists in other tools. |
|
Method |
Endpoint |
Guidance usage |
|
GET |
/ticketTypes |
Query available ticket types. |
|
GET |
/ticketTypes/{modelId}/fields |
Query configured fields for a ticket type. |
|
GET |
/tickets |
Search existing tickets or query their status. |
|
POST |
/tickets |
Create a new ticket. |
|
PUT |
/tickets/{modelId} |
Update ticket data. |
|
POST |
/tickets/{modelId}/owners/{objectId} |
Associate owners to the ticket. |
|
POST |
/tickets/{modelId}/files |
Attach documentation or evidence to the ticket. |
|
POST |
/tickets/{modelId}/ticketRelations/{objectId} |
Relate the ticket to other records. |
|
Recommendation
|
3. Query risk analysis and automate calculations
|
Business objective |
Extract information from risk analysis or launch calculations from automated processes, for example, to feed reports, audits, or dashboards. |
|
Scenario example |
A team needs to consolidate assets, threats, controls, and risks into a corporate repository or launch a recalculation when key information is updated. |
|
Recommended flow |
1) Identify the analysis. 2) Query included assets. 3) Query related threats, controls, and risks. 4) Execute calculation requests when applicable. 5) Exploit results in reporting. |
|
User benefit |
Improves traceability of the analysis, enables reporting automation, and reduces time in periodic risk reviews. |
|
Method |
Endpoint |
Guidance usage |
|
GET |
/analysis/{modelId}/assets |
Query assets included in an analysis. |
|
GET |
/analysis/{modelId}/controls |
Query controls associated with the analysis. |
|
POST |
/analysis/{modelId}/controls |
Add controls to the analysis if applicable. |
|
POST |
/analysis/{modelId}/assets/{assetId}/threats/{threatId}/calculateRequest |
Request calculation associated with a threat. |
|
POST |
/analysis/{modelId}/calculateThreatSimulationRequest |
Launch a threat simulation. |
|
POST |
/analysis/{modelId}/calculateControlSimulationRequest |
Launch a control simulation. |
|
GET |
/analysisCatalogs/{modelId}/threats/{threatId}/controls |
Query catalog controls associated with threats. |
|
Recommendation
|
4. Consolidate BIA results and impact calculations
|
Business objective |
Automate calculations related to business continuity, such as accumulated MTPD or impacted RTO, based on criteria configured in GlobalSuite. |
|
Scenario example |
The organization needs to recalculate impacts after changes in processes, assets, or dependencies, or consolidate results for continuity reporting. |
|
Recommended flow |
1) Verify BIA configuration and calculation criteria. 2) Send the corresponding calculation request. 3) Review the result in GlobalSuite and associated reports. |
|
User benefit |
Helps keep continuity indicators updated without relying solely on manual reviews. |
|
Method |
Endpoint |
Guidance usage |
|
POST |
/calculateAccumulatedMtpd |
Calculate accumulated MTPD. |
|
POST |
/calculateImpactedMtpd |
Calculate impacted MTPD. |
|
POST |
/calculateImpactedRto |
Calculate impacted RTO. |
|
Recommendation
|
5. Synchronize processes, services, and business relationships
|
Business objective |
Connect the process and service map of GlobalSuite with corporate inventories, service catalogs, or enterprise architecture repositories. |
|
Scenario example |
The business area maintains processes and services in a corporate tool, but GlobalSuite needs them for continuity, risks, compliance, and dashboards. |
|
Recommended flow |
1) Query existing processes and services. 2) Create or update basic information when applicable. 3) Maintain employees, stakeholders, inputs, actions, and outputs. 4) Consolidate metrics into reporting. |
|
User benefit |
Facilitates a common vision between service management, continuity, risks, and executive reporting. |
|
Method |
Endpoint |
Guidance usage |
|
GET |
/processes |
Query business processes. |
|
GET |
/processes/{modelId} |
Consult the details of a process. |
|
GET |
/processes/{modelId}/employees |
Consult employees associated with the process. |
|
GET |
/processes/{modelId}/inputActionOutput |
Consult inputs, actions, and outputs of the process. |
|
GET |
/services |
Consult services. |
|
POST |
/services |
Create services. |
|
PUT |
/services/{modelId} |
Update service data. |
|
Recommendation
|
6. Maintain suppliers, agreements, services, and SLAs
|
Business objective |
Integrate GlobalSuite's supplier management with procurement tools, TPRM, due diligence, or third-party master systems. |
|
Scenario example |
Procurement maintains the supplier master, while GlobalSuite manages risks, evidence, agreements, contacts, affected services, and tracking. |
|
Recommended flow |
1) Search or create supplier. 2) Maintain contacts and agreements. 3) Associate services and SLAs. 4) Attach documentation. 5) Register tracking traces. |
|
User benefit |
Allows connecting third-party governance, procurement, and operational risk, preventing teams from maintaining supplier data in separate silos. |
|
Method |
Endpoint |
Guided use |
|
GET |
/suppliers |
Consult existing suppliers. |
|
POST |
/suppliers |
Create a supplier. |
|
PUT |
/suppliers/{modelId} |
Update supplier information. |
|
GET |
/suppliers/{modelId}/agreements |
Consult supplier agreements. |
|
POST |
/suppliers/{modelId}/contacts |
Create associated contacts. |
|
POST |
/suppliers/{modelId}/files |
Attach documentation. |
|
GET |
/suppliers/{modelId}/services |
Consult related services. |
|
POST |
/suppliers/{modelId}/slas |
Create supplier SLAs. |
|
POST |
/suppliers/{modelId}/tracings |
Register follow-ups or traces. |
|
Recommendation
|
7. Manage evidence and compliance from external repositories
|
Business objective |
Automate the upload or update of evidence and its association with controls, roles, or responsible employees. |
|
Scenario example |
A document repository, audit tool, or compliance solution generates evidence that must be linked to controls managed in GlobalSuite. |
|
Recommended flow |
1) Consult evidence types. 2) Create or update evidence. 3) Attach files if necessary. 4) Associate evidence with controls and responsible parties. 5) Review traceability and permissions. |
|
User benefit |
Improves audit preparation and reduces the loss of evidence scattered in folders or disconnected tools. |
|
Method |
Endpoint |
Guided use |
|
GET |
/evidenceTypes |
Consult evidence types. |
|
GET |
/evidences |
Search existing evidence. |
|
POST |
/evidences |
Create evidence. |
|
PUT |
/evidences/{modelId} |
Update evidence. |
|
POST |
/evidences/{modelId}/files |
Attach files to evidence. |
|
POST |
/evidences/{modelId}/controls/{objectId} |
Associate evidence with a control. |
|
POST |
/evidences/{modelId}/roles/{objectId}/employees/{employeeId} |
Assign employees to roles related to the evidence. |
|
Recommendation
|
8. Maintain users, employees, and roles aligned
|
Business objective |
Ensure that people and roles used in GlobalSuite are aligned with corporate identity or human resources sources. |
|
Scenario example |
HR or IAM maintains employee additions, removals, and changes. GlobalSuite needs this data for responsible parties, permissions, filters, approvals, or assignments in functional modules. |
|
Recommended flow |
1) Consult existing employees and users. 2) Create or update records. 3) Review roles and assignments. 4) Manage removals in a controlled manner. |
|
User benefit |
Prevents misalignments between real people, functional managers, and users registered in GlobalSuite. |
|
Method |
Endpoint |
Guided use |
|
GET |
/users |
Consult application users. |
|
POST |
/users |
Create users if the defined flow allows it. |
|
PUT |
/users/{modelId} |
Update user data. |
|
GET |
/employees |
Consult employees. |
|
POST |
/employees |
Create employees. |
|
PUT |
/employees/{modelId} |
Update employee data. |
|
GET |
/configRoles |
Consult configured roles. |
|
Recommendation
|
Recommended design for integration
To move from a use case to a stable integration, an incremental approach is recommended:
-
Define the functional objective: what data you want to consult, create, update, or relate and why it adds value to the process.
-
Identify the master system for each data: for example, CMDB for technical assets, procurement for suppliers, or IAM for users.
-
Review the model in Swagger: mandatory fields, parameters, response examples, errors, and available relationships.
-
Prepare data mapping: equivalences between fields from the source system and GlobalSuite fields, including catalogs, dimensions, and configurable values.
-
Validate permissions and scope of the API Key: entity, sub-entity, validity, allowed operations, and visible data.
-
Test with a reduced subset: few records, demo environment, and functional validation by key users.
-
Incorporate technical controls: pagination, retries, treatment of errors 403/429, logs, and integration alerts.
-
Document the integration: responsible party, frequency, used endpoints, deduplication rules, master system, and procedure for errors.
|
Recommended pattern
|
Best practices for exploitation
|
Practice |
Why it is important |
|
One API Key per integration |
Facilitates traceability, revocation, and limit control. Avoid reusing the same key for processes with different purposes. |
|
Periodic key rotation |
Plan renewal before the expiration date to avoid interruptions. |
|
Rate limit control |
Group calls, paginate correctly, and space batch processes to not exceed 180 calls per minute per API Key. |
|
Do not automate DELETE without validation |
Deletions or disassociations should require additional controls or approval flows. |
|
Register traceability |
Log what was sent, when, through which endpoint, and what the response was. |
|
Design deduplication rules |
Before creating records, search for matches using functional identifiers. |
|
Validate catalogs and configuration |
Do not assume that categories, fields, dimensions, or ticket types are the same for all clients. |
|
Manage business errors |
Distinguish authentication errors, permissions, limits, data validation, and resources not found. |
Map of functional areas and endpoints
The following table summarizes the functional areas identified in the commercial guide and shows examples of endpoints that can be reviewed in Swagger. It is not an exhaustive catalog of parameters or responses.
|
Functional area |
No. ops. |
Endpoint examples |
|
Users and account security |
5 |
GET /users, POST /users, GET /users/{modelId}, DELETE /users/{modelId}... |
|
Tickets |
28 |
GET /tickets, POST /tickets, GET /tickets/{modelId}, PUT /tickets/{modelId}... |
|
Assets (inventory) |
32 |
GET /assetAttributes, GET /assetAttributes/{modelId}, GET /assets, POST /assets... |
|
Risk analysis |
23 |
GET /analysis/{modelId}/assets, POST /analysis/{modelId}/assets/{assetId}/controls/{controlId}/calculateRequest, POST /analysis/{modelId}/assets/{assetId}/threats/{threatId}/calculateRequest, GET /analysis/{modelId}/assets/{assetId}/threats/{threatId}/controls... |
|
BIA, surveys, and impact calculations |
3 |
POST /calculateAccumulatedMtpd, POST /calculateImpactedMtpd, POST /calculateImpactedRto |
|
Processes, services, and consolidation |
12 |
GET /processes, GET /processes/{modelId}, GET /processes/{modelId}/employees, GET /processes/{modelId}/inputActionOutput... |
|
Employees and roles |
12 |
GET /configRoles, GET /employees, POST /employees, GET /employees/{modelId}... |
|
Companies |
5 |
POST /companies/copyCompany, GET /companies/{modelId}/analysis, PUT /companies/{modelId}/analysis, GET /companies/{modelId}/roles... |
|
ENS compliance and evaluations |
17 |
PUT /controls/{modelId}, GET /evidenceTypes, GET /evidences, POST /evidences... |
|
Dashboards |
1 |
GET /dashboard/{modelId}/updatedDate/{objectId} |
|
Reports, metrics, and projects |
1 |
DELETE /testplans/{modelId}/processes/{objectId} |
|
Suppliers |
30 |
GET /suppliers, POST /suppliers, PUT /suppliers/{modelId}, GET /suppliers/{modelId}... |
|
Catalogs and risk tree |
1 |
GET /risks |
|
Configuration, methodology, and rules |
11 |
GET /connectionsPrefixes, GET /controlLevels, GET /controlLevels/{modelId}, GET /methodologies/{modelId}... |
Help and references
-
Swagger documentation should be the final reference for mandatory parameters, request body structure, responses, and errors.
-
Before using the API, it is advisable to review the GlobalSuite User Manual to understand the functional logic of the module to be integrated.
-
If an endpoint does not respond as expected, first validate API Key, environment, entity/sub-entity, permissions, rate limit, and test data.
-
For questions or issues, channel the query through the provider or the GlobalSuite Customer Support Center.
Reference links: