---
title: "EAM API"
url: "https://apiportal-ppd.np.six-group.com/apis/eam-public-v1-api-az-ch-preprod-v1/versions/46a433cc-2c51-4d40-83e4-c9868fcbc0b0"
---

# EAM API

OpenAPI specification document.

```json
{"openapi":"3.1.0","info":{"title":"EAM API","description":"EAM Abstraction Layer REST API.\nConsumers must apply the Tolerant Reader rule: ignore unknown response fields\nand handle unknown vocabulary values gracefully (store and forward as-is).\nError responses follow the SIX Group REST API Guidelines.\n","contact":{"email":"Enterprise_Architecture@six-group.com"},"version":"0.0.1"},"servers":[{"url":"https://api-preprod.np.azure.six-group.com:8443/eal/ext/v1"}],"security":[{"bearerAuth":[]}],"tags":[{"name":"Applications"},{"name":"Platforms"},{"name":"TechnicalDebt"}],"paths":{"/applications":{"get":{"tags":["Applications"],"summary":"Get applications from EAM","description":"Returns the list of applications from the EAM system.","operationId":"getApplications","parameters":[{"name":"start","in":"query","description":"Zero-based offset of the first item to return. Defaults to 0 when omitted.","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0,"minimum":0}},{"name":"count","in":"query","description":"Maximum number of items to return. Defaults to 50 when omitted.","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":50,"maximum":200,"minimum":1}},{"name":"includeAll","in":"query","description":"When set to true, returns applications including \"Final\" state. Defaults to false when omitted.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Applications list.","headers":{"traceparent":{"$ref":"#/components/headers/traceparent"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationListResponse"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}},"security":[{"bearerAuth":[]}]}},"/applications/{id}":{"get":{"tags":["Applications"],"summary":"Get application by id","description":"Returns a single application from the EAM system.","operationId":"getApplicationById","parameters":[{"name":"id","in":"path","description":"Application business identifier.","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Application details.","headers":{"traceparent":{"$ref":"#/components/headers/traceparent"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApplicationItem"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"description":"Resource not found.","headers":{"traceparent":{"$ref":"#/components/headers/traceparent"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"$ref":"#/components/responses/InternalServerError"}},"security":[{"bearerAuth":[]}]}},"/platforms":{"get":{"tags":["Platforms"],"summary":"Get platforms from EAM","description":"Returns the list of platforms from the EAM system.","operationId":"getPlatforms","parameters":[{"name":"start","in":"query","description":"Zero-based offset of the first item to return. Defaults to 0 when omitted.","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":0,"minimum":0}},{"name":"count","in":"query","description":"Maximum number of items to return. Defaults to 50 when omitted.","required":false,"style":"form","explode":true,"schema":{"type":"integer","format":"int32","default":50,"maximum":200,"minimum":1}},{"name":"includeAll","in":"query","description":"When set to true, returns platforms including \"Final\" state. Defaults to false when omitted.","required":false,"style":"form","explode":true,"schema":{"type":"boolean","default":false}}],"responses":{"200":{"description":"Platforms list.","headers":{"traceparent":{"$ref":"#/components/headers/traceparent"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformListResponse"}}}},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"500":{"$ref":"#/components/responses/InternalServerError"}},"security":[{"bearerAuth":[]}]}}},"components":{"schemas":{"ApplicationStakeholderNominations":{"type":"object","properties":{"appITOwnerPrimary":{"type":"string","description":"Primary IT owner (SIX username, must start with tk/tx and be exactly 5 characters).","maxLength":5,"minLength":5},"appITOwnerDeputy":{"type":["string","null"],"description":"Deputy IT owner (SIX username, must start with tk/tx and be exactly 5 characters).","maxLength":5,"minLength":5},"appITArchitectPrimary":{"type":["string","null"],"description":"Primary IT architect (SIX username, must start with tk/tx and be exactly 5 characters).","maxLength":5,"minLength":5},"appITManagerPrimary":{"type":"string","description":"Primary IT manager (SIX username, must start with tk/tx and be exactly 5 characters).","maxLength":5,"minLength":5},"appITManagerDeputy":{"type":["string","null"],"description":"Deputy IT manager (SIX username, must start with tk/tx and be exactly 5 characters).","maxLength":5,"minLength":5},"appBusinessOwnerPrimary":{"type":["string","null"],"description":"Primary Business Owner (SIX username, must start with tk/tx and be exactly 5 characters).","maxLength":5,"minLength":5},"appBusinessOwnerDeputy":{"type":["string","null"],"description":"Deputy Business Owner (SIX username, must start with tk/tx and be exactly 5 characters).","maxLength":5,"minLength":5}},"required":["appITManagerPrimary","appITOwnerPrimary"]},"ApplicationLifecycle":{"type":"object","properties":{"status":{"type":"string","description":"Lifecycle status of the application.","maxLength":8,"minLength":7,"x-extensible-enum":["PROPOSED","PLANNED"]},"date":{"type":"string","format":"date","description":"ISO 8601 UTC date (e.g. YYYY-MM-DD) of the lifecycle status."}}},"TechnicalDebtListResponse":{"type":"object","description":"Paginated list of technical debt entries.","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/TechnicalDebtItem"}},"total":{"type":"integer","description":"Total number of matching records in EAM."}},"required":["items","total"]},"TechnicalDebtItem":{"type":"object","description":"A single technical debt entry (Essential Issue class).","properties":{"name":{"type":"string","description":"Name."},"description":{"type":["string","null"],"description":"Description."},"businessId":{"type":["string","null"],"description":"Business identifier of the Technical Debt."},"lifecycleStatus":{"type":["string","null"],"description":"Current lifecycle status.","x-extensible-enum":["Draft","In Review","Approved","Closed"]},"requiredFromDate":{"type":["string","null"],"description":"ISO 8601 date from which this requirement applies."},"owningApplicationOrPlatform":{"type":"array","description":"EA references of applications or platforms this requirement applies to.","items":{"type":"string"}},"rootCauses":{"type":"array","description":"EA references of applications or platforms that are root causes.","items":{"type":"string"}},"yearlyInactionCosts":{"type":"array","description":"Cost totals grouped by currency for costs_for_element nested entries.","items":{"$ref":"#/components/schemas/TechnicalDebtCost"}},"remediationCosts":{"allOf":[{"$ref":"#/components/schemas/TechnicalDebtCost"}],"description":"Cost total and currency resolved from sr_cost_estimate nested entries."},"risks":{"type":"array","description":"Associated risks.","items":{"$ref":"#/components/schemas/TechnicalDebtRisk"}},"consequencesOfInaction":{"type":"array","description":"Consequences if this technical debt is not resolved.","items":{"type":"string"}},"priorityScore":{"type":["number","null"],"format":"double","description":"Priority score."},"strategicRelevance":{"type":["string","null"],"description":"Relevance indicator."},"priorityClass":{"type":["string","null"],"description":"Priority class."}},"required":["name"]},"PaginationMeta":{"type":"object","properties":{"page":{"type":"integer","description":"Current page index (0-indexed)."},"pageSize":{"type":"integer"},"totalCount":{"type":"integer"},"totalPages":{"type":"integer"}},"required":["page","pageSize","totalCount","totalPages"]},"TechnicalDebtCost":{"type":"object","description":"Cost information for a technical debt entry.","properties":{"totalCost":{"type":["number","null"],"format":"double","description":"Total cost amount."},"currency":{"type":["string","null"],"description":"Currency code (e.g. CHF, EUR)."}}},"TechnicalDebtRisk":{"type":"object","description":"A risk associated with a technical debt entry.","properties":{"name":{"type":["string","null"],"description":"Risk name."},"description":{"type":["string","null"],"description":"Risk description."},"impact":{"type":["string","null"],"description":"Risk impact level."},"likelihood":{"type":["string","null"],"description":"Risk likelihood."},"riskCategory":{"type":["string","null"],"description":"Risk category."}}},"ApplicationListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ApplicationItem"}},"pagination":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","pagination"]},"ApplicationItem":{"type":"object","properties":{"businessKey":{"type":"string"},"name":{"type":"string"},"longName":{"type":"string"},"description":{"type":"string"},"criticality":{"type":"string"},"biaCriticality":{"type":"string"},"currentLifecycle":{"type":"string"},"owningOrganization":{"type":"string"},"majorDeploymentModel":{"type":["string","null"],"description":"Primary deployment model.","x-extensible-enum":["On-Premises","On-Premises outsourced","Private Cloud Service","Public Cloud IaaS","Hybrid Cloud Service","Public Cloud PaaS","Managed Service","Public Cloud Service","SaaS","Business Service","External Application"]},"stakeholders":{"$ref":"#/components/schemas/EamStakeholder"},"connectsToCde":{"type":"boolean"},"containsPan":{"type":"boolean"},"massCid":{"type":"boolean"},"availability":{"type":"string"},"integrity":{"type":"string"},"rto":{"type":"string"},"rpo":{"type":"string"},"applicationDomain":{"type":"array","items":{"$ref":"#/components/schemas/EamBusinessKeyRef"}},"deploymentLocation":{"type":"array","items":{"$ref":"#/components/schemas/EamBusinessKeyRef"}},"containedRegulatedData":{"type":"array","items":{"$ref":"#/components/schemas/EamNameRef"}},"privacy":{"type":"string"},"confidentiality":{"type":"string"},"applicationComponent":{"type":"array","items":{"$ref":"#/components/schemas/EamBusinessKeyRef"}},"firewallAsset":{"type":"array","items":{"$ref":"#/components/schemas/EamBusinessKeyRef"}},"itService":{"type":"array","items":{"$ref":"#/components/schemas/EamBusinessKeyRef"}},"categorization":{"type":"array","items":{"$ref":"#/components/schemas/EamBusinessKeyRef"}}}},"PlatformListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PlatformItem"}},"pagination":{"$ref":"#/components/schemas/PaginationMeta"}},"required":["data","pagination"]},"PlatformItem":{"type":"object","properties":{"businessKey":{"type":"string"},"name":{"type":"string"},"longName":{"type":"string"},"description":{"type":"string"},"lifecyclePhase":{"type":"string"},"stakeholders":{"$ref":"#/components/schemas/EamStakeholder"},"platformDomain":{"type":"array","items":{"$ref":"#/components/schemas/EamBusinessKeyRef"}}}},"EamBusinessKeyRef":{"type":"object","properties":{"businessKey":{"type":"string"},"name":{"type":"string"}}},"EamNameRef":{"type":"object","properties":{"name":{"type":"string"}}},"EamUser":{"type":"object","properties":{"roleName":{"type":"string"},"name":{"type":"string"},"emailAddress":{"type":"string"},"userId":{"type":"string"}}},"EamSupportGroup":{"type":"array","items":{"type":"object","properties":{"roleName":{"type":"string"},"name":{"type":"string"},"businessKey":{"type":"string"}}}},"EamSupportMailbox":{"type":"array","items":{"type":"object","properties":{"roleName":{"type":"string"},"name":{"type":"string"}}}},"EamGovernanceRole":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/EamUser"}},"description":"Governance roles keyed by the EAM role name e.g. appITManagerPrimary, appITManagerDeputy, appITArchitectPrimary, appITArchitectDeputy, appITOwnerPrimary, appITOwnerDeputy, appITOperatorPrimary, appITOperatorDeputy, appBusOwnerPrimary, appBusOwnerDeputy, appBusManagerPrimary, appBusManagerDeputy, appITDomainOwnerPrimary, appITDomainOwnerDeputy, appITDomainArchitectPrimary, appITDomainArchitectDeputy, businessServiceOwnerPrimary, businessServiceOwnerDeputy, platformManagerPrimary, platformManagerDeputy, platformArchitectPrimary, platformArchitectDeputy, platformOwnerPrimary, platformOwnerDeputy, platformOperatorPrimary, platformOperatorDeputy, platformDomainOwnerPrimary, platformDomainOwnerDeputy, platformDomainArchitectPrimary, platformDomainArchitectDeputy, softwareManagerPrimary, softwareManagerDeputy."},"EamStakeholder":{"type":"object","properties":{"governanceRole":{"$ref":"#/components/schemas/EamGovernanceRole"},"supportGroup":{"$ref":"#/components/schemas/EamSupportGroup"},"supportMailbox":{"$ref":"#/components/schemas/EamSupportMailbox"},"subjectMatterExpert":{"type":"array","items":{"$ref":"#/components/schemas/EamUser"}}}},"ErrorResponse":{"type":"object","description":"Canonical error payload as defined in the SIX Group REST API Guidelines.","properties":{"timestamp":{"type":"string","format":"date-time","description":"ISO 8601 UTC timestamp of when the error was produced."},"status":{"type":"integer","description":"HTTP status code (RFC 7231 6)."},"code":{"type":"string","description":"Machine-readable application-specific error code (e.g. RESOURCE_NOT_FOUND)."},"message":{"type":"string","description":"Human-readable summary of the problem."},"path":{"type":["string","null"],"description":"Request path that produced the error. Optional."},"traceId":{"type":["string","null"],"description":"W3C trace ID (32-char lowercase hex) for correlation."},"invalidParams":{"type":"array","description":"Parameters whose values failed validation. Omitted when empty.","items":{"$ref":"#/components/schemas/InvalidParam"}}},"required":["message","status","timestamp"]},"InvalidParam":{"type":"object","properties":{"in":{"type":"string","description":"Location of the invalid parameter.","enum":["BODY","PATH","QUERY","HEADER"]},"name":{"type":"string","description":"Name of the invalid parameter."},"reason":{"type":"string","description":"Why the parameter value is invalid."},"value":{"type":["string","null"],"description":"The rejected value. May be null when unsafe to echo back."}},"required":["in","name","reason"]}},"responses":{"ValidationError":{"description":"Request body or parameter validation failed.","headers":{"traceparent":{"$ref":"#/components/headers/traceparent"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthenticated":{"description":"Missing or invalid credentials.","headers":{"traceparent":{"$ref":"#/components/headers/traceparent"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"State conflict (e.g. duplicate resource name).","headers":{"traceparent":{"$ref":"#/components/headers/traceparent"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"UnsupportedMediaType":{"description":"Request Content-Type is not supported.","headers":{"traceparent":{"$ref":"#/components/headers/traceparent"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"UnprocessableEntity":{"description":"Request is well-formed but contains an unrecognized vocabulary value (e.g. unknown status).","headers":{"traceparent":{"$ref":"#/components/headers/traceparent"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The caller does not have permission to access this resource.","headers":{"traceparent":{"$ref":"#/components/headers/traceparent"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InternalServerError":{"description":"An unexpected server-side error occurred.","headers":{"traceparent":{"$ref":"#/components/headers/traceparent"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"headers":{"traceparent":{"description":"W3C Trace Context traceparent header. Include in all downstream calls and log entries.","style":"simple","explode":false,"schema":{"type":"string"}}},"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}}}
```