{"openapi":"3.0.0","info":{"title":"5GFF MEC Exposure & Experience Management API","version":"1.2.0","description":"# Introduction\n---\n\nUse 5GFF's RESTful API for discovery and utilisation of Multi-Access Edge Compute (MEC) \nresources and services. \nFind out more about accelerated MEC development with 5GFF [here](link_to_5GFF_here).\n\n---\n# API Scope\n\n---\n\nAPIs defined in this version of the specification can be categorized into the following areas:\n\n* __MEC Edge Discovery__ - discovery of optimal MEC platforms\n* __MEC Service Discovery__ - discovery of optimal Service Endpoints for client connections\n* __MEC Service Profile management__ - register, retrieve, update, and delete MEC Service Profiles\n* __MEC Service Endpoint management__ - register one or more Service Endpoints, and retrieve, update, and delete those registrations\n* __MEC Edge Event notification__ - subscription management for MEC and Service discovery Event notifications\n\n---\n# Definitions\n---\nThis section provides definitions of terminologies commonly referred to throughout the API descriptions.\n\n* __API Consumer__ - A user or an application consuming the MEC Exposure and Experience Management APIs. \n* __Application Service Provider__ - the developer/publisher who deploys applications on MEC platforms.\n* __Density__ - Minimum 4G/5G subscriber density in a geographical area, represented as the number of subscribers per square kilometer.\n* __Edge Application__ - A cloud application that has some services deployed to MEC Platforms to take advantage of low latency and high bandwidth when interacting with devices.\n* __Edge Discovery Service (EDS)__ - MEC Exposure and Experience Management APIs exposed as a service by a TSP.\n* __Edge Resource__ - An object defined by the sevice provider representing an edge resource within its network domain, such as a MEC Platform.\n* __Event__ - A MEC event is triggered if the previously-discovered MEC platform is no longer the optimal choice of all available MEC platforms, due to a change in the underlying network or MEC infrastructure. The TSP will send out change notifications to API Consumers who have active subscription to the event notification. \n* __MEC  Platform__ - A collection of cloud computing resources housed in a TSP's network facility that provide Multi-access Edge Computing (MEC) capabilities.    \n* __Optimal MEC  Platforms__ - A list of one or more optimal MEC Platforms to register a Service Endpoint, based on the latency and availability of each MEC platform, and optionally also based on various query criteria (Service Profile, Region, subscriber density or UE identity) defined by the API Consumer.      \n* __Optimal MEC Service Endpoints__ – A list of one or more MEC Service Endpoints that provide optimal user experience to the client device, based on internal network conditions known to the MEC Platform, and also optionally based on various query criteria (Service Profile, Region, subscriber density or UE identity) defined by the API Consumer. \n* __Region__ - A TSP-defined string identifier representing a certain geographical or logical area where MEC resources and services are provided.\n* __Registered MEC Hosted Services__ - Applications running on MEC platforms which are registered with Edge Discovery Service using the service registry APIs.\n* __Service Endpoint__ - The routable endpoint of the service(s) within a deployed application that clients connect to, where a service is a subcomponent of application    \n* __Service Profile__ - Information about the MEC application and the associated service characteristics.\n* __TSP__ - Telecommunications Service Provider.      \n* __UEIdentity__ - User Equipment identity, which can be a device's IP address, MSISDN, IMEI, MDN, or GPSI.\n* __Zone__ - A logical collection of MEC Platforms in a telecommunication provider's network. A Zone is part of a Region.\n  \n---\n# Link relationships\n---\n\n__REGIONS__\n* __All-regions__  list all regions\n\n__ZONES__\n* __All-zones__  list all available zones\n\n__MEC PLATFORMS__\n* __All-mec-platforms__ list all MEC platforms\n* __Optimal-MECPlatforms-by-density__ return the optimal MEC platform for a given subscriber density\n* __Optimal-MECPlatforms-by-service-profile__ return the optimal MEC platform for a given service profile\n* __Optimal-MECPlatforms-by-UE__ return the optimal MEC platform for a given UE identifier\n* __Optimal-MECPlatforms-by-region__ return the optimal MEC platform for a given region\n* __Optimal-MECPlatforms-by-zone__ return the optimal MEC platform for a given zone\n\n__Service Endpoints__\n* __All-service-endpoints__ list all Service Endpoints\n* __Register-service-endpoint__ Register a Service Endpoint     \n* __Update-service-endpoint__ Update a Service Endpoint\n* __Delete-service-endpoint__ Delete a Service Endpoint\n* __Optimal-service-endpoints-by-zone__ return the optimal Service Endpoints associated with the specified Zone\n* __Optimal-service-endpoints-by-region__ return the optimal Service Endpoints associated with the specified Region\n* __Optimal-service-endpoints-by-service-profile__ return the optimal Service Endpoints associated with the specified Service Profile\n\n__SERVICE PROFILES__\n* __All-service-profiles__ list all Service Profiles\n* __Create-service-profile__ create a new Service Profile\n* __Update-service-profiles__ Update a Service Profiles\n* __Delete-service-profile__ Delete a Service Profile based on ID  \n\n__EVENTS AND SUBSCRIPTIONS__\n* __All-events__ list all events\n* __All-subscriptions__ list all subscriptions\n* __Create-subscription__ create a subscription for Edge Discovery and workload discovery events\n* __Update-subscription__ Update a subscription for Edge Discovery and workload discovery events\n* __Delete-subscription__ Delete a subscription for Edge Discovery and workload discovery events\n\n__COMMON__\n* __Self__ the self-referring URI for the response\n* __Version-History__ link to version history for this API\n* __Terms-of-Service__ link The Terms of Service for this API\n* __Bookmark__ link to the API bookmark\n\n---\n# Security and resilience\n---\n* __Authentication:__ API requests are made with the API Consumer's unique key\n* __Integrity:__ APIs requests, responses and callbacks are made using HTTP over TLS 1.3 (HTTPS)\n* __Consent to access resources__ is brokered via OAuth2.0 with implicit, password and client credentials grant flows\n* __Replay errors__ are mitigated through use of request correlator IDs.\n---\n# Useful links\n---\n","termsOfService":"http://5gff/terms/","license":{"name":"BSD-3-Clause","url":"https://5gff.com/legal"},"contact":{"email":"admin@5gff.com"},"x-logo":{"url":"/swagger/mexdemo/logo.svg","backgroundColor":"#fafafa","version":"1.0"}},"externalDocs":{"description":"5GFF homepage","url":"https://5gff.com"},"security":[{"oAuth2":["edge:discovery:read","edge:serviceprofile:read","edge:serviceprofile:write","edge:serviceregistry:read","edge:serviceregistry:write"]}],"servers":[{"url":"http://localhost:{port}/v1","description":"Local host API","variables":{"port":{"enum":["3333"],"default":"3333"}}},{"url":"https://edge.5gff.com:{port}/v1","description":"Production API","variables":{"port":{"enum":["443","8443"],"default":"443"}}},{"url":"https://{region}.edge.5gff.com:{port}/v1","description":"Production API for Regions","variables":{"region":{"default":"east"},"port":{"enum":["443","8443"],"default":"443"}}}],"tags":[{"name":"Discovery","description":"Discover the regions and zones in the MEC service, find optimal MEC Platforms for your deployed applications, and optimal service endpoints for your clients to connect to.\n"},{"name":"Service Endpoints","description":"Register and manage the routable Service Endpoints of your deployed applications.\n"},{"name":"Service Profiles","description":"Create and manage profiles that describe the service requirements of your MEC applications, such as the required connection bandwidth and maximum latency. \n"},{"name":"Events and Subscriptions","description":"Subscribe to event notification callbacks to monitor platform and workload events and retrieve event details.\n"}],"paths":{"/":{"get":{"responses":{"200":{"description":"List of top-level resources and their links","content":{"application/json":{"schema":{"title":"GetResourcesResponse","type":"object","properties":{"resources":{"$ref":"#/components/schemas/resources"},"links":{"$ref":"#/components/schemas/links_Common"}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"default":{"$ref":"#/components/responses/Unexpected"}},"tags":["Discovery"],"operationId":"bookmark","summary":"List the links to the top-level resources of this API","description":"List the top level resources available from the API bookmark and the links to reach them"}},"/serviceprofiles":{"post":{"operationId":"create-service-profile","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resources_service_profile"}}},"description":"service profile"},"responses":{"201":{"description":"service profile ID","content":{"application/json":{"schema":{"title":"PostServiceProfileResponse","type":"object","properties":{"serviceProfileId":{"$ref":"#/components/schemas/types_service_profile_Id"},"links":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/links_Update-service-profile"},{"$ref":"#/components/schemas/links_Delete-service-profile"},{"$ref":"#/components/schemas/links_Common"}]}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"default":{"$ref":"#/components/responses/Unexpected"}},"tags":["Service Profiles"],"summary":"Create a service profile","description":"Creates a service profile that describes the resource requirements of a service."},"get":{"operationId":"get-service-profiles","responses":{"200":{"description":"List all service profiles registered under your API key","content":{"application/json":{"schema":{"title":"GetServiceProfilesResponse","type":"object","properties":{"serviceProfiles":{"type":"array","items":{"$ref":"#/components/schemas/resources_service_profile"}},"links":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/links_Create-service-profile"},{"$ref":"#/components/schemas/links_Common"}]}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"default":{"$ref":"#/components/responses/Unexpected"}},"tags":["Service Profiles"],"summary":"List all service profiles registered under your API key","description":"List all service profiles registered under your API key"}},"/serviceprofiles/{serviceProfileId}":{"parameters":[{"name":"serviceProfileId","in":"path","required":true,"schema":{"type":"string"}}],"get":{"operationId":"get-service-profile-by-profile-Id","summary":"Fetch a service profile","description":"Returns a specified service profile.","responses":{"200":{"description":"Requested service profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/resources_service_profile"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"$ref":"#/components/responses/Unexpected"}},"tags":["Service Profiles"]},"put":{"summary":"Update Service Profile","description":"Update the definition of a Service Profile.","operationId":"update-service-profile","requestBody":{"description":"Service Profile definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/resources_service_profile"}}}},"responses":{"204":{"$ref":"#/components/responses/NoContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"$ref":"#/components/responses/Unexpected"}},"tags":["Service Profiles"]},"delete":{"summary":"Delete a Service Profile","operationId":"delete-service-profile","responses":{"204":{"$ref":"#/components/responses/NoContent"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"$ref":"#/components/responses/Unexpected"}},"description":"Delete Service Profile based on unique service profile ID","tags":["Service Profiles"]}},"/serviceendpoints":{"get":{"operationId":"get-service-endpoints","parameters":[{"$ref":"#/components/parameters/region"},{"$ref":"#/components/parameters/zone"},{"$ref":"#/components/parameters/serviceEndpointsIds"},{"$ref":"#/components/parameters/subscriberDensity"},{"$ref":"#/components/parameters/UEIdentityType"},{"$ref":"#/components/parameters/UEIdentity"}],"responses":{"200":{"description":"Find optimal Service Endpoints for clients to connect to","content":{"application/json":{"schema":{"title":"GetServiceEndpointsResponse","type":"object","properties":{"serviceEndpoints":{"type":"array","items":{"$ref":"#/components/schemas/resources_edge_hosted_service"}},"links":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/links_Register-service-endpoint"},{"$ref":"#/components/schemas/links_Common"}]}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"default":{"$ref":"#/components/responses/Unexpected"}},"tags":["Discovery"],"summary":"Find optimal Service Endpoints for clients to connect to","description":"Returns a list of optimal Service Endpoints that client devices can connect to. You can search based on Service Profile, Region, subscriber density or UEIdentity."},"post":{"operationId":"register-service-endpoints","requestBody":{"description":"Array of Service Endpoints for a deployed application","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/resources_edge_hosted_service"}}}}},"responses":{"201":{"description":"Returns a serviceEndpointsId","content":{"application/json":{"schema":{"title":"PostServiceEndpointResponse","type":"object","properties":{"serviceEndpointsId":{"$ref":"#/components/schemas/types_serviceEndpoints_Id"},"links":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/links_Update-service-endpoint"},{"$ref":"#/components/schemas/links_Delete-service-endpoint"},{"$ref":"#/components/schemas/links_Optimal-service-endpoints-by-service-profile"},{"$ref":"#/components/schemas/links_Common"}]}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"default":{"$ref":"#/components/responses/Unexpected"}},"tags":["Service Endpoints"],"summary":"Register Service Endpoints","description":"Register Service Endpoints of a deployed application to specified MEC Platforms."}},"/serviceendpoints/{serviceEndpointsId}":{"parameters":[{"name":"serviceEndpointsId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/types_serviceEndpoints_Id"}}],"get":{"operationId":"get-service-endpoints-by-serviceEndpointsId","responses":{"200":{"description":"Arry of registered service endpoints","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/resources_edge_hosted_service"}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"$ref":"#/components/responses/Unexpected"}},"tags":["Service Endpoints"],"summary":"Get registered edge service endpoint information","description":"Returns endpoint information for all Service Endpoints registered to a specified serviceEndpointId."},"put":{"operationId":"update-service-endpoint","requestBody":{"description":"Service Endpoint information","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/resources_edge_hosted_service"}}}}},"responses":{"204":{"$ref":"#/components/responses/NoContent"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"$ref":"#/components/responses/Unexpected"}},"tags":["Service Endpoints"],"summary":"Update a Service Endpoint","description":"Update registered Service Endpoint information."},"delete":{"operationId":"deregister-service-endpoint","responses":{"204":{"$ref":"#/components/responses/NoContent"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"$ref":"#/components/responses/Unexpected"}},"tags":["Service Endpoints"],"summary":"Deregister an application's Service Endpoint","description":"Deregister an application's Service Endpoint from the MEC Platform(s)."}},"/events":{"get":{"operationId":"get-events","summary":"List events, optionally filtered by query parameters","parameters":[{"in":"query","name":"eventIds","description":"Event identifiers, delimited by pipe","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/types_event_Id"}},"style":"pipeDelimited","explode":false},{"in":"query","name":"limit","required":false,"schema":{"type":"integer","minimum":1,"maximum":50,"default":20},"description":"The numbers of items to return."},{"in":"query","name":"resourceName","required":false,"schema":{"$ref":"#/components/schemas/types_resource_name"},"description":"resource name to filter data"}],"responses":{"200":{"description":"List of events","content":{"application/json":{"schema":{"title":"GetEvents","type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/resources_event"}}}}}}}},"tags":["Events and Subscriptions"]}},"/events/{eventId}":{"parameters":[{"in":"path","name":"eventId","required":true,"schema":{"$ref":"#/components/schemas/types_event_Id"}}],"get":{"operationId":"get-event-by-Id","summary":"Retrieve an event by event ID","responses":{"200":{"description":"Returns the event object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/resources_event"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"$ref":"#/components/responses/Unexpected"}},"description":"Retrieve single event by event id","tags":["Events and Subscriptions"]}},"/mecplatforms":{"get":{"operationId":"get-mecplatforms","parameters":[{"$ref":"#/components/parameters/region"},{"$ref":"#/components/parameters/zone"},{"$ref":"#/components/parameters/serviceProfileId"},{"$ref":"#/components/parameters/subscriberDensity"},{"$ref":"#/components/parameters/UEIdentityType"},{"$ref":"#/components/parameters/UEIdentity"}],"responses":{"200":{"description":"MEC platforms matching query parameters","content":{"application/json":{"schema":{"title":"GetMECPlatformsResponse","type":"object","properties":{"MECPlatforms":{"type":"array","items":{"$ref":"#/components/schemas/resources_mecplatform"}},"links":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/links_Optimal-MEC-platforms-by-region"},{"$ref":"#/components/schemas/links_Optimal-MEC-platforms-by-density"},{"$ref":"#/components/schemas/links_Optimal-MEC-platforms-by-service-profile"},{"$ref":"#/components/schemas/links_Optimal-MEC-platforms-by-UE"},{"$ref":"#/components/schemas/links_Register-service-endpoint"},{"$ref":"#/components/schemas/links_Common"}]}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"default":{"$ref":"#/components/responses/Unexpected"}},"tags":["Discovery"],"summary":"Discover optimal MEC Platforms for deployed applications","description":"Returns a list of optimal MEC Platforms where you can register your deployed application. You can choose to search without passing any of the inputs paramaters or a combination of Service Profile, Region, subscriber density or UEIdentity."}},"/regions":{"get":{"operationId":"get-regions","responses":{"200":{"description":"List of the supported geographical regions","content":{"application/json":{"schema":{"title":"GetRegionsResponse","type":"object","properties":{"regions":{"type":"array","items":{"$ref":"#/components/schemas/resources_region_metadata"}},"links":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/links_Optimal-MEC-platforms-by-region"},{"$ref":"#/components/schemas/links_Optimal-service-endpoints-by-region"},{"$ref":"#/components/schemas/links_Common"}]}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"default":{"$ref":"#/components/responses/Unexpected"}},"tags":["Discovery"],"summary":"List the geographical regions supported, and the associated zones","description":"List the geographical regions supported and the zones within each"}},"/regions/{regionId}":{"parameters":[{"in":"path","name":"regionId","required":true,"schema":{"$ref":"#/components/schemas/types_region_Id"}}],"get":{"operationId":"get-region","responses":{"200":{"description":"Details of a region","content":{"application/json":{"schema":{"$ref":"#/components/schemas/resources_region"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"$ref":"#/components/responses/Unexpected"}},"tags":["Discovery"],"summary":"Fetch details for a region","description":"Fetch details for a region"}},"/subscriptions":{"get":{"operationId":"get-subscriptions","summary":"List event subscriptions registered under your API key","parameters":[{"in":"query","name":"userId","required":false,"schema":{"$ref":"#/components/schemas/types_user_Id"},"style":"form","explode":true},{"in":"query","name":"type","required":false,"schema":{"$ref":"#/components/schemas/types_subscription"}}],"responses":{"200":{"description":"Returns list of subscriptions by the user ID","content":{"application/json":{"schema":{"title":"GetSubscriptionsResponse","type":"object","properties":{"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/resources_subscription"}},"links":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/links_Create-subscription"},{"$ref":"#/components/schemas/links_Update-subscription"},{"$ref":"#/components/schemas/links_Delete-subscription"},{"$ref":"#/components/schemas/links_Common"}]}}}}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"$ref":"#/components/responses/Unexpected"}},"description":"Retrieve events subscription by user","tags":["Events and Subscriptions"]},"post":{"operationId":"create-subscription","summary":"Subscribe to notifications of specific edge events","responses":{"201":{"description":"Returns a subscription identifier","content":{"application/json":{"schema":{"$ref":"#/components/schemas/resources_subscription"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"$ref":"#/components/responses/Unexpected"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resources_subscription"}}}},"callbacks":{"onData":{"{$request.body.callbackUrl}/data":{"post":{"requestBody":{"description":"edge event notification payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/types_notification"}}}},"responses":{"202":{"description":"Event notification receiver implementation should return this HTTP status code\nif the data was received successfully\n"},"204":{"description":"Event notification receiver should return this HTTP status code if no longer interested\nin further updates\n"}}}}}},"description":"Subscribe to list of edge events","tags":["Events and Subscriptions"]}},"/subscriptions/{subscriptionId}":{"parameters":[{"schema":{"type":"string"},"name":"subscriptionId","in":"path","required":true}],"get":{"operationId":"get-subscription-by-Id","summary":"Retrieve a specified subscription","responses":{"200":{"description":"The subscription object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/resources_subscription"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"$ref":"#/components/responses/Unexpected"}},"description":"Retrieve events subscription by subscription ID","tags":["Events and Subscriptions"]},"put":{"summary":"Update an events subscription","operationId":"update-event-subscription","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/resources_subscription"}}}},"responses":{"200":{"description":"Event notification subscription updated"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"$ref":"#/components/responses/Unexpected"}},"tags":["Events and Subscriptions"]},"delete":{"summary":"Delete an events subscription","operationId":"delete-event-subscription","responses":{"200":{"description":"Events subscription deleted"},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"$ref":"#/components/responses/Unexpected"}},"tags":["Events and Subscriptions"]}},"/zones":{"get":{"operationId":"get-zones","parameters":[{"$ref":"#/components/parameters/region"}],"responses":{"200":{"description":"Zones matching query parameters","content":{"application/json":{"schema":{"title":"GetZonesResponse","type":"object","properties":{"zones":{"type":"array","items":{"$ref":"#/components/schemas/resources_zone_metadata"}},"links":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/links_Optimal-MEC-platforms-by-region"},{"$ref":"#/components/schemas/links_Optimal-MEC-platforms-by-zone"},{"$ref":"#/components/schemas/links_Optimal-service-endpoints-by-zone"},{"$ref":"#/components/schemas/links_Common"}]}}}}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"default":{"$ref":"#/components/responses/Unexpected"}},"tags":["Discovery"],"summary":"List all zones, or zones within a region","description":"Returns a list of all zones or zones within a specified region."}},"/zones/{zoneId}":{"parameters":[{"schema":{"$ref":"#/components/schemas/types_zone_Id"},"name":"zoneId","in":"path","required":true}],"get":{"operationId":"get-zone-by-Id","summary":"Read the properties of a zone","responses":{"200":{"description":"Representation of the Zone resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/resources_zone"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"},"default":{"$ref":"#/components/responses/Unexpected"}},"description":"Read the properties of a zone","tags":["Discovery"]}}},"components":{"securitySchemes":{"oAuth2":{"type":"oauth2","description":"This API uses OAuth 2 with the implicit, password and client credentials grant flow","flows":{"implicit":{"authorizationUrl":"https://5gff.com/oauth/authorize","scopes":{"discovery:read":"Grant read-only access to discovery data","serviceprofile:read":"Grant read-only access to service profile data","serviceprofile:write":"Grant write access to service profile data","serviceregistry:read":"Grant read-only access to service registry data","serviceregistry:write":"Grant write access to service registry data"}},"password":{"tokenUrl":"https://5gff.com/oauth/token","scopes":{"discovery:read":"Grant read-only access to discovery data","serviceprofile:read":"Grant read-only access to service profile data","serviceprofile:write":"Grant write access to service profile data","serviceregistry:read":"Grant read-only access to Service registry data","serviceregistry:write":"Grant write access to Service registry data"}},"clientCredentials":{"tokenUrl":"https://5gff.com/oauth/token","scopes":{"discovery:read":"Grant read-only access to discovery data","serviceprofile:read":"Grant read-only access to service profile data","serviceprofile:write":"Grant write access to service profile data","serviceregistry:read":"Grant read-only access to Service registry data","serviceregistry:write":"Grant write access to Service registry data"}}}}},"schemas":{"resources":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/links_All-regions"},{"$ref":"#/components/schemas/links_All-zones"},{"$ref":"#/components/schemas/links_All-mec-platforms"},{"$ref":"#/components/schemas/links_All-service-profiles"},{"$ref":"#/components/schemas/links_All-service-endpoints"},{"$ref":"#/components/schemas/links_All-subscriptions"},{"$ref":"#/components/schemas/links_All-events"}]},"additionalProperties":false},"resources_service_profile":{"type":"object","properties":{"serviceProfileId":{"$ref":"#/components/schemas/types_service_profile_Id"},"clientType":{"type":"string","enum":["V2X","ComputerVision","MachineLearning","IoT","Gaming","AR","VR","Analytics","Robotics"],"description":"The category of application client."},"ecspFilter":{"type":"string","description":"identity of the preferred Edge Computing Service Provider"},"clientSchedule":{"type":"string","description":"The expected operation schedule of the application client (e.g. time windows)"},"clientServiceArea":{"type":"string","description":"The expected location(s) (e.g. route) of the hosting UE during the Client's operation schedule."},"networkResources":{"type":"string","description":"network resource name or properties","additionalProperties":{"$ref":"#/components/schemas/types_networkResources"}},"computeResources":{"type":"string","description":"compute resource name or properties","additionalProperties":{"$ref":"#/components/schemas/types_computeResources"}},"properties":{"type":"object","properties":{"type":{"type":"string"},"data":{"type":"object"}}}},"required":["clientType"],"additionalProperties":false},"resources_event":{"description":"A change in MEC Platform or Service Endpoint status","type":"object","properties":{"eventId":{"$ref":"#/components/schemas/types_event_Id"},"resourceName":{"$ref":"#/components/schemas/types_resource_name"},"eventType":{"$ref":"#/components/schemas/types_event_type"},"eventVersion":{"$ref":"#/components/schemas/types_event_version"},"desc":{"description":"An elaborated description of the event","type":"string"}},"additionalProperties":false},"resources_edge_services_registration":{"type":"array","items":{"$ref":"#/components/schemas/resources_edge_service_description"}},"resources_edge_service_description":{"type":"object","properties":{"edgeHostedService":{"$ref":"#/components/schemas/resources_edge_hosted_service"}}},"resources_edge_hosted_service":{"description":"Edge hosted service represented by Service Endpoint definition","type":"object","properties":{"ern":{"$ref":"#/components/schemas/types_edgeResource"},"serviceEndpointsId":{"$ref":"#/components/schemas/types_serviceEndpoints_Id"},"serviceEndpoint":{"$ref":"#/components/schemas/resources_service_endpoint"},"applicationServerProviderId":{"type":"string","description":"Unique ID representing the Edge Application Provider"},"applicationId":{"type":"string","description":"Unique ID representing the Edge Application"},"serviceDescription":{"type":"string","description":"Description of the Service Endpoint","additionalProperties":false},"serviceProfileID":{"$ref":"#/components/schemas/types_service_profile_Id"}}},"resources_service_endpoint":{"type":"object","properties":{"URI":{"type":"string","description":"URI of Service Endpoint if available","format":"uri"},"FQDN":{"type":"string","description":"FQDN of Service Endpoint if available"},"IPv4Address":{"type":"string","description":"IPv4 Address of Service Endpoint if available","format":"ipv4"},"IPv6Address":{"type":"string","description":"IPv6 Address of Service Endpoint if available","format":"ipv6"},"port":{"type":"integer","description":"Port information of Service Endpoint if IPv4 or IPv6 is mentioned\n"}},"additionalProperties":false},"resources_mecplatform":{"type":"object","properties":{"ern":{"$ref":"#/components/schemas/types_edgeResource"},"zone":{"$ref":"#/components/schemas/types_zone_Id"},"region":{"$ref":"#/components/schemas/types_region_Id"},"status":{"description":"Status of the MEC Platform (default is 'unknown')","type":"string","enum":["active","inactive","unknown"],"default":"unknown"},"properties":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"data":{"type":"object"}}}}},"additionalProperties":false},"resources_region":{"allOf":[{"$ref":"#/components/schemas/resources_region_metadata"},{"type":"object","required":["zones"],"properties":{"zones":{"type":"array","items":{"$ref":"#/components/schemas/resources_zone"}}}}],"additionalProperties":false},"resources_region_metadata":{"type":"object","properties":{"regionId":{"$ref":"#/components/schemas/types_region_Id"},"name":{"type":"string"},"countryCode":{"type":"string"},"metro":{"type":"string"},"area":{"type":"string"}},"additionalProperties":false},"resources_subscription":{"description":"Data structure describing a subscription. It is used to subscribe to event notifications, or to update or delete an existing subscription. It is also the subscription infomation returned from querying by subscription identifier.","type":"object","properties":{"subscriptionId":{"$ref":"#/components/schemas/types_subscription_Id"},"subscriptionStatus":{"$ref":"#/components/schemas/types_subscription_status"},"UEList":{"type":"array","items":{"$ref":"#/components/schemas/types_user_Id"}},"events":{"description":"List of events to subscribe","type":"array","items":{"$ref":"#/components/schemas/types_event_type"}},"callback":{"type":"object","properties":{"uri":{"type":"string","format":"uri","description":"Callback URI for sending the subscribed event notifications"},"authRequired":{"type":"boolean"},"authType":{"type":"string","enum":["basicauth","certificate"],"description":"the authorisation type (if required)"},"authProperties":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"},"certificate":{"type":"string"}}}}},"interval":{"description":"Notification interval, subscriber receives no more than 1 notification per interval seconds\nImplementation should impose a minimum interval to avoid flooding\n","type":"integer","format":"int32","nullable":true},"expiry":{"description":"Date and time when this subscription will be expired","type":"string","format":"date-time","nullable":true},"filters":{"description":"Subscriber only receives events matching all of the filtering criteria","type":"object","nullable":true,"properties":{"zones":{"description":"List of zones","type":"array","items":{"$ref":"#/components/schemas/types_zone_Id"}},"regions":{"description":"List of regions","type":"array","items":{"$ref":"#/components/schemas/types_region_Id"}},"density":{"description":"Mobile subscriber density","type":"integer"},"serviceProfileID":{"$ref":"#/components/schemas/types_service_profile_Id"}}}},"additionalProperties":false},"resources_zone":{"allOf":[{"$ref":"#/components/schemas/resources_zone_metadata"},{"type":"object","required":["MECPlatforms"],"properties":{"MECPlatforms":{"type":"array","items":{"$ref":"#/components/schemas/resources_mecplatform"}}}}],"additionalProperties":false},"resources_zone_metadata":{"type":"object","properties":{"zoneId":{"$ref":"#/components/schemas/types_zone_Id"},"regionId":{"$ref":"#/components/schemas/types_region_Id"}},"additionalProperties":false},"types_edgeResource":{"description":"An object defined by the service provider representing an edge resource within its network domain, such as a MEC Platform.  The string contains colon-separated metadata in the form   ern:<tsp-identifier>:<tsp-region>:<resource-type>:<resource-identifier>:<tsp-extensions>\n","type":"string","additionalProperties":false},"types_event_Id":{"description":"A unique string identifier defined by the application provider of the event. The identifier string may have embedded structure (provider dependent) to potentially facilitate pattern matching.\n","type":"string","additionalProperties":false},"types_resource_name":{"description":"A user friendly name to group events.\n","enum":["ern","networkIntelligence","edgeApplicationServer","ue"],"additionalProperties":false},"types_event_type":{"description":"A user friendly event type defined by the application provider of the event. The identifier string may have embedded structure (provider dependent) to potentially facilitate pattern matching.\n","type":"string","additionalProperties":false},"types_event_version":{"description":"Defined by the application provider of the event to support multiple versions of the events. \n","type":"string","additionalProperties":false},"types_region_Id":{"description":"Unique identifier representing a region\n","type":"string","additionalProperties":false},"types_serviceEndpoints_Id":{"description":"A system-defined string identifier representing one or more registered Service Endpoints.\n","type":"string","readOnly":true,"additionalProperties":false},"types_service_profile_Id":{"description":"Unique identifier for a service profile\n","type":"string","readOnly":false,"additionalProperties":false},"types_subscription":{"description":"Type of subscription","type":"string","enum":["events"],"additionalProperties":false},"types_subscription_Id":{"description":"Unique identifier for a Subscription to be notifed of Events.\n","type":"string","readOnly":true,"additionalProperties":false},"types_subscription_status":{"description":"Indicates the status of the subscription as Active vs Inactive.\n","type":"string","enum":["active","pending_active","failed","deleted","pending_delete","inactive"],"additionalProperties":false},"types_user_Id":{"description":"User equipment identifier that uniquely identifies an API caller","type":"object","properties":{"UEIdentityType":{"type":"string","enum":["MSISDN","IPAddress","IMEI","MDN","GPSI"]},"UEIdentity":{"$ref":"#/components/schemas/types_UEIdentity"}},"required":["UEIdentityType","UEIdentity"],"additionalProperties":false},"types_zone_Id":{"description":"Unique identifier representing a zone\n","type":"string","additionalProperties":false},"types_networkRourceName":{"description":"name or tshirt size associated to the network resources required","type":"string","additionalProperties":false},"types_networkResources":{"type":"object","properties":{"minBandwidthKbits":{"type":"integer","description":"Minimum required connection bandwidth in Kbit/s for the application"},"serviceContinuitySupport":{"type":"boolean","description":"Indicates if service continuity support is required or not for the application."},"maxRequestRate":{"type":"integer","description":"Maximum request rate that the application can handle"},"maxLatencyMs":{"type":"integer","description":"Maximum response time or latency that the application can handle, in miliseconds"},"minAvailability":{"type":"integer","description":"Minimum availability required for the server"}},"additionalProperties":false},"types_computeResources":{"type":"object","properties":{"GPU":{"type":"object","properties":{"minCoreClockMHz":{"type":"integer","description":"Minimum Core Clock value in megahertz"},"minMemoryClockMHz":{"type":"integer","description":"Minimum Memory Clock value in megahertz"},"minBandwidthGBs":{"type":"integer","description":"Minimum GPU bandwidth in GB/s"},"minTFLOPS":{"type":"integer","description":"Minimum Floating Point Operations Per Second in Teraflops."}}},"minRAMGB":{"type":"integer","description":"minimum RAM required in Gigabytes."},"minStorageGB":{"type":"integer","description":"Minimum storgae requirement in Gigabytes"}},"description":"Compute resources of a service profile","additionalProperties":false},"types_notification":{"description":"Payload data structure of event notification","type":"array","items":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/resources_event"},"timestamp":{"description":"Timestamp when the event occurred","type":"string","format":"date-time"},"regions":{"description":"Regions where the event occurred","type":"array","items":{"$ref":"#/components/schemas/types_region_Id"}},"zones":{"description":"Zones where the event occurred","type":"array","items":{"$ref":"#/components/schemas/types_zone_Id"}},"resources":{"description":"The edge resources the event originated from","type":"array","items":{"$ref":"#/components/schemas/types_edgeResource"}}}},"additionalProperties":false},"types_error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"links":{"$ref":"#/components/schemas/links_Common"}},"required":["code","message","links"],"additionalProperties":false},"types_success":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"links":{"$ref":"#/components/schemas/links_Common"}},"required":["code","message","links"],"additionalProperties":false},"types_UEIdentityType":{"description":"Type of User Equipment identifier used in `UEIdentity`.","type":"string","enum":["IPAddress","MSISDN","IMEI","MDN","GPSI"]},"types_UEIdentity":{"description":"Identifier value for User Equipment. The type of identifier is defined by the 'UEIdentityType' parameter.","type":"string"},"links_All-mec-platforms":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"ListMECPlatforms","example":"ListMECPlatforms"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","pattern":"\\/mecplatforms","example":"/mecplatforms"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_All-service-profiles":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"ListServiceProfiles","example":"ListServiceProfiles"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","pattern":"\\/serviceprofiles","example":"/serviceprofiles"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_All-events":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"ListEvents","example":"ListEvents"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","pattern":"\\/events","example":"/events"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_All-service-endpoints":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"ListServiceEndpoints","example":"ListServiceEndpoints"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","pattern":"\\/serviceendpoints","example":"/serviceendpoints"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_All-regions":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"ListRegions","example":"ListRegions"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","pattern":"\\/regions","example":"/regions"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_All-subscriptions":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"ListSubscriptions","example":"ListSubscriptions"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","pattern":"\\/subscriptions","example":"/subscriptions"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_All-zones":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"ListZones","example":"ListZones"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","pattern":"\\/zones","example":"/zones"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Optimal-MEC-platforms-by-region":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"GetOptimalPlatformsByRegion","example":"GetOptimalPlatformsByRegion"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","pattern":"\\/mecplatforms\\?region=[a-zA-Z0-9-]*$","example":"/mecplatforms?region=us-east1"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Optimal-MEC-platforms-by-zone":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"GetOptimalPlatformsByZone","example":"GetOptimalPlatformsByZone"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","pattern":"\\/mecplatforms\\?zone=[a-zA-Z0-9-]*$","example":"/mecplatforms?zone=us-east1-boston"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Optimal-MEC-platforms-by-density":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"GetOptimalPlatformsBySubscriberDensity","example":"GetOptimalPlatformsBySubscriberDensity"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","pattern":"\\/mecplatforms\\?subscriberDensity=[0-9]*$","example":"/mecplatforms?subscriberDensity=100"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Optimal-MEC-platforms-by-service-profile":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"GetOptimalPlatformsByServiceProfile","example":"GetOptimalPlatformsByServiceProfile"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","pattern":"\\/mecplatforms\\?serviceProfileId=[a-zA-Z0-9-]*$","example":"/mecplatforms?serviceProfileId=12345"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Optimal-MEC-platforms-by-UE":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"GetOptimalPlatformsByUEId","example":"GetOptimalPlatformsByUEId"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","pattern":"\\/mecplatforms\\?UEIdentityType=[a-zA-Z0-9-]*\\&UEIdentity=[a-zA-Z0-9.-]*","example":"/mecplatforms?UEIdentityType=IPAddress&UEIdentity=123.456.78.101"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Register-service-endpoint":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"RegisterServiceEndpoint","example":"RegisterServiceEndpoint"},"method":{"type":"string","pattern":"post","example":"post"},"href":{"type":"string","pattern":"/serviceendpoints","example":"/serviceendpoints"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Update-service-endpoint":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"UpdateServiceEndpoint","example":"UpdateServiceEndpoint"},"method":{"type":"string","pattern":"put","example":"put"},"href":{"type":"string","pattern":"\\/serviceendpoints\\/[A-Za-z0-9]*$","example":"/serviceendpoints/98765"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Delete-service-endpoint":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"DeleteServiceEndpoint","example":"DeleteServiceEndpoint"},"method":{"type":"string","pattern":"delete","example":"delete"},"href":{"type":"string","pattern":"\\/serviceendpoints\\/[A-Za-z0-9]*$","example":"/serviceendpoints/98765"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Optimal-service-endpoints-by-service-profile":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"ListServiceEndpointsByServiceProfileId","example":"ListServiceEndpointsByServiceProfileId"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","pattern":"\\/serviceendpoints\\?serviceProfileId=[A-Za-z0-9]*$","example":"/serviceendpoints?serviceProfileId=12345"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Optimal-service-endpoints-by-zone":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"GetOptimalServiceEndpointsByZone","example":"GetOptimalServiceEndpointsByZone"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","pattern":"\\/serviceendpoints\\?zone=[A-Za-z0-9-]*$","example":"/serviceendpoints?zone=us-east1"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Optimal-service-endpoints-by-region":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"GetOptimalServiceEndpointsByRegion","example":"GetOptimalServiceEndpointsByRegion"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","pattern":"/serviceendpoints?region={string}","example":"/serviceendpoints?region=us-east1"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Create-service-profile":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"CreateServiceProfile","example":"CreateServiceProfile"},"method":{"type":"string","pattern":"post","example":"post"},"href":{"type":"string","pattern":"/serviceprofiles","example":"/serviceprofiles"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Update-service-profile":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"UpdateServiceProfile","example":"UpdateServiceProfile"},"method":{"type":"string","pattern":"put","example":"put"},"href":{"type":"string","pattern":"\\/serviceprofiles\\/[0-9]*$","example":"/serviceprofiles/12345"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Delete-service-profile":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"DeleteServiceProfile","example":"DeleteServiceProfile"},"method":{"type":"string","pattern":"delete","example":"delete"},"href":{"type":"string","pattern":"\\/serviceprofiles\\/[0-9]*$","example":"/serviceprofiles/12345"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Create-subscription":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"CreateEventSubscription","example":"CreateEventSubscription"},"method":{"type":"string","pattern":"post","example":"post"},"href":{"type":"string","pattern":"/subscriptions","example":"/subscriptions"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Update-subscription":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"UpdateEventSubscription","example":"UpdateEventSubscription"},"method":{"type":"string","pattern":"put","example":"put"},"href":{"type":"string","pattern":"\\/subscriptions\\/[A-Za-z0-9]*$","example":"/subscriptions/246810"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Delete-subscription":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"DeleteEventSubscription","example":"DeleteEventSubscription"},"method":{"type":"string","pattern":"delete","example":"delete"},"href":{"type":"string","pattern":"\\/subscriptions\\/[A-Za-z0-9]*$","example":"/subscriptions/246810"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Self":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"self","example":"self"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","format":"uri"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Version-History":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"version-history","example":"version-history"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","format":"uri"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Terms-of-Service":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"terms-of-service","example":"terms-of-service"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","format":"uri"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Bookmark":{"type":"object","readOnly":true,"properties":{"link":{"type":"object","properties":{"rel":{"type":"string","pattern":"bookmark","example":"bookmark"},"method":{"type":"string","pattern":"get","example":"get"},"href":{"type":"string","format":"uri"}},"required":["href","rel","method"]}},"additionalProperties":false},"links_Common":{"type":"array","readOnly":true,"items":{"oneOf":[{"$ref":"#/components/schemas/links_Self"},{"$ref":"#/components/schemas/links_Version-History"},{"$ref":"#/components/schemas/links_Terms-of-Service"},{"$ref":"#/components/schemas/links_Bookmark"}]}}},"parameters":{"serviceProfileId":{"name":"serviceProfileId","description":"service profile identifier","in":"query","required":false,"schema":{"type":"string"}},"region":{"name":"region","description":"MEC region ID","in":"query","required":false,"schema":{"type":"string"}},"serviceEndpointsIds":{"name":"serviceEndpointsIds","description":"serviceEndpointsIds, delimited by pipe. Each serviceEndpointsId is a pointer to the service endpoints (IP address, FQDN etc.) previously registered for a given service.","in":"query","required":true,"schema":{"type":"array","items":{"$ref":"#/components/schemas/types_serviceEndpoints_Id"}},"style":"pipeDelimited","explode":false},"subscriberDensity":{"name":"subscriberDensity","description":"Minimum number of 4G/5G subscribers per square kilometer.","in":"query","required":false,"schema":{"type":"integer"}},"UEIdentityType":{"name":"UEIdentityType","description":"Type of User Equipment identifier used in `UEIdentity`.","in":"query","required":false,"schema":{"$ref":"#/components/schemas/types_UEIdentityType"}},"UEIdentity":{"name":"UEIdentity","description":"Identifier value for User Equipment. The type of identifier is defined by the UEIdentityType parameter.","in":"query","required":false,"schema":{"$ref":"#/components/schemas/types_UEIdentity"}},"zone":{"name":"zone","description":"MEC zone ID","in":"query","required":false,"schema":{"type":"string"}}},"responses":{"OK":{"description":"HTTP 200 OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/types_success"}}}},"Created":{"description":"HTTP 201 Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/types_success"}}}},"NoContent":{"description":"HTTP 204 No Content"},"BadRequest":{"description":"HTTP 400 Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/types_error"}}}},"NotFound":{"description":"HTTP 404 The specified resource was not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/types_error"}}}},"Unauthorized":{"description":"HTTP 401 Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/types_error"}}}},"Unexpected":{"description":"HTTP 500 Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/types_error"}}}}}}}